ZynthianWiki - Recent changes [en]

Zynthian UI User's Guide - Vangelis

Jofemodo — Wed, 20 May 2026 14:05:16 GMT

Zynpad (Scene)

Zynthian UI User's Guide - Vangelis

Wyleu — Tue, 19 May 2026 12:30:24 GMT

Assistive Technology and accessibility - Vangelis

Riban — Mon, 18 May 2026 10:39:45 GMT

Physical device

Assistive Technology and accessibility - Vangelis

Riban — Sun, 17 May 2026 17:21:02 GMT

Creates assistive technology guide

New page

= Zynthian Accessible Technology =

Zynthian aspires to be as accessible as possible. That includes publishing the source code and hardware designs with open source licences, providing low cost access to hardware and making the user interface accessible to as many people as we can. This document describes some of the ways we try to achieve this.

== Physical device ==

Zynthian V5 is a metal box with user controls on its front or top panel, and interface connectors on the rear.

=== Front Panel ===

The front (or top) panel has 20 rubber buttons on its left hand side, arranged in a grid of four wide and five high. The STOP button, located in the second column, third row, has a raised dimple to give some location registration to the user. There are four endless knobs arranged in a vertical column on the right hand side. Each knob may be pressed to trigger a switch operation. A touchscreen lies between these. All control can be done with the buttons and knobs. The touchscreen offers some alternative access to functions but is not required to control the zynthian.

The button layout is:

* Top row:
** Option menu
** Mixer
** Control and presets
** ZS3 and snapshot
* Second row:
** Alternative function toggle or, ALT button
** Tempo
** Step sequencer
** Function 1
* Third row:
** Record
** Stop
** Play
** Function 2
* Fourth row:
** Back or cancel
** Up arrow
** Select or confirm
** Function 3
* Bottom row:
** Left arrow
** Down arrow
** Right arrow
** Function 4 or, ZynSpeak button

The knobs or rotary encoders are numbered 1 to 4. 1 is the furthest away and 4 is the closest.

=== Rear Panel ===

The rear panel has the physical connectors. From left to right, with the back facing away from you, (that is right to left if looking at the back) these are:

* Headphones: 6.35mm or 1/4 inch jack socket providing stereo audio output for monitoring.
* Audio Outputs 1 and 2: 6.35mm or 1/4 inch jack sockets providing balanced TRS or single-ended TS signals.
* Audio Inputs 1 and 2: 6.35mm or 1/4 inch jack sockets accepting balanced TRS or single-ended TS signals.
* MIDI In: 5-pin DIN socket accepting standard MIDI 1.0 signal.
* MIDI Thru: 5-pin DIN socket passing a buffered copy of the MIDI In signal.
* MIDI Out: 5-pin DIN socket providing standard MIDI 1.0 signal.
* Network: RJ45 Gigabit Ethernet.
* USB: 4 USB type-A connectors.
* USB Peripheral: A USB type-B socket allowing connection to a host device, like a personal computer exposing zynthain as a USB MIDI device to that host.
* Power switch: Connects power to the internal power circuit. This is a hard switch and does not perform a controlled shutdown.
* Power inlet: Accepts a 5.5 x 2.5 mm, center-positive barrel connector supplying 12V to 24V DC.

== Software ==

There are some configuration options to make zynthian more accessible.

=== ZynSpeak ===

ZynSpeak is the zynthian's text-to-speech assistive technology that provides audible prompts to assist users with reduced vision. It is enabled and disabled by pressing and holding the ZynSpeak button, which is the bottom right front panel button. Audio is provided via the first available audio output (that is not configured as the zynthian's main audio output). This could be a plugin USB audio device.

=== Help ===

There is a help system built into zynthian that is accessed by pressing the ALT button for 1.5 seconds then releasing. (Remember, the ALT button is located in the first column and second row from the top.) When ZynSpeak is enabled, help information will be spoken for the current view.

Knob 3 assists the help reader. Pressing knob 3 will toggle pause, stopping playback or resuming from the start of the current sentence. Rotating knob 3 will select the previous or next sentence. Bold pressing knob 3 will announce the actions for the knobs in this view, including their rotation, press, and bold press actions. The Navigator button may be used to stop or restart from the beginning of the page. Press knob 4 to toggle hyperlink mode. Rotate knob 4 to select a link then press knob 4 to follow the link. Press back to exit link mode. The first link on each page is to an index of all available help pages. If there are no other links on the page, pressing knob 4 will immediately access the index.

There is a dedicated help page for ZynSpeak that you should review for full details.

Zynthian Users Guide

Riban — Sun, 17 May 2026 17:20:17 GMT

Adds assistive technology link

Zynthian UI User's Guide - Vangelis

Riban — Sat, 09 May 2026 15:55:07 GMT

Remove views - these are described in V5 built-in docs.

Show changes

No Hardware Build

Riban — Sat, 09 May 2026 12:03:04 GMT

Requirements

Zynthian UI User's Guide - Vangelis

Riban — Sat, 09 May 2026 11:59:38 GMT

Introduction

Adding LV2 plugins

Wyleu — Wed, 06 May 2026 18:05:07 GMT

Zynthian UI User's Guide - Vangelis

Riban — Wed, 29 Apr 2026 07:17:10 GMT

Remove erroneous text from snapshot section

@@ Line 765: / Line 765: @@
 Zynthian includes an advanced MIDI sequencer capable of pattern based and linear sequences. There is a [[ZynSeq_User_Guide|full user guide]] that describes the use of the sequencer in detail. This section gives a high-level overview of accessing and using the sequencer.
 ===Pattern Editor===
@@ Line 855: / Line 830: @@
 <br clear=all>
 </div>
 ==Custom Control Views==

← Older revision		Revision as of 12:30, 19 May 2026
Line 120:		Line 120:

	Each processor has parameters that may be controlled with zynthian knobs or mapped to MIDI CC messages. Processors may have presets that may be arranged in banks.		Each processor has parameters that may be controlled with zynthian knobs or mapped to MIDI CC messages. Processors may have presets that may be arranged in banks.
		+
		+	<br clear=all>
		+
		+	===Snapshots===
		+	[[File:snapshot_structure.png\|400px\|right]]
		+
		+	A snapshot is the captured state of zynthian at the time of saving the snapshot. Snapshots are saved in a JSON file with ''.zss'' extension and can be loaded at any time, which effectively restores the state of the zynthian device when the snapshot was saved. Snapshots include:
		+
		+	* '''chains layout:''' configuration of each chain including its processors and how they are arranged and connected
		+	* '''audio levels:''' (optional) physical audio interface settings
		+	* '''sequencer:''' patterns & sequences
		+	* '''MIDI settings:''' global MIDI settings, USB MIDI port names, etc.!!
		+	* '''multitrack record settings:''' mixer strips armed for multitrack recording
		+	* '''UI state:''' some user interface configuration relevant to the snapshot (most UI is configured globally)
		+	* '''sub-snapshots (ZS3s):''' most other configuration ([[#Sub-snapshots: ZS3\|see ZS3]])
		+
		+	Each time you overwrite an existing snapshot file, a backup copy is created. Backups can also be restored at any time, which can avoid much suffering. When you feel the panic, remember that zynthian stores the full ''save history'' for '''all''' snapshots!
		+
		+	<br clear=all>
		+
		+	{{NoteBox\|Many zynthian users like to see snapshots as "zynthian project" files and it's not a a bad approach.}}
		+
		+	====Last state snapshot====
		+	When zynthian starts, it always tries to restore the last state saved as this snapshot. It always tries to save the current state before performing some operations, like:
		+
		+	* power-off
		+	* restart
		+	* update
		+	* clean all
		+	* etc.
		+
		+	For convenience, the last state snapshot can also be saved or restored manually.
		+
		+	===Sub-snapshots: ZS3===
		+	ZS3 means '''Z'''ynthian '''S'''ub-'''S'''nap'''S'''hot. A ZS3 is a partial state that is stored in memory and can be recalled very fast. ZS3s can easily be associated (learned) to MIDI Programs (program change events). Of course, all ZS3s are saved and restored with snapshots, including the default state of the snapshot when first loaded (ZS3-0).
		+
		+	Please bear in mind that in the case of USB-connected MIDI devices there are two settings configured in admin under "MIDI-USB mapped by port" that affect this functionality.
		+	With mapped to port set the learnt settings will apply only to the specific USB Configuration in place at the time of learning. So if you add a USB hub to the rig the ZS3 sub-snapshots won't act.
		+	Turning this off will allow control simply by the MIDI message only.
		+
		+	When in the ZS3 screen, you can save the current (sub)state to ZS3 by sending a Program Change from any MIDI controller.
		+
		+	BUT In order to be able to change ZS3 by Program Change, you have to tick the box at
		+
		+	'''Interface->MIDI-options->Program Change ZS3 (Program Change for SubSnapShots)'''
		+
		+	ZS3s include:
		+
		+	* '''chains configuration:''' for each chain, MIDI channel, note-range, transpose, etc.
		+	* '''processors state:''' for each processor, bank, preset & parameter values
		+	* '''mixer settings:''' for each mixer strip, fader, balance, mute, solo, etc.
		+	* '''MIDI devices configuration:''' active / multitimbral mode, etc.
		+	* '''MIDI & Audio routing:''' connections between chains
		+	* '''MIDI learning:''' MIDI bindings to processor and mixer parameters
		+	* '''global settings:''' some global settings that can be changed by ZS3, e.g. MIDI transpose (most global settings are not available to ZS3)
		+	* '''active chain''': chain that was active when the ZS3 was saved
		+
		+	The key concept to understand how ZS3s work is noting that the '''chains layout is not stored in ZS3s'''. In other words, the chains layout is not modified when restoring ZS3s. You can't add/remove chains or processors by restoring ZS3s because this is a slow operation and ZS3s need to be restored very fast.
		+
		+	When loading a snapshot that contains ZS3s, all the chains and processors are created. Later, when recalling the ZS3s, the chains layout will remain the same. Although ZS3s can modify routing, splits, banks, presets, etc., the quantity of chains and processors will be unchanged.
		+
		+	{{NoteBox\|For instance, if you are keyboardist that plays with several bands, you could have a snapshot for each band with ZS3s for each song.}}
		+
		+	<br clear=all>
		+
	<br clear=all>		<br clear=all>

← Older revision		Revision as of 17:20, 17 May 2026
Line 7:		Line 7:

	*'''[[Zynthian UI User's Guide - Vangelis]]''' (work in progress): Vangelis is the development version.		*'''[[Zynthian UI User's Guide - Vangelis]]''' (work in progress): Vangelis is the development version.
		+
		+	*'''[[Assistive Technology and accessibility - Vangelis]]''': A guide of Vangelis accessibility features.

	*'''[[Learning Pills - Vangelis]]''': Short tutorials, usually under 5 minute view / listen / read.		*'''[[Learning Pills - Vangelis]]''': Short tutorials, usually under 5 minute view / listen / read.

@@ Line 19: / Line 19: @@
 * HDMI monitor
 * Micro HDMI to standard HDMI cable (standard HDMI for Pi 3)
-* USB computer keyboard
+* USB computer keyboard (optional)
 * USB computer mouse
 * Headphones or audio cable to connect to sound system with stereo 3.5mm plug
@@ Line 25: / Line 25: @@
 To setup remote access, update your Zynthian and enable a headless (no screen) setup:
-* Wired connection from the Raspberry Pi to your personal computer
+* Wired network connection from the Raspberry Pi to your personal computer, e.g. direct cable or via network switch
 </blockquote>

@@ Line 3: / Line 3: @@
 ==Introduction==
-Welcome to the Zynthian project, an open source hardware and software platform for musical explorers. Zynthian is a capable platform that can serve a range of musical needs from practice tool to sound design to live performance rig and more. You find out some of the features on the [[Zynthian Wiki Home|front page]] and [[Zynthian Features|here]].
+Welcome to the Zynthian project, an open source hardware and software platform for musical explorers. Zynthian is a capable platform that can serve a range of musical needs from practice tool to sound design to live performance rig and more. You can find out about some of the features on the [[Zynthian Wiki Home|front page]] and [[Zynthian Features|here]].
-The hardware includes the various official boxes from v1 through to the current (as of March 2026) V5.1 ([[Zynthian_Boxes_Photo_Gallery|see how some early versions evolved]]). On the software side, Zynthian '''Oram''' is the most recent version of zynthianOS, first released in September 2024 but this guide is for the development version that is prone to unannounced changes.
+The hardware includes the various official boxes from v1 through to the current (as of May 2026) V5.1. ([[Zynthian_Boxes_Photo_Gallery|See how some early versions evolved]]). On the software side, Zynthian '''Oram''' is the most recent version of zynthianOS, first released in September 2024 but this guide is for the development version that is prone to unannounced changes.
@@ Line 17: / Line 17: @@
 === Choose your own adventure ===
-This user guide describes the core concepts of the system and gives detailed guidance on how to use it.
+This user guide describes how to start with zynthian but does not delve into much detail. There is built-in help within the zynthian that provides contextural help. Access this at any time by <div class="show_only_v5">BOLD PRESS ALT</div><div class="show_only_v4">LONG PRESS Knob 1</div>.
-<blockquote>'''''You can select the documentation for different hardware types (V5, V4, Touch) with the selector in the top right of the page''''' ↑</blockquote>
-If you are using V1-V3 then select V4. If you have a custom build, then select the version that closest matches your hardware. If your hardware uses features from different official kits then you may wish to check the documentation for each hardware type.
+<blockquote>'''''You can select the documentation for different hardware types (V5 or V4) with the selector in the top right of the page''''' ↑</blockquote>
 It is '''strongly recommended that you read section 2 on core concepts''' which explains many aspects of how zynthian works. This provides essential knowledge to improve your understanding and ability to use zynthian. This guide includes details of how to navigate the user interface and some explanation of common workflows.
 === Quick Start ===
 Near the bottom of the guide are links to '''[[Zynthian UI User's Guide - Vangelis#Learning Pills|Learning Pills]]''': short video tutorials that show and describe various workflows. These are short, easily digestible snippets of information that can get you started quickly.

@@ Line 5: / Line 5: @@
 == Physical device ==
-Zynthian V5 is a metal box with user controls on its front or top panel, and interface connectors on the rear.
+Zynthian V5 is a metal box with user controls on its front or top panel, and interface connectors on the rear. This provides tactile user interface with positive feedback on all controls.
 === Front Panel ===
@@ Line 39: / Line 39: @@
 ** Function 4 or, ZynSpeak button
-The knobs or rotary encoders are numbered 1 to 4. 1 is the furthest away and 4 is the closest.
+The knobs or rotary encoders are numbered 1 to 4. 1 is the furthest away and 4 is the closest. Each knob has 24 detents per rotation, to give positive tactile feedback to the user.
 === Rear Panel ===
@@ Line 71: / Line 71: @@
 Knob 3 assists the help reader. Pressing knob 3 will toggle pause, stopping playback or resuming from the start of the current sentence. Rotating knob 3 will select the previous or next sentence. Bold pressing knob 3 will announce the actions for the knobs in this view, including their rotation, press, and bold press actions. The Navigator button may be used to stop or restart from the beginning of the page. Press knob 4 to toggle hyperlink mode. Rotate knob 4 to select a link then press knob 4 to follow the link. Press back to exit link mode. The first link on each page is to an index of all available help pages. If there are no other links on the page, pressing knob 4 will immediately access the index.
-There is a dedicated help page for ZynSpeak that you should review for full details.
+There is a dedicated built-in help page for ZynSpeak that you should review for full details.

@@ Line 73: / Line 73: @@
   https://github.com/x42/xfade.lv2/blob/master/Makefile
-for those that like the gore.
+for those that like the gore. . .
 So after make:

@@ Line 146: / Line 146: @@
 <br clear=all>
-===Snapshots===HiFiberry DAC Light only supports a single (stereo) DAC. You may find this works with Hifiberry DAC8X but maybe more likely with Zynaudio8X.
+===Snapshots===
 [[File:snapshot_structure.png|400px|right]]