Changes

Jump to navigation Jump to search

Accessing Zynthian from your computer (view source)

Revision as of 16:14, 29 March 2022

2,143 bytes added ,  16:14, 29 March 2022
→‎CUIA: Callable User Interface Actions
Line 25: Line 25:  
== 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 32: 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]]  
 +
 
 +
<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".
Line 60: Line 62:  
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) 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 ==
+
== Viewing Zynthian UI and 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:
  −
 
  −
  # apt-get install vnc4server blackbox
  −
  # pico ~/.vncrc
  −
 
  −
* enter this line to set the desktop size:
  −
 
  −
    $geometry = “2048x1600”;
  −
 
  −
* start the vnc server:
  −
 
  −
  # vnc4server
     −
* Connect to the vnc server using (e.g.) Windows TightVNC viewer.
+
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:
   −
====RealVNC====
+
* 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)
   −
[[File:VNCReal_Zynthians.png]]
+
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.
    +
The VNC views may be accessed directly via the URLs:
   −
====Turning on the Raspi VNC Server to start up every time====
+
* http://zynthian.local:6080/vnc.html (Main UI)
 +
* http://zynthian.local:6081/vnc.html (Engines desktop)
   −
[[File:Vncreal-setup.png]]
+
or with a VNC client by connecting to ports:
   −
[[File:Realvnc-step2.png]]
+
* 5900 (Main UI)
 +
* 5901 (Engines desktop)software can be launched, like ''qjackctl'' or a virtual MIDI keyboard for testing.
   −
[[File:Realvnc-step3.png]]
+
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: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.
+
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 189: 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
    
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_MAIN
 +
# send_osc 1370 /CUIA/LAYER_CONTROL 2
    
An example Python script to start a MIDI recording:
 
An example Python script to start a MIDI recording:
 
  import liblo
 
  import liblo
−
  liblo.send(('zynthian.local', 1370), "/cuia", ('s', 'START_MIDI_RECORD'))
+
  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 ====
Retrieved from "http://wiki.zynthian.org/index.php/Special:MobileDiff/11684...12167"

Navigation menu