3,528
edits
Changes
Jump to navigation
Jump to search
Line 1:
Line 1: − ==General Concepts== − <div class="show_only_v5">+ − [[File:v5_render_zenital_mixer_leds.jpg|1024px|center]] − + + + − * '''5x4 push button grid with RGB-LED feedback'''+ − * '''5 inch display with capacitive touch''' − * '''4 infinite knobs (rotary encoders) with push switches''' − This richer interface allows to simplify navigation and reduce the number of "clicks", which improves workflow and makes it faster and more intuitive.+ + + + + + + + + + + − The 20 silicone push buttons and the 4 knobs with switches are the primary control mechanism to navigate the UI:+ − * '''accessing the different screens'''+ − * '''selecting options on menus and lists''' − * '''adjusting parameters''' − Each push button is engraved with a text legend or icon and backlit with RGB LED that gives status feedback. The knobs are numbered from top to bottom, so the top one is knob#1 and the bottom one is knob#4. We will refer knobs in this way throughout this guide.+ − </div> − <div class="show_only_v4">+ − The core Zynthian UI consists of a display and four knobs with push switches. You can also control the UI with a touchscreen, a mouse or a keyboard (computer keyboard or MIDI keyboard, both!) − [[File:Zynthian v4 top legend.png|600px|center]]+ − The four knobs with switches are the primary control mechanism to navigate the UI: + + − * '''accessing the different screens'''+ − * '''selecting options on menus and lists''' − * '''adjusting parameters''' − </div> − Most operations may be performed with the touchscreen but some may not be intuitive or easy to perform with it. On the other hand, some operations are specially optimized for using the touch screen. This will be detailed when explaining the different screens and workflows. − − − <div class="show_only_v5"> − The two main differences between the V5 UI and the ''classic'' zynthian UI are: − − * the big 5x4 silicone button grid, that adds 20 push buttons with RGB LED feedback. − * as a consequence of the availability of more buttons, the 4 knobs are often used in quite a different way. − − </div> − − There are 3 types of push actions that can be performed, depending on how long you hold down the button (or knob!): − − * '''short-push:''' Less than 0.3 seconds − * '''bold-push:''' Between 0.3 and 2 seconds − * '''long-push:''' More than 2 seconds (until the long-action is triggered!) − − <br clear=all> − {{NoteBox|Not all buttons have actions assigned to all three push types. You can change these timings from the [[Web_Configuration_User_Guide#User_Interface|webconf's UI tab]].}} + + − ===The Title Bar===+ − [[File:Screenshot 2024-06-22 11.41.54.png|400px|right|Title Bar]] − The title bar acts as a kind of breadcrumb. It normally shows the screen title or current chain information: MIDI channel, engine, bank & preset.+ + − <br clear=all>+ − ===The Status Area===+ − [[File:Zynthian_Status_Bar.png|400px|right]] − On the top-right corner, aside the title bar, is an area where some useful information is displayed in real time:+ − * '''Digital audio Peak Meter (DPM)''': horizontal bars indicating digital audio level and peaks+ − * '''Status Icons''': indication of various zynthian states+ − Let's see the details:+ − + − The DPM covers the range -50dBFS to 0dBFS, i.e. maximum permissible level at full scale (far right) down to 50dB below (far left): + − * The green segment covers the range -50dBFS to -10dBFS.+ − * The yellow segment covers the range -10dBFS to -3dBFS.+ − * The red segment covers the range -3dBFS to 0dBFS. − − There are independent meters for left and right channels which monitor the system output, i.e. the mix of audio that feeds the Zynthian output. Level decays with a logarithmic rule, taking one second to decay to -200dBFS so will decay to -50dBFS (the displayed range) in about quarter of a second. Peaks are displayed instantly, i.e. the attack of the meter is immediate (*). The peak hold bar remains for two seconds or until a higher peak is reached. − This meter is the same as the main mixbus DPM that is always visible in the mixer view and is therefore hidden when the audio mixer view is shown.+ + − (*) Meter is updated 5 times per second so there can be 200 ms delay in peak being displayed.+ + − ====The Status Icons====+ − {| class="wikitable"+ − !colspan="3"|1st row: Health & Load+ − |-+ − |style="padding:10px"|<span style="color:#00FF00">{{#fas:heart}}</span> − |style="padding:10px;width: 200px;|'''Cpu Load''' − |style="padding:10px"|Heart, indicating CPU load. It displays as green when under 50%, yellow when load is over 50% and red over 75%. − |- − |style="padding:10px"|<span style="color:#00FF00">{{#fas:recycle}}</span> − |style="padding:10px;width: 200px;|'''Software update available''' − |style="padding:10px"|When a software update is available, the green recycle symbol is shown. You can update from the admin menu, webconf or terminal. − |- − |style="padding:10px"|<span style="color:#FF0000">{{#fas:exclamation-triangle}}</span> − |style="padding:10px"|'''XRun''' − |style="padding:10px"|It's shown when there are XRuns. This may be accompanied by clicks and pops on audio output. This means the CPU can't process or transfer audio fast enough and you should consider disabling some CPU-hungry option (like VNC, headphones, etc.) or reducing the complexity of your chains. − |- − |style="padding:10px"|<span style="color:#FF0000">{{#fas:bolt}}</span> − |style="padding:10px"|'''Under-voltage''' − |style="padding:10px"|Zynthian is working in a degraded state, with the CPU frequency capped to 600-800 MHz, trying to stabilize the system and avoid a system crash. You shouldn't see that icon and if you do so, you should consider looking for a better power source. − |- − |style="padding:10px"|<span style="color:#FF0000">{{#fas:temperature-high}}</span> − |style="padding:10px"|'''Over-temperature''' − |style="padding:10px"|Zynthian is working in a degraded state, with the CPU frequency capped to 600-800 MHz, trying to stabilize the system and avoid a system crash. You shouldn't see that icon and if you do so, you should improve heat dissipation (using a heat sink, etc.) − |- − !colspan="3"|2nd row: MIDI activity & Playing/Recording − |- − |style="padding:10px"|<span style="color:#8080FF">'''m'''</span> − |style="padding:10px;width: 200px;|'''MIDI-IN''' − |style="padding:10px"|It's shown when MIDI messages are received. Underscore indicates system message such as MIDI clock. − |- − |style="padding:10px"|<span style="color:#B00000">{{#fas:circle}}</span> − |style="padding:10px"|'''Recording Audio''' − |style="padding:10px"|Audio is being recorded. − |- − |style="padding:10px"|<span style="color:#00B000">{{#fas:play}}</span> − |style="padding:10px"|'''Playing Audio''' − |style="padding:10px"|Audio track is being played. − |- − |style="padding:10px"|<span style="color:#F000F0">{{#fas:circle}}</span> − |style="padding:10px"|'''Recording MIDI''' − |style="padding:10px"|MIDI is being recorded. − |- − |style="padding:10px"|<span style="color:#F000F0">{{#fas:play}}</span> − |style="padding:10px"|'''Playing MIDI''' − |style="padding:10px"|MIDI track is being played. − |- − |style="padding:10px"|<span style="color:#F07000">{{#fas:circle}}</span> − |style="padding:10px"|'''Recording Pattern''' − |style="padding:10px"|A sequencer's pattern is being recorded. − |- − |style="padding:10px"|<span style="color:#F07000">{{#fas:play}}</span> − |style="padding:10px"|'''Playing Sequence''' − |style="padding:10px"|A sequence or pattern is being played. − |} − ==The Zynthian UI Workflow==+ − Zynthian workflow is based around chains of audio/MIDI generators & processors feeding an audio summing mixer. − [[File:Zynthian Signal Flow.png|800px|center]]+ − ===Chains=== − Chains are a key concept of the Zynthian. The first thing you will do after powering-on your Zynthian is probably to create a chain. (It does little without any chains!) − A chain is composed of one or more interconnected blocks (processor slots), capable of generating or processing audio & MIDI. Each chain is normally assigned to a MIDI channel. These blocks are chained in the same order they are created, but you can change this order from the '''Chain Options''' menu. When a chain is created it is assigned a type:+ + − * '''Synth Chain''' => Receives MIDI note-events and generate audio output. It must have a synth processor.+ − * '''Audio Chain''' => Receives audio-input and generates audio-output. It only has audio-FX processors.+ − * '''MIDI Chain''' => Receives MIDI-input and generates MIDI-output. It only has MIDI processors. − − * '''Generator Chain''' => Generate audio output using an algorithm. The first processor is an audio generator. − * '''Special Chain''' => It can contains special processors, a MOD-UI pedalboard or a Pure Data patch. It can process audio and MIDI. − <br> − + − <!--+ − (Oram) Synth, MIDI & MIDI+Audio chains have a MIDI channel assigned. MIDI channels are not exclusive. You can assign the same MIDI channel to several chains. MIDI and MIDI+Audio chains can receive '''all MIDI channels'''. + + − (Oram) In MIDI+Audio chains, all audio processors in the chain receive all the MIDI events on the assigned channel (this should be improved!).+ − --> − (*) If Master Channel is enabled, this is excluded from the MIDI channels available for chain assignment.+ + + − Having several chains on the same MIDI channel is not allowed currently. If you want two or more chains to play in unison (like being on the same MIDI channel), you can use the "Clone" feature, which allows you to bind several chains while keeping MIDI CCs and other MIDI messages (Program Change, Channel Pressure, etc.) independent.+ + − + + − ===MIDI input===+ − Each chain receive MIDI input from selected devices (keyboards and other MIDI controllers). You can configure the MIDI input devices from the chain's option menu. Use short-push for selecting the devices and bold-push for changing the input mode. All input devices are selected by default when creating a new chain. + + + − Each input device can work in 3 different modes:+ − + − + − + + − When using ACTI mode you don't need to worry about the MIDI channel your keyboard/controller is using. You change the instrument you play by changing the active chain in your zynthian. You can change the active chain by simply rotating the select knob (#4) in the Mixer view or using the the left/right arrows.+ + − In the other hand, MULTI mode allows receiving and managing separately every MIDI channel. Each MIDI controller will drive the chains assigned to the controller's MIDI channel. If you are using a MIDI controller that can sequence multiple tracks (Beatstep Pro, Keystep Pro, Novation Circuit etc.) then you will generally want to use this mode.+ + − Finally, OMNI mode allows one or several chains to receive all MIDI input from your device translated to chain's MIDI channel. This can be useful for some use-cases. Be warned that this mode will be dropped in the near future so you should avoid it.+ + + + + + + + + − Note that MIDI CC (Continuous Controllers) events are handled differently and they are not routed to chains. See section on [[#MIDI-learning_.2F_binding|MIDI Learning & binding]].+ − <br clear=all>+ − ==Using the push buttons==+ + + − The push buttons grid is divided in 5 groups:+ + − + − ===<span style="color:#00D000;">Screen access buttons</span>===+ + + + + Line 249:
Line 199: − − ===<span style="color:#D000D0;">ALT button</span>===+ Line 259:
Line 208: + − ===<span style="color:#F00000;">Transport buttons</span>===+ − Line 284:
Line 233: + + − ===<span style="color:#F0C000;">Navigation buttons</span>===+ − Line 308:
Line 258: + − ===<span style="color:#0000D0;">Custom function buttons (F1-F4)</span>===+ − Line 325:
Line 275: + + + + + + − + − + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + − − ===General rule===+ Line 343:
Line 332: − + + + + + + + + + + + + + + + + + + + + + + + − + − + + + + + + + + + + + + + + + − * '''Knob#1 - #4'''+ − ** ''rotate'' any knob to change the value of the assigned parameter, same as the classic UI. This has not changed. − ** ''short-push'' any knob to start MIDI-learning for the associated parameter. Move a knob/fader in your MIDI controller end the learn. Push back to cancel. − ** ''bold-push'' any knob to open the options menu for the associated parameter. − <br>+ − + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + − <br clear=all>+ + + Line 379:
Line 456: + + + + + + + + + + + + + + + + + + + + + − + + + + + + + + + + + + + + + + + + + + + + + + + + + Line 400:
Line 524: + − + + Line 411:
Line 537: + + Line 420:
Line 548: − + + Line 429:
Line 558: + − + − − − − [[File:Mixer.jpg|center]] Line 477:
Line 603: − − =='''Work In Progress'''== − − This V5 documentation is a work in progress and it will be improved during the next weeks/months. Meanwhile, you could find very useful to consult: − − * the [[Zynthian UI User Guide - V1/V4|Zynthian V1-V4 UI User Guide]] − * the [[ZynSeq User Guide]] − − − <br clear=all>
Zynthian UI User's Guide - Oram (view source)
Revision as of 23:20, 28 July 2024
, 23:20, 28 July 2024no edit summary
{{VersionBar}}
{{VersionBar}}
==Introduction==
The zynthian V5 physical user interface is composed, from left to right, of:
==Basic concepts==
===Chains & Processors===
Chains are a key concept in Zynthian. The first thing you will do after powering-on your Zynthian, once you stop celebrating your success, is creating a chain. It does little without any chains!.
A chain is composed of one or more interconnected blocks, called '''processors''', capable of generating or processing audio and MIDI. By default, processors are chained in the order they are created, but you can change this order from the '''chain options''' menu. Chain processors can be re-ordered and arranged as serial or parallel paths. Audio processors can be added pre-fader and post-fader.
====Type of chains====
When a chain is created it is assigned a type:
<br>
* '''Synth Chain''' => Receives MIDI note-events and generate audio output. It must have a synth processor.
* '''Audio Chain''' => Receives audio-input and generates audio-output. It only has audio-FX processors.
* '''MIDI Chain''' => Receives MIDI-input and generates MIDI-output. It only has MIDI processors.
* '''MIDI + Audio Chain''' => Receives MIDI + Audio input and generates MIDI + Audio output. It has MIDI and audio-FX processors.
* '''Generator Chain''' => Generate audio output using an algorithm. The first processor is an audio generator.
* '''Special Chain''' => It can contains special processors, a MOD-UI pedalboard or a Pure Data patch. It can process audio and MIDI.
<br>
The chain's type can't be changed after creating the chain. Depending of the chain's type, MIDI processors can be added to the start of the chain and audio processors can be added to the end of the chain.
Synth and MIDI chains must have a '''MIDI channel''' assigned. MIDI channels are not exclusive, so you can assign the same MIDI channel to several chains.
In MIDI+Audio chains, all audio processors in the chain receive all the MIDI events in the assigned channel. This is very convenient with some processors, like vocoder and auto-tune ones.
MIDI chains can be configured to receive '''all MIDI channels'''. This is specially useful when using zynthian as a MIDI router.
{{NoteBox|If Master Channel is enabled, this is excluded from the MIDI channels available for chain assignment.}}
<br clear=all>
===Signal workflow===
Zynthian workflow is based around chains of audio/MIDI generators & processors that feed an audio summing mixer and external MIDI devices.
[[File:Zynthian Signal Flow.png|800px|center]]
<br clear=all>
<br clear=all>
===MIDI input===
Each chain receive MIDI input from selected devices (keyboards and other MIDI controllers). You can configure the MIDI input devices from the chain's option menu. Use short-push for selecting the devices and bold-push for changing the input mode. All input devices are selected by default when creating a new chain.
Each input device can work in 2 different modes:
* '''ACTI:''' the active chain receives all MIDI input from the device and all MIDI events are translated to the active chain's MIDI channel. It's the default mode for all input devices.
* '''MULTI:''' each chain receives MIDI from the input device in the configured MIDI channel. No MIDI channel translation is done.
When using ACTI mode you don't need to worry about the MIDI channel your keyboard/controller is using. You change the instrument you play by changing the active chain in your zynthian (see below).
In the other hand, MULTI mode allows receiving and managing separately every MIDI channel. Each MIDI controller will drive the chains assigned to the controller's MIDI channel. If you are using a MIDI controller that can sequence multiple tracks (Beatstep Pro, Keystep Pro, Novation Circuit etc.), you will generally want to use this mode.
{{NoteBox|Note that MIDI CC (Continuous Controllers) events are handled differently and they are not routed to chains. See section on [[#MIDI-learning_.2F_binding|MIDI Learning & binding]].}}
====Active Chain====
The active chain is the chain currently selected. This is specially important when using the ACTI mode (the default mode!).
From the mixer, you can change the active chain by <span class="show_only_v5">rotating the '''knob#4''' or using the '''left/right arrows'''</span><span class="show_only_v4">rotating the '''SELECT knob'''</span><span class="show_only_touch">touching the chain's strip fader</span>.
====Digital audio Peak Meter (DPM)====
If you push the <span class="show_only_v5"> '''knob#4''' or the '''SEL button'''</span><span class="show_only_v4">'''SELECT knob'''</span><span class="show_only_touch">legend area under the chain's strip fader</span>, you enter the '''chain control screen''', what turns the chain active if it's not yet. <span class="show_only_v5">From the control screen you can change the active chain using the '''left/right arrows'''.</span><span class="show_only_v4">From the control screen you can short-push the '''LAYER knob''' to rotate the active chain.</span>
Finally, you can also change the active chain by recalling ZS3s (subsnapshots).
====Active MIDI channel====
This global option can be toggled from the admin menu and it modifies the way ACTI mode works:
* '''Disabled:''' Only the active chain receive MIDI input from the device. It's the default.
* '''Enabled:''' All chains with the same MIDI channel that the active chain receive MIDI input from the device. This is very useful for layering sounds without any extra routing. You simply create several synth chains, assigning the same MIDI channel to all of them and they will play unison. You can also create keyboard splits with by adjusting note range and transpose for each chain from the chain options menu.
===Snapshots===
A snapshot is the captured state of a zynthian device at the time of saving the snapshot. Snapshots are saved in a JSON file with ''.zss'' extension and can be restored at any time, what effectively restore the state of the zynthian device when the snapshot was saved. A snapshot include chains and processor state info, patterns, mixer settings, MIDI device configuration, routing, audio levels, configuration options, etc. Each time you save a snapshot file, a backup copy is created. Of course, these backup files can be also restored at any time, what can avoid much suffering.
{{NoteBox|Many zynthian users like to see snapshots as "zynthian project" files and it's not a a bad approach.}}
===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 be easily associated (learned) to MIDI Program Change events.
Of course, all ZS3s are saved/restored with snapshots.
For instance, if you are keyboardist that plays with several bands, you could have a snapshot for each band and one or several ZS3s for each song.
'''TO BE CONTINUED ...'''
<br clear=all>
<br clear=all>
==The physical interface==
===Description===
<div class="show_only_v5">
[[File:v5_render_zenital_mixer_leds.jpg|1024px|center]]
<!--* (Oram) '''MIDI + Audio Chain''' => Receives MIDI + Audio input and generates MIDI + Audio output. It has MIDI and audio-FX processors.-->
The chain's type can't be changed. Depending of the chain's type, MIDI processors can be added to the start of the chain and audio processors can be added to the end of the chain. Chain processors can be re-ordered and arranged as serial and / or parallel paths.
The V5 physical user interface is composed of:
* '''5x4 silicone push button grid with RGB-LED feedback'''
* '''5 inch display with capacitive touch'''
* '''4 infinite knobs (rotary encoders) with push switches'''
The 20 silicone push buttons and the 4 knobs with switches are the primary user input mechanism to navigate the UI:
* '''access the different screens'''
* '''select options on menus and lists'''
* '''adjust parameters'''
Each push button is engraved with a text legend or icon and backlit with RGB LED that gives status feedback. The knobs are numbered from top to bottom, so the top one is knob#1 and the bottom one is knob#4. We will refer knobs in this way throughout this guide.
</div>
<br clear=all>
<div class="show_only_v4">
[[File:v4_render_zenital_mixer.jpg|1024px|center]]
The V4 physical user interface is composed of:
* '''3,5 inch display with resistive touch'''
* '''4 infinite knobs (rotary encoders) with push switches'''
* '''4 silicone push buttons'''
The four knobs with switches are the primary user input mechanism to navigate the UI:
* '''ACTI:''' only the active chain receives all MIDI input from the device and all MIDI events are translated to the active chain's MIDI channel. It's the default mode.
* '''access the different screens'''
* '''OMNI:''' each chain receives all MIDI input from the device and all MIDI events are translated to each chain's MIDI channel.
* '''select options on menus and lists'''
* '''MULTI:''' each chain receives MIDI from the input device in the configured MIDI channel. No MIDI channel translation is done.
* '''adjust parameters'''
</div>
<div class="show_only_touch">
[[File:zynthian_barebones.png|800px|center]]
The barebones user interface is composed of a display with capacitive touch or mouse. A minimum display size of 5 inches is strongly advised when touch is the primary user input method.
</div>
===User interaction===
<span class="show_only_v4 show_only_v5">
Users interact with the system by pushing the silicone buttons or knob-switches or rotating the knobs. Touch can be used too for most operations and some interactions are only available from the touch interface, like the X-Y control ''ala kaos pad''.
</span>
<span class="show_only_touch">
Users interact with the system by touching/clicking the display elements and performing touch/mouse gestures, like horizontal or vertical swipes, pitch-zoom, etc.
</span>
User actions normally produce some feedback in the display. <span class="show_only_v5">Also, the V5's RBG LEDs give feedback and status info.</span>
</div>
===Types of push action===
There are 3 types of push actions that can be performed, depending on how long you hold down the button, knob-switch or display widget:
* '''short-push:''' Less than 0.3 seconds
* '''bold-push:''' Between 0.3 and 2 seconds
* '''long-push:''' More than 2 seconds (until the long-action is triggered!)
You can change the timings from the [[Web_Configuration_User_Guide#User_Interface|webconf's UI options tab]].
Not all buttons have actions assigned to all three push types. You can modify the assigned actions from the webconf tool, accessing the advanced options in the ''wiring layout'' section.
<br clear=all>
===Using the push buttons===
<div class="show_only_v5">
The V5 push buttons grid is divided in 5 groups:
<br>
<br>
'''<span style="color:#00D000;">Screen access buttons</span>'''
[[File:v5_buttons_outlined.png|400px|right]]
[[File:v5_buttons_outlined.png|400px|right]]
* '''CTRL/PRESET''' => Long-push to enter/leave preset favorites
* '''CTRL/PRESET''' => Long-push to enter/leave preset favorites
* '''PAD/STEP''' => Long-push to access Arranger
* '''PAD/STEP''' => Long-push to access Arranger
<br clear=all>
<br clear=all>
'''<span style="color:#D000D0;">ALT button</span>'''
[[File:v5_buttons_outlined-4.png|400px|right]]
[[File:v5_buttons_outlined-4.png|400px|right]]
* '''Transport buttons''' will toggle between Audio Player/Recorder <span style="color:#0000F0">(normal)</span> and MIDI Player/Recorder <span style="color:#D000D0">(alternate)</span>.
* '''Transport buttons''' will toggle between Audio Player/Recorder <span style="color:#0000F0">(normal)</span> and MIDI Player/Recorder <span style="color:#D000D0">(alternate)</span>.
* '''Customizable F1-F4 buttons''' will toggle between Program Change 1-4 <span style="color:#0000F0">(normal)</span> and Program Change 5-8 <span style="color:#D000D0">(alternate)</span>, so you can use it for easily learning and recalling up to 8 subsnapshots (ZS3s).
* '''Customizable F1-F4 buttons''' will toggle between Program Change 1-4 <span style="color:#0000F0">(normal)</span> and Program Change 5-8 <span style="color:#D000D0">(alternate)</span>, so you can use it for easily learning and recalling up to 8 subsnapshots (ZS3s).
<br>
'''<span style="color:#F00000;">Transport buttons</span>'''<br>
By default, transport buttons control the '''global audio recorder/player''' and default color is blue. When "ALT" button is pushed (ALT mode enabled), transport buttons control the '''MIDI recorder/player''' and default color is purple.
By default, transport buttons control the '''global audio recorder/player''' and default color is blue. When "ALT" button is pushed (ALT mode enabled), transport buttons control the '''MIDI recorder/player''' and default color is purple.
From all other screens, transport buttons behave normally as explained above, controlling global audio recorder/player or MIDI recorder/player (ALT mode).
From all other screens, transport buttons behave normally as explained above, controlling global audio recorder/player or MIDI recorder/player (ALT mode).
<br>
<br>
'''<span style="color:#F0C000;">Navigation buttons</span>'''<br>
Navigation buttons are used for basic navigation:
Navigation buttons are used for basic navigation:
{{NoteBox|When not in the control screen, '''knob#4 acts as the ''select'' knob''' similar to the classic V1-V4 UI. Rotate to browse lists and move the cursor horizontally in grids (zynpad, pattern editor, etc.). Push to select items, same than SELECT button. Knob#3 can be used to move the cursor vertically in grids (zynpad, pattern editor, etc.).}}
{{NoteBox|When not in the control screen, '''knob#4 acts as the ''select'' knob''' similar to the classic V1-V4 UI. Rotate to browse lists and move the cursor horizontally in grids (zynpad, pattern editor, etc.). Push to select items, same than SELECT button. Knob#3 can be used to move the cursor vertically in grids (zynpad, pattern editor, etc.).}}
<br>
'''<span style="color:#0000D0;">Custom function buttons (F1-F4)</span>'''<br>
These buttons are considered to be customizable buttons, e.g. if you want direct access to other screens, etc. you may reconfigure these buttons using the webconf's wiring layout tab.
These buttons are considered to be customizable buttons, e.g. if you want direct access to other screens, etc. you may reconfigure these buttons using the webconf's wiring layout tab.
<br clear=all>
<br clear=all>
</div>
<div class="show_only_v4">
This is the basic V4 workflow based in the 4 knob switches:
[[File:zynthian_v4_workflow.jpg|800px|center]]
==Using the knobs==
It's a good cheat sheet to have at hand when starting with zynthian. These screens and others will be discussed in detail along the next sections.
[[File:v5_render_knobs_numbered.jpg|160px|right]]
The V4's extra silicone push buttons (S1-S4) can be configured depending of the user preference. This can be done from the webconf tool, accessing the advanced options in the wiring layout section. Some predefined customization profiles are available from there:
* '''V4 Stage:''' The 4 silicone push buttons are assigned to MIDI program change 1-4. It's specially thought to use with ZS3.
** '''S1''' => MIDI Program 1
** '''S2''' => MIDI Program 2
** '''S3''' => MIDI Program 3
** '''S4''' => MIDI Program 4
* '''V4 Studio:''' The 4 silicone push buttons are assigned like this:
** '''S1'''
***Short => Audio Recorder/Player
***Bold => MIDI Recorder/Player
***Long => All Sounds Off
** '''S2'''
***Short => Zynpad
***Bold => Pattern Editor
***Long => All Sounds Off
** '''S3'''
***Short/Bold => Arrow Up
***Long => All Sounds Off
** '''S4'''
***Short/Bold => Arrow Down
***Long => All Sounds Off
* '''V4 CC Switches:''' The 4 silicone push buttons are assigned to MIDI CC 47-50. It's specially thought to MIDI learn toggle parameters (i.e. to use with SooperLooper)
** '''S1''' => CC 47 (value 0/127)
** '''S2''' => CC 48 (value 0/127)
** '''S3''' => CC 49 (value 0/127)
** '''S4''' => CC 50 (value 0/127)
</div>
===Using the knobs===
<div class="show_only_v5">
[[File:v5_render_knobs_numbered.jpg|140px|right]]
The V5 knobs behave quite differently to V1-V4 knobs. Because of the 20 silicone buttons, there is no need to use the knobs' switches to navigate the UI which now is best achieved with the push buttons, so when appropriate, knobs' switches have been mapped to drive the MIDI learning functionality, which is quite intuitive. The knobs are numbered from top to bottom, so the top one is knob#1 and the bottom one is knob#4. We will refer knobs in this way throughout this guide.
The V5 knobs behave quite differently to V1-V4 knobs. Because of the 20 silicone buttons, there is no need to use the knobs' switches to navigate the UI which now is best achieved with the push buttons, so when appropriate, knobs' switches have been mapped to drive the MIDI learning functionality, which is quite intuitive. The knobs are numbered from top to bottom, so the top one is knob#1 and the bottom one is knob#4. We will refer knobs in this way throughout this guide.
<br>
<br>
'''General rule'''
Although knob's functionality is contextual in V5, there is a kind of pattern that can serve as a ''general rule'' and applies to many screens:
Although knob's functionality is contextual in V5, there is a kind of pattern that can serve as a ''general rule'' and applies to many screens:
<br>
<br>
{{NoteBox| MAIN Volume is allways available with one click, push MIX button and '''Knob#3''' rotate is used to change the MAIN volume.}}
{{NoteBox| MAIN Volume is always available with one click. Push '''MIX button''' and rotate '''Knob#3''' to change the MAIN volume.}}
</div>
<div class="show_only_v4">
'''General rule'''
Although knob's functionality is contextual in V4, there is a kind of pattern that can serve as a ''general rule'' and applies to many screens:
<br>
* '''SELECT Knob''' acts as the '''select knob''' similar to the classic V1-V4 UI.
** ''rotate'' to browse lists and move the cursor horizontally in grids (zynpad, pattern editor, etc.).
** ''short-push'' to select items.
* '''BACK Knob'''
** ''Rotate'' to move the cursor vertically in grids (zynpad, pattern editor, etc.).
<br>
{{NoteBox| MAIN Volume is always available with one click. Bold-push '''BACK Knob''' to open the mixer screen, then rotate '''Learn/Shot Knob''' to change the MAIN volume.}}
</div>
==The top-bar==
===The title-bar===
[[File:Screenshot 2024-06-22 11.41.54.png|400px|right|Title Bar]]
The title bar acts as a kind of breadcrumb. It normally shows the screen title or current chain information: MIDI channel, engine, bank & preset.
<br clear=all>
<br clear=all>
===Chain Control (Instrument)===
===The status area===
[[File:v5_mockup_control_01.png|800px|right]]
[[File:Zynthian_Status_Bar.png|400px|right]]
On the top-right corner, aside the title bar, is an area where some useful information is displayed in real time:
* '''Digital Audio Peak Meter (DPM)''': horizontal bars indicating digital audio level and peaks
* '''Status icons''': indication of various zynthian states
====The Digital Audio Peak Meter (DPM)====
The DPM covers the range -50dBFS to 0dBFS, i.e. maximum permissible level at full scale (far right) down to 50dB below (far left):
* The green segment covers the range -50dBFS to -10dBFS.
* The yellow segment covers the range -10dBFS to -3dBFS.
* The red segment covers the range -3dBFS to 0dBFS.
There are independent meters for left and right channels which monitor the system output, i.e. the mix of audio that feeds the Zynthian output. Level decays with a logarithmic rule, taking one second to decay to -200dBFS so will decay to -50dBFS (the displayed range) in about quarter of a second. Peaks are displayed instantly, i.e. the attack of the meter is immediate (*). The peak hold bar remains for two seconds or until a higher peak is reached.
This meter is the same as the main mixbus DPM that is always visible in the mixer view and is therefore hidden when the audio mixer view is shown.
(*) Meter is updated 5 times per second so there can be 200 ms delay in peak being displayed.
{{NoteBox|To '''navigate the controller screens''' (select mode), you must '''push the SEL button'''. Bold-pushing knob#4 doesn't work for this in V5. }}
====The status icons====
{| class="wikitable"
!colspan="3"|1st row: Health & Load
|-
|style="padding:10px"|<span style="color:#00FF00">{{#fas:heart}}</span>
|style="padding:10px;width: 200px;|'''Cpu Load'''
|style="padding:10px"|Heart, indicating CPU load. It displays as green when under 50%, yellow when load is over 50% and red over 75%.
|-
|style="padding:10px"|<span style="color:#00FF00">{{#fas:recycle}}</span>
|style="padding:10px;width: 200px;|'''Software update available'''
|style="padding:10px"|When a software update is available, the green recycle symbol is shown. You can update from the admin menu, webconf or terminal.
|-
|style="padding:10px"|<span style="color:#FF0000">{{#fas:exclamation-triangle}}</span>
|style="padding:10px"|'''XRun'''
|style="padding:10px"|It's shown when there are XRuns. This may be accompanied by clicks and pops on audio output. This means the CPU can't process or transfer audio fast enough and you should consider disabling some CPU-hungry option (like VNC, headphones, etc.) or reducing the complexity of your chains.
|-
|style="padding:10px"|<span style="color:#FF0000">{{#fas:bolt}}</span>
|style="padding:10px"|'''Under-voltage'''
|style="padding:10px"|Zynthian is working in a degraded state, with the CPU frequency capped to 600-800 MHz, trying to stabilize the system and avoid a system crash. You shouldn't see that icon and if you do so, you should consider looking for a better power source.
|-
|style="padding:10px"|<span style="color:#FF0000">{{#fas:temperature-high}}</span>
|style="padding:10px"|'''Over-temperature'''
|style="padding:10px"|Zynthian is working in a degraded state, with the CPU frequency capped to 600-800 MHz, trying to stabilize the system and avoid a system crash. You shouldn't see that icon and if you do so, you should improve heat dissipation (using a heat sink, etc.)
|-
!colspan="3"|2nd row: MIDI activity & Playing/Recording
|-
|style="padding:10px"|<span style="color:#8080FF">'''m'''</span>
|style="padding:10px;width: 200px;|'''MIDI-IN'''
|style="padding:10px"|It's shown when MIDI messages are received. Underscore indicates system message such as MIDI clock.
|-
|style="padding:10px"|<span style="color:#B00000">{{#fas:circle}}</span>
|style="padding:10px"|'''Recording Audio'''
|style="padding:10px"|Audio is being recorded.
|-
|style="padding:10px"|<span style="color:#00B000">{{#fas:play}}</span>
|style="padding:10px"|'''Playing Audio'''
|style="padding:10px"|Audio track is being played.
|-
|style="padding:10px"|<span style="color:#F000F0">{{#fas:circle}}</span>
|style="padding:10px"|'''Recording MIDI'''
|style="padding:10px"|MIDI is being recorded.
|-
|style="padding:10px"|<span style="color:#F000F0">{{#fas:play}}</span>
|style="padding:10px"|'''Playing MIDI'''
|style="padding:10px"|MIDI track is being played.
|-
|style="padding:10px"|<span style="color:#F07000">{{#fas:circle}}</span>
|style="padding:10px"|'''Recording Pattern'''
|style="padding:10px"|A sequencer's pattern is being recorded.
|-
|style="padding:10px"|<span style="color:#F07000">{{#fas:play}}</span>
|style="padding:10px"|'''Playing Sequence'''
|style="padding:10px"|A sequence or pattern is being played.
|}
==Basic Screens==
===Mixer===
===Mixer===
[[File:Mixer.jpg|center]]
<div class="show_only_v5">
[[File:v5_mockup_mixer_01.png|800px|right]]
[[File:v5_mockup_mixer_01.png|800px|right]]
<br clear=all>
<br clear=all>
</div>
===Selectors: menus and lists===
===Engine Selector===
===Chain Control===
<div class="show_only_v5">
[[File:v5_mockup_control_01.png|800px|right]]
* '''Knob#1 - #4'''
** ''rotate'' any knob to change the value of the assigned parameter, same as the classic UI. This has not changed.
** ''short-push'' any knob to start MIDI-learning for the associated parameter. Move a knob/fader in your MIDI controller end the learn. Push back to cancel.
** ''bold-push'' any knob to open the options menu for the associated parameter.
<br>
{{NoteBox|To '''navigate the controller screens''' (select mode), you must '''push the SEL button'''. Bold-pushing knob#4 doesn't work for this in V5. }}
<br clear=all>
</div>
===Scene (ZynPad)===
===Chain Options===
===Banks & Presets===
===Confirmation Dialog===
===On-screen Keyboard===
===Admin===
===Others===
==Basic workflow==
===Chain creation===
===Basic chain manipulation===
===Layering chains===
===Etc.===
==Advanced workflow==
===MIDI learning===
===Audio routing===
===MIDI routing===
==The Sequencer==
===Zynpad (Scene)===
<div class="show_only_v5">
[[File:v5_mockup_zynpad_01.png|800px|right]]
[[File:v5_mockup_zynpad_01.png|800px|right]]
<br clear=all>
<br clear=all>
</div>
===Pattern===
===Pattern Editor===
<div class="show_only_v5">
[[File:v5_mockup_pated_01.png|800px|right]]
[[File:v5_mockup_pated_01.png|800px|right]]
**** duration
**** duration
**** velocity
**** velocity
**** offset
**** stutter count
**** stutter count
**** stutter duration
**** stutter duration
**** play chance
*** rotate knob#3 to change coarse value.
*** rotate knob#3 to change coarse value.
*** rotate knob#2 to change fine value (when available).
*** rotate knob#2 to change fine value (when available).
** ''rotate'' to move cursor vertically.
** ''rotate'' to move cursor vertically.
* '''Knob#2'''
* '''Knob#2'''
** ''rotate'' to change the pattern to edit.
** ''rotate'' to change the zoom level.
** ''short push'' to restore default zoom level.
* '''Knob#1'''
* '''Knob#1'''
** ''rotate'' to adjust tempo BPM.
** ''rotate'' to adjust tempo BPM.
<br clear=all>
<br clear=all>
</div>
==The UI Screens==
===Arranger===
=== Mixer ===
==Learning Pills==
==Learning Pills==
https://discourse.zynthian.org
https://discourse.zynthian.org