Changes

=The Zynthian's Hardware User Interface=

=General Concepts=

[[File:zynthian_controllers.png|430px|right]]

[[File:zynthian_controllers.png|430px|right]]

[[File:zynthian_ui_workflow_1.png|400px|thumb]]

[[File:zynthian_ui_workflow_1.png|400px|thumb]]

[[File:zynthian_ui_workflow_2.png|400px|thumb]]

[[File:zynthian_ui_workflow_2.png|400px|thumb]]

The Zynthian's Hardware UI is displayed on a touch display and controlled by 4 rotary-encoders with switches (push).

The Zynthian UI is displayed on a touch display and controlled by 4 rotary-encoders with switches (push).

The encoders/switch knobs are used to navigate between the different screens/menus, select options and change the instrument parameters, acting as MIDI/OSC controllers.

The encoders/switch knobs are used to navigate between the different screens/menus, select options and change the instrument parameters, acting as MIDI/OSC controllers. You can emulate the knobs behaviour using the touch-display, but it's sub-optimal and accessing some features could be tricky.

Currently there are two main screen types (layouts):

Currently there are two main screen-types (screen-layouts):

* '''Selector Screen''': a list of items that you can scroll and select with the SELECT (4) knob

* '''Selector Screen''': a list of items that you can scroll and select with the SELECT (4) knob

* '''Controller Screen''': In the corners, 4 control widgets (one for each knob), with label and value indicator (graphic and numeric). In the middle, a list of controller maps which you can use to change or rotate using the SELECT (4) knob.

* '''Controller Screen''': In the corners, 4 control widgets (one for each knob), with label and value indicator (graphic and numeric). In the middle, a list of controller maps which you can use to change or rotate using the SELECT (4) knob.

Almost every Zynthian UI screen fits in one of these 2 types, however, other screen types does exist:

Almost every Zynthian UI screen fits in one of these 2 types, however, other screen-types does exist:

* '''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''': It display info about some operation, like "Update Software", or "Network Info"

* '''Info Screen''': It display info about some operation, like "Update Software", or "Network Info"

* '''Sequencer''': It's a planned feature not implemented yet ;-)

* '''Sequencer''': It's a planned feature not implemented yet ;-)

There are 3 types of clicks (push) that can be performed, depending on how long you hold down the knob:

There are 3 types of clicks (push) that can be performed, depending on how long you hold down the knob (or push on the touch-display):

* '''short:''' less than 0.3 seconds

* '''short:''' less than 0.3 seconds

* '''long:''' more than 2 seconds

* '''long:''' more than 2 seconds

Actions for each knob and click type are context dependent. Generally, the SELECT knob and a short click is used to navigate and select items on a "Selector Screen". Inside a "Controller Screen", short clicks can be used to rotate between layers (LAYER) or between controller pages (SELECT). "Bold" clicks are intended as shortcuts for jumping to some specific screens. Clicking the BACK knob generally jumps to the previous screen in the sequence.  

Actions for each knob and click-type are context dependent. Generally, the SELECT knob is 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 actions depends on context (the current screen), but there are some actions that are global and will work from any menu screen:

Most of actions depends on context (the current screen), but there are some actions that are global and will work from any screen:

* '''long-back''': go to the admin menu

* '''long-back''': go to the admin menu

Snapshot actions are also global an will work from any point in the workflow. If you click SNAPSHOT (3) once, you get the Load Snapshot menu, another click and you will be in the Save Snapshot menu. If you bold-click SNAPSHOT then you will go directly to the Save Snapshot screen. The Snapshot screen have 2 levels: bank selection (directory) and snapshot (file). These actions are better explained below.

Snapshot actions are also global an will work from any point in the workflow. If you click SNAPSHOT (3) once, you get the Load Snapshot menu, another click and you will be in the Save Snapshot menu. If you bold-click SNAPSHOT then you will go directly to the Save Snapshot screen. The Snapshot screen have 2 levels: bank selection (directory) and snapshot (file). These actions are better explained below.

=The Zynthian UI Workflow=

=The Zynthian UI Workflow=