Difference between revisions of "ICube Max Plugin-40 Commands"
| Line 1: | Line 1: | ||
| − | The iCube Max plugin responds to the following commands. If a command has aliases they are displayed following the command, in brackets and separated by commas. Commands that in turn send commands as System Exclusive MIDI messages to the digitizer refer to the firmware command in capitals. | + | The iCube Max plugin responds to the following commands. If a command has aliases they are displayed following the command, in brackets and separated by commas. Commands that in turn send commands as System Exclusive MIDI messages to the digitizer refer to the firmware command in capitals. More information about the command can be found in the applicable firmware section on this support wiki. |
| Line 7: | Line 7: | ||
<u>version</u> (0 version) | <u>version</u> (0 version) | ||
| − | Prints the iCube version and, if available, digitizer version. | + | Prints the iCube version and, if available, digitizer version in the Max window. |
| Line 51: | Line 51: | ||
<u>mode <value></u> (0 mode <value>) | <u>mode <value></u> (0 mode <value>) | ||
| − | Sends a SET MODE command to the digitizer | + | Sends a SET MODE command to the digitizer to set to its mode specified by <value>. |
| − | <u>interval</u> (0 interval) | + | <u>interval <value></u> (0 interval <value>) |
| + | Sends an INTERVAL command to the digitizer to set its sampling interval to <value> ms. | ||
| − | |||
| + | <u>rate <value></u> (0 rate <value>) | ||
| − | <u>mute</u> (0 mute) | + | Sends an INTERVAL command to the digitizer to set its sampling rate to <value> Hz. |
| + | |||
| + | |||
| + | <u>mute <value></u> (0 mute <value>) | ||
| + | |||
| + | Sends an SET MUTE command to the digitizer to set its mute status to <value> (0 is off, 1 is on). | ||
<u>print</u> (0 print) | <u>print</u> (0 print) | ||
| + | Prints all the available data stored in the iCube data structure in the Max window. | ||
| − | <u>verbose</u> (0 verbose) | + | |
| + | <u>verbose <value></u> (0 verbose) | ||
| + | |||
| + | Sets what kind of messages are printed in the Max window, according to <value>: | ||
| + | |||
| + | * 0: no messages | ||
| + | * 1: confirmation messages | ||
| + | * 2: confirmation and error messages | ||
| + | * 3: all messages | ||
<u>help</u> (0 help) | <u>help</u> (0 help) | ||
| + | Prints the URL of the main page about iCube on this support wiki in the Max window. | ||
| − | |||
| + | <u>thru <value></u> (0 thru <value>) | ||
| − | <u>midiout</u> (0 midiout) | + | Sends a THRU command to the digitizer, if it is a microDig, miniDig or Digitizer, to set the MIDI thru status to <value> (0 is off, 1 is on). |
| + | |||
| + | |||
| + | <u>midiout <value></u> (0 midiout <value>) | ||
| + | |||
| + | Sends a MIDIOUT command to the digitizer, if it is a USB-microDig, Wi-microDig or Wi-miniDig, to set the MIDI out port (for use with the USB-microMIDICable) status to <value> (0 is off, 1 is on). | ||
<u>power</u> (0 power) | <u>power</u> (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 power voltage status. | ||
<u>battery</u> (0 battery) | <u>battery</u> (0 battery) | ||
| + | Sends a BATTERY command to the digitizer, if it is a Wi-microDig to request the battery voltage status. | ||
<u>clearconfig</u> (0 clearconfig) | <u>clearconfig</u> (0 clearconfig) | ||
| + | Sends a CLEAR CONFIG command to the digitizer to set its standalone mode configuration to default values. | ||
| + | |||
| + | |||
| + | <u>runningstatus <value></u> (0 runningstatus) | ||
| + | |||
| + | Sends a RUNNING STATUS or MIDI STATUS (depending on the digitizer's firmware) command to the digitizer to set its standalone mode MIDI running status to <value> (0 is on, 1 is off). | ||
| − | |||
| + | <u>activesensing <value></u> (0 activesensing <value>) | ||
| − | < | + | Sends a RUNNING STATUS or MIDI STATUS (depending on the digitizer's firmware) command to the digitizer to set its standalone mode MIDI active sensing status to <value> (0 is off, 1 is on). |
| − | <u>intervalmarking</u> (0 intervalmarking) | + | <u>intervalmarking <value></u> (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 <value> (0 is off, 1 is on). | ||
| Line 102: | Line 133: | ||
| − | <u>connect</u> (assign) | + | <u><outlet> connect <input></u> (<outlet> assign <input>) |
| − | <u>stream</u> | + | <u><outlet> stream</u> |
| − | <u>on</u> | + | <u><outlet> on</u> |
| − | <u>off</u> | + | <u><outlet> off</u> |
| − | <u>sample</u> | + | <u><outlet> sample</u> |
| − | <u>res</u> | + | <u><outlet> res</u> |
| − | <u>address</u> | + | <u><outlet> address</u> |
| − | <u>function</u> (func) | + | <u><outlet> function</u> (func) |
| − | <u>method</u> | + | <u><outlet> method</u> |
| − | <u>analog, biobeat3d, hotspot2d, magnetic3d, moist3d, movealong, movearound, orient3d, orient4d, reachclosed, reachid, swipe3d</u> | + | <u><outlet> analog, biobeat3d, hotspot2d, magnetic3d, moist3d, movealong, movearound, orient3d, orient4d, reachclosed, reachid, swipe3d</u> |
Revision as of 15:33, 20 January 2018
The iCube Max plugin responds to the following commands. If a command has aliases they are displayed following the command, in brackets and separated by commas. Commands that in turn send commands as System Exclusive MIDI messages to the digitizer refer to the firmware command in capitals. More information about the command can be found in the applicable firmware section on this support wiki.
System-wide commands
version (0 version)
Prints the iCube version and, if available, digitizer version in the Max window.
reset (0 reset)
Initializes the iCube data structure and sends a RESET command to the digitizer.
init (0 init)
Initializes the iCube data structures
0 refresh
sync (0 sync)
Retrieves all the configuration information from the digitizer and stores it in the iCube data structure.
digid <value> (setdigid <value>, 0 digid <value>)
Sends a SET ID command to the digitizer to set the digitizer's System Exclusive ID to <value>.
id <value> (0 id <value>)
Sets the iCube to respond to and send System Exclusive messages with the System Exclusive ID equal to <value>.
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 specified by <value>.
interval <value> (0 interval <value>)
Sends an INTERVAL command to the digitizer to set its sampling interval to <value> ms.
rate <value> (0 rate <value>)
Sends an INTERVAL command to the digitizer to set its sampling rate to <value> Hz.
mute <value> (0 mute <value>)
Sends an SET MUTE command to the digitizer to set its mute status to <value> (0 is off, 1 is on).
print (0 print)
Prints 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 <value>:
- 0: no messages
- 1: confirmation messages
- 2: confirmation and error messages
- 3: all messages
help (0 help)
Prints 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 <value> (0 is off, 1 is on).
midiout <value> (0 midiout <value>)
Sends a MIDIOUT command to the digitizer, if it is a USB-microDig, Wi-microDig or Wi-miniDig, to set the MIDI out port (for use with the USB-microMIDICable) status to <value> (0 is off, 1 is on).
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 power voltage status.
battery (0 battery)
Sends a BATTERY command to the digitizer, if it is a Wi-microDig to request the battery voltage status.
clearconfig (0 clearconfig)
Sends a CLEAR CONFIG command to the digitizer to set its standalone mode configuration 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 standalone mode MIDI running status to <value> (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 standalone mode MIDI active sensing status to <value> (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 <value> (0 is off, 1 is on).
Input-specific commands
<outlet> connect <input> (<outlet> assign <input>)
<outlet> stream
<outlet> on
<outlet> off
<outlet> sample
<outlet> res
<outlet> address
<outlet> function (func)
<outlet> method
<outlet> analog, biobeat3d, hotspot2d, magnetic3d, moist3d, movealong, movearound, orient3d, orient4d, reachclosed, reachid, swipe3d
min
max
inmin
inmax
steps (step)
unit
offset
normal
noise
smooth
preset
raw
