3,509
edits
Changes
→Snapshots
Line 83:
Line 83:
+[[File:Topbar back.png|right|Topbar back button]]+
−
+
+
In addition. you can also modify global device options:+
−* '''capture mode:''' ACTIVE / MULTI
−* '''load/unload drivers'''
−* '''rename the device'''
−
−Initially all input devices are in ACTIVE mode. When creating a new chain, all input devices are selected by default.
===Snapshots===
===Snapshots===
+[[File:snapshot_structure.png|400px|right]]
+
A snapshot is the captured state of zynthian at the time of saving the snapshot. Snapshots are saved in a JSON file with ''.zss'' extension and can be loaded at any time, which effectively restores the state of the zynthian device when the snapshot was saved. Snapshots include:
A snapshot is the captured state of zynthian at the time of saving the snapshot. Snapshots are saved in a JSON file with ''.zss'' extension and can be loaded at any time, which effectively restores the state of the zynthian device when the snapshot was saved. Snapshots include:
Line 94:
Line 96:
Each time you overwrite an existing snapshot file, a backup copy is created. Backups can also be restored at any time, which can avoid much suffering. When you feel the panic, remember that zynthian stores the full ''save history'' for '''all''' snapshots!
Each time you overwrite an existing snapshot file, a backup copy is created. Backups can also be restored at any time, which can avoid much suffering. When you feel the panic, remember that zynthian stores the full ''save history'' for '''all''' snapshots!
+
+<br clear=all>
{{NoteBox|Many zynthian users like to see snapshots as "zynthian project" files and it's not a a bad approach.}}
{{NoteBox|Many zynthian users like to see snapshots as "zynthian project" files and it's not a a bad approach.}}
Line 215:
Line 219:
|style="padding:10px"|<span style="color:#00FF00">[[File:Ui push short icon.png|35px]]</span>
|style="padding:10px"|<span style="color:#00FF00">[[File:Ui push short icon.png|35px]]</span>
|style="padding:10px"|'''Short Push'''
|style="padding:10px"|'''Short Push'''
−|style="padding:10px"|Push and release in less than 0.3 seconds.
+|style="padding:10px"|Push and release in less than 0.3 seconds. Normally used to select an item, check/uncheck an option or trigger the default action for the item.
|-
|-
−|style="padding:10px"|<span style="color:#00FF00">[[File:Ui push bold icon.png|35px]]</span>
+|style="padding:10px"|<span style="color:#008F00">[[File:Ui push bold icon.png|35px]]</span>
|style="padding:10px"|'''Bold Push'''
|style="padding:10px"|'''Bold Push'''
−|style="padding:10px"|Push and hold for longer than 0.3 seconds then release before 2 seconds.
+|style="padding:10px"|Push and hold for longer than 0.3 seconds then release before 2 seconds. Normally used to open options menu, access extra details or edit the item.
|-
|-
−|style="padding:10px"|<span style="color:#00FF00">[[File:Ui push long icon.png|35px]]</span>
+|style="padding:10px"|<span style="color:#008F00">[[File:Ui push long icon.png|35px]]</span>
|style="padding:10px"|'''Long Push'''
|style="padding:10px"|'''Long Push'''
−|style="padding:10px"|Push and hold for longer than 2 seconds. Long-action triggers before release.
+|style="padding:10px"|Push and hold for longer than 2 seconds. Long-action triggers before release. Used for important functions that are not used very often.
|-
|-
−|style="padding:10px"|<span style="color:#00FF00">[[File:Ui knob rotate icon.png|35px]]</span>
+|style="padding:10px"|<span style="color:#008F00">[[File:Ui knob rotate icon.png|35px]]</span>
|style="padding:10px"|'''Knob Rotate'''
|style="padding:10px"|'''Knob Rotate'''
−|style="padding:10px"|Rotate the knob.
+|style="padding:10px"|Rotate the knob. Used to change parameter values or move across a list or grid.
|}
|}
{| class="wikitable show_only_touch" style="margin:auto"
{| class="wikitable show_only_touch" style="margin:auto"
!colspan="3"|UI actions
!colspan="3"|UI actions
|-
|-
−|style="padding:10px"|<span style="color:#00FF00">[[File:Ui push short icon.png|35px]]</span>
+|style="padding:10px"|<span style="color:#008F00">[[File:Ui push short icon.png|35px]]</span>
|style="padding:10px"|'''Short Push'''
|style="padding:10px"|'''Short Push'''
−|style="padding:10px"|Push and release in less than 0.3 seconds.
+|style="padding:10px"|Push and release in less than 0.3 seconds. Normally used to select an item, check/uncheck an option or trigger the default action for the item.
|-
|-
−|style="padding:10px"|<span style="color:#00FF00">[[File:Ui push bold icon.png|35px]]</span>
+|style="padding:10px"|<span style="color:#008F00">[[File:Ui push bold icon.png|35px]]</span>
|style="padding:10px"|'''Bold Push'''
|style="padding:10px"|'''Bold Push'''
−|style="padding:10px"|Push and hold for longer than 0.3 seconds then release before 2 seconds.
+|style="padding:10px"|Push and hold for longer than 0.3 seconds then release before 2 seconds. Normally used to open options menu, access extra details or edit the item.
|-
|-
−|style="padding:10px"|<span style="color:#00FF00">[[File:Ui push long icon.png|35px]]</span>
+|style="padding:10px"|<span style="color:#008F00">[[File:Ui push long icon.png|35px]]</span>
|style="padding:10px"|'''Long Push'''
|style="padding:10px"|'''Long Push'''
−|style="padding:10px"|Push and hold for longer than 2 seconds. Long-action triggers before release.
+|style="padding:10px"|Push and hold for longer than 2 seconds. Long-action triggers before release. Used for important functions that are not used very often.
|-
|-
−|style="padding:10px"|<span style="color:#00FF00">Horizontal Drag</span>
+|style="padding:10px"|<span style="color:#008F00">Horizontal Drag</span>
|style="padding:10px"|'''Horizontal Drag'''
|style="padding:10px"|'''Horizontal Drag'''
|style="padding:10px"|Push and drag horizontally. Must release before you can drag vertically. If still moving when released, a swipe action may occur.
|style="padding:10px"|Push and drag horizontally. Must release before you can drag vertically. If still moving when released, a swipe action may occur.
|-
|-
−|style="padding:10px"|<span style="color:#00FF00">Vertical Drag</span>
+|style="padding:10px"|<span style="color:#008F00">Vertical Drag</span>
|style="padding:10px"|'''Vertical Drag'''
|style="padding:10px"|'''Vertical Drag'''
|style="padding:10px"|Push and drag vertically. Must release before you can drag horizontally. If still moving when released, a swipe actin may occur.
|style="padding:10px"|Push and drag vertically. Must release before you can drag horizontally. If still moving when released, a swipe actin may occur.
|-
|-
−|style="padding:10px"|<span style="color:#00FF00">2 Finger Horizontal Drag</span>
+|style="padding:10px"|<span style="color:#008F00">2 Finger Horizontal Drag</span>
|style="padding:10px"|'''2 Finger Horizontal Drag'''
|style="padding:10px"|'''2 Finger Horizontal Drag'''
|style="padding:10px"|Push with 2 fingers and drag horizontally. Must release before you can drag vertically. If still moving when released, a swipe actin may occur.
|style="padding:10px"|Push with 2 fingers and drag horizontally. Must release before you can drag vertically. If still moving when released, a swipe actin may occur.
|-
|-
−|style="padding:10px"|<span style="color:#00FF00">2 Finger Vertical Drag</span>
+|style="padding:10px"|<span style="color:#008F00">2 Finger Vertical Drag</span>
|style="padding:10px"|'''2 Finger Vertical Drag'''
|style="padding:10px"|'''2 Finger Vertical Drag'''
|style="padding:10px"|Push with 2 fingers and drag vertically. Must release before you can drag horizontally. If still moving when released, a swipe actin may occur.
|style="padding:10px"|Push with 2 fingers and drag vertically. Must release before you can drag horizontally. If still moving when released, a swipe actin may occur.
|-
|-
−|style="padding:10px"|<span style="color:#00FF00">Horizontal Pinch</span>
+|style="padding:10px"|<span style="color:#008F00">Horizontal Pinch</span>
|style="padding:10px"|'''Horizontal Pinch'''
|style="padding:10px"|'''Horizontal Pinch'''
|style="padding:10px"|Push with two fingers then drag horzontally towards or away from each other. Must release before you can pinch vertically.
|style="padding:10px"|Push with two fingers then drag horzontally towards or away from each other. Must release before you can pinch vertically.
|-
|-
−|style="padding:10px"|<span style="color:#00FF00">Vertical Pinch</span>
+|style="padding:10px"|<span style="color:#008F00">Vertical Pinch</span>
|style="padding:10px"|'''Vertical Pinch'''
|style="padding:10px"|'''Vertical Pinch'''
|style="padding:10px"|Push with two fingers then drag vertically towards or away from each other. Must release before you can pinch horizontally.
|style="padding:10px"|Push with two fingers then drag vertically towards or away from each other. Must release before you can pinch horizontally.
Line 287:
Line 291:
** '''rotate''' to browse lists and move the cursor horizontally in grids.
** '''rotate''' to browse lists and move the cursor horizontally in grids.
** '''short-push''' to select items, like the SEL button.
** '''short-push''' to select items, like the SEL button.
+** '''bold-push''' to open contextual options, like the OPT button.
* '''Knob#3'''
* '''Knob#3'''
** '''rotate''' to move the cursor vertically in grids.
** '''rotate''' to move the cursor vertically in grids.
Line 320:
Line 325:
<div class="show_only_v4 show_only_v5">
<div class="show_only_v4 show_only_v5">
+
===Using the push buttons===
===Using the push buttons===
<div class="show_only_v5">
<div class="show_only_v5">
Line 508:
Line 514:
At the top of the display there is usually a bar that contains information. This may not be visible for some views, such as confirmation or information pop-ups.
At the top of the display there is usually a bar that contains information. This may not be visible for some views, such as confirmation or information pop-ups.
===The title-bar===
===The title-bar===
−[[File:Screenshot 2024-06-22 11.41.54.png|400px|right|Title Bar]]
+<div class="show_only_v5 show_only_v4">
−[[File:title_bar_mixer.png|400px|right|Title Bar]]
−The title bar acts as a kind of breadcrumb. It normally shows the view's title or current chain information: MIDI channel, engine, bank & preset.
+</div>
+<div class="show_only_touch">
+[[File:title_bar_mixer_touch.png|400px|right|Title bar with touch back button]]
+</div>
+The title bar acts as a kind of breadcrumb. It normally shows the view's title or info about the current snapshot/zs3 or chain (MIDI channel, engine, bank & preset).
<div class="show_only_touch">
<div class="show_only_touch">
−It may also show a BACK button on the left which. When tapped will return to the previous view. Tapping the title's bar itself will open the options menu
−It may also show a BACK button on the left which, when tapped will return to the previous view.
</div>
</div>
Line 913:
Line 921:
</div>
</div>
−Processor parameters can be easily bond to your MIDI controller's knobs & faders (MIDI CC) by using the [[#MIDI learning|'''MIDI learning''' mechanism]].
+Processor parameters can be easily bond to your MIDI controller's knobs & faders (MIDI CC) by using the '''MIDI learning''' mechanism. There are two MIDI learning modes:
+'''Chain MIDI learning:'''<br>
+The controller widget displays a green <span style="color:#00D000;">??</span> legend.
+When a parameter is chain-learned, the binding only works when the chain is active. This allow to use the same knobs to control different parameters in different chains.
+'''Global MIDI learning:'''<br>
+The controller widget displays a yellow <span style="color:#F0F000;">??#??</span> legend.
+When a parameter is globally-learned, the binding works all the time, no matter the active chain.
+<br clear=all>
<br clear=all>
Line 924:
Line 941:
* '''knob#1 - knob#4'''
* '''knob#1 - knob#4'''
** '''''rotate''''' any knob to '''change the value''' of the assigned parameter.
** '''''rotate''''' any knob to '''change the value''' of the assigned parameter.
−** '''''short-push''''' any knob to '''start MIDI-learning''' for the associated parameter.
+** '''''short-push''''' any knob to '''start MIDI-learning''' for the associated parameter. First push for '''chain MIDI-learn''', second push for '''global MIDI-learn'''.
** '''''bold-push''''' any knob to open the '''options menu''' for the associated parameter.
** '''''bold-push''''' any knob to open the '''options menu''' for the associated parameter.
Line 947:
Line 964:
* '''knob#1 - knob#4'''
* '''knob#1 - knob#4'''
−** '''''short-push''''' for global learning. A third push to cancel.
+** from the control view, '''''short-push''''' any knob for entering '''chain MIDI-learning''' mode. The controller widget will display a green <span style="color:#00D000;">??</span> legend.
+** a second '''''short-push''''' for '''global MIDI-learning'''. The controller widget will display a yellow <span style="color:#F0F000;">??#??</span> legend.
+** a third push to cancel MIDI-learning.
−* '''move a knob/fader in the MIDI device''' to complete the learn.
+* '''move the desired knob/fader in the MIDI controller''' to complete the MIDI-learn procedure.
* '''BACK''' to cancel MIDI learning.
* '''BACK''' to cancel MIDI learning.
Line 988:
Line 1,007:
** '''''short-push''''' to cancel ''midi learning''.
** '''''short-push''''' to cancel ''midi learning''.
* '''learn/shot'''
* '''learn/shot'''
−** '''''short-push''''' for global learning. A third push to cancel.
+** from the control view, '''''short-push''''' for entering '''chain MIDI-learning''' mode. Controller widgets will display a green <span style="color:#00D000;">??</span> legend.
+** a second '''''short-push''''' for '''global MIDI-learning'''. Controller widgets will display a yellow <span style="color:#F0F000;">??#??</span> legend.
+** a third '''''short-push''''' to cancel MIDI-learning.
* '''rotate any knob''' to select the parameter to learn.
* '''rotate any knob''' to select the parameter to learn.
−* '''move a knob/fader in the MIDI device''' to complete the learn.
+* '''move the desired knob/fader in the MIDI controller''' to complete the learn.
</div>
</div>
Line 1,222:
Line 1,243:
[[File:zui_v5_global_midi_in.png|793px|right]]
[[File:zui_v5_global_midi_in.png|793px|right]]
−'''Global''' MIDI input/output view is accessed from the admin menu. It allows to manage MIDI input/output sources and modify MIDI device global options:
+'''Global''' MIDI input/output view is accessed from the admin menu. It allows to manage MIDI input/output sources:
* '''enable/disable MIDI network services'''
* '''enable/disable MIDI network services'''
* '''enable/disable bluetooth MIDI devices'''
* '''enable/disable bluetooth MIDI devices'''
+
+'''Bold push''' on any device to access the '''device options''':
+
* '''toggle capture mode:''' ACTIVE / MULTI
* '''toggle capture mode:''' ACTIVE / MULTI
* '''load/unload controller drivers'''
* '''load/unload controller drivers'''
* '''rename the device'''
* '''rename the device'''
−'''Chain's''' MIDI input/output view is accessed from the chain's options menu. It allows to select the devices from which it will receive MIDI input or to which it will send MIDI output.
+'''Chain's''' MIDI input/output view is accessed from the chain's options menu. It allows to '''select the devices''' from which it will receive MIDI input or to which it will send MIDI output. You can also access device options by bold-pushing any device.
−When creating a new chain, all input devices are selected by default and capture mode is ACTIVE.
−<br clear=all>
<br clear=all>
Line 1,302:
Line 1,320:
* '''short-push back button''' to close the view and back to chain options.
* '''short-push back button''' to close the view and back to chain options.
* '''drag list up/down''' to move across the list
* '''drag list up/down''' to move across the list
−* '''short-push on list item''' to check/uncheck a device.
+* '''short-push on list item''' to check/uncheck a device or enable/disable network/bluetooth service
−* '''bold-push on list item''' to open the '''device options'''.
+* '''bold-push on a MIDI device''' to open the '''device options'''.
<br clear=all>
<br clear=all>
Line 1,534:
Line 1,552:
===AidaX===
===AidaX===
+
+==Software Version==
+
+By default, zynthian runs the stable release, oram-2409.
+
+[[File:Update available icon.png|Software update available icon|right]]
+Any stable point releases are advertised in the user interfaces with an icon showing in the top right. Updates may be applied by selecting 'Update Software' in the admin menu or selecting the SOFTWARE->Update option in webconf, then pressing the 'Update Software' button.
+
+There are four options for selecting which version of zynthian to run. The selection is made in webconf's SOFTWARE->Version page.
+
+[[File:Software version - oram stable.png|Webconf software version with oram stable selected|800px]]
+
+Select from the four options in the 'Version' selection box.
+
+===Stable (oram-2409)===
+
+Selecting this version will configure zynthian to run the most stable version of the software. Updates are infrequent and extensively tested. This is the default version and is recommended for production use. Only ''point releases'' appear in this software channel. A point release is a stable version, e.g. oram-24090.1 is the firsts stable update after the release of oram-2409.
+
+After selecting this option, select 'Software Update' to apply changes.
+
+===Staging (oram)===
+
+Selecting this version will configure zynthian to run the staging version which is used as a pre-release test version. Staging version ''should'' work with minimal issues but is not fully tested. It is recommended to use this if you want to act as a zynthian tester, testing new features and bug fixes aheand of the next point release.
+
+After selecting this option, select 'Software Update' to apply changes.
+
+===Testing (vangelis)===
+
+Selecting this version will configure zynthian to run the testing version which is used as the main development version. Testing version is under continual development and will change frequently, sometimes breaking or with substantial workflow changes. It is recommended to use this only if you are a developer or wish to contribute to testing bleeding edge developement. The Testing version is generally maintained in a working stage so it ''should'' work most of the time.
+
+After selecting this option, select 'Software Update' to apply changes.
+
+===Custom===
+
+[[File:Software version - custom.png|Webconf software version with custom selected|800px|right]]
+
+Selecting the ''Custom'' option will, after a few seconds, allow individual selection of each software repository. This provides granular control of the software configuration. Each list contains the stable version, stable point releases, testing version and all developement branches. There are two main usecases for selecting custom:
+
+* Freezing the software at a specific point release - selecting a point release for each of the repositories will freeze the software at that version and no updates will be advertised in the user interface.
+* Testing bleeding edge development - a new feature may be developed in a specific development branch which may need to be selected to allow testing. It is highly recommended to avoid using this option unless you have a clear understanding of why it may be necessary, e.g. instructed to do so by a core developer.
+
+
+After selecting this option, select 'Save' and then 'Software Update' to apply changes.
==Learning Pills==
==Learning Pills==