OCube Max Plugin-83 Commands Output Specific

The oCube accepts output-specific commands as listed below.

For the messages sent to the digitizer by the various oCube commands below, see the firmware documentation.

Output-specific commands apply only to the specified inlet and the actuator output it is connected to, if any. Inlets and outputs are numbered starting with 1. The inlet parameter "<inlet>" can be substituted by "<inlet1> - <inlet2>" to specify all inlets from <inlet1> to <inlet2>, which range can be ascending or descending.

Digitizer outputs can operate binary (ie. two-state) actuators, PWM (pulse width modulated) actuators and I2C actuators. Binary actuators are operated by the application of either 0 or 5 V, which then result in either of the two states of the binary actuator. PWM actuators are operated by the application of a repeating pulse of variable width, a special case of which are servos which are usually operated by applying a repeating pulse with an interval of 20 ms and a width between 1 - 2 ms. I2C actuators are operated by setting their method which is implemented by an exchange of pulse trains that represent a series of bytes as commands/messages.

For digital binary actuators the "on" status is represented by logic level value 1, which corresponds to 5 V. The "off" status is represented by logic level value 0, which corresponds to 0 V.

For an I2C actuator the "on" status is implemented as the execution of a method that can be set by sending the "function" command or by sending the "cci" command. The "off" status is implemented as the execution of a method 0.

<inlet> report

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

<inlet> dump <value>

Sends for the specified inlet all the available data stored in the oCube data structure as messages out the status outlet, and if the specified value = 1 reports the same in the Max window.

<inlet> connect <output> (<inlet> assign <output>)

Connects the specified inlet to specified digitizer actuator output. Just like the inlet parameter "<inlet>" can be substituted by "<inlet1> - <inlet2>" to specify all inlets from <inlet1> to <inlet2>, which range can be ascending or descending, the output parameter "<output>" can be substituted by "<output1> - <output2>" to specify a range of outputs, which can also be ascending or descending. Example: "1 - 4 connect 4 - 1" connects inlets 1 thru 4 to outputs 4 thru 1, ie. inlet 1 is connected to output 4 etc.

<inlet> on <duration>

Sends a SET OUTPUT command to the digitizer to turn a digital binary or I2C actuator connected to the output that's connected to the specified inlet on for the specified duration [0..12700] in ms.

<inlet> off <duration>

Sends a SET OUTPUT command to the digitizer to turn a digital binary or I2C actuator connected to the output that's connected to the specified inlet off for the specified duration [0..12700] in ms.

<inlet> toggle <duration>

Sends a SET OUTPUT command to the digitizer to switch the on/off status of a digital binary or I2C actuator connected to the output that's connected to the specified inlet for the specified duration [0..12700] in ms.

<inlet> onoff <duration>

Sends SET OUTPUT commands to the digitizer to immediately turn a digital binary or I2C actuator connected to the output that's connected to the specified inlet on for the specified duration [0..12700] in ms and then to turn it off. If the actuator output is already on, it will be turned off after the specified duration.

<inlet> offon <duration>

Sends SET OUTPUT commands to the digitizer to immediately turn a digital binary or I2C actuator connected to the output that's connected to the specified inlet off for the specified duration [0..12700] in ms and then to turn it on. If the actuator output is already off, it will be turned on after the specified duration.

<inlet> tc <duration> (<inlet> sp <duration>)

Sends a SET OUTPUT INIT command to the digitizer to use threshold control for the actuator output connected to the specified inlet. The actuator output will switch status after the specified duration [0..12700] in ms.

<inlet> rp <pulse_width>

Sends a SET OUTPUT command to the digitizer to set the actuator output connected to the specified inlet, if it is configured for a digital binary actuator, to output repeating pulses with the specified pulse_width [1..127] in milliseconds.

<inlet> cc <value>

Sends a SET OUTPUT INIT command to the digitizer to use the continuous control mode for the actuator output connected to the specified inlet at power up or upon execution of the init command. If it is configured for a digital binary actuator, it will output repeating pulses with the specified value as pulse_width [1..127] in milliseconds. If it is configured for an I2C actuator, it will execute the specified value as method [1..127].

<inlet> oninit <duration> (<inlet> oni <duration>)

Sends a SET OUTPUT INIT command to the digitizer to set the actuator output connected to the "on" status, at power up, reset or upon execution of the init command.

<inlet> offinit <duration> (<inlet> offi <duration>)

Sends a SET OUTPUT INIT command to the digitizer to set the actuator output connected to the "off" status, at power up, reset or upon execution of the init command.

<inlet> tcinit <duration> (<inlet> tci <duration>, <inlet> spi <duration>)

Sends a SET OUTPUT INIT command to the digitizer to use threshold control for the actuator output connected to the specified inlet, at power up, reset or upon execution of the init command. The actuator output will switch status after the specified duration [0..12700] in ms.

<inlet> rpinit <pulse_width> (<inlet> rpi <pulse_width>)

Sends a SET OUTPUT INIT command to the digitizer to set the actuator output connected to the specified inlet, if it is configured for a digital binary actuator, to output repeating pulses with the specified pulse_width [1..127] in milliseconds, at power up or upon execution of the init command.

<inlet> ccinit <value> (<inlet> cci <value>)

Sends a SET OUTPUT INIT command to the digitizer to use the continuous control mode for the actuator output connected to the specified inlet at power up or upon execution of the init command. If it is configured for a digital binary actuator, it will output repeating pulses with the specified value as pulse_width [1..127] in milliseconds. If it is configured for an I2C actuator, it will execute the specified value as method [1..127]. This command also sets the method to be executed when the I2C actuator switches to the "on" status.

<inlet> address <value> (<inlet> da <value>)

Sends a FUNCTION command to the digitizer to set the I2C address of the digital actuator connected to the actuator output which in turn is connected to the specified inlet, to the specified value [0..127].

<inlet> function <value> (<inlet> df <value>)

Sends a FUNCTION command to the digitizer to set the function number of the digital actuator connected to the actuator output which in turn is connected to the specified inlet, to the specified value [0..127].

<inlet> method <value> (<inlet> dm <value>)

Sends a FUNCTION command to the digitizer to set the method number of the digital actuator connected to the actuator output which in turn is connected to the specified inlet, to the specified value [0..127]. This command also sets the method to be executed when the I2C actuator switches to the "on" status.

<inlet> digital <value>
<inlet> cvolt <value>
<inlet> drivem <value>
<inlet> feelvibe <value>
<inlet> seergb <value>

Sends a FUNCTION command to the digitizer to set function number and (if applicable) the I2C address according to the type (as specified by the name of the command) of the actuator connected to the actuator output which in turn is connected to the specified inlet, and its method to the specified value [0..127]. The "digital" command covers binary and PWM (pulse width modulated) actuators and not actuators that use the I2C protocol. The method value is ignored in case of the "digital" command. This command also sets the method to be executed when the I2C actuator switches to the "on" status.