Difference between revisions of "Zynthian Users Guide"

From ZynthianWiki
Jump to: navigation, search
(Fixed English grammar.)
Line 1: Line 1:
  
The Zynthian User Interface is formed by 4 rotary encoders with switch and one TFT display.
+
The Zynthian User Interface is displayed on a TFT display and controlled by 4 rotary-encoders with push switches.
The encoders/switches 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.
  
 
[[File:zynthian_ui_legend.png]]
 
[[File:zynthian_ui_legend.png]]
  
Currently there are two screen patterns:
+
Currently there are two screen layouts:
  
- '''Selector Screen''': a list of items that you can scroll and select with the SELECT(4) encoder/switch
+
# '''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 encoder/switch), with label and value indicator (graphic and numeric). In the middle, a list of controller maps to which you can change or rotate using the SELECT(4) encoder/switch.
+
# '''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.
  
And there are 3 types of clicks (push) action that can be realized on every switch:
+
And there are 3 types of clicks (push) that can be performed, depending on how long you hold down the knob:
  
 
  - '''short:''' less than 0.3 seconds
 
  - '''short:''' less than 0.3 seconds
Line 16: Line 16:
 
  - '''long:''' more than 2 seconds
 
  - '''long:''' more than 2 seconds
  
Actions bond to every different switch and click type are context dependent. Generally, SELECT rotary and short click is used to navigate and select items in a "Selector Screen". From "Controller Screen", short click can be used to rotate between channels (CH) or between controller maps (SELECT). "Bold" clicks are intended as shortcuts for jumping to some specific screens. Clicking BACK generally jumps to the previous screen in the sequence. For a detailed description, see the next flowcharts:
+
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". On a "Controller Screen", short clicks can be used to rotate between channels (CH) or between controller maps (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. For a detailed description, see the next flowcharts:
  
  

Revision as of 00:49, 16 August 2017

The Zynthian User Interface is displayed on a TFT display and controlled by 4 rotary-encoders with push switches. 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.

Zynthian ui legend.png

Currently there are two screen layouts:

  1. Selector Screen: a list of items that you can scroll and select with the SELECT(4) knob
  2. 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.

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

- short: less than 0.3 seconds
- bold: between 0.3 and 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". On a "Controller Screen", short clicks can be used to rotate between channels (CH) or between controller maps (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. For a detailed description, see the next flowcharts:


Zynthian ui workflow 1.png

Zynthian ui workflow 2.png

If you want to contribute improving these flowcharts, you can edit it using the Google Documents Tools:

- Main sequence: zynthian_ui_workflow_1
- Aux. Sequences: zynthian_ui_workflow_2