Changes

Jump to navigation Jump to search

Accessing Zynthian from your computer (view source)

Revision as of 21:08, 17 February 2021

4,377 bytes added ,  21:08, 17 February 2021
→‎Accessing the Web Configuration Tool
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 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 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.
+
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]]
−
Instead, you can use the zynthian's IPaddress. Find out what that is using the "Network Info" utility in the Zynthian's Admin menu.
+
 
 +
== 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 ==
   −
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)
−
# Open the browser in your camputer 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)
   −
The web config tool will load and prompt for the admin password. It is "raspberry".
+
{{NoteBox|If zynthian.local does not work, see [[Finding your IP address]]
   −
[[File:ZynLogin.png]]
+
<br>''If you can't access WebConf with your browser, there is a command-line option. See [[Command_Line_User_Guide#Configuration_without_WebConf]]''}}
   −
== Wifi Configuration ==
+
The web config tool will load and ask for the admin password. The default password is "raspberry".
   −
When you are logged in with ssh, you can configure the wifi access by editing this file:
+
[[File:zynthian_webconf_login.png]]
   −
$ sudo vi /etc/wpa_suppplicant/wpa_supplicant.conf
+
Here are the details on using the Web configuration tool: [[Configuration_Users_Guide]]
   −
Note that this file is protected and you have to edit as root user (sudo).
+
== Wifi Configuration ==
   −
After editing the WPA settings, you can restart the network interface using a command like this:
+
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'.
−
 
  −
$ sudo ifdown wlan0
  −
$ 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 (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]]
   −
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,
+
== Opening Synth Engine Native GUIs on your Computer ==
   −
or
+
Some engines have a native GUI that can be accessed from your desktop/laptop computer. There are several methods for achieving this:
   −
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.
+
====X11 Server====
−
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):
+
 
 +
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
 
   $ 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]]
   −
Currently only ZynAddSubFX has a supported native GUI. Other GUI software can be installed to control other synths, also virtual MIDI keyboard software can be used - for testing.
+
====VNC====
    +
You could also use VNC, although it's a bit complex:
   −
'''IMPORTANT:''' Try to use an ethernet-to-ethernet connection as it will reduce latency and improve usability.
+
* Login into your zynthian box and enter:
   −
== Copying your presets/soundfonts to Zynthian ==
+
  # apt-get install vnc4server blackbox
 +
  # pico ~/.vncrc
   −
You can copy your presets/soundfonts/pedalboards in the next forlder:
+
* 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====
 +
 
 +
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.
 +
 
 +
{{NoteBox|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
 
  /zynthian/zynthian-my-data
   −
There are different subfolders:
+
This is the subfolder structure:
   −
  + mod-pedalboards
+
  + '''presets'''
−
  + soundfonts
+
  + zynaddsubfx
−
   + gig
+
  + puredata
−
   + sfz
+
  + pianoteq
−
   + sf2
+
  + lv2
−
  + snapshots
+
  + mod-ui
−
  + zynbanks
+
  + '''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'''
   −
In 'mod-pedalboards' you will find your stored MOD-UI pedalboards.
+
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.
−
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:
 
If you have doubts of how to store your data, take a look in this directory:
Line 92: Line 188:  
  /zynthian/zynthian-data
 
  /zynthian/zynthian-data
   −
Here you will find the same folder structure, with some additions.
+
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.
 
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...)
+
{{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.}}
 +
 
 +
== 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
   −
If you are using an old SD image (prior to Gorgona), the username and password are the default for Raspbian:
+
is interpreted the same as
 +
/CUIA/REBOOT
   −
  user=pi
+
An example Python script to start a MIDI recording:
−
  password=raspberry
+
  import liblo
 +
liblo.send(('zynthian.local', 1370), "/cuia", ('s', 'START_MIDI_RECORD'))
 +
 
 +
==== 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)))
Gmeader
393

edits

Retrieved from "http://wiki.zynthian.org/index.php/Special:MobileDiff/1601...11710"

Navigation menu