Changes

Jump to navigation Jump to search

Accessing Zynthian from your computer (view source)

Revision as of 16:14, 29 March 2022

3,236 bytes added ,  16:14, 29 March 2022
→‎CUIA: Callable User Interface Actions
Line 1: Line 1:  
== Network Connection ==
 
== Network Connection ==
   −
The easier way of connecting 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 its 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" 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).  
   −
You can also login with '''ssh''' to access the Linux console. see [[Command_Line_User_Guide]] (use '''PuTTY''' software for Windows). The username and default password are:
+
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
 
  user=root
 
  password=raspberry
 
  password=raspberry
   −
If the link-local address (zynthian.local) is not found, test 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]]
+
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 ==
 +
 
 +
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.
 +
 
 +
# Open the Admin screen on your Zynthian.
 +
# Select the "Wifi Hotspot" option.
 +
#* This will take up to thirty seconds to complete.
 +
# Connect to the "zynthian" network with another device.
 +
# In the Admin screen on your Zynthian, select "Network Info".
 +
# Connect to the displayed IP address with the browser on your other device.
 +
 
 +
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 ==
 
== 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)
Line 19: Line 32:  
  http://zynthian.local  (or the IP address of your Zynthian)
 
  http://zynthian.local  (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]]  
   −
The web config tool will load and prompt for the admin password. It is "raspberry".
+
<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".
    
[[File:zynthian_webconf_login.png]]
 
[[File:zynthian_webconf_login.png]]
   −
Here's details on using the Web configuration tool: [[Configuration_Users_Guide]]
+
Here are the details on using the Web configuration tool: [[Configuration_Users_Guide]]
    
== Wifi Configuration ==
 
== Wifi Configuration ==
Line 35: Line 50:  
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:
   −
* Create a Special Layer with "MOD-UI" engine from the Zynthian's UI
+
* Create a Special Layer with a "MOD-UI" engine from the Zynthian's UI
 
* 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 camputer and navigate to:
+
* Open the browser in your computer and navigate to:
    
  zynthian.local:8888
 
  zynthian.local:8888
   −
The MOD-UI webpage should appear. Enjoy! ;-)
+
The MOD-UI webpage should appear.
−
 
  −
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. Instead, you can use the zynthian's IP address. See: [[Finding your IP address]]
  −
 
  −
== Opening Synth Engine Native GUIs in 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====
  −
 
  −
For using this method, you need an X11 Server running on your desktop/laptop computer.
  −
 
  −
* If you use Linux, probably you already have it, so you don't need to do nothing 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.  
+
When a MOD-UI layer exist, this link is also accessible from the webconf's software menu (reload webconf after creating the layer).
   −
[[File:Putty-on-zynth-X11.png]]
+
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]]
   −
====VNC====
+
== Viewing Zynthian UI and Synth Engine Native GUIs on your Computer ==
   −
You also could use VNC on any platform, although it's slighty complex:
+
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:
   −
* Login into your zynthian box and enter:
+
* Connect via web browser to webconf
 +
* 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)
   −
  # apt-get install vnc4server blackbox
+
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.
−
  # pico ~/.vncrc
     −
* enter this line to set the desktop size:
+
The VNC views may be accessed directly via the URLs:
   −
    $geometry = “2048x1600”;
+
* http://zynthian.local:6080/vnc.html (Main UI)
 +
* http://zynthian.local:6081/vnc.html (Engines desktop)
   −
* start the vnc server:
+
or with a VNC client by connecting to ports:
   −
  # vnc4server
+
* 5900 (Main UI)
 +
* 5901 (Engines desktop)software can be launched, like ''qjackctl'' or a virtual MIDI keyboard for testing.
   −
* Connect to the vnc server using (e.g.) windows TightVNC viewer.
+
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
    
====Supported Engines with Native GUI====
 
====Supported Engines with Native GUI====
   −
Currently ''ZynAddSubFX'', ''Aeolus'', ''Pianoteq'' and ''Pure Data'' have support for displaying remotely their native GUIs, that is launched automatically when layer is created. Other GUI software can be launched, like ''qjackctl'' or a virtual MIDI keyboard for testing.
+
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  
−
 
   
{{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.}}
   Line 96: Line 97:  
   http://zynthian.local/lib-presets
 
   http://zynthian.local/lib-presets
   −
From there you manage your preset & soundfont libraries: renaming, deleting and uploading, including automatic convertion from some native formats:
+
From there you manage your preset & soundfont libraries: renaming, deleting, and uploading, including automatic conversion from some native formats:
    
* DX7 SysEX files
 
* DX7 SysEX files
Line 103: Line 104:  
* padthv1 native format
 
* padthv1 native format
   −
If it's not working for you or you prefer to do it by hand, you can copy your presets/soundfonts/pedalboards into the next folder:
+
If if this doesn't work for you, or you prefer to do it by hand, you can copy your presets/soundfonts/pedalboards into the next folder:
    
  /zynthian/zynthian-my-data
 
  /zynthian/zynthian-my-data
Line 143: Line 144:  
  /zynthian/zynthian-data
 
  /zynthian/zynthian-data
   −
Here you will find the same folder structure, and could help you to udnerstand.
+
Here you will find the same folder structure, and could help you to understand.
    
Also it's interesting:
 
Also it's interesting:
Line 157: Line 158:  
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
   Line 170: Line 174:  
  /CUIA/REBOOT
 
  /CUIA/REBOOT
   −
This is why you should operate secure networks ... :-D
+
Some examples using the command line tool "send_osc":
 +
# send_osc 1370 /CUIA/SCREEN_MAIN
 +
# 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 list
 +
|-
 +
! Action !! Parameters !! Description
 +
|-
 +
| POWER_OFF || ||
 +
|-
 +
| REBOOT || ||
 +
|-
 +
| RESTART_UI || ||
 +
|-
 +
| RELOAD_MIDI_CONFIG || ||
 +
|-
 +
| RELOAD_KEY_BINDING || ||
 +
|-
 +
| LAST_STATE_ACTION || ||
 +
|-
 +
| ALL_NOTES_OFF || ||
 +
|-
 +
| ALL_SOUNDS_OFF || ||
 +
|-
 +
| ALL_OFF || ||
 +
|-
 +
| TOGGLE_AUDIO_RECORD || ||
 +
|-
 +
| START_AUDIO_RECORD || ||
 +
|-
 +
| STOP_AUDIO_RECORD || ||
 +
|-
 +
| TOGGLE_AUDIO_PLAY || ||
 +
|-
 +
| START_AUDIO_PLAY || ||
 +
|-
 +
| STOP_AUDIO_PLAY || ||
 +
|-
 +
| TOGGLE_MIDI_RECORD || ||
 +
|-
 +
| START_MIDI_RECORD || ||
 +
|-
 +
| STOP_MIDI_RECORD || ||
 +
|-
 +
| TOGGLE_MIDI_PLAY || ||
 +
|-
 +
| START_MIDI_PLAY || ||
 +
|-
 +
| STOP_MIDI_PLAY || ||
 +
|-
 +
| SELECT || %i || Highlight an element in the list
 +
|-
 +
| SELECT_UP || ||
 +
|-
 +
| SELECT_DOWN || ||
 +
|-
 +
| BACK_UP || ||
 +
|-
 +
| BACK_DOWN || ||
 +
|-
 +
| LAYER_UP || ||
 +
|-
 +
| LAYER_DOWN || ||
 +
|-
 +
| SNAPSHOT_UP || ||
 +
|-
 +
| SNAPSHOT_DOWN || ||
 +
|-
 +
| SWITCH_BACK_SHORT || ||
 +
|-
 +
| SWITCH_BACK_BOLD || ||
 +
|-
 +
| SWITCH_BACK_LONG || ||
 +
|-
 +
| SWITCH_SELECT_SHORT || ||
 +
|-
 +
| SWITCH_SELECT_BOLD || ||
 +
|-
 +
| SWITCH_SELECT_LONG || ||
 +
|-
 +
| SWITCH_LAYER_SHORT || ||
 +
|-
 +
| SWITCH_LAYER_BOLD || ||
 +
|-
 +
| SWITCH_LAYER_LONG || ||
 +
|-
 +
| SWITCH_SNAPSHOT_SHORT || ||
 +
|-
 +
| SWITCH_SNAPSHOT_BOLD || ||
 +
|-
 +
| SWITCH_SNAPSHOT_LONG || ||
 +
|-
 +
| SCREEN_MAIN || ||
 +
|-
 +
| SCREEN_LAYER || ||
 +
|-
 +
| SCREEN_BANK || ||
 +
|-
 +
| SCREEN_PRESET || ||
 +
|-
 +
| SCREEN_CONTROL || ||
 +
|-
 +
| MODAL_SNAPSHOT || ||
 +
|-
 +
| MODAL_AUDIO_RECORDER || ||
 +
|-
 +
| MODAL_MIDI_RECORDER || ||
 +
|-
 +
| MODAL_ALSA_MIXER || ||
 +
|-
 +
| MODAL_STEPSEQ || ||
 +
|-
 +
| MODAL_ADMIN || ||
 +
|-
 +
| LAYER_CONTROL || %i || Set active layer to %i and show control screen
 +
|}
 +
 
 +
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]
   −
=== TouchOSC ===
+
==== TouchOSC ====
−
TouchOSC protocol is supported if the option is enabled on the Zynthian admin menu. This accepts OSC on port 12101 using UDP datagrams and includes raw MIDI data interpretation on OSC path
+
The TouchOSC protocol is supported if the option is enabled in the Zynthian admin menu. This accepts OSC on port 12101 using UDP datagrams and includes raw MIDI data interpretation on OSC path
 
  /midi
 
  /midi
 
This path accepts an OSC MIDI type message. An example Python script to send MIDI note on / off messages:
 
This path accepts an OSC MIDI type message. An example Python script to send MIDI note on / off messages:
Retrieved from "http://wiki.zynthian.org/index.php/Special:MobileDiff/10623...12167"

Navigation menu