Difference between revisions of "Configuration Users Guide"

From ZynthianWiki
Jump to: navigation, search
(MIDI)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
The '''WebConf Tool''' is the ''Zynthian Web Configuration Tool'', a web interface hosted inside your Zynthian device that 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.
  
 
==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).
  
For connecting your Zynthian Box to your local network you can use an ethernet cable connected from your router to your Zynthian Box. Also, if the 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 allowed to connect by WiFi.  
  
For addressing your Zynthian box from your browser, you can use this 2 methods:
+
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 doesn't fully support the [https://en.wikipedia.org/wiki/Multicast_DNS mDNS] protocol.
+
* 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'''. Easy!
Line 18: Line 18:
  
 
==Dashboard==
 
==Dashboard==
 
 
[[File:zynthian_webconf_dashboard.png|right]]
 
[[File:zynthian_webconf_dashboard.png|right]]
 +
 +
The Dashboard displays basic configuration information about your Zynthian.
  
 
<br clear=all>
 
<br clear=all>
+
 
 
==Library==
 
==Library==
 +
The library is where mutiple configuration snapshots, Instrument soundfonts, Presets and Capture files are managed.
  
 
===Snapshots===
 
===Snapshots===
 +
[[File:WebLibrarySnapshots.png|right]]
 +
Manage the snapshots (a stored configuration of instruments and settings.)
 +
 +
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===
 
===Presets===
  
 
===Captures (Audio & MIDI)===
 
===Captures (Audio & MIDI)===
 +
Manage files that contain musical performance data that you have captured.
  
 
<br clear=all>
 
<br clear=all>
Line 38: Line 46:
  
 
===Audio===
 
===Audio===
 
 
[[File:zynthian_webconf_hardware_audio.png|right]]
 
[[File:zynthian_webconf_hardware_audio.png|right]]
 +
 +
Configure soundcards and audio adapters
  
 
<br clear=all>
 
<br clear=all>
  
 
===Display===
 
===Display===
 
 
[[File:zynthian_webconf_hardware_display.png|right]]
 
[[File:zynthian_webconf_hardware_display.png|right]]
 +
 +
Configure the touchscreen display.
  
 
<br clear=all>
 
<br clear=all>
  
 
===Wiring Layouts===
 
===Wiring Layouts===
 
 
[[File:zynthian_webconf_hardware_wiring.png|right]]
 
[[File:zynthian_webconf_hardware_wiring.png|right]]
 
+
Configure wiring for the encoders/knobs and switches.
Controllers/knobs/switches
+
  
 
<br clear=all>
 
<br clear=all>
Line 60: Line 68:
  
 
===Update===
 
===Update===
 +
 +
Update the Zynthian OS and associated application software.
  
 
===Pianoteq===
 
===Pianoteq===
 +
configure the Pianoteq plugin. (enable paid license)
  
 
===Plugins===
 
===Plugins===
 +
Manage the installed plugins.
  
 
[[File:zynthian_webconf_software_plugins.png|center]]
 
[[File:zynthian_webconf_software_plugins.png|center]]
Line 69: Line 81:
 
<br clear=all>
 
<br clear=all>
  
==Interface==
+
==Interfaces==
  
 
===MIDI===
 
===MIDI===
 
 
[[File:zynthian_webconf_MIDI.png|right]]
 
[[File:zynthian_webconf_MIDI.png|right]]
 +
MIDI configuration page. Setup and store different profiles that are MIDI configurations.
 +
 +
<br clear=all>
  
 
====Profiles====
 
====Profiles====
 +
Manage storage of MIDI configuration profiles
  
 
====Options====
 
====Options====
Line 82: Line 97:
  
 
====[[Configure_MIDI_Filter/Router|Filter/Router]]====
 
====[[Configure_MIDI_Filter/Router|Filter/Router]]====
 +
Visit here to [[Configure_MIDI_Filter/Router|Filter/Router]]
  
 +
<br clear=all>
 
====Devices====
 
====Devices====
  
<br clear=all>
+
====MIDI Log====
 
+
[[File:MIDILog.png|right]]
 
Displays all received MIDI messages. Useful for debugging MIDI connection and configuration.
 
Displays all received MIDI messages. Useful for debugging MIDI connection and configuration.
[[File:MIDILog.png|right]]
 
  
===User Interface===
+
<br clear=all>
  
 +
===User Interface===
 
[[File:zynthian_webconf_ui.png|right]]
 
[[File:zynthian_webconf_ui.png|right]]
 +
Customize the user interface.
  
 
<br clear=all>
 
<br clear=all>
Line 99: Line 117:
  
 
====Restore Status on Startup====
 
====Restore Status on Startup====
 +
 +
====Display Log====
 +
[[File:UIlog.png|right]]
 +
Display a log of User Interface actions for debugging.
  
 
<br clear=all>
 
<br clear=all>

Latest revision as of 22: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.

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


Dashboard

Zynthian webconf dashboard.png

The Dashboard displays basic configuration information about your Zynthian.


Library

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

Snapshots

WebLibrarySnapshots.png

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


Hardware

Audio

Zynthian webconf hardware audio.png

Configure soundcards and audio adapters


Display

Zynthian webconf hardware display.png

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

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


Devices

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.


Colors, Fonts, Sizes, etc.

Restore Status on Startup

Display Log

UIlog.png

Display a log of User Interface actions for debugging.


System Management

WIFI

Zynthian webconf wifi.png


Security/Access

Backups/Restore