API
This page will Describe How the API for VEMIO can be used to sense its inputs and control its outputs. Before going into those details, it is important to note that VEMIO's API follows a mapping as described in IO Mapping.
As usual, VEMIO follows Qibixx' Common serial Protocol Rules:
- End of Line indicated by carriage return (\r), line feed (\n), or both.
- a single (capitalized) character indicates a command, followed by eventual parameters. NOTE: the device will also accept noncapitalized commands.
- Answers follow the same principle, the device always sends and the answer messages start with a small (non-capitalised) letter.
Software Version
VThe response to this command wil be VEMIO H0X VY.YY, where X is the hardware version (1 or 2) and Y.YY its the software version.
VEMIO H01 V01.09 # VEMIO 1 VEMIO H02 V01.09 # VEMIO 2Activate Output (VEMIO 1)
The following commands only set the logical value of the Output to 0 or 1. The Voltage level of the Given Output actually depends if it is an Active High or Active Low Output. The Output Pin Mapping to API Index is provided below below.
O1,1 #Activate output 1O2,0 #Deactivate outputThe response from VEMIO is a 32 bit word shown in HEX format. aa shows the values of outputs 1 to 8 (API index, not necessarily the Pin Number on the Board), bb shows outputs 9 to 16 , cc is not used , and dd is used for the outputs 25 to 32.
o,aa,bb,cc,ddO1,1 # Set output 1 to 1o,01,c0,00,00 #Vemio answers with the value of all outputs, with output 1 set to 1O2,1 # Set output 2 to 1o,03,c0,00,00 #Vemio answers with the value of all outputs, with output 2 and 1 set to 1O2,0 # # Set output 2 to 0 o,01,c0,00,00 # #Vemio answers with the value of all outputs, with output 2 set to 0 and output 1 set to 1Some outputs are specific to VEMIO2, like the Relay and LED Outputs. The following example shows how to Enable and Disable these outputs. These outputs are shown in the second block of the output and its default value is c0 (1100 in Binary), since the LED bits (15 and 16) are default with value 1 and the relay bits (13 and 14) are default to 0.
o13,1 # Enable Relay 1o,00,d0,00,00 # Bit 13 set to 1o14,1 # Enable Relay 2o,00,f0,00,00 # Bit 14 set to 1o15,1 # Enable Red LEDo,00,b0,00,00 #Bit 15 set to 0o16,1 # Enable Green LEDo,00,30,00,00 # Bit 16 set to 0o16,0 # Dnable Green LEDo,00,b0,00,00 # Bit 16 set to 1o15,0 #Disable Red LEDo,00,f0,00,00 #Bit 15 set to 1o14,0 # Disable Relay 2o,00,d0,00,00 #Bit 14 set to 0o13,0 # Disable Relay 2o,00,c0,00,00 #Bit 13 set to 0Activate Output (VEMIO 2 - Software Version Below 2.0)
VEMIO 2 has the Driver Low and Driver Hight Outputs flipped.
| Vemio 2 | Output Command |
|---|---|
| Driver Low 1 | O12,1 |
| Driver Low 2 | O11,1 |
| Driver Low 3 | O10,1 |
| Driver Low 4 | O9,1 |
| Driver Low 5 | O8,1 |
| Driver Low 6 | O7,1 |
| Driver Low 7 | O6,1 |
| Driver Low 8 | O5,1 |
| Driver Low 9 | O4,1 |
| Driver Low 10 | O3,1 |
| Driver Low 11 | O2,1 |
| Driver Low 12 | O1,1 |
| Driver Hight 1 | O32,1 |
| Driver Hight 2 | O31,1 |
| Driver Hight 3 | O30,1 |
| Driver Hight 4 | O29,1 |
| Driver Hight 5 | O28,1 |
| Driver Hight 6 | O27,1 |
| Driver Hight 7 | O26,1 |
| Driver Hight 8 | O25,1 |
Read Digital Inputs
The Inputs on VEMIO1 and VEMIO2 are active low, meaning that they need to be pulled to Ground in order to be detected in the API.
Inputs can be configured to automatic report, or manual read. The automatic report of the inputs can be configured with the following commands:
I1 #Enable Automatic Report of the InputsI2 #Disable Automatic Report of the InputsWhen the Automatic Input Report is enabled, each time that one of the inputs changes its level, all inputs will be reported in the serial port, like in the example below.
i,00fe #Input 1 is pulled to groundi,00ff #Input 1 is releasedWhen the Automatic Input Report is disabled, the inputs can be read with the following commands. Although both commands are supported, their respective behavior does not show any difference.
I #without argumentI0 #with argumentI #Read inputsi,00ff #vemio reports all inputs downI0i,00fe #vemio reports input 1 pulled to groundRead Analog Inputs (VEMIO 1)
VEMIO 1 has 2 10 bit (approximately 4.8 mV resolution) Analog to Digital Converters that can be used to read the Analog Input. The Analog Input can be read using:
AThe read response is returned as 2 16 bit HEX numbers, corresponding to the value read from each of the inputs. In the example below, Analog Input was 5V on input 1 and 0V on input 2 (Analog Input 2 and 3, according to pin numbering on the board).
Aa03fd,0005 #Input 1 shows 1021*4.88mV=4.99V and Input 2 shows 5*4.88mV=0.02VMonitor Current Output (VEMIO2)
Depending on the number of outputs that are activated at a given instant, the current being drawn by the Output loads may vary. This current could be measured using the following command.
CThe output current measure can be approximate by I = 0.0009 * Current(decimal) - 0.007 . When the current is read, three readings are shown, where the first is for active low outputs, the second is for active high outputs and the third is unused.
Cc0003,004e,0000 # Active low inputs are drawing mA (reading 0) and Active High inputs are drawing 0.0009 * 78 - 0.007 = 66 mARead 1 Wire Sensor (VEMIO 2)
VEMIO2 is equipped with a 1-Wire Sensor input that can be used for instance to plug a Temperature Sensor. To read the value from this Sensor, the following command can be used:
TThis example refers to a specific sensor. Results may differ depending on the data being sent by the sensor in use.
T # Read Temperaturet,4095 # Not connectedt,18 # Temperature Sensor reads 18 degreesEmulate Keypad (VEMIO1)
VEMIO 1 is equipped with a Keypad Simulator that can be used to replace upt to 4x4 Matrix Keyboards. When used, it can emulate short key presses at any point of the Keypad matrix.
The keys can be activated with the following comand:
K"aa"In the command above, aa is an 8 bit hexadecimal word, where the bit combination is an instruction to VEMIO1. The bits are mapped to pins as follows:
| Pins | Description/Instructions |
|---|---|
| Bits 0 .. 1 | Select which matrix column to activate. Accepts 0,1,2,3 to select up to 4 columns. |
| Bit 2 | Do Not Use , should be set to 0 |
| Bit 3 | Set to 1 to engage and 0 to disengage the Keypad Simulator. |
| Bits 4 .. 5 | Select which matrix row to activate. Accepts 0,1,2,3 to select up to 4 rows. |
| Bit 6 | Do Not Use , should be set to 0 |
| Bit 7 | Do not use, must be set to 1 |
So let's assume we have a 4x4 keyboard like the following and we want to emulate it with VEMIO1.
This keyboard has 3 columns and 4 rows (rows count from top to bottom and columns from left to right). Now let's see in the example below how we could type "1, Enter" in this keyboard.
K88 # Binary 1000 1000 Bit 5,4 = 00 (row 0), Bit 1,0 = 00 (column 0), Bit 3 = 1 (engage keyboard)K80 # Bit 3 = 0 (disengage keyboard) , bits 5,4 and 1,0 are "Don't care"KBA # Binary 1011 1010 Bit 5,4 = 11 (row 3), Bit 1,0 = 10 (column 2), Bit 3 = 1 (engage keyboard)K80 # Bit 3 = 0 (disengage keyboard) , bits 5,4 and 1,0 are "Don't care"Note that the wiring is a responsibility of the Buyer. The following picture shows how the Pins on VEMIO1 are mapped to API Pins.
