366
edits
Changes
Jump to navigation
Jump to search
mLine 1,612:
Line 1,612: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
→AidaX
===AidaX===
===AidaX===
==CUIA: Callable UI Actions==
The Zynthian UI can be controlled remotely using a set of commands called CUIA: Callable UI Actions. These CUIAs are available on several interfaces: Key Bindings, MIDI, OSC, etc.
==Key Bindings: Controlling the UI with a computer keyboard==
[[File:webconf_key_bindings.png|600px|right]]
The user interface may be driven using a computer keyboard (QWERTY, Dvorak, etc.). Key assignment map can be consulted and configured from the webconf tool:
'''Interface->UI Key Binding'''
Zynthian has default keybinding for a standard (UK) QWERTY keyboard that maps logically to V4 encoders:
‘<’ (actually ‘,’) represents counter-clockwise encoder rotation.
‘>’ (actually ‘.’) represents clockwise encoder rotation.
Without any modifiers these operate on encoder 4 (bottom right on V4).
Adding ‘Ctrl’ modifier will operate on left encoders on V4.
Adding 'Shift will operate on the top encoders on V4.
The four keys (in a square) above these operate as the push switches:
‘i’ is switch 1 (top left).
‘k’ is switch 2 (bottom left).
‘o’ is switch 3 (top right).
‘l’ is switch 4 (bottom right).
Of course this mapping makes sense on keyboards that have those button grouped in the bottom right of the keyboard and for users familiar with V4 layout but they do work well.
<br clear=all>
==Controlling the UI with MIDI messages==
CUIA may be triggered by MIDI messages on the Master Channel (disabled by default, but configurable with the webconf tool), specifically, note-on messages (0x9) are used so you can use a MIDI keyboard for controlling the Zynthian UI. For instance, to Power Off the Zynthian, you send this message:
0x9F (Channel 16 Note ON)
0x00 (Note code for POWER_OFF as below)
0x00 (Velocity / parameter)
or play the C-0 key, if your keyboard has it.
Please, note that you can use the velocity for sending the first CUIA parameter when it's required by the action (for instance, SELECT or CHAIN_CONTROL).
[[File:webconf_midi_options_master_key_actions.png|600px|right]]
You can check the map of MIDI-CUIA actions in the webconf tool:
'''Interface->MIDI-options->Master Key Actions'''
From there, you can also reconfigure the map to better suit your needs.
For a detailed list of available CUIAs, [[Accessing Zynthian from your computer#CUIA:_Callable_User_Interface_Actions|check this section]].
<br clear=all>
==Controlling the UI with OSC (Open Sound Control) messages==
CUIA may be triggered using OSC (Open Sound Control protocol) on UDP port 1370, with the path prefix "/cuia", e.g. "/cuia/reboot". Take a look at "[[Accessing_Zynthian_from_your_computer#OSC|Calling CUIA with OSC]]".
Also see [https://en.wikipedia.org/wiki/Open_Sound_Control Open Sound Control] at Wikipedia and [https://youtu.be/rf8YNPjVvF4 this explanatory video] for more information about the protocol.
==Software Version==
==Software Version==