Component: MIAC USB Slave API (PIC) (AllCode)
| Author | Matrix Ltd |
| Version | 1.1 |
| Category | AllCode |
MIAC USB Slave API (PIC) component
Allows Matrix's MIAC PLC to be used as a PC peripheral controlled by Flowcode via a USB connection. Requires that the MIAC (PIC) has the USB Slave firmware downloaded to it.
Component Pack
FREE
Detailed description
No detailed description exists yet for this component
Examples
Firmware & USB Driver
The MIAC needs programming with the USB Slave firmware to function correctly with the MIAC USB Slave component.
Use the MIACprog tool to download the firmware .hex file to the MIAC.
File:MIAC USB Slave Firmware.zip
The MIAC USB Slave USB driver will need to be installed before Windows will correctly recognise the device and allow Flowcode to communicate correctly.
Controlled Using Flowcode
Here is a simple Flowcode program to toggle one of the transistor outputs on the MIAC USB Slave device. Remember to connect a linking wire between the (M) screw terminal to the (V+) screw terminal to allow the Transistor LEDs to light.
MIAC USB Slave
Here is an example of the high level MIAC USB Slave console.
Here is an example of the low level MIAC USB Slave console.
If the MIAC USB Slave component can see the MIAC USB Slave then you will able to select the instance via the Instance property.
Multiple MIAC USB slaves can be connected to a single PC and controlled by adding multiple MIAC USB Slave components each referring to their own instance of the hardware.
Controlled Using VB6 / VB2008
Files taken from the Locktronics Industrial sensor, actuator and control applications solution
Controlled Using Labview
Files taken from the Locktronics Industrial sensor, actuator and control applications solution
Command Table
| Command Number | Description | Parameters | Returns |
| 1 | Digital Input | Channel (1-8) | Input State (0-1) |
| 2 | Digital Multi Input | N/A | Input State 8-bit (0-255) |
| 3 | Analogue Input | Channel (1-8) | Input ADC Reading (0-255) |
| 4 | Read Keypad Buffer | N/A | Key Press (0-8 or 255) |
| 5 | Clear Keypad Buffer | N/A | N/A |
| 6 | Relay Control | Channel (1-4)
Relay State (0-1) |
N/A |
| 7 | Transistor Control | Channel (1-4)
Transistor State (0-1) |
N/A |
| 8 | Multi Output Control | Output Value (0-255)
Output Mask (0-255) |
N/A |
| 9 | Display Clear | N/A | N/A |
| 10 | Display Cursor Position | X Coord (0-15)
Y Coord (0-3) |
N/A |
| 11 | Display Number | Number Low Byte (0-255)
Number High Byte (0-255) |
N/A |
| 12 | Display String | String Data | N/A |
| 13 | PWM Enable Control | PWM Channel (1-2)
Enabled (0-1) |
N/A |
| 14 | PWM Duty Control | PWM Channel (1-2)
Duty (0-255) |
N/A |
| 15 | PWM Period Control | Prescaler (0-2) | N/A |
| 16 | PWM Overcurrent Check | N/A | Overcurrent State (0-1) |
| 17 | EEPROM Write | Address (0-255)
Data (0-255) |
N/A |
| 18 | EEPROM Read | Address (0-255) | Data (0-255) |
| 19 | CAN Set Data | Num Bytes (0-8)
Data0 (0-255) Data1 (0-255) Data2 (0-255) Data3 (0-255) Data4 (0-255) Data5 (0-255) Data6 (0-255) Data7 (0-255) |
N/A |
| 20 | CAN Send Message | ID Low Byte (0-255)
ID High Byte (0-7) |
N/A |
| 21 | CAN Check Incoming | N/A | ID High
ID Low |
| 22 | CAN Get RX Data | N/A | Num Bytes (0-8)
Data0 (0-255) Data1 (0-255) Data2 (0-255) Data3 (0-255) Data4 (0-255) Data5 (0-255) Data6 (0-255) Data7 (0-255) |
| 23 | Register Read | Address Low Byte (0-255)
Address High Byte (0-255) |
Register Data Byte (0-255) |
| 24 | Register Write | Address Low Byte (0-255)
Address High Byte (0-255) Register Data Byte (0-255) |
N/A |
Component Source
The component source code is available here.
Downloadable macro reference
|
LCDPrintString |
| Prints a string to the LCD on the MIAC. | |
 - STRING
|
Str |
 - VOID
|
Return |
|
|
GetRegisterValue |
| Gets the value of the register specified on the MIAC | |
 - UINT
|
RegAddress |
 - BYTE
|
Return |
|
|
GetAnalogueInput |
| Returns the value for a specific analogue input on the MIAC slave. | |
| - BYTE
|
Input |
| - BYTE
|
Return |
|
|
LCDPrintNumber |
| Prints out a number to the display on the MIAC. | |
 - INT
|
Number |
| - VOID
|
Return |
|
|
CANTx |
| Sends the Tx data with the ID specified in the form of a CAN message | |
| - UINT
|
CANID |
| - VOID
|
Return |
|
|
GetKeypadBuffer |
| Returns a keypress from the keypress buffer, returns 255 if no keypress is available. | |
| - BYTE
|
Return |
|
|
SetRegisterValue |
| Sets the value of the register specified on the MIAC | |
| - UINT
|
RegAddress |
| - BYTE
|
Value |
| - VOID
|
Return |
|
|
PWMSetPeriod |
| Sets the PWM period for the channel specified | |
| - BYTE
|
Prescaler |
| - BYTE
|
Period |
| - VOID
|
Return |
|
|
PWMOvercurrentCheck |
| Checks the PWM outputs to see if they are overcurrent | |
| - BYTE
|
Return |
|
|
GetEEPROMData |
| Reads a byte from the EEPROM data memory | |
| - BYTE
|
Address |
| - BYTE
|
Return |
|
|
PWMControl |
| Sets the PWM channel specified to be enabled or disabled | |
| - BYTE
|
Channel |
| - BYTE
|
Enable |
| - VOID
|
Return |
|
|
CANSetTxData |
| Sets the LCD cursor position on the MIAC | |
| - BYTE
|
DataCount |
| - BYTE
|
d0 |
| - BYTE
|
d1 |
| - BYTE
|
d2 |
| - BYTE
|
d3 |
| - BYTE
|
d4 |
| - BYTE
|
d5 |
| - BYTE
|
d6 |
| - BYTE
|
d7 |
| - VOID
|
Return |
|
|
GetDigitalInputs |
| Returns the value for a all 8 digital inputs on the MIAC slave. | |
| - BYTE
|
Return |
|
|
SetEEPROMData |
| Writes a byte to the EEPROM data memory | |
| - BYTE
|
Address |
| - BYTE
|
Data |
| - VOID
|
Return |
|
|
CANGetRxData |
| Collects the data from the last received CAN message | |
| - STRING
|
Return |
|
|
PWMSetDuty |
| Sets the duty cycle for the PWM channel specified | |
| - BYTE
|
Channel |
| - BYTE
|
Duty |
| - VOID
|
Return |
|
|
SetOutputBank |
| Controls the state of one of the transistor outputs on the MIAC slave. | |
| - BYTE
|
Mask |
| - BYTE
|
Output_States |
| - VOID
|
Return |
|
|
SetTransistorOutput |
| Controls the state of one of the transistor outputs on the MIAC slave. | |
| - BYTE
|
Transistor |
| - BYTE
|
State |
| - VOID
|
Return |
|
|
GetDigitalInput |
| Returns the value for a specific digital input on the MIAC slave. | |
| - BYTE
|
Input |
| - BYTE
|
Return |
|
|
ClearKeypadBuffer |
| Destroys the contents of the keypad buffer. | |
| - VOID
|
Return |
|
|
LCDSetCursor |
| Sets the LCD cursor position on the MIAC | |
| - BYTE
|
x |
| - BYTE
|
y |
| - VOID
|
Return |
|
|
CANCheckRx |
| Checks to see if a CAN message has been received, if so the ID is returned | |
| - UINT
|
Return |
|
|
LCDClear |
| Clears the LCD display on the MIAC. | |
| - VOID
|
Return |
|
|
SetRelayOutput |
| Controls the state of one of the Relay outputs on the MIAC slave. | |
| - BYTE
|
Relay |
| - BYTE
|
State |
| - VOID
|
Return |
Property reference
|
Properties |
|
Instance |
| USB Slave Instance, if empty then is the MIAC slave firmware loaded, Is the MIAC slave driver installed, Is the MIAC connected and powered. | |
|
Connections |
|
|
Simulations |