Changes

Jump to navigation Jump to search
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 or directly to your computer (Ethernet to Ethernet). Your Zynthian box uses the link-local name "zynthian.local" and its files can be accessed with '''sftp''' and '''scp''' (If you are using Windows, get '''Winscp''' - free software needed to communicate using this Internet protocol).  
+
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).  
   −
You can also login with '''ssh''' to access the Linux console. see [[Command_Line_User_Guide]] (use '''PuTTY''' software for Windows). The username and password are:
+
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:
    
  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 is disabled and local names are not recognized (i.e. on Windows).
+
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 (i.e. on Windows). Instead, you can use the Zynthian's IP address.  Find out what that is using the "Network Info" utility in the Zynthian's Admin menu. or See: [[Finding your IP address]]
Instead, you can use the Zynthian's IP address.  Find out what that is using the "Network Info" utility in the Zynthian's Admin menu. or See: [[Finding your IP address]]  
      
== Accessing the Web Configuration Tool ==
 
== Accessing the Web Configuration Tool ==
Line 24: Line 23:  
The web config tool will load and prompt for the admin password. It is "raspberry".
 
The web config tool will load and prompt for the admin password. It is "raspberry".
   −
[[File:ZynLogin.png]]
+
[[File:zynthian_webconf_login.png]]
    
Here's details on using the Web configuration tool: [[Configuration_Users_Guide]]
 
Here's details on using the Web configuration tool: [[Configuration_Users_Guide]]
Line 31: Line 30:     
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 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'.
  −
==Audio Configuration==
  −
  −
[[Configuring_Audio_Devices]]
      
== Accessing the MOD-UI web interface ==
 
== Accessing the MOD-UI web interface ==
Line 52: Line 47:  
== Opening Synth Engine Native GUIs in your Computer ==
 
== Opening Synth Engine Native GUIs in your Computer ==
   −
You can attach an HDMI monitor, mouse and keyboard to your Zynthian, run '''startx''' to display the LINUX desktop and access the various synth engines,
+
Some engines have a native GUI that can be accessed from your desktop/laptop computer. There are several methods for achieving this:
 +
 
 +
===X11 Server===
   −
or
+
For using this method, you need an X11 Server running on your desktop/laptop computer.
   −
You can remote login from another computer/laptop. To do this, you need an XServer running on your computer. Linux is best, but i've tested with Mac and Windows too.
+
* 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:
The only thing you have to do is login into your Zynthian Box with '''ssh''' using the "-Y" option to tunnel the X connection (or the equivalent option if you are not using a standard ssh client):
      
   $ ssh -Y root@zynthian.local
 
   $ ssh -Y root@zynthian.local
   −
or use vnc:
+
* 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===
   −
SSH into the zynthian box and enter:
+
You also could use VNC on any platform, although it's slighty complex:
 +
 
 +
* Login into your zynthian box and enter:
    
   # apt-get install vnc4server blackbox
 
   # apt-get install vnc4server blackbox
 
   # pico ~/.vncrc
 
   # pico ~/.vncrc
   −
and enter this line to set the desktop size:
+
* enter this line to set the desktop size:
    
     $geometry = “2048x1600”;
 
     $geometry = “2048x1600”;
   −
start the vnc server:
+
* start the vnc server:
    
   # vnc4server
 
   # vnc4server
   −
Connect to the vnc server using (e.g.) windows TightVNC viewer.
+
* Connect to the vnc server using (e.g.) windows TightVNC viewer.
   −
or use Putty:
+
===Supported Engines with Native GUI===
  −
# Works on Windows and also is available in Linux and makes a handy alternative to command line ssh.
  −
 
  −
 
  −
[[File:Putty-on-zynth.png]]
      +
Currently ''ZynAddSubFX'', ''Aeolus'' and ''Pure Data'' have support for native GUI, that is launched automatically when layer is created. Other GUI software can be launched, like ''qjackctl'' or a virtual MIDI keyboard for testing. Support for Soundfont GUI using ''Polyphone'' will be added in the future ;-)
   −
You should set the X11 Windows options:
+
'''IMPORTANT:''' Using an ethernet-to-ethernet (cable) connection will reduce latency and improve usability.
 
  −
[[File:Putty-on-zynth-X11.png]]
  −
 
  −
 
  −
Good to store settings for different setups.
  −
 
  −
 
  −
 
  −
Currently ZynAddSubFX and Aeolus have support for native GUI's. They  will be launched automatically when a either patch is selected. Other GUI software can be installed to control other synths, also virtual MIDI keyboard software can be used - for testing.
  −
 
  −
 
  −
'''IMPORTANT:''' Try to use an ethernet-to-ethernet connection as it will reduce latency and improve usability.
      
== Copying your presets/soundfonts to Zynthian ==
 
== Copying your presets/soundfonts to Zynthian ==
   −
You can copy your presets/soundfonts/pedalboards in the next forlder:
+
You can copy your presets/soundfonts/pedalboards in the next folder:
    
  /zynthian/zynthian-my-data
 
  /zynthian/zynthian-my-data
Line 130: Line 118:  
'''IMPORTANT:''' after adding or changing something in 'zynthian-data', you can’t update the zynthian-library from the Admin menu. (The "git-based" updating system should be improved...)
 
'''IMPORTANT:''' after adding or changing something in 'zynthian-data', you can’t update the zynthian-library from the Admin menu. (The "git-based" updating system should be improved...)
   −
If you are using an old SD image (prior to Gorgona), the username and password are the default for Raspbian:
+
== OSC ==
 +
 
 +
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 ===
 +
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
 +
/cuia
 +
 
 +
Example:
 +
/cuia/reboot
 +
 
 +
Note: CUIA paths are case insensitive, e.g.
 +
/cuia/reboot
 +
 
 +
is interpreted the same as
 +
/CUIA/REBOOT
   −
  user=pi
+
This is why you should operate secure networks ... :-D
  password=raspberry
+
 
 +
=== 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
 +
/midi
 +
This path accepts an OSC MIDI type message. An example Python script to send MIDI note on / off messages:
 +
import liblo
 +
import time
 +
   
 +
cmdNoteOn = 0x90
 +
cmdNoteOff = 0x80
 +
note = 60
 +
  vel = 100
 +
 +
liblo.send(('zynthian.local', 12101), "/midi", ('m', (vel,note,cmdNoteOn,0)))
 +
time.sleep(1)
 +
liblo.send(('zynthian.local', 12101), "/midi", ('m', (0,note,cmdNoteOff,0)))

Navigation menu