Changes

Jump to navigation Jump to search
Line 1: Line 1:    −
=Zynthian's Hardware User Interface=
+
=The Zynthian's Hardware User Interface=
The Zynthian's Hardware User Interface is displayed on a TFT display and controlled by 4 rotary-encoders with push switches.
+
The Zynthian's Hardware 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.
   −
[[File:zynthian_ui_legend.png]]
+
[[File:zynthian_controllers.png]]
    
Currently there are two screen layouts:
 
Currently there are two 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.
    
And there are 3 types of clicks (push) that can be performed, depending on how long you hold down the knob:
 
And there are 3 types of clicks (push) that can be performed, depending on how long you hold down the knob:
Line 16: Line 16:  
* '''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". 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.  
+
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.  
   −
Loading and Saving: You have to push the LS (Load/Save) knob (3). If you click once, you get the Load menu, another click and you are in the Save menu. Normal click opens the engine's LS menu, that lists the current engine's snapshots, but if you bold-click LS when an engine is active, then you get the global LS menu, that lists the snapshots for all the engines.
+
Loading and Saving snapshots: 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 menu. The Snapshot menu have 2 levels: bank selection (directory) and snapshot (file).
   −
For a detailed description, see the next flowcharts:
+
=The Zynthian UI Workflow=
 +
 
 +
The next flowcharts show the different "screens" or "functions" and the way to reach each one using the 4 switches:
    
[[File:zynthian_ui_workflow_1.png]]
 
[[File:zynthian_ui_workflow_1.png]]
Line 26: Line 28:  
[[File:zynthian_ui_workflow_2.png]]
 
[[File:zynthian_ui_workflow_2.png]]
   −
=Admin menu=
+
If you want to contribute improving these flowcharts, you can edit it using the Google Documents Tools:
 +
 
 +
- [https://docs.google.com/drawings/d/1jmt3zrJjPkbqj3hpzCIwRgFIKxiX2UptebBA_GN8e5I/edit?usp=sharing Main sequence: zynthian_ui_workflow_1]
 +
- [https://docs.google.com/drawings/d/1Um1HVCvvb4gZF_X-vcIN9cTxYIBRCtZ5oxniUdSTB3c/edit?usp=sharing Aux. Sequences: zynthian_ui_workflow_2]
 +
 
 +
=Admin Menu=
 
Pressing the Back knob, when you are in the Layer List screen, brings you to the Admin menu. The last item is how you safely power off the Zynthian without corrupting data files.  
 
Pressing the Back knob, when you are in the Layer List screen, brings you to the Admin menu. The last item is how you safely power off the Zynthian without corrupting data files.  
   Line 78: Line 85:     
When clicking (tapping/touching) the topbar, a "back" event is triggered. It's a quick & dirty fix and probably it will change in the future, but meanwhile it will enable you to fully control Zynthian using the touchscreen if you don't have knob hardware. [[File:Topbar.png]]
 
When clicking (tapping/touching) the topbar, a "back" event is triggered. It's a quick & dirty fix and probably it will change in the future, but meanwhile it will enable you to fully control Zynthian using the touchscreen if you don't have knob hardware. [[File:Topbar.png]]
  −
=Help improve this documentation=
  −
If you want to contribute improving these flowcharts, you can edit it using the Google Documents Tools:
  −
  −
- [https://docs.google.com/drawings/d/1jmt3zrJjPkbqj3hpzCIwRgFIKxiX2UptebBA_GN8e5I/edit?usp=sharing Main sequence: zynthian_ui_workflow_1]
  −
- [https://docs.google.com/drawings/d/1Um1HVCvvb4gZF_X-vcIN9cTxYIBRCtZ5oxniUdSTB3c/edit?usp=sharing Aux. Sequences: zynthian_ui_workflow_2]
 

Navigation menu