Difference between revisions of "Web Configuration User Guide"

Latest revision as of 07:56, 28 September 2024

The WebConf Tool is the Zynthian Web Configuration Tool, a website hosted inside your Zynthian device that allows you to configure and inspect the settings and attributes of your Zynthian. Note: if you can't access the WebConf tool, see Configuration by ssh at the bottom of this page.

1 Login

You can access the Webconf tool from any computer using a web browser. Your Zynthian Box must be connected to your local network, or directly to your computer with an Ethernet cable (link local, point to point).

To connect your Zynthian Box to your local network you can use an Ethernet cable connected from your router to your Zynthian Box. Also, if WiFi has been configured previously in your Zynthian, you should be able to connect by WiFi.

To access your Zynthian box from your browser, you can use either of these 2 methods:

Browse to http://zynthian.local or http://zynthian.lan. This doesn't work in all devices. Many Windows-PCs and mobile devices don't fully support the mDNS protocol that enable the use of named addresses on a local network.

If you your browser can’t find the zynthian.local address, you will then need to figure out what IP address has been assigned to your Zynthian Box. For more details, see Finding your IP address. Once you have your Zynthian's IP address (xxx.xxx.xxx.xxx), you can browse to http://xxx.xxx.xxx.xxx.

Note:

Default password is: opensynth
Releases prior to Oram use: raspberry

2 Dashboard

The Dashboard displays basic configuration information about your Zynthian.

3 Library

The library is where multiple configuration snapshots, Instrument soundfonts, Presets, and Capture files are managed.

3.1 Snapshots

The Snapshots is where you can manage your snapshots (a stored configuration of instruments and settings.)

Bank/Program refers to MIDI Program Change commands that can enable a specific snapshot.

3.2 Soundfonts

Soundfonts are files which contain a set of sampled sounds for an instrument.

3.3 Captures (Audio & MIDI)

Manage files that contain musical performance data that you have captured.

4 Hardware

4.1 Audio

This page lets you configure your sound cards and audio adapters.

Audio is probably the setting that most affects the behaviour. Get it wrong and the GUI probably won’t start (You'll see an error display). Luckily the webconf allows you to set the device up in spite of a non start of the GUI and the generic USB will generally work. If it doesn’t you will need to play around with the USB alsa settings. Understanding of the jackd start up settings is probably what’s required. It’s normally the hw: setting.

The audio settings for USB are really just passed to jackd (the audio server) and if they don’t match then jackd won’t start hence no audio. The GUI logging in the webconf will tell you if this is happening. A very good starting point if it’s not working is by logging onto the Zynthian with SSH and giving the command: 'aplay -L'

This will tell you about ALSA settings (the audio hardware handler) and these settings will contain details that will be useful configuring the Jack settings.

More info: https://discourse.zynthian.org/t/audio-setup/2647

4.2 Display

This is where you can configure the touchscreen display.

the hdmi display setting will deal with an hdmi monitor and the width & height settings will allow you to deal with any aspect ratio issues. The UI ffont settings might need altering to fit the screen

4.3 Wiring Layout

Configure the "wiring" for your encoders/knobs and switches. Select "dummies" if your zynthian has none.

You can also configure the V4's customizable switches (S1, S2, S3 & S4), the zynaptik's analog & digital inputs and 2 TOF distance sensors that can be assigned to MIDI actions. Take a look to this section.

5 Software

5.1 Plugins LV2

Manage the installed LV2 plugins. Enable/Disable synthesizers, audio effects and MIDI tools.

5.2 Pianoteq

Configure the Pianoteq plugin. Enable license, add instrument packs, etc.

5.3 Update

Update the Zynthian software.

5.4 Repositories

Maintain the Zynthian Repositories

6 Interfaces

This is where you configure the various interfaces in your Zynthian

6.1 MIDI

MIDI configuration page. Setup and store different profiles that are MIDI configurations.

6.1.1 Profiles

Manage storage of MIDI configuration profiles

6.1.2 Options

Master Channel, Active Layer, MIDI over Network, Preload Presets on Note, etc.

6.1.3 Filter/Router

The MIDI filter allows to filter the MIDI messages using rules. You can use the visual rule builder, or type the rules directly. Read the MIDI Filter Rule Language documentation.

6.1.4 Ports

This is an "advanced" option that allows to configure your hardware MIDI ports as INPUT/OUTPUT or for receiving MIDI feedback on controllers that support this feature (i.e. motorized faders).

6.1.5 MIDI Log

Displays all received MIDI messages. Useful for debugging MIDI connection and configuration.

6.1.6 Keyboard Binding

The keyboard Binding Page allows configuration of particular functions from a connected USB keyboard this can obviously be a full ASCII keyboard or a small number pad or even 3 foot switches.

6.1.7 Using MIDI controllers instead of Encoders

Using midi driven encoders instead of encoders bult-in to the Zynthian is a little bit confusing, and that’s conceptual rather than technical. A MIDI controller is normally a pot or an encoder pretending to be a potentiometer. Its value varies from 0 to 127. The problem with that is the Zynthian encoders work as proper encoders using up and down signals. To produce something that could control a list properly when you move to a specific screen after you’ve come from another page is rather complicated because most pots will simply send the maximum value but not repeatedly send if further turns are made.

The next issue is handling the pushbutton functions of the encoder and bold presses and long presses.

You can send CUIA commands to drive the GUI and that would allow you to drive the whole device from push buttons but it might be a lot of switches.

And you really can do an awful lot with a mouse! Really easy if you get a wireless(not Bluetooth) one it’s really intuitive once you learn the trick to do the back button.

6.2 User Interface

Customize the user interface.

6.2.1 UI Log

Display a log of User Interface actions for debugging.

7 System Management

7.1 WIFI

This page allows your to connect to WiFi networks, as well as manage stored connections.

To enable wifi access follow these steps:

1. In the Web config on the WIFI page you need to click Add Network

2. On the next screen choose your SSID from the dropdown menu and enter the passord.

3. Click the Add button

4. Enable wifi from the zynthian screen or in the Web Config set mode to On

7.2 Security / Access

Allows you to change the password & set the hostname of the zynthian ( don't forget to select advanced to get hostname)

7.3 Backup & Restore

These pages allow you to backup & restore your system & data components.

8 Configuration with ssh

For Linux savvy users:

If you can't access the WebConf pages with a browser, you can login with ssh and "manually" edit the configuration file.

Simply edit this file:

/zynthian/config/zynthian_envars.sh

and run this command after saving the changes:

# zynthian_update_sys.sh

@@ Line 1: / Line 1: @@
-The '''WebConf Tool''' is the ''Zynthian Web Configuration Tool'', a website hosted inside your Zynthian device that allows you to configure and inspect the settings and attributes of your Zynthian.
+The '''WebConf Tool''' is the ''Zynthian Web Configuration Tool'', a website hosted inside your Zynthian device that allows you to configure and inspect the settings and attributes of your Zynthian. Note: if you can't access the WebConf tool, see '''Configuration by ssh''' at the bottom of this page.
 ==Login==
-[[File:zynthian_webconf_login.png|right]]
+[[File:zynthian_webconf_login.png|600px|right]]
 You can access the Webconf tool from any computer using a web browser. Your Zynthian Box must be connected to your local network, or directly to your computer with an Ethernet cable (link local, point to point).
@@ Line 11: / Line 11: @@
 To access your Zynthian box from your browser, you can use either of these 2 methods:
-* Browse to '''http://zynthian.local'''. This doesn't work in all devices. Many Windows-PCs and mobile devices don't fully support the [https://en.wikipedia.org/wiki/Multicast_DNS mDNS] protocol that enable the use of named addresses on a local network.
+* Browse to '''http://zynthian.local''' or '''http://zynthian.lan'''. This doesn't work in all devices. Many Windows-PCs and mobile devices don't fully support the [https://en.wikipedia.org/wiki/Multicast_DNS mDNS] protocol that enable the use of named addresses on a local network.
 * If you your browser can’t find the '''zynthian.local''' address, you will then need to figure out what IP address has been assigned to your Zynthian Box. For more details, see [[Finding your IP address]]. Once you have your Zynthian's IP address (xxx.xxx.xxx.xxx), you can browse to '''http://xxx.xxx.xxx.xxx'''.
 <br clear=all>
+{{NoteBox| Default password is: '''opensynth''' <br>
+Releases prior to Oram use: ''raspberry'' }}
 ==Dashboard==
-[[File:zynthian_webconf_dashboard.png|right]]
+[[File:zynthian_webconf_dashboard.png|600px|right]]
 The Dashboard displays basic configuration information about your Zynthian.
@@ Line 28: / Line 31: @@
 ===Snapshots===
-[[File:WebLibrarySnapshots.png|right]]
+[[File:WebLibrarySnapshots.png|600px|right]]
 The Snapshots is where you can manage your snapshots (a stored configuration of instruments and settings.)
@@ Line 45: / Line 48: @@
 ===Audio===
-[[File:zynthian_webconf_hardware_audio.png|right]]
+[[File:zynthian_webconf_hardware_audio.png|600px|right]]
+This page lets you configure your sound cards and audio adapters.
+Audio is probably the setting that most affects the behaviour. Get it wrong and the GUI probably won’t start (You'll see an error display).  Luckily the webconf allows you to set the device up in spite of a non start of the GUI and the generic USB will generally work. If it doesn’t you will need to play around with the USB alsa settings. Understanding of the jackd start up settings is probably what’s required. It’s normally the hw: setting.
+The audio settings for USB are really just passed to jackd (the audio server) and if they don’t match then jackd won’t start hence no audio. The GUI logging in the webconf will tell you if this is happening. A very good starting point if it’s not working is by logging onto the Zynthian with SSH and giving the command: 'aplay -L'
-This page lets you configure your sound cards and audio adapters
+This will tell you about ALSA settings (the audio hardware handler) and these settings will contain details that will be useful configuring the Jack settings.
+More info: https://discourse.zynthian.org/t/audio-setup/2647
 <br clear=all>
 ===Display===
-[[File:zynthian_webconf_hardware_display.png|right]]
+[[File:zynthian_webconf_hardware_display.png|600px|right]]
 This is where you can configure the touchscreen display.
+the hdmi display setting will deal with an hdmi monitor and the width & height settings will allow you to deal with any aspect ratio issues. The UI ffont settings might need altering to fit the screen
 <br clear=all>
-===Wiring Layouts===
+===Wiring Layout===
-[[File:zynthian_webconf_hardware_wiring.png|right]]
+[[File:zynthian_webconf_hardware_wiring.png|600px|right]]
-Configure wiring for the encoders/knobs and switches.
+Configure the "wiring" for your encoders/knobs and switches. Select "dummies" if your zynthian has none.
+You can also configure the V4's customizable switches (S1, S2, S3 & S4), the zynaptik's analog & digital inputs and 2 TOF distance sensors that can be assigned to MIDI actions. Take a look to [https://wiki.zynthian.org/index.php/Adding_Extra_I/O_with_the_Zynaptik_Module this section].
 <br clear=all>
 ==Software==
+===Plugins LV2===
+[[File:zynthian_webconf_software_plugins.png|600px|right]]
+Manage the installed LV2 plugins. Enable/Disable synthesizers, audio effects and MIDI tools.
+===Pianoteq===
+Configure the Pianoteq plugin. Enable license, add instrument packs, etc.
 ===Update===
+Update the Zynthian software.
-Update the Zynthian OS and associated application software.
-===Pianoteq===
-configure the Pianoteq plugin. (enable paid license)
-===Plugins===
-Manage the installed plugins.
-[[File:zynthian_webconf_software_plugins.png|center]]
+===Repositories===
+Maintain the Zynthian Repositories
+[[File:Zynthian software repositories.png|600px|right]]
 <br clear=all>
@@ Line 85: / Line 101: @@
 ===MIDI===
-[[File:zynthian_webconf_MIDI.png|right]]
+[[File:zynthian_webconf_MIDI.png|600px|right]]
 MIDI configuration page. Setup and store different profiles that are MIDI configurations.
-<br clear=all>
 ====Profiles====
@@ Line 94: / Line 108: @@
 ====Options====
+Master Channel, Active Layer, MIDI over Network, Preload Presets on Note, etc.
-Master Channel, Active Layer, MIDI over Network, Preload Presets on Note, etc.
+<br clear=all>
 ====[[Configure_MIDI_Filter/Router|Filter/Router]]====
-Visit here to [[Configure_MIDI_Filter/Router|Filter/Router]]
+[[File:zynthian_webconf_midi_router.png|600px|right]]
+The MIDI filter allows to filter the MIDI messages using rules. You can use the visual rule builder, or type the rules directly.
+[[Configure_MIDI_Filter/Router|Read the MIDI Filter Rule Language documentation.]]
+<br clear=all>
+====Ports====
+[[File:zynthian_webconf_midi_ports.png|600px|right]]
+This is an "advanced" option that allows to configure your hardware MIDI ports as INPUT/OUTPUT or for receiving MIDI feedback on controllers that support this feature (i.e. motorized faders).
 <br clear=all>
 ====MIDI Log====
-[[File:MIDILog.png|right]]
+[[File:MIDILog.png|600px|right]]
 Displays all received MIDI messages. Useful for debugging MIDI connection and configuration.
+<br clear=all>
+====Keyboard Binding====
+[[File:Keyboard binding.png|600px|right]]
+The keyboard Binding Page allows configuration of particular functions from a connected USB keyboard this can obviously be a
+full ASCII keyboard or a small number pad or even 3 foot switches.
+[[File:3footpedal.png|left|400px]]
+<br clear=all>
+====Using MIDI controllers instead of Encoders====
+Using midi driven encoders instead of encoders bult-in to the Zynthian is a little bit confusing, and that’s conceptual rather than technical. A MIDI controller is normally a pot or an encoder pretending to be a potentiometer. Its value varies from 0 to 127. The problem with that is the Zynthian encoders work as proper encoders using up and down signals. To produce something that could control a list properly when you move to a specific screen after you’ve come from another page is rather complicated because most pots will simply send the maximum value but not repeatedly send if further turns are made.
+The next issue is handling the pushbutton functions of the encoder and bold presses and long presses.
+You can send CUIA commands to drive the GUI and that would allow you to drive the whole device from push buttons but it might be a lot of switches.
+And you really can do an awful lot with a mouse! Really easy if you get a wireless(not Bluetooth) one it’s really intuitive once you learn the trick to do the back button.
 <br clear=all>
 ===User Interface===
-[[File:zynthian_webconf_ui.png|right]]
+[[File:zynthian_webconf_ui.png|600px|right]]
 Customize the user interface.
@@ Line 116: / Line 159: @@
 ====UI Log====
-[[File:UIlog.png|right]]
+[[File:UIlog.png|600px|right]]
 Display a log of User Interface actions for debugging.
@@ Line 124: / Line 167: @@
 ===WIFI===
+[[File:zynthian_webconf_wifi.png|600px|right]]
 This page allows your to connect to WiFi networks, as well as manage stored connections.
-[[File:zynthian_webconf_wifi.png|right]]
+To enable wifi access follow these steps:
+. In the Web config on the WIFI page you need to click '''Add Network'''
+. On the next screen choose your SSID from the dropdown menu and enter the passord.
+. Click the '''Add''' button
+. Enable wifi from the zynthian screen or in the Web Config set mode to '''On'''
 <br clear=all>
-===Security/Access===
+===Security / Access===
-===Backups/Restore===
+[[File:Security-access.png|600px|right]]
+Allows you to change the password & set the hostname of the zynthian ( don't forget to select advanced to get hostname)
 <br clear=all>
+===Backup & Restore===
+These pages allow you to backup & restore your system & data components.
+== Configuration with ssh ==
+For Linux savvy users:
+If you can't access the WebConf pages with a browser, you can login with ssh and "manually" edit the configuration file.
+Simply edit this file:
+ /zynthian/config/zynthian_envars.sh
+and run this command after saving the changes:
+ # zynthian_update_sys.sh