2,705
edits
Changes
Jump to navigation
Jump to search
mLine 2:
Line 2: − + − Anyway, the 4 knobs+switches are the primary control mechanism used to navigate the UI: selecting options on menus and adjust the instrument parameters. The knobs can act as assignable MIDI/OSC controllers for the instrument's parameters (frequently lots of them!). You can emulate the knob's behavior using the touch-display, but it's sub-optimal and accessing some features could be tricky.+ Line 19:
Line 19: + − + − + − + − + − + − Click actions for each knob are context dependent. The SELECT knob is mainly used to navigate and a short click on it will select an item on a "Selector Screen". Inside a "Controller Screen", short clicks can be used to rotate between layers (LAYER knob) or between controller pages (SELECT knob). "Bold-clicks" are normally intended as shortcuts for jumping to specific screen like "layer options", "main menu", etc. Clicking the BACK knob generally jumps to the previous screen in the workflow sequence.+ − Many actions depend of context (current screen), but there are some actions that are global and will always work (from any screen):+ Line 49:
Line 50: + + + − [[File:Status display.png|400px|right]]+ + − * Audio Peak-meter or CPU-load => 1 or 2 small horizontal bars on the top right.+ − * MIDI-IN => '''Blue "m"''' flag+ − * Xrun => '''Red Warning''' flag+ − * Under-voltage => '''Red Lightning''' flag+ − * Over-temperature => '''Red Thermometer''' flag+ − * Recording Audio => '''Red Circle''' flag+ − * Playing Audio => '''Green Play''' flag+ + + + + + + + + + + + + + + + + + + + + Line 78:
Line 103: − + − − ===The Flags=== − − * The '''Blue "m"''' flag is shown when MIDI messages are received. − − * The '''Red Warning Triangle''' flag is shown when there are Xruns. If many, you should hear clicks and pops too. − − * When the '''Red Lightning''' or '''Red Thermometer''' flag is shown, your 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 any of them and if you do so, you should consider looking for a better power source (under-voltage) or using a heat sink (over-temperature). − − * Finally, the '''Red Circle''' and '''Green Play''' flags show the status of audio/MIDI capture: recording / playing − − <br clear=all> Line 104:
Line 117: − + Line 119:
Line 132: − + − + − + + − + − + − + Line 181:
Line 195: + + − * '''Transpose''' => Transpose the '''layer's MIDI channel''' up and down, by semitones. Line 207:
Line 222: − + − + − + Line 280:
Line 295: − + Line 351:
Line 366: − + + + Line 517:
Line 534: + + + Line 572:
Line 592: − + Line 638:
Line 658: −
Zynthian UI User Guide (oldstable-2109) (view source)
Revision as of 18:45, 1 November 2022
, 18:45, 1 November 2022Jofemodo moved page Zynthian UI Users Guide to Zynthian UI Users Guide (oldstable-2109): Bump to stable-2210
=General Concepts=
=General Concepts=
The Zynthian UI is displayed on a display and controlled by 4 knobs (rotary-encoders with push-switches). You can also control the UI with a touch-display, a mouse or a keyboard (computer keyboard or MIDI keyboard, both!)
The Zynthian UI is displayed on a display and controlled by 4 knobs with switches. You can also control the UI with a touch-display, a mouse or a keyboard (computer keyboard or MIDI keyboard, both!)
The 4 knobs+switches are the primary control mechanism to navigate the UI: selecting options on menus and adjusting the instrument parameters. The knobs can act as assignable MIDI/OSC controllers for the instrument's parameters (frequently lots of them!). You can emulate the knob's behaviour using the touch-display, but it's sub-optimal and accessing some features could be tricky.
[[File:Zynthian v4 top legend.png|600px|center]]
[[File:Zynthian v4 top legend.png|600px|center]]
* '''Info Screen''': It displays info about an operation, like "Update Software", or "Network Info".
* '''Info Screen''': It displays info about an operation, like "Update Software", or "Network Info".
* '''Key Range & Transpose Screen''': It allows to choose the key range and transpose notes by octaves or semitones.
* '''Key Range & Transpose Screen''': It allows to choose the key range and transpose notes by octaves or semitones.
* etc.
There are 3 types of clicks (push actions) that can be performed, depending on how long you hold down the knob (or hold your finger on the touch-display).
There are 3 types of push actions that can be performed, depending on how long you hold down the knob/button (or hold your finger on the touch-display).
* '''Short click:''' Less than 0.3 seconds
* '''Short push:''' Less than 0.3 seconds
* '''Bold click:''' Between 0.3 and 2 seconds
* '''Bold push:''' Between 0.3 and 2 seconds
* '''Long click:''' More than 2 seconds (until the long-action is triggered!)
* '''Long push:''' More than 2 seconds (until the long-action is triggered!)
These timing values are the default ones. You can adjust them to your personal feeling from the UI options on the webconf tool.
These timing values are the default ones. You can adjust them to your personal feeling from the webconf's UI options.
Some push actions depends of context. The SELECT knob is mainly used to navigate and a short push on it will select an item on a "Selector Screen". Inside a "Controller Screen", short pushes can be used to rotate between layers (LAYER knob) or between controller pages (SELECT knob). "Bold-pushes" are normally intended as shortcuts for jumping to specific screen like "layer options", "main menu", etc. Pushing the BACK knob generally close the current modal-screen or jumps to the previous screen in the workflow sequence.
Although some push actions depend of context (current screen), there are some actions that are global and will work from any screen:
* '''Bold-Back''': Main Menu
* '''Bold-Back''': Main Menu
* Kind of Breadcrumb, normally showing the screen title or current layer information: MIDI channel, engine, bank & preset
* Kind of Breadcrumb, normally showing the screen title or current layer information: MIDI channel, engine, bank & preset
* Back-button, when using the touch-interface. It's far from intuitive, but Zynthian-UI was not designed with touch-navigation in mind.
* Back-button, when using the touch-interface. It's far from intuitive, but Zynthian-UI was not designed with touch-navigation in mind.
<br clear=all>
=The Status Area=
=The Status Area=
[[File:Status display.png|400px|right]]
On the top-right corner there is a small area where some useful information is displayed in real time:
On the top-right corner there is a small area where some useful information is displayed in real time:
* '''Audio peak-meter''' or '''CPU load-bar''' => 1 or 2 small horizontal bars on the top.
* '''Status Icons''' => Displayed under the peak-meter.
{| class="wikitable"
!colspan="3"|Status Icons Legend
|-
|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.
|-
|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. If many, you should hear clicks and pops too. This means the CPU can't process audio fast enough and you should consider disabling some CPU-hungry option (like VNC, headphones, etc.) or reducing the complexity of your layer setup.
|-
|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.)
|-
|style="padding:10px"|<span style="color:#b00000">{{#fas:circle}}</span>
|style="padding:10px"|'''Recording Audio/MIDI'''
|style="padding:10px"|An audio or MIDI recording is going on.
|-
|style="padding:10px"|<span style="color:#00b000">{{#fas:play}}</span>
|style="padding:10px"|'''Playing Audio/MIDI'''
|style="padding:10px"|An audio or MIDI track is being played.
|}
===The Peak-meter===
===The Peak-meter===
Alternately, the "CPU-load" bar can be enabled from webconf, replacing the Audio Peak-meter. The CPU-load bar shows the CPU usage as calculated by the Jack Audio Server:
Alternately, the "CPU-load" bar can be enabled from webconf, replacing the Audio Peak-meter. The CPU-load bar shows the CPU usage as calculated by the Jack Audio Server:
This is a running average of the time it takes to execute a full process cycle for all clients as a percentage of the real time available per cycle determined by the buffer size and sample rate.
This is a running average of the time it takes to execute a full process cycle for all clients as a percentage of the real time available per cycle determined by the buffer size and sample rate.
=The Zynthian UI Workflow=
=The Zynthian UI Workflow=
</gallery>
</gallery>
If you want to contribute to improving these flowcharts, you can edit them using the Google Documents Tools:
If you want to contribute to improve these flowcharts, you can edit them using the Google Documents Tools:
- [https://docs.google.com/drawings/d/1jmt3zrJjPkbqj3hpzCIwRgFIKxiX2UptebBA_GN8e5I Main sequence: zynthian_ui_workflow_main]
- [https://docs.google.com/drawings/d/1jmt3zrJjPkbqj3hpzCIwRgFIKxiX2UptebBA_GN8e5I Main sequence: zynthian_ui_workflow_main]
[[File:Zynthian_ui_main.png|400px|right]]
[[File:Zynthian_ui_main.png|400px|right]]
This is the first screen you would see when you power on your zynthian for first time and no default snapshot or last-state snapshot has been saved yet.
This is the first screen you would see when you power on your zynthian for first time and no default or last-state snapshot has been saved yet.
The Main menu gives easy and intuitive access to the Zynthian-UI's main features:
The Main menu gives easy access to the Zynthian-UI's main features:
* '''Layers'''
* '''Layers'''
* '''Snapshots'''
* '''Sequencer'''
* '''Audio Levels'''
* '''Audio Recorder'''
* '''Audio Recorder'''
* '''MIDI Recorder'''
* '''MIDI Recorder'''
* '''ALSA-Mixer'''
* '''Snapshots'''
* '''Auto-EQ'''
* '''Clean All'''
* '''Admin'''
* '''Admin'''
You always can access this menu with '''bold-back'''.
You always can access this menu with '''bold-back'''.
The Zynthian-UI has a lot of short-cuts and most of the options on the Main menu can be accessed on this way, but until you learn the shortcuts and feel comfortable with them, you will find this menu very useful.
The Zynthian-UI has a lot of short-cuts and most of the options on the main menu can be accessed with them, but until you learn the shortcuts and feel comfortable with them, you will find this menu very useful.
<br clear=all>
<br clear=all>
[[File:Zynthian_ui_layer_options.png|400px|right]]
[[File:Zynthian_ui_layer_options.png|400px|right]]
[[File:Zynthian_ui_layer_options_transpose.png|400px|right]]
[[File:Zynthian_ui_layer_options2.png|400px|right]]
[[File:Zynthian_ui_layer_options2.png|400px|right]]
If you bold-click the select switch over a layer from the list, the "Layer Options" menu will be displayed for the selected layer. This menu allows you to:
If you bold-click the select switch over a layer from the list, the "Layer Options" menu will be displayed for the selected layer. This menu allows you to:
* '''Note Range & Transpose''' => Select the '''layer's''' key-range and transpose by octaves or semitones.
* '''Clone MIDI to...''' => Clone the '''layer's MIDI channel''' messages to other MIDI channels. Note that only note on/off, pitch-bending, and key-press messages are cloned, while the rest are kept independent by default (CC, channel-pressure, program change, ...). You can select what CC will be cloned by bold-clicking on the channel list.
* '''Clone MIDI to...''' => Clone the '''layer's MIDI channel''' messages to other MIDI channels. Note that only note on/off, pitch-bending, and key-press messages are cloned, while the rest are kept independent by default (CC, channel-pressure, program change, ...). You can select what CC will be cloned by bold-clicking on the channel list.
* '''Audio Output''' => Route the '''layer's''' audio output to any available audio input port, allowing to process the audio in almost any way you can imagine. You can use this feature for creating your own customized/bizarre FX chains. If this is not enough for you, try MOD-UI engine with the MOD-UI web GUI. This option is not available on MIDI-FX layers.
* '''Audio Output''' => Route the '''layer's''' audio output to any available audio input port, allowing to process the audio in almost any way you can imagine. You can use this feature for creating your own customized/bizarre FX chains. If this is not enough for you, try MOD-UI engine with the MOD-UI web GUI. This option is not available on MIDI-FX layers.
* '''Audio Capture''' => Select the soundcard's capture channels used for audio processing. This option is only available on Audio-FX layers.
* '''Audio Capture''' => Select the soundcard's capture channels used for audio processing. This option is only available on Audio-FX layers.
By bold-clicking on an FX-unit (Audio or MIDI) from the list, you will access the FX's Options:
By bold-clicking on an FX-unit (Audio or MIDI) from the list, you will access the FX's Options:
* '''Replace FX'''
* '''Presets'''
* '''Effect Presets'''
* '''Replace'''
* '''Move Upchain'''
* '''Move Upchain'''
* '''Move Downchain'''
* '''Move Downchain'''
* '''Remove FX'''
* '''Remove'''
Note that not all these options will be available all the time. For instance, if there is only one effect in the chain, "Move" options won't be shown. Same if the FX has not presets, etc.
Note that not all these options will be available all the time. For instance, if there is only one effect in the chain, "Move" options won't be shown. Same if the FX has not presets, etc.
From the instrument control screen, if you bold-press two knobs at once, you should enter the XY-select mode.
From the instrument control screen, if you bold-press two knobs at once, you should enter the XY-select mode.
The 2 controllers you pushed will be green, indicating they are pre-selected for XY-control. You can change the pre-selection by rotating any knob, navigating through the controller pages if needed.
The 2 controllers you pushed will be green, indicating they are pre-selected for XY-control. You can change the pre-selection by rotating any knob. (The knob must be rotated through several values before it will be detected.) Use the ''select'' switch to navigate through the controller pages to select different controllers if needed.
<br clear=all>
<br clear=all>
Learning to create a SubSnapShot is obscenely easy:
Learning to create a SubSnapShot is obscenely easy:
'''1.''' From the Control screen, click the snapshot button '''twice'''. You will see the current list of ZS3s (initially empty) and a message: “Waiting for Program Change…”
'''0.''' Ensure "Program Change ZS3" is enabled in the admin menu.
'''1.''' From the Control screen, short click the snapshot button to enter MIDI control learn mode then short click the snapshot button. You will see the current list of ZS3s (initially empty) and a message: “Waiting for Program Change…”
'''2.''' Push a “Program Change” button in your keyboard/controller and the ZS3 will be stored in memory, associated with the Program Number you pushed on your keyboard/controller.
'''2.''' Push a “Program Change” button in your keyboard/controller and the ZS3 will be stored in memory, associated with the Program Number you pushed on your keyboard/controller.
Use BACK button or wait for timeout to cancel calibration. Timer is reset to 15s when screen is touched and paused until released. The purpose of the timeout is to avoid users of Zynthians without back button being stuck in calibration screen view.
Use BACK button or wait for timeout to cancel calibration. Timer is reset to 15s when screen is touched and paused until released. The purpose of the timeout is to avoid users of Zynthians without back button being stuck in calibration screen view.
{{NoteBox| The resistive touchscreen works better with a stylus. Finger is too coarse. It's strongly recommended to run the calibration using a stylus. }}
<br clear=all>
<br clear=all>
| LAYER_DOWN || Shift || Down
| LAYER_DOWN || Shift || Down
|-
|-
| LAYER_UP || Shift || Down
| LAYER_UP || Shift || Up
|-
|-
| POWER_OFF || Ctrl || End
| POWER_OFF || Ctrl || End
| TOGGLE_MIDI_RECORD || CapsLock || m
| TOGGLE_MIDI_RECORD || CapsLock || m
|}
|}
==Controlling the UI with MIDI messages==
==Controlling the UI with MIDI messages==