Difference between revisions of "Zynthian Users Guide"

From ZynthianWiki
Jump to navigation Jump to search
(37 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.
+
==Beginers==
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]]
+
'''[[Building_a_Zynthian_Box_using_an_official_Kit_v3#First_Boot|First Steps]]''': ''A brief tutorial on basic UI usage''
  
Currently there are two screen patterns:
+
'''[[Quick Start]]''': ''A beginners tutorial on how to make a piano snapshot''
  
- '''Selector Screen''': a list of items that you can scroll and select with the SELECT(4) encoder/switch
+
==User Guides: The 4 interfaces==
- '''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:
+
Zynthian has 4 user interfaces that we have documented separately:
  
- '''short:''' less than 0.3 seconds
+
1. '''[[Zynthian UI Users Guide]]''': The Hardware UI. '''<= You should start here!'''
- '''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:
+
2. [[Configuration Users Guide]]: Web Configuration Tool.
  
 +
3. [[MOD Users Guide|MOD-UI Users Guide]]: MOD Plugin-Host UI.
  
[[File:zynthian_ui_workflow_1.png]]
+
4. [[Command Line User Guide]]: If you need to manually setup/configure things.
  
[[File:zynthian_ui_workflow_2.png]]
+
 
 +
[[Understanding LINUX Audio]] Help in understanding all those acronyms mentioned in this Wiki

Revision as of 20:03, 17 July 2019

1 Beginers

First Steps: A brief tutorial on basic UI usage

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

2 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