Difference between revisions of "OCube Max Plugin-83 Commands System Wide"

From I-CubeX Wiki
Jump to: navigation, search
 
Line 1: Line 1:
 
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.
 
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.
 +
 +
 +
<u>help</u> (0 help)
 +
 +
Display the URL of the main page about oCube on this support wiki in the Max window.
 +
 +
 +
<u>sync</u> (0 sync)
 +
 +
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.
 +
 +
 +
<u>report</u> (0 report, print, 0 print)
 +
 +
Reports all the available data stored in the oCube data structure in the Max window.
 +
 +
 +
<u>verbose <value></u> (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
  
  
Line 15: Line 40:
  
 
Initializes the oCube data structure to the initial settings as set by the levelinit, rpinit and rpwidthinit commands.
 
Initializes the oCube data structure to the initial settings as set by the levelinit, rpinit and rpwidthinit commands.
 
 
<u>sync</u> (0 sync)
 
 
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.
 
  
  
Line 60: Line 80:
  
 
Sends an SET OUTPUT PULSE command to the digitizer to set the maximum repeating pulse width to the specified duration [1 ..127] in milliseconds.  
 
Sends an SET OUTPUT PULSE command to the digitizer to set the maximum repeating pulse width to the specified duration [1 ..127] in milliseconds.  
 
 
 
<u>report</u> (0 report, print, 0 print)
 
 
Reports all the available data stored in the oCube data structure in the Max window.
 
 
 
<u>verbose <value></u> (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
 
 
 
<u>help</u> (0 help)
 
 
Display the URL of the main page about oCube on this support wiki in the Max window.
 
  
  

Revision as of 01:46, 19 May 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.


help (0 help)

Display the URL of the main page about oCube on this support wiki in the Max window.


sync (0 sync)

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.


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)

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 levelinit, rpinit and rpwidthinit commands (if applicable to the firmware of the digitizer). The oCube data structure is also initialized as per the initial settings as set by the levelinit, rpinit and rpwidthinit commands.


init (0 init)

Initializes the oCube data structure to the initial settings as set by the levelinit, rpinit and rpwidthinit 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).


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.


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


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.