Difference between revisions of "Accessing Zynthian from your computer"

From ZynthianWiki
Jump to navigation Jump to search
(25 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
== Network Connection ==
 
== Network Connection ==
  
The easier way of connecting your Zynthian is using the ethernet RJ45 connector 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
+
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).  
can be accessed with sftp and scp (winscp, if you are using windows yet). Of course, you can login with ssh too. The username and password are the default for Raspbian:
 
  
  user=pi
+
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:
 +
 
 +
  user=root
 
  password=raspberry
 
  password=raspberry
  
If the link-local address (zynthian.local) is not found, test if the link-local feature is enabled in your system. Sometimes is disabled and local names are not recognized.
+
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).
Also, you can use directly the zynthian IP, using the "Network Info" utility in the Zynthian's Admin menu.
+
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 ==
 +
 
 +
You can access 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)
 +
# Open the browser in your computer and type in the address bar:
 +
 
 +
zynthian.local  (or the IP address of your Zynthian)
 +
 
 +
(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".
  
== Wifi Configuration ==
+
[[File:zynthian_webconf_login.png]]
  
Once you are login in with ssh, you can configure the wifi access by editing this file:
+
Here's details on using the Web configuration tool: [[Configuration_Users_Guide]]
  
$ sudo vi /etc/wpa_suppplicant/wpa_supplicant.conf
+
== Wifi Configuration ==
  
Note that this file is protected and you have to edit as root user (sudo).
+
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'.
  
After editing the WPA settings, you can restart the network interface using a command like this:
+
==Audio Configuration==
  
$ sudo ifdown wlan0
+
[[Configuring_Audio_Devices]]
$ sudo ifup wlan0
 
  
 
== Accessing the MOD-UI web interface ==
 
== Accessing the MOD-UI web interface ==
  
If you have a recent zynthian image with MOD integration, you can access the MOD-UI web interface using the web browser from your computer:
+
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:
  
 
# 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 45:
 
  zynthian.local:8888
 
  zynthian.local:8888
  
The MOD-UI should be loaded. Enjoy! ;-)
+
The MOD-UI webpage should appear. Enjoy! ;-)
 +
 
 +
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 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 ==
 +
 
 +
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 the link-local address (zynthian.local) is not found, test if the link-local feature is enabled in your system. Sometimes is disabled and local names are not recognized.
+
* 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:
Also, you can use directly the zynthian IP, using the "Network Info" utility in the Zynthian's Admin menu.
 
  
== Opening Synth Engine Natives GUIs in your Computer ==
+
  $ ssh -Y root@zynthian.local
  
For doing this, you need a XServer running on your computer. Linux is best tested, but i've tested with Mac and Windows too.
+
* If you are a "Mac" user, you should install and enable the '''XQuartz''' package. After that, login into your zynthian with the same command.
You must follow this simple steps:
 
  
1. Login into zynthian using the "-Y" option or equivalent (tunnel X connections)
+
* 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.  
  $ ssh -Y pi@zynthian.local
 
 
2. Stop zynthian GUI:
 
  $ sudo /etc/init.d/zynthian stop
 
  
3. Start zynthian GUI in remote GUI mode:  
+
[[File:Putty-on-zynth-X11.png]]
  $ sudo /etc/init.d/zynthian startx
 
  
4. From Zynthian GUI, select the synth engine. Currently only ZynAddSubFX and Carla have supported native GUIs.
+
===VNC===
  
5. Enjoy!! ;-)
+
You also could use VNC on any platform, although it's slighty complex:
  
'''IMPORTANT:''' Try to use ethernet-to-ethernet connection as it will reduce latency and improve usability.
+
* 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.
 +
 
 +
===Supported Engines with Native GUI===
 +
 
 +
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 ;-)
 +
 
 +
'''IMPORTANT:''' Using an ethernet-to-ethernet (cable) connection will reduce latency and improve usability.
  
 
== Copying your presets/soundfonts to Zynthian ==
 
== Copying your presets/soundfonts to Zynthian ==
  
You can copy your presets/soundfonts in the next forlder:
+
You can copy your presets/soundfonts/pedalboards in the next forlder:
  
  /home/pi/zynthian/zynthian-data
+
  /zynthian/zynthian-my-data
  
There are different subfolders for every type/synth-engine:
+
There are different subfolders:
  
  carla
+
  + mod-pedalboards
  dexed
+
  + soundfonts
lscp
+
  + gig
midish
+
  + sfz
setbfree
+
  + sf2
  soundfonts
+
  + snapshots
  zynbanks
+
  + zynbanks
zynconf
 
  
You can use SFZ soundfonts with LinuxSampler but GIG are not integrated yet. I will do it very soon. SF2 soundfonts can be used with FluidSynth.
+
In 'mod-pedalboards' you will find your stored MOD-UI pedalboards.
 +
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.
  
Also, you can add your ZynAddSubFX instruments/banks, Carla patches, edit the setBfree configuration, etc.
+
If you have doubts of how to store your data, take a look in this directory:
  
'''IMPORTANT:''' after adding or changing something in zynthian-data, you can’t update the zynthian-library from the Admin menu nevermore.  
+
/zynthian/zynthian-data
I have to implement the use of “zynthian-my-data” folder to avoid this problem and maintain separated the “official” library from user’s library. TODO!
+
 
 +
Here you will find the same folder structure, with some additions.
 +
 
 +
If you are really interested, you could, for instance, edit the setBfree configuration, and change the CC assignments, etc.
 +
 
 +
'''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:
 +
 
 +
user=pi
 +
password=raspberry

Revision as of 01:38, 2 January 2019

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

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:

user=root
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

2 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:
zynthian.local   (or the IP address of your Zynthian)

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

Zynthian webconf login.png

Here's details on using the Web configuration tool: Configuration_Users_Guide

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

4 Audio Configuration

Configuring_Audio_Devices

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

  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 camputer and type in the address bar:
zynthian.local:8888

The MOD-UI webpage should appear. Enjoy! ;-)

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 IPaddress. Find out what that is using the "Network Info" utility in the Zynthian's Admin menu.

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

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

Putty-on-zynth-X11.png

6.2 VNC

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

6.3 Supported Engines with Native GUI

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

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

7 Copying your presets/soundfonts to Zynthian

You can copy your presets/soundfonts/pedalboards in the next forlder:

/zynthian/zynthian-my-data

There are different subfolders:

+ mod-pedalboards
+ soundfonts
 + gig
 + sfz
 + sf2
+ snapshots
+ zynbanks

In 'mod-pedalboards' you will find your stored MOD-UI pedalboards. 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:

/zynthian/zynthian-data

Here you will find the same folder structure, with some additions.

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

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:

user=pi
password=raspberry