OCube Max Plugin-41 Commands Output Specific

The oCube accepts output-specific commands as listed below.

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 the exchange of pulse trains that represent a series of bytes as commands/messages.

For a binary actuator "on" means the state corresponding to logic level "1", ie. when applying 5 V, and "off" means the state corresponding to logic level "0", ie. when applying 0 V. For an I2C actuator "on" and "off" mean the states that result from specific pulse trains that represent a series of bytes which the actuator interprets as "on" or "off" commands. The "on" and "off" definitions do not apply to PWM actuators.

<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 <delay>

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 after the specified delay [0..long_max] in ms.

<inlet> off <delay>

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 after the specified delay [0..long_max] in ms.

<inlet> toggle <delay>

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 after the specified delay [0..long_max] in ms.

<inlet> onoff <delay>

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 and then to turn it off after the specified delay [0..long_max] in ms. If the actuator output is already on, it will be turned off after the specified delay.

<inlet> offon <delay>

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 and then to turn it on after the specified delay [0..long_max] in milliseconds. If the actuator output is already off, it will be turned on after the specified delay.

<inlet> pulse <duration>

Sends SET OUTPUT commands to the digitizer to immediately switch the on/off status of a digital binary or I2C actuator connected to the output that's connected to the specified inlet and then to switch the on/off status again after the specified duration [0..long_max] in milliseconds.

<inlet> level <value>

Sends a SET OUTPUT command to the digitizer to set the actuator output connected to the specified inlet to the voltage level corresponding to the specified logic level value [0..1] ("0" corresponds to 0 V or "off", "1" corresponds to 5 V or "on").

<inlet> levelinit <value>

Sends a SET OUTPUT INIT command to the digitizer to set the actuator output connected to the specified inlet to the voltage level corresponding to the specified logic level value [0..1] ("0" corresponds to 0 V or "off", "1" corresponds to 5 V or "on"), at power up, reset or upon execution of the init command.

<inlet> rp <status>

Sends a SET OUTPUT command to the digitizer to set the actuator output connected to the specified inlet to the specified repeating pulse generation status [0..1] ("0" corresponds to "off", "1" corresponds to "on").

<inlet> rpinit <status>

Sends a SET OUTPUT INIT command to the digitizer to set the actuator output connected to the specified inlet to the specified pulse generation status [0..1] ("0" corresponds to "off", "1" corresponds to "on"), at power up, reset or upon execution of the init command.

<inlet> rpwidth <width>

Sends a SET OUTPUT command to the digitizer to set the actuator output connected to the specified inlet to output repeating pulses with the specified width [1..] in milliseconds.

<inlet> rpwidthinit <width>

Sends a SET OUTPUT INIT command to the digitizer to set the actuator output connected to the specified inlet to output repeating pulses with the specified width [1..] in milliseconds, at power up or upon execution of the init command.

<inlet> address <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> func <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>

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].

<inlet> digital, feelvibe, 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.