188
edits
Changes
Jump to navigation
Jump to search
mLine 1:
Line 1: + + − + − You can also login with '''ssh''' to access the Linux console. see [[Command_Line_User_Guide]] (use '''PuTTY''' for Windows). The username and default password is:+ − user=root+ − password=raspberry − If the link-local address (zynthian.local or zynthian.lan) is not found, make sure that the link-local feature is enabled in your system. Sometimes it's disabled and link-local names are not recognized (windows). If you can't manage to get link-local names to work, you can use the Zynthian's IP address. The zynthian's IP address can be found int the UI's "Admin->Network Info" menu, and it's also printed on the zynthian's error screen. See: [[Finding your IP address]]+ − + Line 22:
Line 23: − + + + + + + + + + + + + Line 37:
Line 49: − + − − Here are the details on using the Web configuration tool: [[Configuration_Users_Guide]] − == Wifi Configuration ==+ + − Wifi credentials can be set via the web config tool: System - Wifi - Add Network. Wifi must be enabled in the Zynthian Gui: press the Back button until you are in the Admin menu. Then select 'Start WIFI'. − == Accessing the MOD-UI web interface == + + Line 61:
Line 72: − + − + Line 153:
Line 164: − + + + Line 174:
Line 187: − + Line 184:
Line 197: − + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + − ! Action !! Parameters !! Description+ + + + + + + + + + + + + + + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − This list is probably outdated, so you may want to get the updated list directly from the [https://github.com/zynthian/zynthian-ui/blob/5badf64c0c4fa0d6101ff223ff0c00c40cd3a476/zynthian_gui.py#L930 Zynthian UI's source code]+
Changed some heading titles and tried to group them in a way that makes more sense
Zynthian offers additional ways to access the system from your computer using either an ethernet or wifi connection. The ''Zynthian Web Configuration Tool'' is a web interface to view and configure settings e.g. midi devices, preset libraries etc. Graphical user interfaces for synth engines and the pedalboard style LV2 plugin patch ''MOD-UI'' are also accessible from your web browser.
== Network Connection ==
== Network Connection ==
The easiest way to connect your Zynthian is to use the Ethernet RJ45 connector with a CAT-5 cable to connect your unit to your local network (DHCP) or directly to your computer (Ethernet to Ethernet, aka link-local). Your Zynthian box uses the link-local name "zynthian.local" or "zynthian.lan", depending of your system, and the filesystem can be accessed with '''sftp''' and '''scp''' (If you are using Windows, use '''Winscp''' - free software needed to communicate using this Internet protocol).
The easiest way to connect your Zynthian is to use the Ethernet RJ45 connector with a CAT-5 cable to connect your unit to your local network (DHCP) or directly to your computer (Ethernet to Ethernet, aka link-local). Your Zynthian box uses the link-local name "zynthian.local" or "zynthian.lan", depending on your system.
If the link-local address (zynthian.local or zynthian.lan) is not found, make sure that the link-local feature is enabled in your system. Sometimes it's disabled and link-local names are not recognized (windows). If you can't manage to get link-local names to work, you can use the Zynthian's IP address. The zynthian's IP address can be found int the UI's "Admin->Network Info" menu, and it's also printed on the zynthian's error screen. See: [[Finding your IP address]]
=== Wifi Configuration ===
Wifi credentials can be set via the web config tool: System - Wifi - Add Network. Wifi must be enabled in the Zynthian Gui: press the Back button until you are in the Admin menu. Then select 'Start WIFI'.
== Wifi Hotspot ==
=== Wifi Hotspot ===
You can connect to your Zynthian using the built-in Wifi Hotspot mode. This is less convenient than using Ethernet or an existing Wifi network, and is mostly useful to configure connections to other wifi networks.
You can connect to your Zynthian using the built-in Wifi Hotspot mode. This is less convenient than using Ethernet or an existing Wifi network, and is mostly useful to configure connections to other wifi networks.
Note that the wifi network created in hotspot mode allows anyone to connect. If using the wifi hotspot in a public place, ensure you've changed your Zynthian password.
Note that the wifi network created in hotspot mode allows anyone to connect. If using the wifi hotspot in a public place, ensure you've changed your Zynthian password.
== Accessing the Web Configuration Tool ==
== Ways to Access Zynthian From Your Computer ==
=== Connecting via SSH and Accessing the File System ===
The filesystem can be accessed with '''sftp''' and '''scp''' (If you are using Windows, use '''Winscp''' - free software needed to communicate using this Internet protocol).
You can also login with '''ssh''' to access the Linux console. see [[Command_Line_User_Guide]] (use '''PuTTY''' for Windows). The username and default password is:
user=root
password=raspberry
=== Accessing the Web Configuration Tool ===
You can access the web configuration tool using the web browser from your computer:
You can access the web configuration tool using the web browser from your computer:
The web config tool will load and ask for the admin password. The default password is "raspberry".
The web config tool will load and ask for the admin password. The default password is "raspberry".
[[File:zynthian_webconf_login.png]]
[[File:zynthian_webconf_login.png|right|500px]]
Here are the details on using the Web configuration tool: [[Zynthian Web Configuration Tool User Guide]]
<br clear=all>
=== Accessing the MOD-UI web interface ===
[[File:MODUI.png|right|500px|MOD-UI pedal board style interface]]
You can access the MOD-UI web interface using the web browser from your computer:
You can access the MOD-UI web interface using the web browser from your computer:
If the link-local address (zynthian.local or zynthian.lam) is not found, test that the link-local feature is enabled in your system. Sometimes is disabled and local names are not recognized. You can use the zynthian's IP address instead. See: [[Finding your IP address]]
If the link-local address (zynthian.local or zynthian.lam) is not found, test that the link-local feature is enabled in your system. Sometimes is disabled and local names are not recognized. You can use the zynthian's IP address instead. See: [[Finding your IP address]]
== Viewing Zynthian UI and Synth Engine Native GUIs on your Computer ==
=== Viewing Zynthian UI and Synth Engine Native GUIs on your Computer ===
[[File:Synth engines native gui.png|right|500px|Synth engines native GUI]]
Some engines have a native GUI that can be accessed from your desktop/laptop computer. Zynthian provides a VNC viewer for a desktop that allows access to these native GUI. By default VNC is disabled and it is recommended to disable for performance (as it has a small overhead which is best saved for your audio). To enable VNC and access the desktop and engines' native GUI:
Some engines have a native GUI that can be accessed from your desktop/laptop computer. Zynthian provides a VNC viewer for a desktop that allows access to these native GUI. By default VNC is disabled and it is recommended to disable for performance (as it has a small overhead which is best saved for your audio). To enable VNC and access the desktop and engines' native GUI:
{{WarningBox|If you add or change something inside the ''zynthian-data'' folder, your changes will be lost on the next update, or, in a worst case scenario, you could break the update system.}}
{{WarningBox|If you add or change something inside the ''zynthian-data'' folder, your changes will be lost on the next update, or, in a worst case scenario, you could break the update system.}}
== OSC ==
== OSC (Open Sound Control)==
Open Sound Control (OSC) is a protocol for networking sound synthesizers, computers, and other multimedia devices for purposes such as musical performance or show control. Zynthian implements OSC in various ways.
Open Sound Control (OSC) is a protocol for networking sound synthesizers, computers, and other multimedia devices for purposes such as musical performance or show control. Zynthian implements OSC in various ways.
For more information about the protocol see [https://en.wikipedia.org/wiki/Open_Sound_Control Open Sound Control] at Wikipedia and [https://youtu.be/rf8YNPjVvF4 this explanatory video].
==== CUIA: Callable User Interface Actions ====
==== CUIA: Callable User Interface Actions ====
Some examples using the command line tool "send_osc":
Some examples using the command line tool "send_osc":
# send_osc 1370 /CUIA/SCREEN_MAIN
# send_osc 1370 /CUIA/SCREEN_MENU
# send_osc 1370 /CUIA/LAYER_CONTROL 2
# send_osc 1370 /CUIA/LAYER_CONTROL 2
{| class="wikitable"
{| class="wikitable"
|+ CUIA list
|+
|-
! CUIA Name !! Parameters !! Description
|-
| ACTION_MIDI_UNLEARN || ||
|-
| ALL_NOTES_OFF || ||
|-
| ALL_SOUNDS_OFF || ||
|-
| ARROW_DOWN || ||
|-
| ARROW_LEFT || ||
|-
| ARROW_NEXT || ||
|-
| ARROW_PREV || ||
|-
| ARROW_RIGHT || ||
|-
| ARROW_UP || ||
|-
| AUDIO_FILE_LIST || ||
|-
| BACK || ||
|-
| BANK_PRESET || ||
|-
| CHAIN_CONTROL || %i || Set active layer to %i and show control screen. Defaults to current chain.
|-
| CHAIN_OPTIONS || %i || Show options for chain %i. Defaults to current chain.
|-
| CLEAN_ALL || ||
|-
| ENTER_MIDI_LEARN || ||
|-
| EXIT_MIDI_LEARN || ||
|-
| EXIT_UI || ||
|-
| HIDE_BUTTONBAR || ||
|-
| HIDE_SIDEBAR || ||
|-
| HIDE_TOPBAR || ||
|-
| LAST_STATE_ACTION || ||
|-
| LAYER_CONTROL || %i || Alias of CHAIN_CONTROL. DEPRECATED!!
|-
| LAYER_OPTIONS || %i || Alias of CHAIN_OPTIONS. DEPRECATED!!
|-
| MENU || ||
|-
| MIDI_LEARN_CONTROL || %i || Learn control knob %i
|-
| MIDI_LEARN_CONTROL_OPTIONS || % || Learn control options for knob %i
|-
| MIDI_UNLEARN_CHAIN || ||
|-
| MIDI_UNLEARN_CONTROL || %i || Unlearn control knob %i
|-
|-
| MIDI_UNLEARN_MIXER || ||
|-
| MIDI_UNLEARN_NODE || ||
|-
|-
| POWER_OFF || ||
| POWER_OFF || ||
|-
| PRESET || ||
|-
| PRESET_FAV || ||
|-
| PROGRAM_CHANGE || ||
|-
|-
| REBOOT || ||
| REBOOT || ||
|-
| RELOAD_KEY_BINDING || ||
|-
| RELOAD_MIDI_CONFIG || ||
|-
| RELOAD_WIRING_LAYOUT || ||
|-
|-
| RESTART_UI || ||
| RESTART_UI || ||
|-
|-
| RELOAD_MIDI_CONFIG || ||
| SCREEN_ADMIN || ||
|-
|-
| RELOAD_KEY_BINDING || ||
| SCREEN_ALSA_MIXER || ||
|-
|-
| LAST_STATE_ACTION || ||
| SCREEN_ARRANGER || ||
|-
|-
| ALL_NOTES_OFF || ||
| SCREEN_AUDIO_MIXER || ||
|-
|-
| ALL_SOUNDS_OFF || ||
| SCREEN_BANK || ||
|-
|-
| ALL_OFF || ||
| SCREEN_CALIBRATE || ||
|-
|-
| TOGGLE_AUDIO_RECORD || ||
| SCREEN_CONTROL || ||
|-
|-
| START_AUDIO_RECORD || ||
| SCREEN_MAIN_MENU || ||
|-
|-
| STOP_AUDIO_RECORD || ||
| SCREEN_MIDI_RECORDER || ||
|-
|-
| TOGGLE_AUDIO_PLAY || ||
| SCREEN_PATTERN_EDITOR || ||
|-
|-
| START_AUDIO_PLAY || ||
| SCREEN_PRESET || ||
|-
|-
| STOP_AUDIO_PLAY || ||
| SCREEN_SNAPSHOT || ||
|-
|-
| TOGGLE_MIDI_RECORD || ||
| SCREEN_ZS3 || ||
|-
|-
| START_MIDI_RECORD || ||
| SCREEN_ZYNPAD || ||
|-
|-
| STOP_MIDI_RECORD || ||
| SELECT || %i || Highlight element %i in the list
|-
|-
| TOGGLE_MIDI_PLAY || ||
| SET_TEMPO || %t || Set tempo BPM
|-
|-
| START_MIDI_PLAY || ||
| SHOW_BUTTONBAR || ||
|-
|-
| STOP_MIDI_PLAY || ||
| SHOW_SCREEN || ||
|-
|-
| SELECT || %i || Highlight an element in the list
| SHOW_SIDEBAR || ||
|-
|-
| SELECT_UP || ||
| SHOW_TOPBAR || ||
|-
|-
| SELECT_DOWN || ||
| START_AUDIO_PLAY || ||
|-
|-
| BACK_UP || ||
| START_AUDIO_RECORD || ||
|-
|-
| BACK_DOWN || ||
| START_MIDI_PLAY || ||
|-
|-
| LAYER_UP || ||
| START_MIDI_RECORD || ||
|-
|-
| LAYER_DOWN || ||
| STOP || ||
|-
|-
| SNAPSHOT_UP || ||
| STOP_AUDIO_PLAY || ||
|-
|-
| SNAPSHOT_DOWN || ||
| STOP_AUDIO_RECORD || ||
|-
|-
| SWITCH_BACK_SHORT || ||
| STOP_MIDI_PLAY || ||
|-
|-
| SWITCH_BACK_BOLD || ||
| STOP_MIDI_RECORD || ||
|-
|-
| SWITCH_BACK_LONG || ||
| TAP_TEMPO || ||
|-
|-
| SWITCH_SELECT_SHORT || ||
| TEMPO || ||
|-
|-
| SWITCH_SELECT_BOLD || ||
| TEMPO_DOWN || ||
|-
|-
| SWITCH_SELECT_LONG || ||
| TEMPO_UP || ||
|-
|-
| SWITCH_LAYER_SHORT || ||
| TEST_MODE || ||
|-
|-
| SWITCH_LAYER_BOLD || ||
| TOGGLE_ALT_MODE || ||
|-
|-
| SWITCH_LAYER_LONG || ||
| TOGGLE_AUDIO_PLAY || ||
|-
|-
| SWITCH_SNAPSHOT_SHORT || ||
| TOGGLE_AUDIO_RECORD || ||
|-
|-
| SWITCH_SNAPSHOT_BOLD || ||
| TOGGLE_MIDI_LEARN || ||
|-
|-
| SWITCH_SNAPSHOT_LONG || ||
| TOGGLE_MIDI_PLAY || ||
|-
|-
| SCREEN_MAIN || ||
| TOGGLE_MIDI_RECORD || ||
|-
|-
| SCREEN_LAYER || ||
| TOGGLE_PLAY || ||
|-
|-
| SCREEN_BANK || ||
| TOGGLE_RECORD || ||
|-
|-
| SCREEN_PRESET || ||
| TOGGLE_SCREEN || ||
|-
|-
| SCREEN_CONTROL || ||
| V5_ZYNPOT_SWITCH || %i, %t || Simulates V5 rotary-switch %i action of type %t (Push ,Short, Bold, Long)
|-
|-
| MODAL_SNAPSHOT || ||
| Z2_ZYNPOT_TOUCH || %i, %s || Simulates Z2 capacitive touch-switch %i
|-
|-
| MODAL_AUDIO_RECORDER || ||
| ZYNAPTIK_CVIN_SET_NOTE0 || %n || Set base note for CV/Gate input
|-
|-
| MODAL_MIDI_RECORDER || ||
| ZYNAPTIK_CVIN_SET_VOLTS_OCTAVE || %f || Set scale for CV/Gate input
|-
|-
| MODAL_ALSA_MIXER || ||
| ZYNAPTIK_CVOUT_SET_NOTE0 || %n || Set base note for CV/Gate output
|-
|-
| MODAL_STEPSEQ || ||
| ZYNAPTIK_CVOUT_SET_VOLTS_OCTAVE || %f || Set scale for CV/Gate output
|-
|-
| MODAL_ADMIN || ||
| ZYNPOT || %i, %s || Simulates rotary %i tick of size %s
|-
|-
| LAYER_CONTROL || %i || Set active layer to %i and show control screen
| ZYNSWITCH || %i, %t || Simulates button %i action of type %t (Push, Short, Bold, Long)
|}
|}
You can see the details in the [https://github.com/zynthian/zynthian-ui/blob/3ce8a5e0f22d4007a5460f61869678b5c78d6f69/zyngui/zynthian_gui.py#L1132 Zynthian UI's source code].
==== TouchOSC ====
==== TouchOSC ====