Changes

Jump to navigation Jump to search
Line 62: 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:
+
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:
   −
====X11 Server====
+
* 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)
   −
To use this method, you need an X11 Server running on your desktop/laptop computer.
+
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.
   −
* 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:
+
The VNC views may be accessed directly via the URLs:
   −
  $ ssh -Y root@zynthian.local
+
* http://zynthian.local:6080/vnc.html (Main UI)
 +
* http://zynthian.local:6081/vnc.html (Engines desktop)
   −
* If you are a Mac user, you should install and enable the '''XQuartz''' package. After that, login into your zynthian with the same command.
+
or with a VNC client by connecting to ports:
   −
* 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.  
+
* 5900 (Main UI)
 +
* 5901 (Engines desktop)software can be launched, like ''qjackctl'' or a virtual MIDI keyboard for testing.
   −
[[File:Putty-on-zynth-X11.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
 
  −
====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.
  −
 
  −
====RealVNC====
  −
 
  −
[[File:VNCReal_Zynthians.png]]
  −
 
  −
 
  −
====Turning on the Raspi VNC Server to start up every time====
  −
 
  −
Log onto the Pi.... and from it's own console
  −
 
  −
to turn on the VNCServer log onto the pi (see instructions elsewhere...)
  −
 
  −
using the webconf terminal, or ssh , or your own personal favourite. .  .
  −
 
  −
 
  −
[[File:Raspi-config-running-in-terminal.png]]
  −
 
  −
and type raspi-config and then press Enter. . .
  −
 
  −
[[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.
+
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 203: Line 159:     
==== CUIA: Callable User Interface Actions ====
 
==== CUIA: Callable User Interface Actions ====
The CUIA is a unidirectional remote API that can be used for sending simple control messages to zynthian. 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 chapter explains how to access the CUIA using OSC on port UDP 1370.  
+
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
+
The OSC base path for CUIA messages is:
    
  /cuia
 
  /cuia
Line 218: Line 174:  
  /CUIA/REBOOT
 
  /CUIA/REBOOT
   −
Some examples using the command line tool "osc_send":
+
Some examples using the command line tool "send_osc":
 
  # send_osc 1370 /CUIA/SCREEN_MAIN
 
  # send_osc 1370 /CUIA/SCREEN_MAIN
 
  # send_osc 1370 /CUIA/LAYER_CONTROL 2
 
  # send_osc 1370 /CUIA/LAYER_CONTROL 2
Line 226: Line 182:  
  liblo.send(('zynthian.local', 1370), "/CUIA", ('s', 'START_MIDI_RECORD'))
 
  liblo.send(('zynthian.local', 1370), "/CUIA", ('s', 'START_MIDI_RECORD'))
   −
And this is the full list of CUIAs:
+
And finally, the full list of CUIAs:
    
{| class="wikitable"
 
{| class="wikitable"
Line 341: Line 297:  
| LAYER_CONTROL || %i || Set active layer to %i and show control screen
 
| 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 ====

Navigation menu