Firmware-640 Operation

From I-CubeX Wiki
Jump to: navigation, search

The Wi-microDig is powered by a battery, communicates through a virtual serial port using the MIDI message protocol, and can operate in host mode or stand-alone mode. Host mode is intended for using the Wi-microDig with a computer running Connect to make the raw sensor data available to other software that processes the sensor data, while stand-alone mode is intended for using the Wi-microDig with a computer running Connect to make the processed sensor data available to other MIDI-capable software.

To set the Wi-microDig mode, use the SET MODE command.


Power

The Wi-microDig is powered by a 9V battery and provides 5V power to the connected sensors.


Standalone Mode

Stand-alone mode allows you to use the Wi-microDig's internal signal processing so that another MIDI capable device can directly use the calculated end result. Processing and mapping of sensor data happens in the Wi-microDig itself, so once it has been programmed using our configuration software (free to download from our website) it can be patched directly to MIDI-capable software or devices using our Connect software. This mode allows sensor inputs to be mapped to channel voice MIDI messages. Stand-alone mode commands (including STREAM and INTERVAL), contrary to host mode commands, change the settings stored in non-volatile memory as well as volatile memory. Stand-alone mode commands are executed in both modes of operation, even though in host mode no channel voice MIDI messages are output to reflect any changed settings.


Host Mode

Host mode requires that the Wi-microDig is connected with a host computer to control and store the Wi-microDig settings, and process the sensor data. In host mode, unprocessed, raw sensor values are output only as system exclusive MIDI messages (ie. no stand-alone mode type channel voice MIDI messages processed from sensor values are output). When using Max/MSP software, host mode allows multiple iCube / oCube Max/MSP objects for each Wi-microDig (to this end, some of the commands are echoed back to the host computer). Host mode commands (except STREAM and INTERVAL), contrary to stand-alone mode commands, do not change the settings stored in non-volatile memory but only the settings stored in volatile memory. Generally, host mode commands have the same effect in either mode of operation.


Communication

To communicate with the Wi-microDig you need to have a Bluetooth server interface such as a USB to Bluetooth adaptor. You can then establish a wireless connection with the Wi-microDig by using the serial port profile (SPP) Bluetooth service. The serial port setting of the Wi-microDig is 115200 bps, no parity, 1 stop bit, 8 data bits, data flow ON. The “Pin number” also known as “Bluetooth Passkey” for pairing the Wi-microDig with the Bluetooth® server interface is “1”. This Pin number cannot be changed.


Flow Control

The Wi-microDig is muted, ie. stops sending any data, when the Bluetooth serial port is closed or immediately after power-up. Once the Wi-microDig has been un-muted using the MUTE command data processing resumes and sensor data may be sent.


Protocol

In this documentation the communication protocol used by the Wi-microDig is based on the MIDI protocol. Despite the fact that the Wi-microDig has a different baud rate, uses a serial port and has no MIDI cables, you can use it as a MIDI device by running our free Connect software that makes the serial port data available at a MIDI port on the computer. This way you can use any MIDI application to communicate with the Wi-microDig. The “MIDI input” and “MIDI output” expressions used in this document therefore refer to a communication setup as established between the Wi-microDig and the computer running our Connect software.


LED status indications

On power-up, the red, yellow and green LEDs all light up normally but briefly.

LINK LED definition The Wi-microDig will give a visual feedback when a link is made with its built-in Bluetooth module. Each time the Wi-microDig is connected through a Bluetooth link the LINK LED will be ON.
IN LED definition The Wi-microDig will give visual feedback via the yellow IN LED for any data received from its Bluetooth interface. Each time data is received from the interface the IN LED will be ON momentarily.
OUT LED definition The Wi-microDig will give visual feedback via the green OUT LED, for any data sent to its Bluetooth interface. Each time data is sent to the interface the OUT LED will be ON momentarily.
POWER LED definition The Wi-microDig will give visual feedback via the red POWER LED when power is applied to the battery connector. When the voltage is above 5.5V the POWER LED will be ON constantly. When the voltage level is below 5.5V the POWER LED will blink to show that the voltage at the sensor input connector is below 5V. Even if the battery voltage level is below 5.5V the Wi-microDig can still convert and transmit the sensor values, see BATTERY VOLTAGE LEVEL and LOW POWER THRESHOLD commands.
POWER and OUT LED ON If the POWER and OUT LED are ON immediately after power the Wi-microDig, the firmware didn't complete its bootup. Please contact us for help.
All LEDs ON If all LEDs are ON, the Wi-microDig has encountered an unexpected error. Power it off and then on again to reset it.