Connect-170 OSC Input

From I-CubeX Wiki
Jump to: navigation, search

Connect can receive OSC messages to control actuator outputs of a digitizer. See the preferences section to configure Connect for this feature.

If the OSC messages match (case insensitive) the format "/<digitizer_name> <command> <set_value(s)>", where digitizer_name is the name of a connected digitizer, the following commands are available:

command set_value1 set_value2 Action
host switch to host mode
standalone switch to standalone mode
reset reset the WiDig and reload the current configuration
resetoutput initialize the actuator outputs, like after power-up or software reset (see OUTPUT INIT command for more details)
mute mute all output from the WiDig
unmute unmute all output from the WiDig
interval 1 .. 16383 set the sampling interval in ms
solo 0 .. 63 set the (virtual) sensor input to allow output from (only available in standalone mode, see SET SOLO command for more details)
pwm 0 .. 127 0 .. 127 set the pulse interval and maximum pulse width for pulse width modulated output (see SET OUTPUT PULSE command for more details)

If the OSC messages match (case insensitive) the format "/<digitizer_name>/<input_name> <command> <set_value>", where digitizer_name is the name of a connected digitizer, the following commands are available:

command Action
{analog, angled .. voltd} {0 .. 127} configure the input for the specified sensor and execute the specified method
on turn the input on
off turn the input off
ghost set the sensor input to ghost mode
sample sample the sensor input once

If the OSC messages match (case insensitive) the format "/<digitizer_name>/<output_name> <command(s)> <set_value>", where digitizer_name is the name of a connected digitizer, the following commands are available (see SET OUTPUT and SET OUTPUT INIT commands for more details) where if the set_value is left unspecified the value (method, delay or pulse width) currently stored for this output is used:

command command2 command3 set_value Action
{digital, cvolt .. seergb} {0 .. 127} configure the input for the specified actuator and execute the specified method
on {0 .. 127} if configured for threshold control, set the output to the ON status and switch to the OFF status after the specified delay in steps of 100 ms, ie. the range is {100 .. 12700 ms} else if configured for continuous control, set the output to the specified value (which is the method in case of an I2C actuator or a pulse width in case of a binary digital actuator) and default to the ON status
off {0 .. 127} if configured for threshold control, set the output to the OFF status and switch to the ON status after the specified delay in steps of 100 ms, ie. the range is {100 .. 12700 ms} else if configured for continuous control, set the output to the specified value (which is the method in case of an I2C actuator or a pulse width in case of a binary digital actuator) and default to the OFF status
tc {0 .. 127} configure the output for threshold control, set the output to the ON or OFF status as already set by another command and switch the status after the specified delay in steps of 100 ms, ie. the range is {100 .. 12700 ms}
cc {0 .. 127} set the output to use continuous control, set the output to the specified value (which is the method in case of an I2C actuator or a pulse width in case of a binary digital actuator) and default to the ON or OFF status as already set by another command
oni {0 .. 127} at power-up or initialization, if configured for threshold control, set the output to the ON status and switch to the OFF status after the specified delay in steps of 100 ms, ie. the range is {100 .. 12700 ms} else if configured for continuous control, set the output to the specified value (which is the method in case of an I2C actuator or a pulse width in case of a binary digital actuator) and default to the ON status
offi {0 .. 127} at power-up or initialization, if configured for threshold control, set the output to the OFF status and switch to the ON status after the specified delay in steps of 100 ms, ie. the range is {100 .. 12700 ms} else if configured for continuous control, set the output to the specified value (which is the method in case of an I2C actuator or a pulse width in case of a binary digital actuator) and default to the OFF status
tci {0 .. 127} at power-up or initialization, configure the output for threshold control, set the output to the ON or OFF status as already set by another command and switch to the ON status after the specified delay in steps of 100 ms, ie. the range is {100 .. 12700 ms}
cci {0 .. 127} at power-up or initialization, set the output to use continuous control, set the output to the specified value (which is the method in case of an I2C actuator or a pulse width in case of a binary digital actuator) and default to the ON or OFF status as set using another command - in the case of an I2C actuator, the specified value also sets the current ON status value
on tc {0 .. 127} configure the output for threshold control, set the output to the ON status and switch to the OFF status after the specified delay in steps of 100 ms, ie. the range is {100 .. 12700 ms}
off tc {0 .. 127} configure the output for threshold control, set the output to the OFF status and switch to the ON status after the specified delay in steps of 100 ms, ie. the range is {100 .. 12700 ms}
on cc {0 .. 127} set the output to use continuous control, set the output to the specified value (which is the method in case of an I2C actuator or a pulse width in case of a binary digital actuator) and default to the ON status
off cc {0 .. 127} set the output to use continuous control, set the output to the specified value (which is the method in case of an I2C actuator or a pulse width in case of a binary digital actuator) and default to the OFF status
init on tc {0 .. 127} at power-up or initialization, configure the output for threshold control, set the output to the ON status and switch to the OFF status after the specified delay in steps of 100 ms, ie. the range is {100 .. 12700 ms}
init off tc {0 .. 127} at power-up or initialization, configure the output for threshold control, set the output to the ON status and switch to the ON status after the specified delay in steps of 100 ms, ie. the range is {100 .. 12700 ms}
init on cc {0 .. 127} at power-up or initialization, set the output to use continuous control, set the output to the specified value (which is the method in case of an I2C actuator or a pulse width in case of a binary digital actuator) and default to the ON status - in the case of an I2C actuator, the specified value also sets the current ON status value
init off cc {0 .. 127} at power-up or initialization, set the output to use continuous control, set the output to the specified value (which is the method in case of an I2C actuator or a pulse width in case of a binary digital actuator) and default to the OFF status - in the case of an I2C actuator, the specified value also sets the current ON status value

If the OSC messages match (case insensitive) the format "/<digitizer_name>/<output_name> <set_value>", where digitizer_name is the name of a connected digitizer, and set_value is in {.. -128, 0 .. 127, 128 .. }, the set_value will be mapped to a SET OUTPUT message as follows:

set_value Action
{0 .. 127} enable and set pulse width modulation (if implemented) or set the I2C actuator method as per OSC message value
{-128 (or less), off} turn output off
{128 (or more), on} turn output on

The pulse width value maximum is 125.

Example:

The OSC message "/USB-microDig_0123/Output_01 62" will set an actuator output configured for a PWM actuator to output a pulse with a width that's half of the configured range, so in case of the default PWM configuration (ie. 1 ms range, from 1 to 2 ms) that would be 1.5 ms.

Sending the same message while the actuator output is configured for an I2C actuator will set the actuator method of the I2C actuator to 62.

Retrieved from "https://infusionsystems.com/support/wiki/index.php?title=Connect-170_OSC_Input&oldid=6657"