Zynthian UI User's Guide - Vangelis - Revision history

Jofemodo: /* Zynpad (Scene) */

2026-05-20T14:05:16Z

Zynpad (Scene)

Jofemodo: /* The Sequencer */

2026-05-20T14:04:54Z

The Sequencer

Wyleu at 12:30, 19 May 2026

2026-05-19T12:30:24Z

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

2026-05-09T15:55:07Z

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

Show changes

Riban: Replace "push" with "press".

2026-05-09T15:45:52Z

Replace "push" with "press".

Show changes

Riban: /* Choose your own adventure */

2026-05-09T15:36:32Z

Choose your own adventure

Riban: /* Introduction */

2026-05-09T11:59:38Z

Introduction

Riban: /* Introduction */

2026-05-09T11:58:19Z

Introduction

Riban at 09:58, 9 May 2026

2026-05-09T09:58:38Z

Riban: Remove erroneous text from snapshot section

2026-04-29T07:17:10Z

Remove erroneous text from snapshot section

← Older revision		Revision as of 14:05, 20 May 2026
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.		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.
−
−	~~===Zynpad (Scene)===~~
−	~~Zynpad is a sequencer launcher, presented as a grid of trigger pads. Each pad can start and stop a sequence which may also be triggered by MIDI note-on commands.~~
−
−	~~<div class="show_only_v5">~~
−	~~[[File:v5_mockup_zynpad_01.png\|800px\|right]]~~
−
−	* '''knob#4'''
−	** '''''rotate''''' to move cursor horizontally.
−	** '''''short-press''''' to play/stop the selected sequence.
−	** '''''bold-press''''' to open the pattern editor for the selected sequence.
−	* '''knob#3'''
−	** '''''rotate''''' to move cursor vertically.
−	** '''''short-press''''' to MIDI-learn the current pad by pressing a note in your MIDI controller.
−	* '''knob#2'''
−	** '''''rotate''''' to change the scene.
−	* '''knob#1'''
−	** '''''rotate''''' to adjust tempo BPM.
−
−	~~<br>~~
−
−	{{NoteBox\|Before MIDI-learning pads, you have to select a trigger device. Press OPT to access the zynpad menu and choose your trigger device. Note that if the selected device is already supported (has a driver!), MIDI-learning is not needed at all and the device will be mapped automatically.}}
−
−	~~<br clear=all>~~
−	~~</div>~~

	===Pattern Editor===		===Pattern Editor===

@@ Line 855: / Line 855: @@
 <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>

@@ Line 17: / Line 17: @@
 === Choose your own adventure ===
-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>.
+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 <span class="show_only_v5">'''bold-press''' ALT</span><span class="show_only_v4">'''long-press''' Knob 1</span>.
-<blockquote>'''''You can select the documentation for different hardware types (V5 or V4) with the selector in the top right of the page''''' ↑</blockquote>
+<blockquote>'''''You can select the documentation for different hardware types (V5 or V4) with the selector in the top right of the page ↑'''''</blockquote>
 If you are using V1-V3 then select V4. If you are using touchscreen only, use V5 with "V5 buttons" enabled. 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.
 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 ===

← Older revision		Revision as of 11:59, 9 May 2026
Line 5:		Line 5:
	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]].		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 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.

@@ 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]]