Difference between revisions of "ICube Max Plugin-40 Commands"
| Line 20: | Line 20: | ||
iCube takes 4 optional arguments. Arguments are entered after the name "iCube" with spaces between each argument. If no arguments are given, the iCube object will default to 8 outlets (virtual outputs) and the MIDI System Exclusive Device ID will default to 0. The first argument indicates the number of outlets. If the first argument is not in the range [0..32] an error message will be shown in the Max window as well as output via the message outlet. The second argument indicates the MIDI System Exclusive Device ID (which must match the System Exclusive Device ID of a connected digitizer in order to work). If only one argument is provided or if the second argument is less than zero, the System Exclusive Device ID defaults to 0 and an error message will be shown in the Max window as well as output via the message outlet. The third argument (a string with at most 99 characters) can be used to identify messages from the iCube object instance in the Max window. It can be left empty by typing " " (a space with two double quotes). The fourth argument specifies the digitizer firmware (where eg. firmware v7.5 is entered as "75"). If no firmware is specified, iCube will assume default digitizer specs (maximum 32 inputs, maximum 12-bit resolution, minimum 0 ms sample interval and System Exclusive Device ID 0) and will try to identify the digitizer upon receipt of the first MIDI byte. See also the <u>version</u> command. If the fourth argument is -1 the iCube object will execute the sync command upon instantiation. | iCube takes 4 optional arguments. Arguments are entered after the name "iCube" with spaces between each argument. If no arguments are given, the iCube object will default to 8 outlets (virtual outputs) and the MIDI System Exclusive Device ID will default to 0. The first argument indicates the number of outlets. If the first argument is not in the range [0..32] an error message will be shown in the Max window as well as output via the message outlet. The second argument indicates the MIDI System Exclusive Device ID (which must match the System Exclusive Device ID of a connected digitizer in order to work). If only one argument is provided or if the second argument is less than zero, the System Exclusive Device ID defaults to 0 and an error message will be shown in the Max window as well as output via the message outlet. The third argument (a string with at most 99 characters) can be used to identify messages from the iCube object instance in the Max window. It can be left empty by typing " " (a space with two double quotes). The fourth argument specifies the digitizer firmware (where eg. firmware v7.5 is entered as "75"). If no firmware is specified, iCube will assume default digitizer specs (maximum 32 inputs, maximum 12-bit resolution, minimum 0 ms sample interval and System Exclusive Device ID 0) and will try to identify the digitizer upon receipt of the first MIDI byte. See also the <u>version</u> command. If the fourth argument is -1 the iCube object will execute the sync command upon instantiation. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 05:09, 13 March 2018
The iCube Max plugin responds to the commands listed below, sent to it using a Max message object.
Commands can be sent while the digitizer is in host or standalone mode, with sensor data being output in either mode.
The command format has the general form "<outlet> <command> <value>", where <outlet> is a value between 0 and 32, and where <value> can be a float as well as an integer and is not required for all commands. If the outlet value is 0 it signifies the command applies system-wide, and not only for a specific input. All other values specified for <outlet> refer to the iCube outlet with the same number. Multiple commands can be entered as one message, ie. without commas between each command. The outlet parameter "<outlet>" can be substituted by "<outlet1> - <outlet2>" to specify all outlets from <outlet1> to <outlet2>, which range can be ascending or descending.
If a command has aliases they are listed following the command, in brackets and separated by commas.
Commands that in turn send commands as System Exclusive MIDI messages to the digitizer refer to the firmware command in capitals. More information about the command can be found in the applicable firmware section on this support wiki.
For each command (sent or received) messages are output via the message outlet that provides confirmation or reports an error. These messages can be used for eg. debugging or the sequential timing of communication with the digitizer.
Arguments
iCube takes 4 optional arguments. Arguments are entered after the name "iCube" with spaces between each argument. If no arguments are given, the iCube object will default to 8 outlets (virtual outputs) and the MIDI System Exclusive Device ID will default to 0. The first argument indicates the number of outlets. If the first argument is not in the range [0..32] an error message will be shown in the Max window as well as output via the message outlet. The second argument indicates the MIDI System Exclusive Device ID (which must match the System Exclusive Device ID of a connected digitizer in order to work). If only one argument is provided or if the second argument is less than zero, the System Exclusive Device ID defaults to 0 and an error message will be shown in the Max window as well as output via the message outlet. The third argument (a string with at most 99 characters) can be used to identify messages from the iCube object instance in the Max window. It can be left empty by typing " " (a space with two double quotes). The fourth argument specifies the digitizer firmware (where eg. firmware v7.5 is entered as "75"). If no firmware is specified, iCube will assume default digitizer specs (maximum 32 inputs, maximum 12-bit resolution, minimum 0 ms sample interval and System Exclusive Device ID 0) and will try to identify the digitizer upon receipt of the first MIDI byte. See also the version command. If the fourth argument is -1 the iCube object will execute the sync command upon instantiation.
