Difference between revisions of "Zynthian Users Guide"

From ZynthianWiki
Jump to: navigation, search
(User Guide: The 4 interfaces)
(32 intermediate revisions by 2 users not shown)
Line 1: Line 1:
  
The Zynthian has 3 user interfaces:
+
==Beginers==
1. [[Configuration]] (web browser UI)
+
2. MOD-UI (web browser UI)
+
3. The device UI (the hardware itself)
+
  
=Device User Interface=
+
'''[[Building_a_Zynthian_Box_using_an_official_Kit_v3#First_Boot|First Steps]]''': ''A brief tutorial on basic UI usage''
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]]
+
'''[[Quick Start]]''': ''A beginners tutorial on how to make a piano snapshot''
  
Currently there are two screen layouts:
+
==User Guides: The 4 interfaces==
  
# '''Selector Screen''': a list of items that you can scroll and select with the SELECT(4) knob
+
Zynthian has 4 user interfaces that we have documented separately:
# '''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:
+
1. '''[[Zynthian UI Users Guide]]''': The Hardware UI. '''<= You should start here!'''
* '''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:
+
2. [[Configuration Users Guide]]: Web Configuration Tool.
  
[[File:zynthian_ui_workflow_1.png]]
+
3. [[MOD Users Guide|MOD-UI Users Guide]]: MOD Plugin-Host UI.
  
[[File:zynthian_ui_workflow_2.png]]
+
4. [[Command Line User Guide]]: If you need to manually setup/configure things.
  
''Need to describe how the UserInterface works with no rotary-encoders and only a touchscreen.''
 
  
If you want to contribute improving these flowcharts, you can edit it using the Google Documents Tools:
+
[[Understanding LINUX Audio]] Help in understanding all those acronyms mentioned in this Wiki
 
+
- [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 22:03, 17 July 2019

Beginers

First Steps: A brief tutorial on basic UI usage

Quick Start: A beginners tutorial on how to make a piano snapshot

User Guides: The 4 interfaces

Zynthian has 4 user interfaces that we have documented separately:

1. Zynthian UI Users Guide: The Hardware UI. <= You should start here!

2. Configuration Users Guide: Web Configuration Tool.

3. MOD-UI Users Guide: MOD Plugin-Host UI.

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


Understanding LINUX Audio Help in understanding all those acronyms mentioned in this Wiki