Difference between revisions of "Web Configuration User Guide"
m (Update all headings and some images to match current state of webconf) |
m (→MIDI Options) |
||
| (8 intermediate revisions by the same user not shown) | |||
| Line 50: | Line 50: | ||
===Kit=== | ===Kit=== | ||
| − | + | Here you can select a 'kit' option based on past and preseent Zynthian kits sold from the online store. This will set appropriate settings in webconf based on the version chosen. | |
===Audio=== | ===Audio=== | ||
| Line 57: | Line 57: | ||
This page lets you configure your sound cards and audio adapters. | This page lets you configure your sound cards and audio adapters. | ||
| − | Audio | + | Audio settings are very important and note that the Zynthian GUI generally won’t start with incorrect audio settings (You'll see an error display). Webconf will still allow you to set the device up in spite of a non start of the GUI and the generic USB soundcard setting 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' | 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' | ||
| Line 100: | Line 100: | ||
==Software== | ==Software== | ||
===Engines=== | ===Engines=== | ||
| − | [[File: | + | [[File:Webconf engines page.png|600px|right]] |
| − | Manage and search the installed engines (LV2 plugins). Use the checkbox to Enable/Disable synthesizers, audio effects and MIDI tools. | + | Manage and search the installed engines (LV2 plugins). Use the checkbox to Enable/Disable synthesizers, audio effects and MIDI tools. A basic rating system is provided to gauge the quality and complexity of the plugins. |
===Pianoteq=== | ===Pianoteq=== | ||
| Line 115: | Line 115: | ||
===Update=== | ===Update=== | ||
| − | Update the Zynthian software. | + | Update the Zynthian software. An update option is also available directly from the admin menu of the native Zynthian UI. |
| + | <br clear=all> | ||
| + | ===Version=== | ||
| + | [[File:Repositories page webconf oram.png|600px|right]] | ||
| + | Allows selection of the Zynthian Repositories to give access to updates and new features. | ||
| − | |||
| − | |||
| − | |||
<br clear=all> | <br clear=all> | ||
| Line 127: | Line 128: | ||
This is where you configure the various interfaces in your Zynthian | This is where you configure the various interfaces in your Zynthian | ||
| − | + | [[File:Webconf User Interface Page Screenshot.png|600px|right]] | |
===UI Options=== | ===UI Options=== | ||
| Line 142: | Line 143: | ||
===UI Key Binding=== | ===UI Key Binding=== | ||
| − | [[File: | + | |
| + | [[File:Computer keyboard binding.png|600px|right]] | ||
The keyboard Binding Page allows configuration of particular functions from a connected USB keyboard this can obviously be a | 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. | full ASCII keyboard or a small number pad or even 3 foot switches. | ||
| Line 152: | Line 154: | ||
====UI Log==== | ====UI Log==== | ||
[[File:UIlog.png|600px|right]] | [[File:UIlog.png|600px|right]] | ||
| − | Display a log of User Interface actions for debugging. | + | Display a log of User Interface actions for debugging. This is a good place to check for any hardware related configuration issues such as buttons, display and audio. |
| − | |||
| + | <br clear=all> | ||
===MIDI Options=== | ===MIDI Options=== | ||
| − | [[File: | + | [[File:Midi options webconf oram.png|600px|right]] |
| − | |||
MIDI configuration page. Save, restore and delete profiles for your custom MIDI settings made on this page. | MIDI configuration page. Save, restore and delete profiles for your custom MIDI settings made on this page. | ||
| Line 171: | Line 172: | ||
====Midi fine tuning (Hz)==== | ====Midi fine tuning (Hz)==== | ||
Make fine tuning adjustments | Make fine tuning adjustments | ||
| − | + | <br clear=all> | |
====Midi Devices==== | ====Midi Devices==== | ||
[[File:zynthian_webconf_midi_ports.png|600px|right]] | [[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). | 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> | |
====Configure MIDI Filter/Router==== | ====Configure MIDI Filter/Router==== | ||
[[File:zynthian_webconf_midi_router.png|600px|right]] | [[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. | 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.]] | [[Configure_MIDI_Filter/Router|Read the MIDI Filter Rule Language documentation.]] | ||
| − | + | <br clear=all> | |
====Master Channel==== | ====Master Channel==== | ||
Allows setting a master midi channel to allow program change and bank change messages and master key actions. | Allows setting a master midi channel to allow program change and bank change messages and master key actions. | ||
| Line 190: | Line 191: | ||
<br clear=all> | <br clear=all> | ||
| − | |||
===VNC-UI=== | ===VNC-UI=== | ||
| Line 217: | Line 217: | ||
<br clear=all> | <br clear=all> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==System== | ==System== | ||
Latest revision as of 12:38, 14 January 2025
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 Captures (Audio & MIDI)
Manage files that contain musical performance data that you have captured in various formats.
3.3 Presets & Soundfonts
This page allows for review of presets across all instruments and effects in your Zynthian box. A simple search is provided. You can also upload and download files containing presets and Soundfonts (files of sampled sounds for an instrument) directly to/from Zynthian.
4 Hardware
4.1 Kit
Here you can select a 'kit' option based on past and preseent Zynthian kits sold from the online store. This will set appropriate settings in webconf based on the version chosen.
4.2 Audio
This page lets you configure your sound cards and audio adapters.
Audio settings are very important and note that the Zynthian GUI generally won’t start with incorrect audio settings (You'll see an error display). Webconf will still allow you to set the device up in spite of a non start of the GUI and the generic USB soundcard setting 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.3 Display
This is where you can configure the touchscreen display. Zynthian provides a set of preconfigured settings for various displays from the first drop down menu.
If required, use the remaining fields to customise width, height and rotation settings to allow you to deal with any aspect ratio or screen orientation issues. The UI font settings might need altering to fit the screen.
Adjustments to display settings generally require a reboot.
4.4 Wiring
This page allows configuration of the "wiring" for your encoders/knobs and switches. Make a selection from the 'Wiring Layout' drop-down menu based on your hardware used e.g. a kit from the store, a Zynaptik module (I/O expansion purchasable here) or your own hardware. Depending on your selection, this will change the available fields that follow. Select "dummies" if your zynthian has none.
4.4.1 Configure Additional Connections via Serial Port Expander (MCP23017)
In combination with an serial port expander chip (e.g. MCP23017) Zynthian allows multiple additional inputs/outputs. When adding a single MCP23017 chip, connected hardware is assigned a number in the Encoders A/B/Switches fields. The numbers assignable to a single MCP chip range from 100-115 (second MCP chip ranges 200-215). So for a single encoder with push switch connected to the first three in/outs of Bank A of the MCP chip you will want to enter 100 (enc A), 101 (enc B) and 102 (switch) consecutively (or some variation of, depending on your wiring).
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.
4.4.2 Serial Port Expander Interrupt Connections
The last two fields in the image show the interrupt GPIO pins that the MCP23017 chip will use to communicate with the Pi. If you are creating custom hardware you may wish to adjust these from the default values. It's easier to use the pin number in brackets as a reference to make your connections (unless you understand how wiringPi assigns GPIOs).
4.4.3 Further configuration info
For a deeper dive on the topic with info about both the Zynaptik modules and how to configure custom hardware see Adding Extra I/O section.
4.5 Options
Configure hardware options on this page such as OTG, USB speed limiting, the level of overclocking for your raspberry pi and areas for custom config and boot commands.
5 Software
5.1 Engines
Manage and search the installed engines (LV2 plugins). Use the checkbox to Enable/Disable synthesizers, audio effects and MIDI tools. A basic rating system is provided to gauge the quality and complexity of the plugins.
5.2 Pianoteq
Configure the Pianoteq plugin. Enable license, add instrument packs, etc.
5.3 DSP56300
The DSP56300 emulator by The Usual Suspects, is a software emulation of the popular DSP563XX family of DSP chips developed originally by Motorola. They were used in a number of hardware synthesizers and other musical gear from the mid 90s, such as Access Virus A, B, C, TI / Clavia Nord Lead 2X, 3, Modular / Waldorf Q, Microwave II / Novation Supernova, Nova and many others.
For using the emulator you must have legal access to a ROM file containing the firmware for the device you want to emulate. If you are the lucky owner of one of this wonderful pieces of gear, you may have legal access to the firmware ROM file and you could use it with this emulator. Please, be aware that most (if not all!) firmware ROM files are not free software and you are not allowed to share them with anyone without permission from the copyright owners (aka, the device manufacturer).
From this page you can upload the firmware ROM files for the supported devices.
5.4 Update
Update the Zynthian software. An update option is also available directly from the admin menu of the native Zynthian UI.
5.5 Version
Allows selection of the Zynthian Repositories to give access to updates and new features.
6 Interface
This is where you configure the various interfaces in your Zynthian
6.1 UI Options
This pages allows adjustment of various UI settings including:
- Power saving (screen off delay)
- Save current state
- MIDI over Network
- Enable/disable VNC for remote screen access
- Fonts and interface colours
6.2 UI Key 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.2.1 UI Log
Display a log of User Interface actions for debugging. This is a good place to check for any hardware related configuration issues such as buttons, display and audio.
6.3 MIDI Options
MIDI configuration page. Save, restore and delete profiles for your custom MIDI settings made on this page.
- Program Change ZS3 (Program Change for SubSnapShots)
- Bank Change with CC#0(MSB) & CC#32(LSB)
- Preload Presets with Note-On events
- Enable System Messages (Transport)
6.3.1 Midi Profile
Save, restore and delete profiles for your custom MIDI configurations made on this page.
6.3.2 Midi fine tuning (Hz)
Make fine tuning adjustments
6.3.3 Midi Devices
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.3.4 Configure MIDI 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.3.5 Master Channel
Allows setting a master midi channel to allow program change and bank change messages and master key actions.
6.3.6 Master Key Action
Use this screen to assign midi note values to control the Zynthian UI.
6.4 VNC-UI
This link opens a tab with the Zynthian UI, same as you would see with a directly connected display.
6.5 VNC-Engines
This link opens a tab with a desktop style GUI for and loaded engines (synths, effects etc.) that have a built-in UI.
6.6 Terminal
Access a terminal window for the OS directly from Webconf to debug, troubleshoot etc.
6.7 MIDI Log
Displays all received MIDI messages. This page now provides a filter selection to focus messages on the various midi inputs & outputs in Zynthian. Useful for debugging MIDI connection and configuration.
6.7.1 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 push button 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.
7 System
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