Difference between revisions of "Zynthian Users Guide"

Revision as of 03:28, 17 September 2017

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

The Zynthian has 4 user interfaces:

1. Zynthian UI Users Guide: The Hardware UI.

2. Configuration Users Guide: Web configuration tool.

3. MOD Users Guide: Web UI for LV2 plugin host.

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

@@ Line 4: / Line 4: @@
 The Zynthian has 4 user interfaces:
-. [[Command Line User Guide]] If you need to manually setup/configure.
+. [[Zynthian UI Users Guide]]: The Hardware UI.
-. [[Configuration Users Guide]] (web browser configuration tool)
+. [[Configuration Users Guide]]: Web configuration tool.
-. [[MOD Users Guide]] (web browser UI for LV2 plugin host)
+. [[MOD Users Guide]]: Web UI for LV2 plugin host.
-. The device UI (the hardware itself)
+. [[Command Line User Guide]]: If you need to manually setup/configure.
-=Device User Interface=
-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.
-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.
-For a detailed description, see the next flowcharts:
-[[File:zynthian_ui_workflow_1.png]]
-[[File:zynthian_ui_workflow_2.png]]
-=Admin menu=
-Pressing the Back knob, when you are in the Layer List screen, brings you to the Admin menu.
-[[File:UI-1.JPG|400px]]
-=Layer List=
-This is the first screen you see when you power on.
-Choose New Layer to get started. A layer is a stored configuration of one synth engine and all its parameters.
-[[File:UI-LayerMenu.JPG|400px]]
-=Engine List=
-Once you have chosen/created a Layer, you see the list of synth engines to choose from.
-[[File:UI-EngineMenu.JPG|400px]]
-= UI with only a touch screen and no encoders=
-''Need to describe how the UserInterface works with no rotary-encoders and only a touchscreen.''
-Now you can navigate and control the Zynthian UI without encoders/switches at all. Only touchscreen.
-You can "emulate" the switches by pushing in the controller widgets. There are short, bold and long actions. Exactly the same workflow than ever. When the "back" widget is not available, you can go back by clicking the top bar.
-Also, as i explained in another post, you can move the controllers by "sliding" over the widgets.
-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]]
-=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]

Difference between revisions of "Zynthian Users Guide"

Revision as of 03:28, 17 September 2017

Navigation menu

Search