Difference between revisions of "Configuration Users Guide"

From ZynthianWiki
Jump to: navigation, search
(Snapshots)
(System Management)
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
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.
+
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.
  
 
==Login==
 
==Login==
Line 5: Line 5:
 
[[File:zynthian_webconf_login.png|right]]
 
[[File:zynthian_webconf_login.png|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).
+
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 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:
 
To access your Zynthian box from your browser, you can use either of these 2 methods:
Line 13: Line 13:
 
* 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'''. 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'''. Easy!
+
* 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>
 
<br clear=all>
Line 25: Line 25:
  
 
==Library==
 
==Library==
 +
The library is where multiple configuration snapshots, Instrument soundfonts, Presets, and Capture files are managed.
  
 
===Snapshots===
 
===Snapshots===
 
[[File:WebLibrarySnapshots.png|right]]
 
[[File:WebLibrarySnapshots.png|right]]
Manage the snapshots (a stored configuration of instruments and settings.)
+
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.
 
Bank/Program refers to MIDI Program Change commands that can enable a specific snapshot.
  
 
===Soundfonts===
 
===Soundfonts===
Soundfonts are files that contain a set of sampled sounds for an instrument.
 
  
===Presets===
+
Soundfonts are files which contain a set of sampled sounds for an instrument.
  
 
===Captures (Audio & MIDI)===
 
===Captures (Audio & MIDI)===
Line 47: Line 47:
 
[[File:zynthian_webconf_hardware_audio.png|right]]
 
[[File:zynthian_webconf_hardware_audio.png|right]]
  
Configure soundcards and audio adapters
+
This page lets you configure your sound cards and audio adapters  
  
 
<br clear=all>
 
<br clear=all>
Line 54: Line 54:
 
[[File:zynthian_webconf_hardware_display.png|right]]
 
[[File:zynthian_webconf_hardware_display.png|right]]
  
Configure the touchscreen display.
+
This is where you can configure the touchscreen display.
  
 
<br clear=all>
 
<br clear=all>
Line 67: Line 67:
  
 
===Update===
 
===Update===
 +
 +
Update the Zynthian OS and associated application software.
  
 
===Pianoteq===
 
===Pianoteq===
Line 79: Line 81:
  
 
==Interfaces==
 
==Interfaces==
 +
 +
This is where you configure the various interfaces in your Zynthian
  
 
===MIDI===
 
===MIDI===
Line 97: Line 101:
  
 
<br clear=all>
 
<br clear=all>
====Devices====
 
  
 
====MIDI Log====
 
====MIDI Log====
Line 111: Line 114:
 
<br clear=all>
 
<br clear=all>
  
====Colors, Fonts, Sizes, etc.====
 
  
====Restore Status on Startup====
+
====UI Log====
 
+
====Display Log====
+
 
[[File:UIlog.png|right]]
 
[[File:UIlog.png|right]]
 
Display a log of User Interface actions for debugging.
 
Display a log of User Interface actions for debugging.
Line 124: Line 124:
  
 
===WIFI===
 
===WIFI===
 +
 +
This page allows your to connect to WiFi networks, as well as manage stored connections.
  
 
[[File:zynthian_webconf_wifi.png|right]]
 
[[File:zynthian_webconf_wifi.png|right]]
  
<br clear=all>
 
 
===Security/Access===
 
===Backups/Restore===
 
 
 
<br clear=all>
 
<br clear=all>

Latest revision as of 15:47, 13 January 2020

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.

Login

Zynthian webconf login.png

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


Dashboard

Zynthian webconf dashboard.png

The Dashboard displays basic configuration information about your Zynthian.


Library

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

Snapshots

WebLibrarySnapshots.png

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.

Soundfonts

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

Captures (Audio & MIDI)

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


Hardware

Audio

Zynthian webconf hardware audio.png

This page lets you configure your sound cards and audio adapters


Display

Zynthian webconf hardware display.png

This is where you can configure the touchscreen display.


Wiring Layouts

Zynthian webconf hardware wiring.png

Configure wiring for the encoders/knobs and switches.


Software

Update

Update the Zynthian OS and associated application software.

Pianoteq

configure the Pianoteq plugin. (enable paid license)

Plugins

Manage the installed plugins.

Zynthian webconf software plugins.png


Interfaces

This is where you configure the various interfaces in your Zynthian

MIDI

Zynthian webconf MIDI.png

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


Profiles

Manage storage of MIDI configuration profiles

Options

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

Filter/Router

Visit here to Filter/Router


MIDI Log

MIDILog.png

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


User Interface

Zynthian webconf ui.png

Customize the user interface.



UI Log

UIlog.png

Display a log of User Interface actions for debugging.


System Management

WIFI

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

Zynthian webconf wifi.png