Difference between revisions of "Zynthian Users Guide"

From ZynthianWiki
Jump to navigation Jump to search
(28 intermediate revisions by 2 users not shown)
Line 1: Line 1:
  
The Zynthian User Interface is formed by 4 rotary encoders with switch and one TFT display.
+
Here's a list of the things Zynthian can do: [[Zynthian Features]]
The encoders/switches 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]]
+
The Zynthian has 4 user interfaces:
  
Currently there are two screen patterns:
+
1. [[Zynthian UI Users Guide|UI Users Guide]]: The Hardware UI.
  
- '''Selector Screen''': a list of items that you can scroll and select with the SELECT(4) encoder/switch
+
2. [[Configuration Users Guide]]: Web Configuration Tool.
- '''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.
 
  
And there are 3 types of clicks (push) action that can be realized on every switch:
+
3. [[MOD Users Guide]]: Plugin Host Web UI.
  
- '''short:''' less than 0.3 seconds
+
4. [[Command Line User Guide]]: If you need to manually setup/configure things.
- '''bold:''' between 0.3 and 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:
 
 
 
 
 
[[File:zynthian_ui_workflow_1.png]]
 
 
 
[[File:zynthian_ui_workflow_2.png]]
 
 
 
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]
 

Revision as of 15:59, 31 December 2018

Here's a list of the things Zynthian can do: Zynthian Features

The Zynthian has 4 user interfaces:

1. UI Users Guide: The Hardware UI.

2. Configuration Users Guide: Web Configuration Tool.

3. MOD Users Guide: Plugin Host Web UI.

4. Command Line User Guide: If you need to manually setup/configure things.