Difference between revisions of "OCube Max Plugin-83 Commands System Wide"
| Line 24: | Line 24: | ||
| − | <u>verbose <value></u> (0 verbose) | + | <u>verbose <value></u> (0 verbose <value>) |
Sets what kind of messages are printed in the Max window, according to the specified value [0..3]: | Sets what kind of messages are printed in the Max window, according to the specified value [0..3]: | ||
| Line 44: | Line 44: | ||
| − | <u> | + | <u>resetoutput</u> (0 reset) |
Sends a RESET OUTPUT command to the digitizer which initializes the digitizer outputs to the initial settings as set by the output-specific init commands (if applicable to the firmware of the digitizer). The oCube data structure is also initialized as per the initial settings. | Sends a RESET OUTPUT command to the digitizer which initializes the digitizer outputs to the initial settings as set by the output-specific init commands (if applicable to the firmware of the digitizer). The oCube data structure is also initialized as per the initial settings. | ||
Latest revision as of 14:03, 8 June 2023
The oCube accepts the following system-wide commands, which means that the commands apply to the overall operation of the digitizer and iCube, and may affect all actuator outputs, if applicable.
For the messages sent to the digitizer by the various oCube commands below, see the firmware documentation.
help (0 help)
Display the URL of the main page about oCube on this support wiki in the Max window.
sync (sync 0, 0 sync 0)
Retrieves all the configuration information from the digitizer and stores it in the oCube data structure. Use the report command to display the information. If multiple oCube objects are connected to the same digitizer, only one object needs to be sent the sync command to sync all objects to the digitizer.
sync 1 (0 sync 1)
Retrieves only the output statuses from the digitizer to update the outlets and stores it in the oCube data structure. Use the report command to display the information. If multiple oCube objects are connected to the same digitizer, only one object needs to be sent the sync command to sync all objects to the digitizer.
report (0 report, print, 0 print)
Reports all the available data stored in the oCube data structure in the Max window.
verbose <value> (0 verbose <value>)
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
version (0 version)
Reports the oCube version and, if available, digitizer version in the Max window.
reset (0 reset)
Sends a RESET command to the digitizer which initializes the digitizer to the initial settings as set by the output-specific init commands (if applicable to the firmware of the digitizer). The oCube data structure is also initialized as per the initial settings.
resetoutput (0 reset)
Sends a RESET OUTPUT command to the digitizer which initializes the digitizer outputs to the initial settings as set by the output-specific init commands (if applicable to the firmware of the digitizer). The oCube data structure is also initialized as per the initial settings.
init (0 init)
Initializes the oCube data structure as per the output-specific init commands.
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 oCube 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).
mode
Sends a DUMP MODE command to the digitizer to retrieve its mode. There is no "0 mode" alias for this command.
rpmode <value> (0 rpmode <value>, servo <value>, 0 servo <value>)
Sends a SET OUTPUT PULSE command to the digitizer to switch the type of repeating pulses between general purpose and servo-specific. If the specified value is 1 the repeating pulse interval is set to 20 ms and the maximum pulse width to 2 ms, for a pulse width range between 1 - 2 ms, for use with servos. If the specified value is 0, the repeating pulse interval and maximum width are reset to the previously set values if these had been set.
rpinterval <duration>
Sends a SET OUTPUT PULSE command to the digitizer to set its repeating pulse interval to the specified duration [1..16383] in milliseconds.
rpwidth <duration>
Sends an SET OUTPUT PULSE command to the digitizer to set the maximum repeating pulse width to the specified duration [1 ..127] in milliseconds.
wifi <value> (0 wifi <value>)
Sends a WIRELESS command to the digitizer, if it is a WiDig running WiConnect for WiFi, to set the WiFi status to the specified value [0..1] (0 is off, 1 is on).
wifi
Sends a DUMP WIRELESS command to the digitizer, if it is a WiDig running WiConnect for WiFi, to retrieve its wifi status. There is no "0 wifi" alias for this command.
blemidi <value> (0 blemidi <value>)
Sends a WIRELESS command to the digitizer, if it is a WiDig running WiConnect for BLE-MIDI, to set the BLE-MIDI status to the specified value [0..1] (0 is off, 1 is on).
blemidi
Sends a DUMP WIRELESS command to the digitizer, if it is a WiDig running WiConnect for BLE-MIDI to retrieve its BLE-MIDI status. There is no "0 blemidi" alias for this command.
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.
midiout
Sends a DUMP MIDIOUT command to the digitizer, if it is a USB-microDig, to retrieve the MIDI out port status. There is no "0 midiout" alias for this command.
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).
thru
Sends a DUMP THRU command to the digitizer, if it is a microDig, miniDig or Digitizer, to retrieve the MIDI thru status. There is no "0 thru" alias for this command.
led <value> (0 led <value>)
Sends a LOW POWER command to the digitizer to set the LED status to the specified value [0..1] (0 is off, 1 is on).
led
Sends a LOW POWER command to the digitizer to retrieve the LED status. There is no "0 led" alias for this command.
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.
