ICube Max Plugin-40 Commands

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 is system-wide, and not only 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 arguments 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.

System-wide commands

version (0 version)

Reports the iCube version and, if available, digitizer version in the Max window.

reset (0 reset)

Initializes the iCube data structure as per the init command if the digitizer is in host mode, and sends a RESET command to the digitizer. If the connected digitizer is reset by other software, iCube will re-upload its configuration to the digitizer.

init (0 init)

Initializes the iCube data structure to the default settings as specified below.

System-wide:

• interval: 10 for firmwares greater than 5.1 and smaller than 6.0, greater than 6.2 and smaller than 7.0, or greater than 7.1, and 100 for other firmwares
• mute: 0, ie. off
• id: 0
• digid: 0

Input-specific:

• connect: connect each outlet to the sensor input with the same number
• stream: 0, ie. off
• inmin: 0 (sensor input minimum voltage)
• inmax: 5 (sensor input maximum voltage)
• min: 0
• max: 5
• res: 1/1024 for all digitizers except the Digitizer, or 1/4096 for Digitizer
• steps: 1024 for all digitizers except the Digitizer, or 4096 for Digitizer
• noise: 1/(steps - 1) in host mode, or 0 in standalone mode
• smooth: 0
• unit: 5/(steps - 1)
• offset: 0
• preset: 1
• address: 0
• function: 0, ie. analog sensor with voltage output
• method: 0

sync (0 sync)

Retrieves all the configuration information from the digitizer and stores it in the iCube data structure. Use the report command to display the information. If multiple iCube objects are connected to the same digitizer, only one object needs to be sent the sync command to sync all objects to the digitizer.

digid <value> (setdigid <value>, 0 digid <value>)

Sends a SET ID command to the digitizer to set the digitizer's System Exclusive ID to the specified value [0..126]. This command is only useful when connected with digitizers that are serially connected via MIDI cables using the digitizer's MIDI thru function, allowing each digitizer to be identified via the MIDI ports.

id <value> (0 id <value>)

Sets the iCube to respond to and send System Exclusive messages with the System Exclusive ID equal to the specified value [0..126]. This command is only useful when connected with digitizers that are serially connected via MIDI cables using the digitizer's MIDI thru function, allowing each digitizer to be identified via the MIDI ports.

host (0 host, 0 hostmode)

Sends a SET MODE command to the digitizer to set it to host mode.

standalone (0 standalone, 0 standalonemode)

Sends a SET MODE command to the digitizer to set it to standalone mode.

mode <value> (0 mode <value>)

Sends a SET MODE command to the digitizer to set to its mode to the specified value [0..1] (0 is host mode, 1 is standalone mode).

interval <value> (0 interval <value>)

Sends an INTERVAL command to the digitizer to set its sampling interval to the specified value [1..16383] in milliseconds.

rate <value> (0 rate <value>)

Sends an INTERVAL command to the digitizer to set its sampling rate to the specified value [0.000061 ..1000] in Hz. the sampling rate setting may not be accurate as it actually sets the sampling interval, which doesn't include the time the digitizer firmware takes to acquire, process and output sensor data. Use the intervalmarking command to obtain more accurate sampling rate information.

mute <value> (0 mute <value>)

Sends an SET MUTE command to the digitizer to set its mute status to the specified value [0..1] (0 is off, 1 is on).

report (0 report, print, 0 print)

Reports all the available data stored in the iCube data structure in the Max window.

verbose <value> (0 verbose)

Sets what kind of messages are printed in the Max window, according to the specified value [0..3]:

• 0: no messages
• 1: confirmation messages
• 2: confirmation and error messages
• 3: all messages

help (0 help)

Display the URL of the main page about iCube on this support wiki in the Max window.

thru <value> (0 thru <value>)

Sends a THRU command to the digitizer, if it is a microDig, miniDig or Digitizer, to set the MIDI thru status to the specified value [0..1] (0 is off, 1 is on).

midiout <value> (0 midiout <value>)

Sends a MIDIOUT command to the digitizer, if it is a USB-microDig, to set the MIDI out port status to the specified value [0..1] (0 is off, 1 is on). This command enables the USB-microDig to be used with a USB-microMIDICable.

power (0 power)

Sends a POWER command to the digitizer, if it is a USB-microDig (with firmware v7.0), Wi-microDig or microDig to request the whether the voltage level of the power supply for the sensors is normal (0) or too low (1).

battery (0 battery)

Sends a BATTERY command to the digitizer, if it is a Wi-microDig to request the battery voltage level.

smc_clear (0 smc_clear)

Sends a CLEAR CONFIG command to the digitizer to set its standalone mode configuration (SMC) to default values.

runningstatus <value> (0 runningstatus)

Sends a RUNNING STATUS or MIDI STATUS (depending on the digitizer's firmware) command to the digitizer to set its MIDI running status to the specified value [0..1] (0 is on, 1 is off).

activesensing <value> (0 activesensing <value>)

Sends a RUNNING STATUS or MIDI STATUS (depending on the digitizer's firmware) command to the digitizer to set its MIDI active sensing status to the specified value [0..1] (0 is off, 1 is on).

intervalmarking <value> (0 intervalmarking <value>)

Sends a RUNNING STATUS or MIDI STATUS (depending on the digitizer's firmware) command to the digitizer to set its interval marking status to the specified value [0..1] (0 is off, 1 is on).

Input-specific commands

Input-specific commands apply only to the specified outlet and the sensor input it is connected to, if any. Outlets and inputs are numbered starting with 1. 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.

<outlet> reset

Initializes the iCube data structure for the specified outlet to the default values and, if the digitizer is in standalone mode, sends a CONFIG command to the digitizer with default values.

<outlet> init

Initializes the iCube data structure for the specified outlet to the default values.

<outlet> connect <input> (<outlet> assign <input>)

Connects the specified outlet to specified digitizer sensor input. Just like 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, the input parameter "<input>" can be substituted by "<input1> - <input2>" to specify a range of inputs, which can also be ascending or descending. Example: "1 - 4 connect 4 - 1" connects outlets 1 thru 4 to inputs 4 thru 1, ie. outlet 1 is connected to input 4 etc.

<outlet> stream <value>

Sends a STREAM command to the digitizer to set the sensor input connected to the specified outlet to the specified value [0..1] (0 is off, 1 is on). if the digitizer is in standalone mode, to turn on a sensor input the processing for the input must also be set to a value such that the input processes sensor values in continuous or peak mode. See also the smc_processing command.

<outlet> on

Sends a STREAM command to the digitizer to enable the sensor input connected to the specified outlet and, if the digitizer is in standalone mode and if processing for the sensor input connected to the specified outlet is off, sends a CONFIG command to the digitizer to set processing to continuous.

<outlet> off

Sends a STREAM command to the digitizer to disable the sensor input connected to the specified outlet.

<outlet> sample

Sends a SAMPLE command to the digitizer to request the latest value of the sensor connected to the sensor input which in turn is connected to the specified outlet.

<outlet> res <value>

Sends a RES command to the digitizer to set the resolution of the sensor input connected to the specified outlet to the specified value [0..1] (0 is low, 1 is high). This command is only applicable to analog sensors. The low resolution is 7-bit (ie. 1/127 = 0.00787), the high resolution is 10-bit (ie. 1/1023 = 0.000978) for all digitizers except the Digitizer which high resolution value is 12-bit (ie. 1/4095 = 0.000244).

<outlet> address <value>

Sends a FUNCTION command to the digitizer to set the I2C device id of the digital sensor connected to the sensor input which in turn is connected to the specified outlet to the specified value [0..127].

<outlet> function <value> (<outlet> func <value>)

Sends a FUNCTION command to the digitizer to set the function number of the digital sensor connected to the sensor input which in turn is connected to the specified outlet to the specified value [0..127].

<outlet> method <value>

Sends a FUNCTION command to the digitizer to set the method number of the digital sensor connected to the sensor input which in turn is connected to the specified outlet to the specified value [0..127].

<outlet> analog, biobeat3d, hotspot2d, magnetic3d, moist3d, movealong, movearound, orient3d, orient4d, reachclosed, reachid, swipe3d <value>

Sends a FUNCTION command to the digitizer to set the I2C device id and function number according to the type (as specified by the name of the command) of the digital sensor connected to the sensor input which in turn is connected to the specified outlet, and its method to the specified value [0..127].

<outlet> inmin <value>

Sets the iCube to discard sensor values received for the sensor input connected to the specified outlet when it is lower than the specified value, and scale sensor values between the inmin and inmax values to the min and max values set by the inmax, min and max commands. The inmin and inmax commands are used to match the digitizer's sensor input range to sensor's output range. If the digitizer's sensor input is configured for an analog sensor that outputs a voltage, for more accurate results, it may be necessary to calibrate inmax and inmax to the actual digitizer's sensor input voltage range by using a volt meter and measuring the voltage supplied by the digitizer to the sensor(s). The default voltage input range assumed by iCube is 0-5V. In the case of analog sensors, the specified value range is the input voltage range, ie. [0..5] or, if the outlet is configured to output raw sensor data, the range of the digital representation of the digitizer's input voltage range, eg. [0..1023] for a USB/Wi-microDig which has 10 bit resolution analog to digital converters. In the case of digital (I2C) sensors, the specified value range is determined by the sensor.

<outlet> inmax <value>

Sets the iCube to discard sensor values received for the sensor input connected to the specified outlet when it is higher than the specified value, and scale sensor values between the inmin and inmax values to the min and max values set by the inmin, min and max commands. The inmin and inmax commands are used to match the digitizer's sensor input range to the sensor's output range. If the digitizer's sensor input is configured for an analog sensor that outputs a voltage, for more accurate results, it may be necessary to calibrate inmax and inmax to the actual digitizer's sensor input voltage range by using a volt meter and measuring the voltage supplied by the digitizer to the sensor(s). The default voltage input range assumed by iCube is 0-5V, but the actual voltage range is likely slightly less than 5 volt. Use the inmax command to calibrate the actual voltage range by measuring the voltage supplied to the sensors by the digitizer. In the case of analog sensors, the specified value range is the input voltage range, ie. [0..5] or, if the outlet is configured to output raw sensor data, the range of the digital representation of the digitizer's input voltage range, eg. [0..1023] for a USB/Wi-microDig which has 10 bit resolution analog to digital converters. In the case of digital (I2C) sensors, the specified value range is determined by the sensor.

<outlet> unit <value>

Sets the iCube to multiply each sensor value received from the sensor input connected to the specified outlet by the specified value so that the output value is in the specified unit of measurement. By default set to the voltage resolution of the digitizer, ie. 5 / 1023 = 0.004888 for a digitzer with 10-bit resolution such as the USB-/Wi-microDig. Note that the actual voltage range is likely slightly less than 5 volt. Use the inmax command to calibrate the actual voltage range by measuring the voltage supplied to the sensors by the digitizer.

<outlet> offset <value>

Sets the iCube to add the specified value to the sensor value received from the sensor input connected to the specified outlet. This may be useful for offsetting a sensor value so that it matches the expected output value in physical units of measurement. By default set to 0.

<outlet> min <value>

Sets the iCube to scale sensor values received for the sensor input connected to the specified outlet to a range with the minimum set by the specified value.

<outlet> max <value>

Sets the iCube to scale sensor values received for the sensor input connected to the specified outlet to a range with the maximum set by the specified value.

<outlet> steps <value> (<outlet> step <value>)

Sets the iCube to divide the output range of the specified outlet into the number of values as per the specified value, which is at most the inverse of the resolution of the sensor value.

<outlet> normal <value>

Sets the iCube to scale sensor values received from the sensor input connected to the specified outlet using the min and max settings to the range {0 .. <value>} if the specified value is greater than zero, or {-<value> .. <value>} if the specified value is smaller than zero.

<outlet> noise <value>

Sets the iCube to only output sensor values received from the sensor input connected to the specified outlet if the value is greater or equal than the specified value.

<outlet> smooth <value>

Sets the iCube to apply an exponential moving average filter to the sensor value received from the sensor input connected to the specified outlet with the level of the filter as per the specified value [0..100]. A higher specified value increases the smoothing.

<outlet> preset <value>

Sets the iCube to select a a preset according to the specified value:

• 0: output raw data, ie. output the sensor values as they were received from the digitizer input.
• 1: output values scaled to the range {0..5}
• 2: output values scaled to the range {-1..1}
• 3: output values scaled to the range {0..1}
• 4: output values scaled to the range {0..10}
• 5: output values scaled to the range {0..100}
• 6: output values scaled to the range {0..127}
• 7: output values scaled to the range {0..1023}
• 8: output values scaled to the range {0..4095}
• 9: output values scaled to the range {0..16383}

<outlet> raw

Sets the iCube to output raw data, ie. output the sensor values received from the sensor input connected to the specified outlet as they were received from the sensor input.

Input-specific commands for standalone mode configuration (SMC)

Outlets and inputs are numbered starting with 1.

<outlet> smc_clear

Sends a CONFIG command to the digitizer to set the standalone mode configuration (SMC) of the sensor input connected to the specified outlet to default values.

<outlet> smc_cvmheader <value>

Sends a CONFIG command to the digitizer to set the Channel Voice MIDI header byte of the standalone mode configuration (SMC) of the sensor input connected to the specified outlet according to the specified value [128..239].

<outlet> smc_cvmdata <value>

Sends a CONFIG command to the digitizer to set the Channel Voice MIDI data byte of the standalone mode configuration (SMC) of the sensor input connected to the specified outlet according to the specified value [0..127].

<outlet> smc_processing <value>

Sends a CONFIG command to the digitizer to set the processing of the standalone mode configuration (SMC) of the sensor input connected to the specified outlet according to the specified value [0..63].

<outlet> smc_threshold <value>

Sends a CONFIG command to the digitizer to set the threshold of the standalone mode configuration (SMC) of the sensor input connected to the specified outlet according to the specified value [0..127]. The threshold function as executed by the digitizer firmware implements similar signal processing as the function controlled by the inmin command but executed by iCube on the host computer.

<outlet> smc_ceiling <value>

Sends a CONFIG command to the digitizer to set the ceiling of the standalone mode configuration (SMC) of the sensor input connected to the specified outlet according to the specified value [0..127]. The ceiling function as executed by the digitizer firmware implements similar signal processing as the function controlled by the inmax command but executed by iCube on the host computer.

<outlet> smc_noisegate <value>

Sends a CONFIG command to the digitizer to set the noisegate of the standalone mode configuration (SMC) of the sensor input connected to the specified outlet according to the specified value [0.5..64] unless PitchBend mapping is selected (ie. the MIDI header byte is greater than 224), in which case the range is [4..512]. The noisegate function as executed by the digitizer firmware implements similar signal processing as the function controlled by the noise command but executed by iCube on the host computer.

<outlet> smc_smoothing <value>

Sends a CONFIG command to the digitizer to set the smoothing of the standalone mode configuration (SMC) of the sensor input connected to the specified outlet according to the specified value [0..7].

<outlet> smc_time <value>

Sends a CONFIG command to the digitizer to set the time window of the standalone mode configuration (SMC) of the sensor input connected to the specified outlet according to the specified value [1..16].

<outlet> smc_constant <value>

Sends a CONFIG command to the digitizer to set the constant value of the standalone mode configuration (SMC) of the sensor input connected to the specified outlet according to the specified value [7..127], in steps of 8 for digitizers with firmware greater than 7.2 or (greater than 6.2 and smaller than 7.0) or (greater than 5.2 and smaller than 6.0). For all other digitizers the range is [15..127], in steps of 16.