Changes

Jump to navigation Jump to search

Accessing Zynthian from your computer (view source)

Revision as of 20:39, 17 September 2023

4,829 bytes added ,  20:39, 17 September 2023
no edit summary
Line 1: Line 1:  +
Using either ethernet or wifi connection, Zynthian offers additional ways to access the system from your computer. 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" 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]]
 +
 
 +
==== 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:
 
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:
Line 8: Line 16:  
  password=raspberry
 
  password=raspberry
   −
If the link-local address (zynthian.local) 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 Hotspot ==
 
== Wifi Hotspot ==
Line 15: Line 23:     
# Open the Admin screen on your Zynthian.
 
# Open the Admin screen on your Zynthian.
−
# Select the "Wifi Hotspot" option.
+
# Select the "Wifi Hotspot" option. This could take up to 30 seconds to complete.
−
#* This will take up to thirty seconds to complete.
   
# Connect to the "zynthian" network with another device.
 
# Connect to the "zynthian" network with another device.
 
# In the Admin screen on your Zynthian, select "Network Info".
 
# In the Admin screen on your Zynthian, select "Network Info".
Line 25: Line 32:  
== Accessing the Web Configuration Tool ==
 
== Accessing the Web Configuration Tool ==
   −
You can access web configuration tool using the web browser from your computer:
+
You can access the web configuration tool using the web browser from your computer:
    
# Connect your Zynthian to your local network using the ethernet connector (RJ45) or directly to your computer (Ethernet to Ethernet)
 
# Connect your Zynthian to your local network using the ethernet connector (RJ45) or directly to your computer (Ethernet to Ethernet)
 
# Open the browser in your computer and type in the address bar:
 
# Open the browser in your computer and type in the address bar:
   −
  http://zynthian.local   (or the IP address of your Zynthian)
+
  [http://zynthian.local http://zynthian.local] or [http://zynthian.lan http://zynthian.lan]  (or the IP address of your Zynthian)
   −
{{NoteBox|If zynthian.local does not work, see [[Finding your IP address]]}}
+
{{NoteBox|If zynthian.local does not work, see [[Finding your IP address]]  
 +
 
 +
<br>''If you can't access WebConf with your browser, there is a command-line option. See [[Command_Line_User_Guide#Configuration_without_WebConf]]''}}
    
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: [[Configuration_Users_Guide]]
+
Here are the details on using the Web configuration tool: [[Zynthian Web Configuration Tool User Guide]]
 +
<br clear=all>
    
== Wifi Configuration ==
 
== Wifi Configuration ==
Line 45: Line 55:     
== Accessing the MOD-UI web interface ==
 
== 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:
   Line 52: Line 62:  
* Open the browser in your computer and navigate to:
 
* Open the browser in your computer and navigate to:
   −
  zynthian.local:8888
+
[http://zynthian.local:8888 http://zynthian.local:8888] or [http://zynthian.lan:8888 http://zynthian.lan:8888]
    
The MOD-UI webpage should appear.
 
The MOD-UI webpage should appear.
Line 58: Line 68:  
When a MOD-UI layer exist, this link is also accessible from the webconf's software menu (reload webconf after creating the layer).
 
When a MOD-UI layer exist, this link is also accessible from the webconf's software menu (reload webconf after creating the layer).
   −
If the link-local address (zynthian.local) 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]]
−
 
  −
== Opening Synth Engine Native GUIs on your Computer ==
  −
 
  −
Some engines have a native GUI that can be accessed from your desktop/laptop computer. There are several methods for achieving this:
  −
 
  −
====X11 Server====
  −
 
  −
To use this method, you need an X11 Server running on your desktop/laptop computer.
  −
 
  −
* If you use Linux, you probably already have it, so you don't need to do anything special. Simply login into your zynthian using the ssh with the "-Y" option for forwarding the X session:
  −
 
  −
  $ ssh -Y root@zynthian.local
  −
 
  −
* If you are a Mac user, you should install and enable the '''XQuartz''' package. After that, login into your zynthian with the same command.
  −
 
  −
* If you are a Windows user, then you should install the '''XMing''' package and login into your zynthian using Putty with the "X11 forwarding" option enabled.
  −
 
  −
[[File:Putty-on-zynth-X11.png]]
  −
 
  −
====VNC====
  −
 
  −
You could also use VNC, although it's a bit complex:
     −
* Login into your zynthian box and enter:
+
== 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:
   −
  # apt-get install vnc4server blackbox
+
* Connect via web browser to webconf
−
  # pico ~/.vncrc
+
* Navigate to INTERFACE->UI Options
 +
* Assert Enable VNC Server option and press Save
 +
* Reload webconf and navigate to INTERFACE->UI-Engines
 +
* Enter the Zynthian password (default: raspberry)
   −
* enter this line to set the desktop size:
+
Note: There is also an option to access the Zynthian main UI by navigating to INTERFACE-VNC UI. This is a mirror of the main UI and may be driven from VNC and/or the physical interface.
   −
    $geometry = “2048x1600”;
+
The VNC views may be accessed directly via the URLs:
   −
* start the vnc server:
+
* http://zynthian.local:6080/vnc.html (Main UI)
 +
* http://zynthian.local:6081/vnc.html (Engines desktop)
   −
  # vnc4server
+
or with a VNC client by connecting to ports:
   −
* Connect to the vnc server using (e.g.) Windows TightVNC viewer.
+
* 5900 (Main UI)
 +
* 5901 (Engines desktop)software can be launched, like ''qjackctl'' or a virtual MIDI keyboard for testing.
   −
====RealVNC====
+
Tip: You can automatically connnect and login to web-based VNC by appending parameters to the URL, e.g. http://zynthian.local:6080/vnc.html?autoconnect=true&password=raspberry
−
 
  −
[[File:VNCReal_Zynthians.png]]
  −
 
  −
[[File:Vncreal-setup.png]]
  −
 
  −
[[File:Realvnc-step2.png]]
  −
 
  −
[[File:Realvnc-step3.png]]
  −
 
  −
[[File:Realvnc-step4.png]]
  −
 
  −
[[File:Realvnc-step5.png]]
  −
 
  −
[[File:Realvnc-help.png]]
      
====Supported Engines with Native GUI====
 
====Supported Engines with Native GUI====
   −
Currently ''ZynAddSubFX'', ''Aeolus'', ''Pianoteq'' and ''Pure Data'' have support for remotely displaying their native GUIs, which is launched automatically when layer is created. Other GUI software can be launched, like ''qjackctl'' or a virtual MIDI keyboard for testing.
+
Many LV2 plugins (NoizeMaker, OBX-d, Surge, DragonFly Reverbs, ...) and some of the standalone engines (ZynAddSubFX, Aeolus, Pianoteq and PureData) have support for remotely displaying their native GUIs. If VNC is enabled, the engine's GUI will be launched automatically when added to a chain.  
−
 
   
{{NoteBox|Using an ethernet-to-ethernet (cable) connection will reduce remote GUI latency and improve usability.}}
 
{{NoteBox|Using an ethernet-to-ethernet (cable) connection will reduce remote GUI latency and improve usability.}}
   −
== Uploading your presets/soundfonts to Zynthian ==
+
== Uploading your presets & soundfonts to Zynthian ==
    
The easiest way of getting your presets & soundfonts inside your zynthian is by using the webconf's preset manager:
 
The easiest way of getting your presets & soundfonts inside your zynthian is by using the webconf's preset manager:
Line 186: Line 166:  
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.
   −
==== CUIA ====
+
==== CUIA: Callable User Interface Actions ====
−
The CUIA features described in the [[Zynthian_UI_Users_Guide#CUIA:_Callable_UI_Actions|user's guide]] can be accessed using OSC on port UDP 1370. The OSC base path for CUIA messages is
+
The CUIA is an unidirectional remote API that can be used to send simple control messages to zynthian UI. The CUIA can be accessed in several ways, as described in the [[Zynthian_UI_Users_Guide#CUIA:_Callable_UI_Actions|user's guide]] and this section explains how to access the CUIA using OSC on port UDP 1370.  
 +
 
 +
The OSC base path for CUIA messages is:
 +
 
 
  /cuia
 
  /cuia
    
Example:
 
Example:
−
  /cuia/reboot
+
  /cuia/restart_ui
   −
Note: CUIA paths are case insensitive, e.g.
+
Note that CUIA paths are case insensitive, e.g.
 
  /cuia/reboot
 
  /cuia/reboot
    
is interpreted the same as
 
is interpreted the same as
 
  /CUIA/REBOOT
 
  /CUIA/REBOOT
 +
 +
Some examples using the command line tool "send_osc":
 +
# send_osc 1370 /CUIA/SCREEN_MENU
 +
# send_osc 1370 /CUIA/LAYER_CONTROL 2
 +
 +
An example Python script to start a MIDI recording:
 +
import liblo
 +
liblo.send(('zynthian.local', 1370), "/CUIA", ('s', 'START_MIDI_RECORD'))
 +
 +
And finally, the full list of CUIAs:
 +
 +
{| class="wikitable"
 +
|+
 +
|-
 +
! 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 || ||
 +
|-
 +
| PRESET || ||
 +
|-
 +
| PRESET_FAV || ||
 +
|-
 +
| PROGRAM_CHANGE || ||
 +
|-
 +
| REBOOT || ||
 +
|-
 +
| RELOAD_KEY_BINDING || ||
 +
|-
 +
| RELOAD_MIDI_CONFIG || ||
 +
|-
 +
| RELOAD_WIRING_LAYOUT || ||
 +
|-
 +
| RESTART_UI || ||
 +
|-
 +
| SCREEN_ADMIN || ||
 +
|-
 +
| SCREEN_ALSA_MIXER || ||
 +
|-
 +
| SCREEN_ARRANGER || ||
 +
|-
 +
| SCREEN_AUDIO_MIXER || ||
 +
|-
 +
| SCREEN_BANK || ||
 +
|-
 +
| SCREEN_CALIBRATE || ||
 +
|-
 +
| SCREEN_CONTROL || ||
 +
|-
 +
| SCREEN_MAIN_MENU || ||
 +
|-
 +
| SCREEN_MIDI_RECORDER || ||
 +
|-
 +
| SCREEN_PATTERN_EDITOR || ||
 +
|-
 +
| SCREEN_PRESET || ||
 +
|-
 +
| SCREEN_SNAPSHOT || ||
 +
|-
 +
| SCREEN_ZS3 || ||
 +
|-
 +
| SCREEN_ZYNPAD || ||
 +
|-
 +
| SELECT || %i || Highlight element %i in the list
 +
|-
 +
| SET_TEMPO || %t || Set tempo BPM
 +
|-
 +
| SHOW_BUTTONBAR || ||
 +
|-
 +
| SHOW_SCREEN || ||
 +
|-
 +
| SHOW_SIDEBAR || ||
 +
|-
 +
| SHOW_TOPBAR || ||
 +
|-
 +
| START_AUDIO_PLAY || ||
 +
|-
 +
| START_AUDIO_RECORD || ||
 +
|-
 +
| START_MIDI_PLAY || ||
 +
|-
 +
| START_MIDI_RECORD || ||
 +
|-
 +
| STOP || ||
 +
|-
 +
| STOP_AUDIO_PLAY || ||
 +
|-
 +
| STOP_AUDIO_RECORD || ||
 +
|-
 +
| STOP_MIDI_PLAY || ||
 +
|-
 +
| STOP_MIDI_RECORD || ||
 +
|-
 +
| TAP_TEMPO || ||
 +
|-
 +
| TEMPO || ||
 +
|-
 +
| TEMPO_DOWN || ||
 +
|-
 +
| TEMPO_UP || ||
 +
|-
 +
| TEST_MODE || ||
 +
|-
 +
| TOGGLE_ALT_MODE || ||
 +
|-
 +
| TOGGLE_AUDIO_PLAY || ||
 +
|-
 +
| TOGGLE_AUDIO_RECORD || ||
 +
|-
 +
| TOGGLE_MIDI_LEARN || ||
 +
|-
 +
| TOGGLE_MIDI_PLAY || ||
 +
|-
 +
| TOGGLE_MIDI_RECORD || ||
 +
|-
 +
| TOGGLE_PLAY || ||
 +
|-
 +
| TOGGLE_RECORD || ||
 +
|-
 +
| TOGGLE_SCREEN || ||
 +
|-
 +
| V5_ZYNPOT_SWITCH || %i, %t || Simulates V5 rotary-switch %i action of type %t (Push ,Short, Bold, Long)
 +
|-
 +
| Z2_ZYNPOT_TOUCH || %i, %s || Simulates Z2 capacitive touch-switch %i
 +
|-
 +
| ZYNAPTIK_CVIN_SET_NOTE0 || %n || Set base note for CV/Gate input
 +
|-
 +
| ZYNAPTIK_CVIN_SET_VOLTS_OCTAVE || %f || Set scale for CV/Gate input
 +
|-
 +
| ZYNAPTIK_CVOUT_SET_NOTE0 || %n || Set base note for CV/Gate output
 +
|-
 +
| ZYNAPTIK_CVOUT_SET_VOLTS_OCTAVE || %f || Set scale for CV/Gate output
 +
|-
 +
| ZYNPOT || %i, %s || Simulates rotary %i tick of size %s
 +
|-
 +
| 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 ====
Retrieved from "http://wiki.zynthian.org/index.php/Special:MobileDiff/11321...12952"

Navigation menu