Component: MIAC USB Slave API (PIC) (AllCode): Difference between revisions

Latest revision as of 14:23, 13 July 2026

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 Source Code

Please click here to download the component source project: FC_Comp_Source_MIAC_Slave.fcsx

Please click here to view the component source code (Beta): FC_Comp_Source_MIAC_Slave.fcsx

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

File:VB Examples.zip

Controlled Using Labview

Files taken from the Locktronics Industrial sensor, actuator and control applications solution

File:Labview Examples.zip

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.

MIAC PIC Slave Component

Macro reference

CANCheckRx

	CANCheckRx
Checks to see if a CAN message has been received, if so the ID is returned
- UINT	Return

CANGetRxData

	CANGetRxData
Collects the data from the last received CAN message
- STRING	Return

CANSetTxData

	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

CANTx

	CANTx
Sends the Tx data with the ID specified in the form of a CAN message
- UINT	CANID

- VOID	Return

ClearKeypadBuffer

	ClearKeypadBuffer
Destroys the contents of the keypad buffer.
- VOID	Return

GetAnalogueInput

	GetAnalogueInput
Returns the value for a specific analogue input on the MIAC slave.
- BYTE	Input

- BYTE	Return

GetDigitalInput

	GetDigitalInput
Returns the value for a specific digital input on the MIAC slave.
- BYTE	Input

- BYTE	Return

GetDigitalInputs

	GetDigitalInputs
Returns the value for a all 8 digital inputs on the MIAC slave.
- BYTE	Return

GetEEPROMData

	GetEEPROMData
Reads a byte from the EEPROM data memory
- BYTE	Address

- BYTE	Return

GetKeypadBuffer

	GetKeypadBuffer
Returns a keypress from the keypress buffer, returns 255 if no keypress is available.
- BYTE	Return

GetRegisterValue

	GetRegisterValue
Gets the value of the register specified on the MIAC
- UINT	RegAddress

- BYTE	Return

LCDClear

	LCDClear
Clears the LCD display on the MIAC.
- VOID	Return

LCDPrintNumber

	LCDPrintNumber
Prints out a number to the display on the MIAC.
- INT	Number

- VOID	Return

LCDPrintString

	LCDPrintString
Prints a string to the LCD on the MIAC.
- STRING	Str

- VOID	Return

LCDSetCursor

	LCDSetCursor
Sets the LCD cursor position on the MIAC
- BYTE	x

- BYTE	y

- VOID	Return

PWMControl

	PWMControl
Sets the PWM channel specified to be enabled or disabled
- BYTE	Channel

- BYTE	Enable

- VOID	Return

PWMOvercurrentCheck

	PWMOvercurrentCheck
Checks the PWM outputs to see if they are overcurrent
- BYTE	Return

PWMSetDuty

	PWMSetDuty
Sets the duty cycle for the PWM channel specified
- BYTE	Channel

- BYTE	Duty

- VOID	Return

PWMSetPeriod

	PWMSetPeriod
Sets the PWM period for the channel specified
- BYTE	Prescaler

- BYTE	Period

- VOID	Return

SetEEPROMData

	SetEEPROMData
Writes a byte to the EEPROM data memory
- BYTE	Address

- BYTE	Data

- VOID	Return

SetOutputBank

	SetOutputBank
Controls the state of one of the transistor outputs on the MIAC slave.
- BYTE	Mask

- BYTE	Output_States

- VOID	Return

SetRegisterValue

	SetRegisterValue
Sets the value of the register specified on the MIAC
- UINT	RegAddress

- BYTE	Value

- VOID	Return

SetRelayOutput

	SetRelayOutput
Controls the state of one of the Relay outputs on the MIAC slave.
- BYTE	Relay

- BYTE	State

- VOID	Return

SetTransistorOutput

	SetTransistorOutput
Controls the state of one of the transistor outputs on the MIAC slave.
- BYTE	Transistor

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

@@ Line 305: / Line 305: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CANCheckRx'''
+| width="90%" class="mtx-class-macrohead" | '''CANCheckRx'''
 |-
 | colspan="2" | Checks to see if a CAN message has been received, if so the ID is returned&nbsp;
@@ Line 319: / Line 319: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CANGetRxData'''
+| width="90%" class="mtx-class-macrohead" | '''CANGetRxData'''
 |-
 | colspan="2" | Collects the data from the last received CAN message&nbsp;
@@ Line 333: / Line 333: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CANSetTxData'''
+| width="90%" class="mtx-class-macrohead" | '''CANSetTxData'''
 |-
 | colspan="2" | Sets the LCD cursor position on the MIAC&nbsp;
@@ Line 392: / Line 392: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CANTx'''
+| width="90%" class="mtx-class-macrohead" | '''CANTx'''
 |-
 | colspan="2" | Sends the Tx data with the ID specified in the form of a CAN message&nbsp;
@@ Line 411: / Line 411: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ClearKeypadBuffer'''
+| width="90%" class="mtx-class-macrohead" | '''ClearKeypadBuffer'''
 |-
 | colspan="2" | Destroys the contents of the keypad buffer.&nbsp;
@@ Line 425: / Line 425: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetAnalogueInput'''
+| width="90%" class="mtx-class-macrohead" | '''GetAnalogueInput'''
 |-
 | colspan="2" | Returns the value for a specific analogue input on the MIAC slave.&nbsp;
@@ Line 444: / Line 444: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetDigitalInput'''
+| width="90%" class="mtx-class-macrohead" | '''GetDigitalInput'''
 |-
 | colspan="2" | Returns the value for a specific digital input on the MIAC slave.&nbsp;
@@ Line 463: / Line 463: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetDigitalInputs'''
+| width="90%" class="mtx-class-macrohead" | '''GetDigitalInputs'''
 |-
 | colspan="2" | Returns the value for a all 8 digital inputs on the MIAC slave.&nbsp;
@@ Line 477: / Line 477: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetEEPROMData'''
+| width="90%" class="mtx-class-macrohead" | '''GetEEPROMData'''
 |-
 | colspan="2" | Reads a byte from the EEPROM data memory&nbsp;
@@ Line 496: / Line 496: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetKeypadBuffer'''
+| width="90%" class="mtx-class-macrohead" | '''GetKeypadBuffer'''
 |-
 | colspan="2" | Returns a keypress from the keypress buffer, returns 255 if no keypress is available.&nbsp;
@@ Line 510: / Line 510: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRegisterValue'''
+| width="90%" class="mtx-class-macrohead" | '''GetRegisterValue'''
 |-
 | colspan="2" | Gets the value of the register specified on the MIAC&nbsp;
@@ Line 529: / Line 529: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''LCDClear'''
+| width="90%" class="mtx-class-macrohead" | '''LCDClear'''
 |-
 | colspan="2" | Clears the LCD display on the MIAC. &nbsp;
@@ Line 543: / Line 543: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''LCDPrintNumber'''
+| width="90%" class="mtx-class-macrohead" | '''LCDPrintNumber'''
 |-
 | colspan="2" | Prints out a number to the display on the MIAC.&nbsp;
@@ Line 562: / Line 562: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''LCDPrintString'''
+| width="90%" class="mtx-class-macrohead" | '''LCDPrintString'''
 |-
 | colspan="2" | Prints a string to the LCD on the MIAC.&nbsp;
@@ Line 581: / Line 581: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''LCDSetCursor'''
+| width="90%" class="mtx-class-macrohead" | '''LCDSetCursor'''
 |-
 | colspan="2" | Sets the LCD cursor position on the MIAC&nbsp;
@@ Line 605: / Line 605: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PWMControl'''
+| width="90%" class="mtx-class-macrohead" | '''PWMControl'''
 |-
 | colspan="2" | Sets the PWM channel specified to be enabled or disabled&nbsp;
@@ Line 629: / Line 629: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PWMOvercurrentCheck'''
+| width="90%" class="mtx-class-macrohead" | '''PWMOvercurrentCheck'''
 |-
 | colspan="2" | Checks the PWM outputs  to see if they are overcurrent&nbsp;
@@ Line 643: / Line 643: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PWMSetDuty'''
+| width="90%" class="mtx-class-macrohead" | '''PWMSetDuty'''
 |-
 | colspan="2" | Sets the duty cycle for the PWM channel specified&nbsp;
@@ Line 667: / Line 667: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PWMSetPeriod'''
+| width="90%" class="mtx-class-macrohead" | '''PWMSetPeriod'''
 |-
 | colspan="2" | Sets the PWM period for the channel specified&nbsp;
@@ Line 691: / Line 691: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetEEPROMData'''
+| width="90%" class="mtx-class-macrohead" | '''SetEEPROMData'''
 |-
 | colspan="2" | Writes a byte to the EEPROM data memory&nbsp;
@@ Line 715: / Line 715: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetOutputBank'''
+| width="90%" class="mtx-class-macrohead" | '''SetOutputBank'''
 |-
 | colspan="2" | Controls the state of one of the transistor outputs on the MIAC slave.&nbsp;
@@ Line 739: / Line 739: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetRegisterValue'''
+| width="90%" class="mtx-class-macrohead" | '''SetRegisterValue'''
 |-
 | colspan="2" | Sets the value of the register specified on the MIAC&nbsp;
@@ Line 763: / Line 763: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetRelayOutput'''
+| width="90%" class="mtx-class-macrohead" | '''SetRelayOutput'''
 |-
 | colspan="2" | Controls the state of one of the Relay outputs on the MIAC slave.&nbsp;
@@ Line 787: / Line 787: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetTransistorOutput'''
+| width="90%" class="mtx-class-macrohead" | '''SetTransistorOutput'''
 |-
 | colspan="2" | Controls the state of one of the transistor outputs on the MIAC slave.&nbsp;
@@ Line 812: / Line 812: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-

SteveT (talk | contribs)