MX Terminal Files

MX Terminal
Author: Paul Vannatto  (donations accepted at paypal.me/PVannatto)
Licence: GPL 3.0
OS Platform: Windows, linux, RPi, OSX
Version: 1.08

* Please see the "Revisions.txt", "English Commands Supplement.pdf" or "MX Terminal User Manual.pdf" for details

Overview
MX Terminal is a terminal emulator based on the old XTerm DOS program, but customized to provide a text based interface for the Music Group OSC protocol. This protocol is the "mother tongue" of the ever popular X32, M32, X-Air and M-Air digital consoles. Unfortunately many users are put off by the odd command syntax and never attempt to control the console using these commands. MX Terminal is an attempt to provide a non-graphical interface with easier to understand (and remember) English words and syntax.

This app was initially conceived when a request by Jim Noseworthy was posted on the Music Group's forum asking for some kind of interface for the blind. Because all of the current apps (both official and 3rd party) were graphical in nature, nothing current would work correctly with the screen readers that the blind community frequently use. A text based interface was required. Thus MX Terminal was born.

Overview:
* Optional words (to, by, for, current, db, hz, %, ,ms, millisecond, milliseconds, sec, second, seconds) can be interspersed in the command line.
* All commands are case insensitive.
* Command scope can be single, range or non-consecutive list (eg. 1,3,5-8)
* Hit enter at the end of the command line to send to the console
* Command groups available:
    OSC commands
	Live Toolbox tidbit commands
	MX Terminal commands
	English commands

* OSC commands - the actual OSC protocol commands, extensively documented by Patrick-Gilles Maillot can be used at any time in MX Terminal. This provides complete control of the console.

* Live Toolbox tidbit commands - Since MX Terminal is based on Live Toolbox OSC engine, it also has access to all tidbit commands. These can be found in the new English Commands Supplement.pdf (pages 35-40)

* MX Terminal commands - to help setup the app as desired.

* English commands - These are a work in progress with many more to come. This provides a simple means of writing OSC commands, but in English.

For example: Instead of writing
	/ch/03/mix/fader ,f 0.75
the user could write
	Set channel 3 fader to 0
which would move channel 3 fader to 0 db

Details are available in the "English Commands Supplement.pdf"

Details:

Terminal commands:
* Get version  - gets MXTerminal version #
* Connect  - same as search, searches for the console and connects
* Connect <IP> <Port>  - connects to the console at IP, Port. Simple connect functions as search
* Search <Port>  - searches for the console and connects (port is optional)
* Disconnect  - disconnect from the console
* Real - get or set real world return values. This is in contrast to the OSC values
* TTS - get or set TTS (text to speech) of return values
  (for visually impaired community)
* Family - get or set console family (X32 or X-Air)
         - important for setting default IP and OSC command set
* Close  - close MXTerminal

Example:
  Set TTS on - turns on text to speech
  Set real on  - turns on real world return values conversion
  Connect 192.169.0.188  - connects to mixer with IP 192.169.0.188
  Connect 192.169.0.188 10024  - connects to an M/X-Air mixer with IP 192.169.0.188

English Translation (of OSC commands):

Tier 1 Commands:
* Get - gets current setting in the console
* Set - sets the console to specified setting
* Toggle - Toggles through a list of values, ON/OFF, etc.
* Increase - increases value relative to current value
* Decrease - decreases value relative to current value
* Raise/Lower - Raises or lowers the value(s).
  Using “to” before the value makes it absolute.
  Using “by” before the value makes it relative.

Examples:
  Get channel 12 color  - will get the color of channel 12
  Set channel 5 fader to -10  - will move fader to -10 db
  Increase channel 7 pan by 10  - will increase pan by 10%
  Decrease bus 3 fader by 15  - will decrease bus 3 master fader by 15 db
  Get channel 4 send 3 fader  - will get the current fader level of channel 4 send 3
  Set channel 7 send 2 pan to -15  - will set the pan of channel 7 send 2 to -15%
  Get channel 3-4 link  - will get the link status of channels 3-4
  Set bus 1-2 link to on - will turn on bus 1-2 link
  Get mixer  - gets the current mixer setting
  Set mixer to XR18  - sets mixer setting to XR18

Tidbit commands
Examples:
  Fade channel 5 4 -10   - fade channel 5 over 4 seconds to -10 db

OSC commands (see "parameters.txt" and "X32 OSC Protocol")
Examples:
  /ch/03/config/name ,s "Vocal Paul"  - set channel 3 name to "Vocal Paul"