Difference between revisions of "Web Configuration User Guide"

Revision as of 20:23, 8 March 2019

The WebConf Tool is the Zynthian Web Configuration Tool, a website hosted inside your Zynthian device that allows you to administer, configure, and inspect attributes of your Zynthian.

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 allowed 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. 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. Easy!

2 Dashboard

The Dashboard displays basic configuration information about your Zynthian.

3 Library

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

3.1 Snapshots

Manage the 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 that contain a set of sampled sounds for an instrument.

3.3 Presets

3.4 Captures (Audio & MIDI)

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

4 Hardware

4.1 Audio

Configure soundcards and audio adapters

4.2 Display

Configure the touchscreen display.

4.3 Wiring Layouts

Configure wiring for the encoders/knobs and switches.

5 Software

5.1 Update

Update the Zynthian OS and associated application software.

5.2 Pianoteq

configure the Pianoteq plugin. (enable paid license)

5.3 Plugins

Manage the installed plugins.

6 Interfaces

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

Visit here to Filter/Router

6.1.4 Devices

6.1.5 MIDI Log

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

6.2 User Interface

Customize the user interface.

6.2.1 Colors, Fonts, Sizes, etc.

6.2.2 Restore Status on Startup

6.2.3 Display Log

Display a log of User Interface actions for debugging.

7 System Management

7.1 WIFI

@@ Line 1: / Line 1: @@
-The "Zynthian Web Configuration Tool" is a website hosted inside your Zynthian device. This website allows you to:
+The '''WebConf Tool''' is the ''Zynthian Web Configuration Tool'', a website hosted inside your Zynthian device that allows you to administer, configure, and inspect attributes of your Zynthian.
-* Configure system password
+==Login==
-* Configure WIFI
-* Configure Hardware: wiring layouts, soundcard, display, etc.
-* Configure UI: colors, fonts, sizes, etc.
-* [[Configure MIDI]]
-* Edit snapshot's names
-* Manage library for the different engines => soundfonts, plugins, presets, etc.
-Access the configuration tool by using a web browser on the same network as your Zynthinan device.
+[[File:zynthian_webconf_login.png|right]]
-You need another computer with a browser to access this website inside your Zynthian.
+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).
-Browse to '''http://zynthian.local'''
+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 allowed to connect by WiFi.
-If you your browser can’t find the zynthian.local address, probably you are using a windows version that doesn’t support the link-local feature and you can’t connect your Zynthian box directly to your computer. Don’t worry. You can connect it to your local network and obtain its IP address by using the Network Info option in the admin menu. Browse to '''http://xxx.xxx.xxx.xxx''' (xxx.xxx.xxx.xxx represents the IP address of your Zynthian)
+To access your Zynthian box from your browser, you can use either of these 2 methods:
-Login to webpage
+* 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.
-[[File:ZynLogin.png]]
+* 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'''. Easy!
-Configure Display
+<br clear=all>
-[[File:ZynDisplay.png]]
+==Dashboard==
+[[File:zynthian_webconf_dashboard.png|right]]
-Configure Audio
+The Dashboard displays basic configuration information about your Zynthian.
-[[File:Webconf.png]]
+<br clear=all>
-Configure Wiring for knobs
+==Library==
+The library is where mutiple configuration snapshots, Instrument soundfonts, Presets and Capture files are managed.
-[[File:ZynWiring.png]]
+===Snapshots===
+[[File:WebLibrarySnapshots.png|right]]
+Manage the snapshots (a stored configuration of instruments and settings.)
-Configure MIDI (this screen capture is out of date)
+Bank/Program refers to MIDI Program Change commands that can enable a specific snapshot.
-Also need explanations of what all these options do. MIDIFilter (not shown here) info is at: [[Configure MIDI]]
-[[File:Zynthian MIDI config.jpg]]
+===Soundfonts===
+Soundfonts are files that contain a set of sampled sounds for an instrument.
+===Presets===
+===Captures (Audio & MIDI)===
+Manage files that contain musical performance data that you have captured.
+<br clear=all>
+==Hardware==
+===Audio===
+[[File:zynthian_webconf_hardware_audio.png|right]]
+Configure soundcards and audio adapters
+<br clear=all>
+===Display===
+[[File:zynthian_webconf_hardware_display.png|right]]
+Configure the touchscreen display.
+<br clear=all>
+===Wiring Layouts===
+[[File:zynthian_webconf_hardware_wiring.png|right]]
+Configure wiring for the encoders/knobs and switches.
+<br clear=all>
+==Software==
+===Update===
+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]]
+<br clear=all>
+==Interfaces==
+===MIDI===
+[[File:zynthian_webconf_MIDI.png|right]]
+MIDI configuration page. Setup and store different profiles that are MIDI configurations.
+<br clear=all>
+====Profiles====
+Manage storage of MIDI configuration profiles
+====Options====
+Master Channel, Active Layer, MIDI over Network, Preload Presets on Note, etc.
+====[[Configure_MIDI_Filter/Router|Filter/Router]]====
+Visit here to [[Configure_MIDI_Filter/Router|Filter/Router]]
+<br clear=all>
+====Devices====
+====MIDI Log====
+[[File:MIDILog.png|right]]
+Displays all received MIDI messages. Useful for debugging MIDI connection and configuration.
+<br clear=all>
+===User Interface===
+[[File:zynthian_webconf_ui.png|right]]
+Customize the user interface.
+<br clear=all>
+====Colors, Fonts, Sizes, etc.====
+====Restore Status on Startup====
+====Display Log====
+[[File:UIlog.png|right]]
+Display a log of User Interface actions for debugging.
+<br clear=all>
+==System Management==
+===WIFI===
+[[File:zynthian_webconf_wifi.png|right]]
+<br clear=all>
+===Security/Access===
+===Backups/Restore===
+<br clear=all>