Difference between revisions of "Zynthian Users Guide"

From ZynthianWiki
Jump to navigation Jump to search
(add topbar image)
(20 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
Here's a list of the things Zynthian can do: [[Zynthian Features]]
 
Here's a list of the things Zynthian can do: [[Zynthian Features]]
  
−
The Zynthian has 3 user interfaces:
+
The Zynthian has 4 user interfaces:
  
−
1. [[Configuration Users Guide]] (web browser UI)
+
1. [[Zynthian UI Users Guide|UI Users Guide]]: The Hardware UI.
  
−
2. [[MOD Users Guide]] (web browser UI)
+
2. [[Configuration Users Guide]]: Web Configuration Tool.
  
−
3. The device UI (the hardware itself)
+
3. [[MOD Users Guide]]: Plugin Host Web UI.
  
−
=Device User Interface=
+
4. [[Command Line User Guide]]: If you need to manually setup/configure things.
−
The Zynthian device 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.
 
−
 
 
−
[[File:zynthian_ui_legend.png]]
 
−
 
 
−
Currently there are two screen layouts:
 
−
 
 
−
# '''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.
 
−
 
 
−
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:
 
−
 
 
−
[[File:zynthian_ui_workflow_1.png]]
 
−
 
 
−
[[File:zynthian_ui_workflow_2.png]]
 
−
 
 
−
''Need to describe how the UserInterface works with no rotary-encoders and only a touchscreen.''
 
−
 
 
−
When clicking (touching) the topbar, a "back" event is triggered. It's quick&dirty fix and probably it will change in the future, but meanwhile it will allow to have a basic functionality using the touchscreen without controllers. [[File:Topbar.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.

Retrieved from "http://wiki.zynthian.org/index.php?title=Zynthian_Users_Guide&oldid=10024"