ICube Max Plugin-83 Commands System wide

From I-CubeX Wiki
Revision as of 01:34, 19 May 2023 by Admin (talk | contribs)
Jump to: navigation, search

The iCube object 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 sensor inputs, if applicable.


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


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.


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 same settings as upon instantiation, see the Commands section.


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 a SET MUTE command to the digitizer to set its mute status to the specified value [0..1] (0 is off, 1 is on).


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

Retrieved from "https://infusionsystems.com/support/wiki/index.php?title=ICube_Max_Plugin-83_Commands_System_wide&oldid=6594"