Difference between revisions of "Component: MIAC AllCode (MIAC: PC Peripheral)"

Revision as of 11:51, 3 February 2023

Author	Matrix TSL
Version	1.0
Category	MIAC: PC Peripheral

MIAC AllCode component

MIAC AllCode. dsPIC version of the MIAC loaded with the AllCode firmware. Usefull for SCADA, Control or Test applications. Allows you to control the MIAC using the programming language of choice. Compatible with simulation / Bluetooth / Wifi / RS232 and RS485

Component Source Code

Please click here to download the component source project: FC_Comp_Source_MIAC_AllCode_Firmware.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_MIAC_AllCode_Firmware.fcfx

Detailed description

No detailed description exists yet for this component

Examples

Bluetooth based examples.

MIAC AllCode Bluetooth

WIFI based examples.

MIAC AllCode WIFI

USB Driver

USB Serial Driver

Macro reference

CommsWrite

	CommsWrite
Writes a byte to the alt communications channel
- BYTE	Data
Range: 0-255
- VOID	Return

WriteTrans

	WriteTrans
Allows all transistor outputs to be switched on or off in a single command.
- BYTE	Value
Range: 0-15 or 0b0000 to 0b1111
- VOID	Return

LCDPixel

	LCDPixel
Controls a single pixel on the MIAC display
- BYTE	X
Range: 0-119
- BYTE	Y
Range: 0-49
- BYTE	State
Range: 0-1
- VOID	Return

CardCreate

	CardCreate
Attempts to create a specific file on the card. Returns 0 for success, 255 for no card or error.
- STRING	Filename

- BYTE	Return

CardDelete

	CardDelete
Attempts to delete a specific file on the card. Returns 0 for success, 255 for no card or error.
- STRING	Filename

- BYTE	Return

LCDBitmap

	LCDBitmap
Draws a bitmap file from the SD card onto the MIAC display
- BYTE	X
Range: 0-119
- BYTE	Y
Range: 0-49
- STRING	Filename
Range: 0-1
- VOID	Return

GetAPIVersion

	GetAPIVersion
Gets the API version of the Robot ARM Firmware
- BYTE	Return

LCDNumber

	LCDNumber
Prints a number to the MIAC display starting from the current cursor position.
- INT	Value
Range: -32678 - 32767
- VOID	Return

CardInserted

	CardInserted
Checks to see if a card is present. Returns 0 for no card or 1 for card detected
- BYTE	Return

ReadRTC

	ReadRTC
Reads a value from the real time clock module. Used for getting the time or date.
- BYTE	Unit
0=Second 1=Minute 2=Hour 3=Day 4=Month 5=Year
- BYTE	Return

CardOpen

	CardOpen
Attempts to open a specific file from the card. Returns 0 for file found and opened, 239 for file not found and 255 for no card.
- STRING	Filename

- BYTE	Return

CommsRead

	CommsRead
Reads a byte from the alt communications channel
- BYTE	Timeout
Range: 0-255 : 0 = Don't wait / 1-255 = ms
- BYTE	Return

ReadKey

	ReadKey
Reads a keypress from the keypad.
- BYTE	Return

WriteRTC

	WriteRTC
Writes a value to the real time clock module. Used for setting the time or date.
- BYTE	Unit
0=Second 1=Minute 2=Hour 3=Day 4=Month 5=Year
- BYTE	Value

- VOID	Return

LCDBacklight

	LCDBacklight
Controls the brightness of the LCD backlight.
- BYTE	Brightness
Range: 0-100
- VOID	Return

WriteRelay

	WriteRelay
Allows a single relay to be switched on or off.
- BYTE	Channel
Range 1-4
- BYTE	Value
0 = Off, 1 = On
- VOID	Return

LCDPrint

	LCDPrint
Prints a string to the MIAC display starting from the current cursor position.
- STRING	data
Range: 0-21
- VOID	Return

LCDLine

	LCDLine
Draws a single pixel width line on the MIAC display
- BYTE	X1
Range: 0-119
- BYTE	Y1
Range: 0-49
- BYTE	X2
Range: 0-119
- BYTE	Y2
Range: 0-49
- VOID	Return

ReadInputs

	ReadInputs
Reads all digital inputs at once and returns as a binary value. Input 1 = Bit 0 Input 8 = Bit 7
- BYTE	Return

CardReadByte

	CardReadByte
Reads a byte from the open file.
- BYTE	Return

WriteRelays

	WriteRelays
Allows all relays to be switched on or off in a single command.
- BYTE	Value
Range: 0-15 or 0b0000 to 0b1111
- VOID	Return

CardWriteByte

	CardWriteByte
Appends a byte to the end of the open file. Returns 0 for success.
- BYTE	data

- BYTE	Return

LCDRect

	LCDRect
Draws a single pixel rectangle on the MIAC display
- BYTE	X1
Range: 0-119
- BYTE	Y1
Range: 0-49
- BYTE	X2
Range: 0-119
- BYTE	Y2
Range: 0-49
- VOID	Return

ReadAnalogInput

	ReadAnalogInput
Reads a single digital input.
- BYTE	Channel

- UINT	Return

CommsBaud

	CommsBaud
Sets the Baud rate of the alt communications channel
- BYTE	Baud
Range: 0-7 : 0=1200 / 7=115200
- VOID	Return

LCDOptions

	LCDOptions
Controls some of the LCD options
- BYTE	Foreground
Range: 0-1
- BYTE	Background
Range: 0-1
- BYTE	Transparent
Range: 0-1
- VOID	Return

LCDVerbose

	LCDVerbose
Controls the Verbose mode. When enabled the LCD automatically displays an account of the incoming API commands and parameters. When switched off the LCD is free for the user to control as required.
- BYTE	Mode
Range: 0-1 : 0=Off or User Mode / 1=API Verbose Mode
- VOID	Return

ReadDigitalInput

	ReadDigitalInput
Reads a single digital input.
- BYTE	Channel

- BYTE	Return

PWMConfig

	PWMConfig
Sets the PWM configuration. Channel = 0 - 1 : 0 = EN_AB, A, B / 1 = EN_CD, C, D Period = 0 - 65535 Scaler = 0 - 3 : 0=1:1 1=1:8 2=1:64 3=1:256
- BYTE	Channel
Range 0-1
- UINT	Period
Range: 0-65535
- BYTE	Scaler
Range: 0-3
- VOID	Return

PWMEnable

	PWMEnable
Allows pulse width modulated transistor outputs to be switched on or off. Bit 0 = Enable AB Bit 1 = A / Bit 2 = B Bit 3 = C / Bit 4 = D Bit 5 = Enable CD
- BYTE	EnableMask
Range 0-63 or 0b00000 to 0b111111
- VOID	Return

PWMDuty

	PWMDuty
Sets a single PWM channel duty. Channel = 0 - 5 : 0=EN_AB, 1=A, 2=B, 3=C, 4=D, 5=EN_CD Duty = 0 - 65535
- BYTE	Channel
Range 0-5
- UINT	Duty

- VOID	Return

LCDCursor

	LCDCursor
Sets the cursor position for the MIAC display
- BYTE	X
Range: 0-21
- BYTE	Y
Range: 0-4
- VOID	Return

WriteTran

	WriteTran
Allows a single transistor output to be switched on or off.
- BYTE	Channel
Range 1-4
- BYTE	Value
0 = Off, 1 = On
- VOID	Return

LCDClear

	LCDClear
Clears the MIAC display
- VOID	Return

Property reference

	Properties
	Connections
	Operating Mode
	Mode
Configures how the simulation component functions, does it simply simulate or does it control real hardware.
	API Connection Type
API connection mode. COM - Bluetooth / RS232 / RS485 WIFI - Network
	AutoDetect Port

	Baud

@@ Line 90: / Line 90: @@
 {{Zip|USBSerial_Driver.zip|USB Serial Driver}}
@@ Line 96: / Line 98: @@
 ==Macro reference==
+===CommsWrite===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 114: / Line 117: @@
+===WriteTrans===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 132: / Line 136: @@
+===LCDPixel===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 160: / Line 165: @@
+===CardCreate===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 178: / Line 184: @@
+===CardDelete===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 196: / Line 203: @@
+===LCDBitmap===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 224: / Line 232: @@
+===GetAPIVersion===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 237: / Line 246: @@
+===LCDNumber===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 255: / Line 265: @@
+===CardInserted===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 268: / Line 279: @@
+===ReadRTC===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 286: / Line 298: @@
+===CardOpen===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 304: / Line 317: @@
+===CommsRead===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 322: / Line 336: @@
+===ReadKey===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 335: / Line 350: @@
+===WriteRTC===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 358: / Line 374: @@
+===LCDBacklight===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 376: / Line 393: @@
+===WriteRelay===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 399: / Line 417: @@
+===LCDPrint===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 417: / Line 436: @@
+===LCDLine===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 450: / Line 470: @@
+===ReadInputs===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 463: / Line 484: @@
+===CardReadByte===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 476: / Line 498: @@
+===WriteRelays===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 494: / Line 517: @@
+===CardWriteByte===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 512: / Line 536: @@
+===LCDRect===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 545: / Line 570: @@
+===ReadAnalogInput===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 563: / Line 589: @@
+===CommsBaud===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 581: / Line 608: @@
+===LCDOptions===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 609: / Line 637: @@
+===LCDVerbose===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 627: / Line 656: @@
+===ReadDigitalInput===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 645: / Line 675: @@
+===PWMConfig===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 673: / Line 704: @@
+===PWMEnable===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 691: / Line 723: @@
+===PWMDuty===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 714: / Line 747: @@
+===LCDCursor===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 737: / Line 771: @@
+===WriteTran===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 760: / Line 795: @@
+===LCDClear===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-