Difference between revisions of "Accessing Zynthian from your computer"

From ZynthianWiki
Jump to: navigation, search
(CUIA Callable UI Actions)
(Using wifi hotspot mode)
 
(23 intermediate revisions by 4 users not shown)
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 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]]
+
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 ==
Line 17: Line 30:
 
# Open the browser in your computer and type in the address bar:
 
# Open the browser in your computer and type in the address bar:
  
  zynthian.local  (or the IP address of your Zynthian)
+
  http://zynthian.local  (or the IP address of your Zynthian)
  
(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".
+
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 ==
  
 
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 ==
  
If you have a recent zynthian image with MOD integration (Gorgona or later), 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:
  
# Connect your Zynthian to your local network using the ethernet connector (RJ45) or directly to your computer (ethernet to ethernet)
+
* Create a Special Layer with a "MOD-UI" engine from the Zynthian's UI
# Open the browser in your camputer and type in the address bar:
+
* 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 navigate to:
  
 
  zynthian.local:8888
 
  zynthian.local:8888
  
The MOD-UI webpage should appear. Enjoy! ;-)
+
The MOD-UI webpage should appear.
  
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.
+
When a MOD-UI layer exist, this link is also accessible from the webconf's software menu (reload webconf after creating the layer).
Instead, you can use the zynthian's IPaddress.  Find out what that is using the "Network Info" utility in the Zynthian's Admin menu.
+
  
== Opening Synth Engine Native GUIs in your Computer ==
+
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 ==
  
 
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. There are several methods for achieving this:
  
===X11 Server===
+
====X11 Server====
  
For using this method, you need an X11 Server running on your desktop/laptop computer.
+
To use 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:
+
* 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
 
   $ 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 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.  
+
* 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]]
 
[[File:Putty-on-zynth-X11.png]]
  
===VNC===
+
====VNC====
  
You also could use VNC on any platform, although it's slighty complex:
+
You could also use VNC, although it's a bit complex:
  
 
* Login into your zynthian box and enter:
 
* Login into your zynthian box and enter:
Line 84: Line 95:
 
   # vnc4server
 
   # vnc4server
  
* Connect to the vnc server using (e.g.) windows TightVNC viewer.
+
* Connect to the vnc server using (e.g.) Windows TightVNC viewer.
  
===Supported Engines with Native GUI===
+
====RealVNC====
  
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 ;-)
+
[[File:VNCReal_Zynthians.png]]
  
'''IMPORTANT:''' Using an ethernet-to-ethernet (cable) connection will reduce latency and improve usability.
+
[[File:Vncreal-setup.png]]
  
== Copying your presets/soundfonts to Zynthian ==
+
[[File:Realvnc-step2.png]]
  
You can copy your presets/soundfonts/pedalboards in the next folder:
+
[[File:Realvnc-step3.png]]
  
/zynthian/zynthian-my-data
+
[[File:Realvnc-step4.png]]
  
There are different subfolders:
+
[[File:Realvnc-step5.png]]
  
+ mod-pedalboards
+
[[File:Realvnc-help.png]]
+ soundfonts
+
  + gig
+
  + sfz
+
  + sf2
+
+ snapshots
+
+ zynbanks
+
  
In 'mod-pedalboards' you will find your stored MOD-UI pedalboards.
+
====Supported Engines with Native GUI====
Use SFZ and GIG soundfonts with LinuxSampler. SF2 soundfonts must be used with FluidSynth. SFZ and GIG fonts must be stored in 'category' subfolders.
+
User's ZynAddSubFX presets/banks must be stored in the "zynbanks" directory.
+
  
If you have doubts of how to store your data, take a look in this directory:
+
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.
  
/zynthian/zynthian-data
+
{{NoteBox|Using an ethernet-to-ethernet (cable) connection will reduce remote GUI latency and improve usability.}}
  
Here you will find the same folder structure, with some additions.
+
== Uploading your presets/soundfonts to Zynthian ==
  
If you are really interested, you could, for instance, edit the setBfree configuration, and change the CC assignments, etc.
+
The easiest way of getting your presets & soundfonts inside your zynthian is by using the webconf's preset manager:
  
'''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...)
+
  http://zynthian.local/lib-presets
  
If you are using an old SD image (prior to Gorgona), the username and password are the default for Raspbian:
+
From there you manage your preset & soundfont libraries: renaming, deleting, and uploading, including automatic conversion from some native formats:
  
user=pi
+
* DX7 SysEX files
password=raspberry
+
* OBXd FXB files
 +
* synthv1 native format
 +
* padthv1 native format
  
==CUIA Callable UI Actions==
+
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:
  
The Zynthian may be controlled by MIDI messages applied to the Master MIDI Channel (default 16) defined in The Webconf Interface
+
/zynthian/zynthian-my-data
  
The Interface allows applying on MIDI IN commands on channel 16 (default) that mimic various zynthian gui interface commands with some functional short cuts also provided ('POWER_OFF', ALL_NOTES_OFF').
+
This is the subfolder structure:
  
The Message is sent as a Note on Message (0x9)
+
+ '''presets'''
 +
  + zynaddsubfx
 +
  + puredata
 +
  + pianoteq
 +
  + lv2
 +
  + mod-ui
 +
+ '''soundfonts'''
 +
  + '''sf2'''
 +
    + bank-1.sf2
 +
    + ...
 +
    + bank-n.sf2
 +
  + '''sfz'''
 +
    + bank-1
 +
      + sfz-bundle1
 +
      + ...
 +
      + sfz-bundle2
 +
    + ...
 +
    + bank-n
 +
  + '''gig'''
 +
    + bank-1
 +
      + instrument-1.gig
 +
      + ...
 +
      + instrument-n.gig
 +
    + ...
 +
    + bank-n
 +
+ '''snapshots'''
 +
+ '''capture'''
  
So To Power Off a zynthian one sends
+
SFZ and GIG soundfonts are used with LinuxSampler. SF2 soundfonts are used with FluidSynth. SFZ and GIG soundfonts must be organized in 'bank' subfolders. SF2 files are considered "banks" by itself.
0x9F  ( Channel 16 Note ON)
+
0x00  ( Note code for POWER_OFF as below )
+
0x00  (Velocity/parameter)
+
  
This is why you should operate secure networks  . . . :-D
+
If you have doubts of how to store your data, take a look in this directory:
  
 +
/zynthian/zynthian-data
  
 +
Here you will find the same folder structure, and could help you to understand.
  
"0": "POWER_OFF",
+
Also it's interesting:
"1": "REBOOT",
+
"2": "RESTART_UI",
+
"3": "RELOAD_MIDI_CONFIG",
+
  
  "10": "ALL_NOTES_OFF",
+
  /zynthian/config
"11": "ALL_SOUNDS_OFF",
+
"12": "ALL_OFF",
+
  
"51": "SELECT",                     D#3/Eb3
+
If you are really interested, you could, for instance, edit the setBfree configuration, and change the CC assignments, etc.
"52": "SELECT_DOWN",               E3
+
"53": "SELECT_UP",                 F3
+
  
"64": "SWITCH_BACK_SHORT",         E4
+
{{WarningBox|If you add or change something inside the ''zynthian-data'' folder, your changes will be lost on the next update, or, in a worst case scenario, you could break the update system.}}
"63": "SWITCH_BACK_BOLD",           D#4/Eb4
+
"62": "SWITCH_BACK_LONG",           D4
+
  
"65": "SWITCH_SELECT_SHORT",        F4
+
== OSC ==
"66": "SWITCH_SELECT_BOLD",        F#4/Gb4
+
"67": "SWITCH_SELECT_LONG",        G4
+
+
"60": "SWITCH_LAYER_SHORT",        C4
+
"61": "SWITCH_LAYER_BOLD",          C#4/Db4
+
"59": "SWITCH_LAYER_LONG",          B4
+
  
"71": "SWITCH_SNAPSHOT_SHORT",     B5
+
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.
"72": "SWITCH_SNAPSHOT_BOLD",       C5
+
"73": "SWITCH_SNAPSHOT_LONG"        C#5/Db5
+
  
[[File:2Oct_Keyboard_CUIA.png|400px|thumb|left|Keyboard]]
+
==== 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
 +
 
 +
==== TouchOSC ====
 +
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
 +
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)))

Latest revision as of 01:36, 13 August 2020

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).

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
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

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.

  1. Open the Admin screen on your Zynthian.
  2. Select the "Wifi Hotspot" option.
    • This will take up to thirty seconds to complete.
  3. Connect to the "zynthian" network with another device.
  4. In the Admin screen on your Zynthian, select "Network Info".
  5. 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

You can access web configuration tool using the web browser from your computer:

  1. Connect your Zynthian to your local network using the ethernet connector (RJ45) or directly to your computer (Ethernet to Ethernet)
  2. Open the browser in your computer and type in the address bar:
http://zynthian.local   (or the IP address of your Zynthian)

Note:

If zynthian.local does not work, see Finding your IP address

The web config tool will load and ask for the admin password. The default password is "raspberry".

Zynthian webconf login.png

Here are the details on using the Web configuration tool: Configuration_Users_Guide

Wifi Configuration

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'.

Accessing the MOD-UI web interface

You can access the MOD-UI web interface using the web browser from your computer:

  • 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)
  • Open the browser in your computer and navigate to:
zynthian.local:8888

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. 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.

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.

RealVNC

VNCReal Zynthians.png

Vncreal-setup.png

Realvnc-step2.png

File:Realvnc-step3.png

Realvnc-step4.png

Realvnc-step5.png

Realvnc-help.png

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.

Note:

Using an ethernet-to-ethernet (cable) connection will reduce remote GUI latency and improve usability.

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:

 http://zynthian.local/lib-presets

From there you manage your preset & soundfont libraries: renaming, deleting, and uploading, including automatic conversion from some native formats:

  • DX7 SysEX files
  • OBXd FXB files
  • synthv1 native format
  • padthv1 native format

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

This is the subfolder structure:

+ presets
 + zynaddsubfx
 + puredata
 + pianoteq
 + lv2
 + mod-ui
+ soundfonts
 + sf2
   + bank-1.sf2
   + ...
   + bank-n.sf2
 + sfz
   + bank-1
     + sfz-bundle1
     + ...
     + sfz-bundle2
   + ...
   + bank-n
 + gig
   + bank-1
     + instrument-1.gig
     + ...
     + instrument-n.gig
   + ...
   + bank-n
+ snapshots
+ capture

SFZ and GIG soundfonts are used with LinuxSampler. SF2 soundfonts are used with FluidSynth. SFZ and GIG soundfonts must be organized in 'bank' subfolders. SF2 files are considered "banks" by itself.

If you have doubts of how to store your data, take a look in this directory:

/zynthian/zynthian-data

Here you will find the same folder structure, and could help you to understand.

Also it's interesting:

/zynthian/config

If you are really interested, you could, for instance, edit the setBfree configuration, and change the CC assignments, etc.

WARNING!!

If you add or change something inside the zynthian-data folder, your changes will be lost on the next update, or, in a worst case scenario, you could break the update system.

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 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

TouchOSC

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

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)))