2,705
edits
Changes
Jump to navigation
Jump to search
Line 2:
Line 2: − [[File:zynthian_controllers.png|430px|right]]+ − + − 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.+ − + − Almost every Zynthian UI screen is of one of these 2 types, however, other screen-layouts do exist:+ − + + + − + − + − + − + − + − 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 intended as shortcuts for jumping to some specific screens. Clicking the BACK knob generally jumps to the previous screen in the workflow sequence.+ − Most of the actions depend of context (current screen), but there are some actions that are global and will work from any screen:+ − + − + − + − + − + − * '''long-select''': Power Off+ + + − =The Title Bar= − + − + + + + − [[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 70:
Line 97: − + − + − − 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 Flags=== − − * The '''Blue M''' flag is shown when MIDI messages pass thru the MIDI router. Not all messages are detected. Only CC, Program Change and Note On/Off. − − * The '''Red Warning''' flag is shown when there are Xruns. 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 96:
Line 111: − + − + − + − + − + Line 117:
Line 132: − + − + − + + − + − + − + Line 179:
Line 195: + + − * '''Transpose''' => Transpose the '''layer's MIDI channel''' up and down, by semitones. Line 205:
Line 222: − + − + − + Line 345:
Line 362: − + − + − + − + − + − + − + Line 369:
Line 386: − − [[File:Zynstatio.png|40px]] Line 417:
Line 432: − + Line 431:
Line 446: − + − + − + − + − + − '''Note: Step Sequencer is alpha software''' − + − * Pattern editor+ − * Song editor − * Pad triggers (ZynPad) − The step sequencer may be accessed from the main Zynthian screen or by a long press of the SNAPSHOT encoder. Access to the editors and players is via a menu.+ + + + + − ===Menu Selection===+ − Short press the LAYER encoder. The menu is displayed. − Use the LAYER or SELECT encoder to highlight a menu entry. − Move beyond the bottom entry to scroll down if more options are available than screen size allows to display. − Short press the LAYER or SELECT encoder to select the menu entry or short press the BACK encoder to cancel. − Menu may also be accessed by clicking the top bar (not the status display on the right) with a pointing device. Menu options are selected by clicking on them and the menu may be scrolled by dragging up and down.+ − All patterns and songs are saved to a common file.+ + − + − Some parameters must be adjusted using the ''parameter editor''. This is a control that appears in the top bar showing the parameter being adjusted, its value and some buttons to allow up / down adjustment of the parameter.+ − Access the ''parameter editor'' by selecting a menu entry. The parameter editor is displayed with the current parameter name and value.+ − Use the LAYER or SELECT encoders to adjust the value. Values may have minimum and maximum limits.+ − Short press the BACK encoder to cancel and close the editor. − Short press the LAYER or SELECT encoder to assert the value and close the editor. − Parameters may be adjusted with a pointing device by clicking on the cancel, up, down and assert buttons.+ − ===Save===+ − Short press LAYER encoder displays a menu. − Select "Save" menu option. All patterns and songs are immediately saved to disk. − ===Load===+ − Short press LAYER encoder displays a menu.+ − Select "Load" menu option. All patterns and songs are immediately loaded from disk. + − ===Pattern Editor===+ − − The pattern editor allows the creation of a sequence of MIDI events within a time-boxed period. This period is defined in ''steps''. The quantity of steps may be selected for each pattern. Any quantity of MIDI events may be added to the pattern at each step. The most common MIDI events are notes. The pattern editor displays a grid with horizontal ''tramlines'' indicating black and white notes. There can be a grid indicating time divisions and octaves. There is a pianoroll on the left with each 'C' note indicated by a legend. Clicking on a note with a pointing device will sound the note briefly. Most common workflows are exposed via rotary encoders, push buttons and pointing device input. More options are available via menus.+ − ====Pattern Selection====+ − There may be up to 999 patterns loaded into the step sequencer. By default pattern 1 is displayed.+ − Short press LAYER encoder displays a menu. − Select "Pattern" menu option. The ''parameter editor'' is displayed in the top bar. − Use the LAYER or SELECT encoder to select the pattern to edit. The title and grid change to show the pattern that will be selected. − Short press the LAYER or SELECT encoder to select the pattern or short press BACK encoder to cancel. − ====Adding Notes====+ − Use the BACK encoder to select the note to add. The screen will scroll at top and bottom edges. − Use the SELECT encoder to select the step at which the note will start. − Use the LAYER encoder to select the duration of the note. Duration is indicated by the length of the highlight border. − Use the SNAPSHOT encoder to select the velocity of the note. Velocity is indicated by a yellow bar in the bottom left of the screen. − Short press the SELECT encoder to add the note. The note is indicated by a shaded block starting at the required start step with length indicating duration and opacity indicating velocity. − Notes may also be added by clicking on the note / start step if you have a pointing device. To scroll screen with pointing device drag the pianoroll up or down.+ − + − Use the BACK encoder to select the note to remove. − Use the SELECT encoder to select the step at which the note starts. − Short press the SELECT encoder to remove the note. − Notes may also be removed by clicking on the note / start step if you have a pointing device.+ − ====Changing Duration====+ − Use the BACK encoder to select the note to adjust. − Use the SELECT encoder to select the step at which the note starts. − Use the LAYER encoder to adjust the duration of the note. − ====Changing Velocity====+ − Use the BACK encoder to select the note to adjust. − Use the SELECT encoder to select the step at which the note starts. − Use the SNAPSHOT encoder to adjust the velocity of the note. − ====Controlling Playback====+ − Short press the SNAPSHOT encoder to start playback of the pattern. The pattern will resume playback from its previously stopped step, looping when it reaches the end of the pattern. − Short press the SNAPSHOT encoder to pause playback. − Bold press the SNAPSHOT encoder to stop playback and / or recue to start of pattern. − NOTE: When exiting the ''pattern editor'' playback will stop. This is because the ''pattern editor'' is a design tool and not intended for performance. − Playback may also be controlled with a pointing device by pressing the start / pause and stop / recue buttons in the topbar.+ − Playback may also be controlled via external MIDI transport control (start, stop, continue, locate).+ − ====Changing Pattern Length====+ − By default each pattern is 16 steps long. This may be adjusted from 1 to 64 steps in each pattern. − Short press LAYER encoder displays a menu. − Select "Steps in pattern" menu option. The ''parameter editor'' is displayed in the top bar. − Use the LAYER or SELECT encoder to adjust the quantity of steps in the pattern. The quantity of grid columns changes to match the step in pattern. − Note: The pattern editor always shows all the steps, i.e. there is no horizontal scrolling or zooming.+ − + − A user may wish to use the concept of time divisions, e.g. beats in a bar, steps in a beat, etc. This is presented by the display of vertical lines. By default the steps per beat is 4. This may be adjusted from 0 to 24. − Short press LAYER encoder displays a menu. − Select "Steps per beat" menu option. The ''parameter editor'' is displayed in the top bar. − Use the LAYER or SELECT encoder to adjust the quantity of steps per beat. The vertical grid lines move to match the steps per beat. − Setting to zero will hide vertical lines. − Note: The steps per beat is constrained to the values: 0, 1, 2, 3, 4, 6, 8, 12, 24. This is because it must divide exactly into 24 which is the quantity of clock cycles per beat.+ − ====Transpose====+ − All notes within a pattern may be permanently transposed. − Short press LAYER encoder displays a menu. − Select "Transpose pattern" menu option. The ''parameter editor'' is displayed in the top bar. − Use the LAYER or SELECT encoder to move all notes up or down. The pianoroll scrolls to indicate the transposition. − ====Vertical Zoom====+ − By default 16 note are shown on the pianoroll and corresponding 16 rows in the grid. − Short press LAYER encoder displays a menu. − Select "Vertical zoom" menu option. The ''parameter editor'' is displayed in the top bar. − Use the LAYER or SELECT encoder to adjust the vertical zoom. The quantity of rows in grid (and notes in pianoroll) change to match the vertical zoom value. − ====MIDI channel==== − The pattern editor plays its sequence of notes out on a single MIDI channel. − Short press LAYER encoder displays a menu. − Select "MIDI channel" menu option. The ''parameter editor'' is displayed in the top bar. − Use the LAYER or SELECT encoder to adjust the MIDI channel between 1 and 16. − ====Clocks Per Step====+ − By default each step within a pattern is advanced after 6 MIDI clock cycles. − Short press LAYER encoder displays a menu. − Select "Clocks per step" menu option. The ''parameter editor'' is displayed in the top bar. − Use the LAYER or SELECT encoder to adjust the clocks per step. − − Note: Adjusting the steps per beat will automatically set the clocks per step. Adjustment of clocks per step allows fine control and less common time signatures. − − ====Clear Pattern==== − A pattern may be cleared of its content. − Short press LAYER encoder displays a menu. − Select "Clear pattern" menu option. The ''parameter editor'' is displayed in the top bar. − Short press the LAYER or SELECT encoder to clear pattern or short press BACK encoder to cancel. − − ====Copy Pattern==== − The currently selected pattern may be copied to another pattern location. − Short press LAYER encoder displays a menu. − Select "Copy pattern" menu option. The ''parameter editor'' is displayed in the top bar. − Use the LAYER or SELECT encoder to select the pattern to copy the previous pattern to. The title and grid change to show the pattern that will be overwritten. − Short press the LAYER or SELECT encoder to overwrite pattern with previously selected pattern or short press BACK encoder to cancel. − − ===Song Editor=== − − [[File:SongEditor.png|400px|right]] − The song editor allows the assignment of patterns to a variable quantity of tracks. Each song may have any quantity of tracks. A track represents a sequence of patterns. Each track may have any quantity of patterns and hence be any duration. Each pattern may belong to a group (A, B, C...), has a MIDI channel and a play mode. The track group and number are shown on the left with its MIDI channel in brackets and its play mode shown by an icon. Patterns may not overlap on the same track. A timeline is shown along the bottom of the grid. Bar (or ''sync point'') markers are indicated by vertical lines with its time (in time divisions) at the bottom in the timeline. There may up to 999 songs loaded. − − ====Song Selection==== − There may be up to 999 songs loaded into the step sequencer. By default no song is displayed. − Short press LAYER encoder displays a menu. − Select "Song" menu option. The ''parameter editor'' is displayed in the top bar. − Use the LAYER or SELECT encoder to select the song to edit. The title and grid change to show the song that will be selected. − Short press the LAYER or SELECT encoder to select the song or short press BACK encoder to cancel. − − ====Adding Patterns==== − Use the BACK encoder to select the track. The screen will scroll at top and bottom edges. − Use the SELECT encoder to select the time at which the pattern will start. The screen will scroll at left and right edges. − Use the LAYER encoder to select the pattern that will be added. Pattern number is shown in the bottom left of the screen. Pattern duration will be indicated by the selection border. − Short press the SELECT encoder to add the sequence. The sequence is indicated by a shaded block starting at the required start step with length indicating pattern duration. − If the pattern overlaps an existing pattern then the existing pattern will be removed. − − Patterns may also be added by clicking on the track / start time if you have a pointing device. To scroll screen with pointing device drag the track list up or down or timeline left and right. − − ====Removing Patterns==== − Use the BACK encoder to select the track. − Use the SELECT encoder to select the time at which the pattern starts. − Short press the SELECT encoder to remove the pattern. − − Notes may also be removed by clicking on the pattern within the grid if you have a pointing device. − − ====Adding Tracks==== − Short press LAYER encoder displays a menu. − Select "Add track" menu option. A new track is added to the end of the track list. − − ====Removing Tracks==== − Short press LAYER encoder displays a menu. − Select "Add track" menu option. A new track is added to the end of the track list. − − ====Controlling Playback==== − Short press the SNAPSHOT encoder to start playback of the song. The song will resume playback from its previously stopped step. Playback will continue to run even if playhead passes beyond the end of the last pattern. − Short press the SNAPSHOT encoder to pause playback. − Bold press the SNAPSHOT encoder to stop playback and / or recue to start of song. − − Playback may also be controlled with a pointing device by pressing the start / pause and stop / recue buttons in the topbar. − − Playback may also be controlled via external MIDI transport control (start, stop, continue, locate). − − ====Time Divisions==== − The timeline is quantised to ''time divisions''. This is the minimum step that may be navigated / pattern positioned. − A user may wish to use the concept of bars (or other larger time divisions). This is presented by the display of vertical lines. By default the time divisions per bar 16. This may be adjusted from 1 to 999. This setting also defines the ''sync point'' for live playout, i.e. the time at which a pattern will start playing after being triggered. − − Short press LAYER encoder displays a menu. − Select "Bar / sync" menu option. The ''parameter editor'' is displayed in the top bar. − Use the LAYER or SELECT encoder to adjust the quantity of time division per marker. The vertical grid lines move to match. − − ====Transpose **NOT YET IMPLEMENTED**==== − All notes within a song may be transposed. − Short press LAYER encoder displays a menu. − Select "Transpose pattern" menu option. The ''parameter editor'' is displayed in the top bar. − Use the LAYER or SELECT encoder to move all notes up or down. − Note: This setting is at song level. Patterns are not individually transposed. Playback is transposed. − − ====Vertical Zoom==== − By default up to 16 tracks are shown. − Short press LAYER encoder displays a menu. − Select "Vertical zoom" menu option. The ''parameter editor'' is displayed in the top bar. − Use the LAYER or SELECT encoder to adjust the vertical zoom. The quantity of tracks change to match the vertical zoom value. − − ====Horizontal Zoom==== − By default 64 time divisions are shown. − Short press LAYER encoder displays a menu. − Select "Horizontal zoom" menu option. The ''parameter editor'' is displayed in the top bar. − Use the LAYER or SELECT encoder to adjust the horizontal zoom. The quantity of columns change to match the horizontal zoom value. − − ====MIDI channel==== − Each track may be assigned a MIDI channel. − Use the BACK encoder to select the track. − Short press LAYER encoder displays a menu. − Select "MIDI channel" menu option. The ''parameter editor'' is displayed in the top bar. − Use the LAYER or SELECT encoder to adjust the MIDI channel between 1 and 16. The track title changes to show the MIDI channel in brackets. − − ====Clocks Per Division==== − By default each time division is 6 MIDI clock cycles. − Short press LAYER encoder displays a menu. − Select "Clocks per division" menu option. The ''parameter editor'' is displayed in the top bar. − Use the LAYER or SELECT encoder to adjust the clocks per division. − − ====Clear Song==== − A song may be cleared of its content. − Short press LAYER encoder displays a menu. − Select "Clear song" menu option. The ''parameter editor'' is displayed in the top bar. − Short press the LAYER or SELECT encoder to clear song or short press BACK encoder to cancel. − − ====Copy Song==== − The currently selected song may be copied to another song location. − Short press LAYER encoder displays a menu. − Select "Copy song" menu option. The ''parameter editor'' is displayed in the top bar. − Use the LAYER or SELECT encoder to select the song to copy the previous song to. The title and grid change to show the song that will be overwritten. − Short press the LAYER or SELECT encoder to overwrite pattern with previously selected song or short press BACK encoder to cancel. − − ====Tempo==== − Each song has a master track displayed along the bottom of the screen. The master track may have tempo changes added at any time during the song. By default songs have a tempo of 120 BPM. − Use the SELECT encoder to select the time at which to add a tempo change. The screen will scroll at left and right edges. − Short press LAYER encoder displays a menu. − Select "Tempo" menu option. The ''parameter editor'' is displayed in the top bar. − Use the LAYER or SELECT encoder to select the tempo. − Short press the LAYER or SELECT encoder to add a tempo change to the selected song or short press BACK encoder to cancel. The tempo is displayed in the master track as red text below the timeline. − − ====Remove Tempo Marker==== − Tempo persists until the next ''different'' tempo change. You cannot have consecutive tempo markers with the same value. − Use the SELECT encoder to select the time at which to remove tempo marker. The screen will scroll at left and right edges. − Short press LAYER encoder displays a menu. − Select "Tempo" menu option. The ''parameter editor'' is displayed in the top bar. − Use the LAYER or SELECT encoder to adjust the tempo. The tempo marker changes and will disappear when it is the same as the previous tempo marker. − Short press BACK encoder to cancel. − − ===ZynPad=== − [[File:ZynPad.png|400px|right]] − ZynPad is a performance mode for the step sequencer. It presents a grid of pads that my be tapped to trigger sequences. Each pad may be a member of a mutually exclusive group where pressing a pad in the group will cause other group members to stop playing. Each group is allocated an alternating colour (blue / purple) and is identified by the first character of the pad name, e.g. A, B. C, etc. − A pad will start playing at the next ''sync point'', e.g. at the end of the current bar. This maintains synchronisation between sequences (assuming the sequences have been programmed to be synchronous). − − ====Playing ZynPad==== − Each pad has a colour which indicates its group. Odd groups are blue whilst even groups are purple. − Click a pad to start the pad's sequence running. If the transport is not running then it will be started and the sequence will begin immediately. If the transport is already running then the sequence will begin at the next ''sync point''. − The pad will change to orange whilst it is waiting to start. − The pad will change to green whilst playing. − Click on a pad to stop the sequence playing. − The pad will change to red whilst waiting to stop. − The pad will change to blue or purple (depending on its group) when stopped. − Click a pad in a different group (with different first letter) will start that pad's sequence running synchronously with existing sequences, starting at the next ''sync point''. − group will stop the currently playing sequence (from this group) and start that pad's sequence running synchronously with existing sequences, starting at the next ''sync point''. − An icon on the pad indicates the play mode: − − {| class="wikitable" style="background-color:#cccccc;" − |- − !Icon − !Mode − !Description − |- − |||Disabled||No sequence will play − |- − |[[File:ZynPadEndnoline.png]]||Oneshot||Sequence will play only once, stopping immediately when pad clicked − |- − |[[File:ZynPadLoop.png]]||Loop||Sequence will play in a continuous loop, stopping immediately when pad clicked − |- − |[[File:ZynPadEnd.png]]||Oneshot All||Sequence will play only once, stopping at next sync point after pad clicked − |- − |[[File:ZynPadLoopstop.png]]||Loop All||Sequence will play in a continuous loop, stopping at next sync point after pad clicked − |} − − The play mode and sync point is set in the song editor. − − ====ZynPad ''Song'' Selection==== − ZynPad is configured by the song editor. Each pad represents a track in a song. − − Short press LAYER encoder displays a menu. − Select "Song" menu option. The ''parameter editor'' is displayed in the top bar. − Use the LAYER or SELECT encoder to select the song. ZynPad changes to match the selected song. − Short press LAYER, SELECT to select song. − Short press BACK encoder to cancel. − − The quantity of pads is defined by the quantity of tracks in the song. There will always be the same quantity of rows as columns. Extra pads required to fill grid (greater than quantity of tracks) are shown disabled. Text and icons scale to match pad size. − − ===MIDI Control=== − Zynthian step sequencer may be controlled by external MIDI controllers. − − ====Transport Control==== − MIDI START message will start playback of the currently selected song or the pattern in the pattern editor if shown, from the start of the song or sequence. − MIDI STOP message will stop (pause) playback of the currently selected song or the pattern in the pattern editor if shown. ZynPad sequences will also be stopped. − MIDI CONTINUE message will resume playback of the currently selected song or the pattern in the pattern editor if shown, from the point it was previously stopped (paused) of the song or sequence. − − ====Clock==== − To use an external MIDI clock to synchronise Zynthian: − Navigate to the ''Admin'' page. − Disable ''MIDI Clock Internal''. − Provide an external MIDI clock. − − Sequences will only play after receiving MIDI START / STOP / CONTINUE or being triggered from Zynthian user interface and will play at the rate of the external clock. 6 MIDI clock messages are sent for each ''beat''. A beat is often considered to be a crotchet / quarter note. − − ====Trigger Sequence **NOT YET IMPLEMENTED**==== − Each sequence (pad) within ZynPad may be triggered by MIDI NOTE ON messages. The MIDI channel is configurable. − − Short press LAYER encoder displays a menu. − Select "MIDI channel" menu option. The ''parameter editor'' is displayed in the top bar. − Use the LAYER or SELECT encoder to select the MIDI channel for external trigger. − Short press LAYER, SELECT to select channel. − Short press BACK encoder to cancel. − − Use the BACK encoder to select the track. − Short press LAYER encoder displays a menu. − Select "Trigger note" menu option. The ''parameter editor'' is displayed in the top bar. − Use the LAYER or SELECT encoder to select the note number for external trigger. − Short press LAYER, SELECT to select note. − Short press BACK encoder to cancel. − − ==Admin Menu== − − [[File:Zynthian_ui_admin.png|400px|right]] − [[File:Zynthian_ui_admin_02.png|400px|right]] − − The Admin menu gives access to some configuration options (most of them also accessible from the webconf tool). Also includes basic testing options for audio and MIDI. − − You can access this menu from the Main menu. Line 828:
Line 571: − + + + + + + + + + + − !Key+ − !Modifier − !Function − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + Line 917:
Line 667: − + + + Line 924:
Line 676: − + + Line 947:
Line 700: + + + + + + Line 964:
Line 723: − + Line 976:
Line 735: + + + −
Zynthian UI User Guide (oldstable-2109) (view source)
Revision as of 11:12, 28 January 2022
, 11:12, 28 January 2022→General Concepts
=General Concepts=
=General Concepts=
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 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 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]]
There are two main screen-layout types:
There are two main screen-layout types:
* '''Selector Screen''': a list of items that you can scroll and select with the SELECT knob (CTRL-4)
* '''Selector Screen''': a list of items that you can scroll and select with the SELECT knob (CTRL-4)
* '''Controller Screen''': 4 control widgets in the corners (one for each knob), with label and value indicators (graphic and numeric). In the middle there is a list of controller maps, which you can use to change the parameters controlled by the knobs.
* '''Controller Screen''': 4 control widgets in the corners (one for each knob), with label and value indicators (graphic and numeric). In the middle there is a list of controller screens, each one mapping 4 controllers which you can use to change the engine parameters.
Most of Zynthian UI screens belongs to one of these 2 categories, however, other screen-layouts do exist:
* '''Confirmation Screen''': It will ask you to confirm some operation.
* '''Confirmation Screen''': It will ask you to confirm some operation.
* '''XY Controller Screen''': It allows to modify 2 parameters at once using the touch interface.
* '''XY Controller Screen''': It allows to modify 2 parameters at once using the touch interface.
* '''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.
* etc.
There are 3 types of clicks (push-switch 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
* '''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
* '''bold-snapshot''': Load Snapshot menu
* '''Long-Layer''': Step Sequencer
* '''long-layer''': ALSA Mixer app
* '''Long-Back''': Admin Menu
* '''long-back''': PANIC! All Notes Off
* '''Long-Learn''': Audio Levels
* '''long-snapshot''': Step Sequencer
* '''Long-Select''': Power Off
Latest versions of zynthian kits include 4 extra push buttons, labelled as S1 to S4. By default, these buttons are assigned to MIDI Program Change 1-4, but this can be easily changed from the webconf's [[Configuration_Users_Guide#Wiring_Layout|Wiring Layout menu]].
<br clear=all>
<br clear=all>
=The Title Bar=
[[File:zynthian_ui_control_status.png|400px|right]]
[[File:zynthian_ui_control_status.png|400px|right]]
The title bar have 2 functions:
The title bar have 2 functions:
* Kind of Breadcrumb, normally showing the screen title or 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. I know, 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===
* The red segment covers the range -3dBFS to 0dBFS.
* 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.
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.
(*) Meter is updated 5 times per second so there can be 200 ms delay in peak being displayed.
(*) Meter is updated 5 times per second so there can be 200 ms delay in peak being displayed.
Alternately, 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.
=The Zynthian UI Workflow=
=The Zynthian UI Workflow=
<gallery mode="slideshow" widths="240" heights="320">
<gallery mode="slideshow" widths="240" heights="320">
Image:zynthian_ui_workflow__main.png|''[[commons:Main Sequence|Main Sequence]]''
Image:zynthian_ui_workflow_main.png|''[[commons:Main Sequence|Main Sequence]]''
Image:zynthian_ui_workflow__layer_options.png|''[[commons:Layer Options|Layer Options]]''
Image:zynthian_ui_workflow_layer_options.png|''[[commons:Layer Options|Layer Options]]''
Image:zynthian_ui_workflow__snapshots.png|''[[commons:Snapshots|Snapshots]]''
Image:zynthian_ui_workflow_snapshots.png|''[[commons:Snapshots|Snapshots]]''
Image:zynthian_ui_workflow__midi_learning.png|''[[commons:MIDI Learning|MIDI Learning]]''
Image:zynthian_ui_workflow_midi_learning.png|''[[commons:MIDI Learning|MIDI Learning]]''
</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.
Once a set of layers has been created (i.e. loading a snapshot), ZS3 loading is very fast in comparison with loading snapshots, as no engine have to be started. It take less than 1 second in most of cases, and you can map ZS3s to MIDI programs very easily using MIDI learning.
Once a set of layers has been created (i.e. loading a snapshot), ZS3 loading is very fast in comparison with loading snapshots, as no engine have to be started. It take less than 1 second in most of cases, and you can map ZS3s to MIDI programs very easily using MIDI learning.
The idea behind this feature is to have a fast preset-change mechanism that can be used on stage. In combination with the “Single Active Layer” feature, it turns Zynthian into a “Stage-Beast”. You can prepare a snapshot for the full performance, and use ZS3s for fast changes from a song to another, or between parts inside the same song.
The idea behind this feature is to have a fast preset-change mechanism that can be used on stage. In combination with the “Stage Mode” feature, it turns Zynthian into a “Stage-Beast”. You can prepare a snapshot for the full performance, and use ZS3s for fast changes from a song to another, or between parts inside the same song.
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 and a message: “Waiting for Program Change…”
'''1.''' From the Control screen, bold 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 selected.
'''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.
After that, you can recall the stored ZS3 by pushing the same Program Change button again. Of course, stored ZS3s will be saved with your snapshot and restored on load.
After that, you can recall the stored ZS3 by pushing the same Program Change button again. Of course, stored ZS3s will be saved with your snapshot and restored on load.
You can update and delete stored ZS3s by bold-clicking on the list. An options menu will be shown with both options.
You can update and delete stored ZS3s by bold-clicking on the list.
ZS3 behavior depends of the "Single Active Layer" option:
ZS3 behavior depends of the mode your zynthian is working on:
* '''Single Active Layer Enabled''': ZS3 list shows all the ZS3s stored, no matter the layer. Recalling a ZS3 changes the active layer, so the layer associated with the recalled ZS3 will receive *ALL* the MIDI input. Only 127 ZS3s can be stored.
* '''Stage Mode''': ZS3 list shows all the ZS3s stored, no matter the layer. Recalling a ZS3 changes the active layer, so the layer associated with the recalled ZS3 will receive *ALL* the MIDI input. Only 127 ZS3s can be stored.
* '''Single Active Layer Disabled''': ZS3 list shows only the ZS3 of the currently active layer. Recalling a ZS3 changes the active layer, but every layer receives MIDI input for its channel only. You can use several keyboards on different channels and store 127 ZS3s by MIDI channel.
* '''Multi-timbral Mode''': ZS3 list shows the ZS3 of the currently active layer only. Recalling a ZS3 changes the active layer, but every layer receives MIDI input from its channel. You can use several keyboards on different channels and store 127 ZS3s by MIDI channel.
<br clear=all>
<br clear=all>
[[File:zynthian_ui_audio_recorder.png|400px|right]]
[[File:zynthian_ui_audio_recorder.png|400px|right]]
[[File:zynthian_ui_midi_recorder.png|400px|right]]
[[File:zynthian_ui_midi_recorder.png|400px|right]]
===Overview===
===Overview===
These simple tools allow you to record Audio & MIDI tracks easily, using the internal SD-card or an USB memory stick for storing the files.
These simple tools allow you to record Audio & MIDI tracks easily, using the internal SD-card or an USB memory stick for storing the files.
===Managing recordings from your computer===
===Managing recordings from your computer===
[[File:Zynthian_webconf_captures_02.png|600px|border|right]]
[[File:Zynthian_webconf_captures_02.png|400px|border|right]]
Audio & MIDI recordings can be managed from your computer by accessing the webconf's captures section. From this section you can:
Audio & MIDI recordings can be managed from your computer by accessing the webconf's captures section. From this section you can:
<br clear=all>
<br clear=all>
==ALSA Mixer==
==Audio Levels==
[[File:zynthian_ui_mixer_control.png|400px|right]]
[[File:zynthian_ui_mixer_control.png|400px|right]]
The '''ALSA Mixer''' app is a pseudo-layer that allows to adjust the soundcard output/input levels and other audio-hardware related options. Technically speaking, it's a user interface for the ALSA (Audio Linux Sound Architecture) mixer.
The '''Audio Levels''' screen allows to adjust the soundcard output/input levels and other audio-hardware related options. Technically speaking, it's a GUI for the ALSA (Audio Linux Sound Architecture) mixer.
For accessing the '''ALSA-Mixer''' app, you have 2 options:
For accessing the '''ALSA-Mixer''' app, you have 2 options:
* Selecting "ALSA-Mixer" option from the Main menu
* Selecting "Audio Levels" option from the Main menu
* '''Long-pushing the layer knob (CTRL-1)'''
* '''Long-pushing the snapshot knob (CTRL-3)'''
You can configure the mixer controllers from the webconf's hardware->audio menu. Simply click the '''+''' button on the "Mixer Controls" text area.
You can configure the Audio Level controllers from the webconf's hardware->audio menu. Simply click the '''+''' button on the "Mixer Controls" text area.
<br clear=all>
<br clear=all>
==Step Sequencer==
==Step Sequencer==
Zynthian has a step sequencer which provides:
Zynthian has a step sequencer which provides methods to create patterns and arrange them into sequences.
The step sequencer may be accessed from the main screen or by clicking long-LAYER.
* There may be up to 999 patterns, each with as many simultaneous notes (polphonic) as required over a set of steps and beats that are configurable for each pattern.
* Patterns are arranged into tracks within sequences.
* Sequences may be configured to loop or play once and may be grouped so that starting one sequence stops another. Sequences may start and stop at the start of each bar.
* Note entry can be performed from the Zynthian user interface or using an external MIDI controller.
* Sequences can be started and stopped from the Zynthian user interface or using an external MIDI controller.
These are three main views:
[[File:Zynpad 4x4 playing starting.png|400px|right]]
'''Pads'''<br>
Grid of pads to launch sequences
===Parameter Editor===
<br clear=all>
[[File:Arranger.png|400px|right]]
'''Arranger'''<br>
Track / timeline editor for complex manipulation of sequences
<br clear=all>
[[File:Zynseq patterneditor notevelocity.png|400px|right]]
'''Pattern Editor'''<br>
Manipulation of individual events within patterns
<br clear=all>
[[Using ZynSeq]] is a detailed tutorial on the use of the step sequencer.
[[File:PatternEditor.png|400px|right]]
==Admin Menu==
[[File:Zynthian_ui_admin.png|400px|right]]
[[File:Zynthian_ui_admin_02.png|400px|right]]
The Admin menu gives access to some configuration options (most of them also accessible from the webconf tool). Also includes basic testing options for audio and MIDI.
You can access this menu from the Main menu.
====Removing Notes====
<br clear=all>
===Touchscreen Calibration===
Zynthian supports touchscreen operation for most operations. To ensure good alignment of the touch interface there is a calibration screen that is accessed from the Admin menu.
[[File:Touchscreen_calibration_1.png|400px|right]]
When the screen opens it shows a target crosshair in the center of the screen and a countdown timer. If the timer expires the screen will close without applying any calibration. Touch the target to detect the screen and begin calibration.
<br clear=all>
[[File:Touchscreen_calibration_2.png|400px|right]]
The name of the detected display is shown at the bottom of the screen. Further targets will appear. Touch the screen, drag to centre of target and release.
When the screen is pressed the target will show red. When released the measurement is taken and the next crosshair target appears white.
====Change Time Divisions====
<br clear=all>
[[File:Touchscreen_calibration_3.png|400px|right]]
After releasing the last target, calibration is applied and the screen closes. Touch is ignored if too close to previous touch.
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>
==Key Bindings: Controlling the UI with a computer keyboard==
==Key Bindings: Controlling the UI with a computer keyboard==
The user interface may be driven using a USB keyboard, e.g. QWERTY, Dvorak, etc.
The user interface may be driven using a USB keyboard, e.g. QWERTY, Dvorak, etc. Key assignment and their combinations can be modified with the webconf tool.
{| class="wikitable"
{| class="wikitable"
|+ Keyboard shortcuts
|-
! Action !! Modifier !! Key
|-
| ALL_NOTES_OFF || None|| Space
|-
| ALL_OFF || Ctrl || Space
|-
| ALL_SOUNDS_OFF || Shift || Space
|-
|-
| BACK_DOWN || CapsLock || Down
|-
|-
|Enter||None||SELECT
| BACK_UP || CapsLock || Up
|-
|-
|Enter||Shift||Bold SELECT
| LAYER_DOWN || Shift || Down
|-
|-
|Enter||Ctrl||Long SELECT
| LAYER_UP || Shift || Up
|-
|-
|Backspace||None||BACK
| POWER_OFF || Ctrl || End
|-
|-
|Backspace||Shift||Bold BACK
| REBOOT || Ctrl || Home
|-
|-
|Backspace||Ctrl||Long BACK
| RELOAD_MIDI_CONFIG || Ctrl || Insert
|-
|-
|Escape||None||BACK
| RESTART_UI || Shift || Home
|-
|-
|Escape||Shift||Bold BACK
| SELECT_DOWN || None || Down
|-
|-
|Escape||Ctrl||Long BACK
| SELECT_UP || None || Up
|-
|-
|L||None||LAYER
| SNAPSHOT_DOWN || Ctrl || Down
|-
|-
|L||Shift||Bold LAYER
| SNAPSHOT_UP || Ctrl || Up
|-
|-
|L||Ctrl||Long LAYER
| START_AUDIO_PLAY || Ctrl || a
|-
|-
|S||None||SNAPSHOT
| START_AUDIO_RECORD || None || a
|-
|-
|S||Shift||Bold SNAPSHOT
| START_MIDI_PLAY || Ctrl || m
|-
|-
|S||Ctrl||Long SNAPSHOT
| START_MIDI_RECORD || None || m
|-
|-
|A||None||Start audio Record
| STOP_AUDIO_PLAY || Ctrl+Shift|| a
|-
|-
|A||Shift||Stop audio Record
| STOP_AUDIO_RECORD || Shift || a
|-
|-
|A||Alt||Toggle audio Record
| STOP_MIDI_PLAY || Ctrl+Shift || m
|-
|-
|A||Ctrl||Start audio Play
| STOP_MIDI_RECORD || Shift || m
|-
|-
|A||Ctrl+Shift||Stop audio Play
| SWITCH_BACK_BOLD || Shift || BackSpace, Escape, Left
|-
|-
|M||None||Start MIDI Record
| SWITCH_BACK_LONG || Ctrl || BackSpace, Escape, Left
|-
|-
|M||Shift||Stop MIDI Record
| SWITCH_BACK_SHORT || None || BackSpace, Escape, Left
|-
|-
|M||Ctrl||Start MIDI Play
| SWITCH_LAYER_BOLD || Shift|| l
|-
|-
|M||Ctrl+Shift||Stop MIDI Play
| SWITCH_LAYER_LONG || Ctrl || l
|-
|-
|Space||None||All Notes Off
| SWITCH_LAYER_SHORT || None|| l
|-
|-
|Space||Shift||All Sounds Off
| SWITCH_SELECT_BOLD || Shift || Return, Right
|-
|-
|Space||Ctrl||All off
| SWITCH_SELECT_LONG || Ctrl || Return, Right
|-
|-
|Home||Shift||Restart UI
| SWITCH_SELECT_SHORT || None || Return, Right
|-
|-
|Insert||Ctrl||Reload MIDI Config
| SWITCH_SNAPSHOT_BOLD || Shift || s
|-
|-
|Home||Ctrl||Reboot
| SWITCH_SNAPSHOT_LONG || Ctrl || s
|-
|-
|End||Ctrl||Power Off
| SWITCH_SNAPSHOT_SHORT || None || s
|-
|-
|Up||None||Listbox Up
| TOGGLE_AUDIO_PLAY || CapsLock+Shift || a
|-
|-
|Down||None||Listbox Down
| TOGGLE_AUDIO_RECORD || CapsLock || a
|-
|-
|Left||None||BACK
| TOGGLE_MIDI_PLAY || CapsLock+Shift || m
|-
|-
|Right||None||SELECT
| TOGGLE_MIDI_RECORD || CapsLock || m
|}
|}
or play the C-1 key, if your keyboard has it.
or play the C-1 key, if your keyboard has it.
This is the full list:
Note that you can use the velocity for sending the CUIA parameter when it's required by the action (SELECT & LAYER_CONTROL).
This is the full map of CUIA to MIDI notes:
'''Num''' '''CUIA''' '''Note''' '''System Real-Time'''
'''Num''' '''CUIA''' '''Note''' '''System Real-Time'''
2 RESTART_UI D-1
2 RESTART_UI D-1
3 RELOAD_MIDI_CONFIG D#-1
3 RELOAD_MIDI_CONFIG D#-1
4 RELOAD_KEY_CONFIG E-1
4 RELOAD_KEY_BINDING E-1
5 LAST_STATE_ACTION F-1
10 ALL_NOTES_OFF A#-1
10 ALL_NOTES_OFF A#-1
52 SELECT_UP E3
52 SELECT_UP E3
53 SELECT_DOWN F3
53 SELECT_DOWN F3
54 BACK_UP F#3
55 BACK_DOWN G3
56 LAYER_UP G#3
57 LAYER_DOWN A3
58 SNAPSHOT_UP A#3
59 SNAPSHOT_DOWN B3
64 SWITCH_BACK_SHORT E4
64 SWITCH_BACK_SHORT E4
73 SWITCH_SNAPSHOT_LONG C#5
73 SWITCH_SNAPSHOT_LONG C#5
80 SCREEN_ADMIN G#5
80 SCREEN_MAIN G#5
81 SCREEN_LAYER A5
81 SCREEN_LAYER A5
82 SCREEN_BANK A#5
82 SCREEN_BANK A#5
94 MODAL_ALSA_MIXER A#6
94 MODAL_ALSA_MIXER A#6
95 MODAL_STEPSEQ B6
95 MODAL_STEPSEQ B6
96 MODAL_ADMIN C7
100 LAYER_CONTROL E7
[[File:2Oct_Keyboard_CUIA.png|600px|Keyboard]]
[[File:2Oct_Keyboard_CUIA.png|600px|Keyboard]]
[[File:Midi-note-chart.jpg]]
[[File:Midi-note-chart.jpg]]
==Controlling the UI with OSC messages==
==Controlling the UI with OSC messages==
The same CUIA calls are available using OSC on UDP 1370, with the base prefix "/cuia". Take a look to "[[Accessing_Zynthian_from_your_computer#OSC|Calling CUIA with OSC]]".
The same CUIA calls are available using OSC on UDP 1370, with the base prefix "/cuia". Take a look to "[[Accessing_Zynthian_from_your_computer#OSC|Calling CUIA with OSC]]".