Component: MIAC AllCode (MIAC: PC Peripheral): Difference between revisions
No edit summary |
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder"" |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/ | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_MIAC_AllCode_Firmware.fcfx FC_Comp_Source_MIAC_AllCode_Firmware.fcfx] | ||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/ | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_MIAC_AllCode_Firmware.fcfx FC_Comp_Source_MIAC_AllCode_Firmware.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| Line 90: | Line 90: | ||
{{Zip|USBSerial_Driver.zip|USB Serial Driver}} | {{Zip|USBSerial_Driver.zip|USB Serial Driver}} | ||
| Line 101: | Line 105: | ||
===CardCreate=== | ===CardCreate=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CardCreate''' | ||
|- | |- | ||
| colspan="2" | Attempts to create a specific file on the card. Returns 0 for success, 255 for no card or error. | | colspan="2" | Attempts to create a specific file on the card. Returns 0 for success, 255 for no card or error. | ||
| Line 120: | Line 124: | ||
===CardDelete=== | ===CardDelete=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CardDelete''' | ||
|- | |- | ||
| colspan="2" | Attempts to delete a specific file on the card. Returns 0 for success, 255 for no card or error. | | colspan="2" | Attempts to delete a specific file on the card. Returns 0 for success, 255 for no card or error. | ||
| Line 139: | Line 143: | ||
===CardInserted=== | ===CardInserted=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CardInserted''' | ||
|- | |- | ||
| colspan="2" | Checks to see if a card is present. Returns 0 for no card or 1 for card detected | | colspan="2" | Checks to see if a card is present. Returns 0 for no card or 1 for card detected | ||
| Line 153: | Line 157: | ||
===CardOpen=== | ===CardOpen=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CardOpen''' | ||
|- | |- | ||
| colspan="2" | 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. | | colspan="2" | 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. | ||
| Line 172: | Line 176: | ||
===CardReadByte=== | ===CardReadByte=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CardReadByte''' | ||
|- | |- | ||
| colspan="2" | Reads a byte from the open file. | | colspan="2" | Reads a byte from the open file. | ||
| Line 186: | Line 190: | ||
===CardWriteByte=== | ===CardWriteByte=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CardWriteByte''' | ||
|- | |- | ||
| colspan="2" | Appends a byte to the end of the open file. Returns 0 for success. | | colspan="2" | Appends a byte to the end of the open file. Returns 0 for success. | ||
| Line 205: | Line 209: | ||
===CommsBaud=== | ===CommsBaud=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CommsBaud''' | ||
|- | |- | ||
| colspan="2" | Sets the Baud rate of the alt communications channel | | colspan="2" | Sets the Baud rate of the alt communications channel | ||
| Line 224: | Line 228: | ||
===CommsRead=== | ===CommsRead=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CommsRead''' | ||
|- | |- | ||
| colspan="2" | Reads a byte from the alt communications channel | | colspan="2" | Reads a byte from the alt communications channel | ||
| Line 243: | Line 247: | ||
===CommsWrite=== | ===CommsWrite=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CommsWrite''' | ||
|- | |- | ||
| colspan="2" | Writes a byte to the alt communications channel | | colspan="2" | Writes a byte to the alt communications channel | ||
| Line 262: | Line 266: | ||
===GetAPIVersion=== | ===GetAPIVersion=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetAPIVersion''' | ||
|- | |- | ||
| colspan="2" | Gets the API version of the Robot ARM Firmware | | colspan="2" | Gets the API version of the Robot ARM Firmware | ||
| Line 276: | Line 280: | ||
===LCDBacklight=== | ===LCDBacklight=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''LCDBacklight''' | ||
|- | |- | ||
| colspan="2" | Controls the brightness of the LCD backlight. | | colspan="2" | Controls the brightness of the LCD backlight. | ||
| Line 295: | Line 299: | ||
===LCDBitmap=== | ===LCDBitmap=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''LCDBitmap''' | ||
|- | |- | ||
| colspan="2" | Draws a bitmap file from the SD card onto the MIAC display | | colspan="2" | Draws a bitmap file from the SD card onto the MIAC display | ||
| Line 324: | Line 328: | ||
===LCDClear=== | ===LCDClear=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''LCDClear''' | ||
|- | |- | ||
| colspan="2" | Clears the MIAC display | | colspan="2" | Clears the MIAC display | ||
| Line 338: | Line 342: | ||
===LCDCursor=== | ===LCDCursor=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''LCDCursor''' | ||
|- | |- | ||
| colspan="2" | Sets the cursor position for the MIAC display | | colspan="2" | Sets the cursor position for the MIAC display | ||
| Line 362: | Line 366: | ||
===LCDLine=== | ===LCDLine=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''LCDLine''' | ||
|- | |- | ||
| colspan="2" | Draws a single pixel width line on the MIAC display | | colspan="2" | Draws a single pixel width line on the MIAC display | ||
| Line 396: | Line 400: | ||
===LCDNumber=== | ===LCDNumber=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''LCDNumber''' | ||
|- | |- | ||
| colspan="2" | Prints a number to the MIAC display starting from the current cursor position. | | colspan="2" | Prints a number to the MIAC display starting from the current cursor position. | ||
| Line 415: | Line 419: | ||
===LCDOptions=== | ===LCDOptions=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''LCDOptions''' | ||
|- | |- | ||
| colspan="2" | Controls some of the LCD options | | colspan="2" | Controls some of the LCD options | ||
| Line 444: | Line 448: | ||
===LCDPixel=== | ===LCDPixel=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''LCDPixel''' | ||
|- | |- | ||
| colspan="2" | Controls a single pixel on the MIAC display | | colspan="2" | Controls a single pixel on the MIAC display | ||
| Line 473: | Line 477: | ||
===LCDPrint=== | ===LCDPrint=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''LCDPrint''' | ||
|- | |- | ||
| colspan="2" | Prints a string to the MIAC display starting from the current cursor position. | | colspan="2" | Prints a string to the MIAC display starting from the current cursor position. | ||
| Line 492: | Line 496: | ||
===LCDRect=== | ===LCDRect=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''LCDRect''' | ||
|- | |- | ||
| colspan="2" | Draws a single pixel rectangle on the MIAC display | | colspan="2" | Draws a single pixel rectangle on the MIAC display | ||
| Line 526: | Line 530: | ||
===LCDVerbose=== | ===LCDVerbose=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''LCDVerbose''' | ||
|- | |- | ||
| colspan="2" | 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. | | colspan="2" | 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. | ||
| Line 545: | Line 549: | ||
===PWMConfig=== | ===PWMConfig=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''PWMConfig''' | ||
|- | |- | ||
| colspan="2" | 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 | | colspan="2" | 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 | ||
| Line 574: | Line 578: | ||
===PWMDuty=== | ===PWMDuty=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''PWMDuty''' | ||
|- | |- | ||
| colspan="2" | 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 | | colspan="2" | 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 | ||
| Line 598: | Line 602: | ||
===PWMEnable=== | ===PWMEnable=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''PWMEnable''' | ||
|- | |- | ||
| colspan="2" | 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 | | colspan="2" | 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 | ||
| Line 617: | Line 621: | ||
===ReadAnalogInput=== | ===ReadAnalogInput=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadAnalogInput''' | ||
|- | |- | ||
| colspan="2" | Reads a single digital input. | | colspan="2" | Reads a single digital input. | ||
| Line 636: | Line 640: | ||
===ReadDigitalInput=== | ===ReadDigitalInput=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadDigitalInput''' | ||
|- | |- | ||
| colspan="2" | Reads a single digital input. | | colspan="2" | Reads a single digital input. | ||
| Line 655: | Line 659: | ||
===ReadInputs=== | ===ReadInputs=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadInputs''' | ||
|- | |- | ||
| colspan="2" | Reads all digital inputs at once and returns as a binary value. Input 1 = Bit 0 Input 8 = Bit 7 | | colspan="2" | Reads all digital inputs at once and returns as a binary value. Input 1 = Bit 0 Input 8 = Bit 7 | ||
| Line 669: | Line 673: | ||
===ReadKey=== | ===ReadKey=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadKey''' | ||
|- | |- | ||
| colspan="2" | Reads a keypress from the keypad. | | colspan="2" | Reads a keypress from the keypad. | ||
| Line 683: | Line 687: | ||
===ReadRTC=== | ===ReadRTC=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadRTC''' | ||
|- | |- | ||
| colspan="2" | Reads a value from the real time clock module. Used for getting the time or date. | | colspan="2" | Reads a value from the real time clock module. Used for getting the time or date. | ||
| Line 702: | Line 706: | ||
===WriteRTC=== | ===WriteRTC=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''WriteRTC''' | ||
|- | |- | ||
| colspan="2" | Writes a value to the real time clock module. Used for setting the time or date. | | colspan="2" | Writes a value to the real time clock module. Used for setting the time or date. | ||
| Line 726: | Line 730: | ||
===WriteRelay=== | ===WriteRelay=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''WriteRelay''' | ||
|- | |- | ||
| colspan="2" | Allows a single relay to be switched on or off. | | colspan="2" | Allows a single relay to be switched on or off. | ||
| Line 750: | Line 754: | ||
===WriteRelays=== | ===WriteRelays=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''WriteRelays''' | ||
|- | |- | ||
| colspan="2" | Allows all relays to be switched on or off in a single command. | | colspan="2" | Allows all relays to be switched on or off in a single command. | ||
| Line 769: | Line 773: | ||
===WriteTran=== | ===WriteTran=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''WriteTran''' | ||
|- | |- | ||
| colspan="2" | Allows a single transistor output to be switched on or off. | | colspan="2" | Allows a single transistor output to be switched on or off. | ||
| Line 793: | Line 797: | ||
===WriteTrans=== | ===WriteTrans=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''WriteTrans''' | ||
|- | |- | ||
| colspan="2" | Allows all transistor outputs to be switched on or off in a single command. | | colspan="2" | Allows all transistor outputs to be switched on or off in a single command. | ||
| Line 809: | Line 813: | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
==Property reference== | ==Property reference== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Properties''' | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Connections | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Operating Mode | ||
|- | |- | ||
|- | |- | ||
Latest revision as of 14:36, 13 July 2026
| 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.
WIFI based examples.
USB Driver
Macro reference
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 |
CardInserted
|
|
CardInserted |
| Checks to see if a card is present. Returns 0 for no card or 1 for card detected | |
| - 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 |
CardReadByte
|
|
CardReadByte |
| Reads a byte from the open file. | |
| - BYTE
|
Return |
CardWriteByte
|
|
CardWriteByte |
| Appends a byte to the end of the open file. Returns 0 for success. | |
| - BYTE
|
data |
| - BYTE
|
Return |
CommsBaud
|
|
CommsBaud |
| Sets the Baud rate of the alt communications channel | |
| - BYTE
|
Baud |
| Range: 0-7 : 0=1200 / 7=115200 | |
 - VOID
|
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 |
CommsWrite
|
|
CommsWrite |
| Writes a byte to the alt communications channel | |
| - BYTE
|
Data |
| Range: 0-255 | |
| - VOID
|
Return |
GetAPIVersion
|
|
GetAPIVersion |
| Gets the API version of the Robot ARM Firmware | |
| - BYTE
|
Return |
LCDBacklight
|
|
LCDBacklight |
| Controls the brightness of the LCD backlight. | |
| - BYTE
|
Brightness |
| Range: 0-100 | |
| - VOID
|
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 |
LCDClear
|
|
LCDClear |
| Clears the MIAC display | |
| - VOID
|
Return |
LCDCursor
|
|
LCDCursor |
| Sets the cursor position for the MIAC display | |
| - BYTE
|
X |
| Range: 0-21 | |
| - BYTE
|
Y |
| Range: 0-4 | |
| - 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 |
LCDNumber
|
|
LCDNumber |
| Prints a number to the MIAC display starting from the current cursor position. | |
 - INT
|
Value |
| Range: -32678 - 32767 | |
| - 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 |
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 |
LCDPrint
|
|
LCDPrint |
| Prints a string to the MIAC display starting from the current cursor position. | |
| - STRING
|
data |
| Range: 0-21 | |
| - VOID
|
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 |
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 |
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 |
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 |
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 |
ReadAnalogInput
|
|
ReadAnalogInput |
| Reads a single digital input. | |
| - BYTE
|
Channel |
| - UINT
|
Return |
ReadDigitalInput
|
|
ReadDigitalInput |
| Reads a single digital input. | |
| - BYTE
|
Channel |
| - BYTE
|
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 |
ReadKey
|
|
ReadKey |
| Reads a keypress from the keypad. | |
| - 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 |
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 |
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 |
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 |
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 |
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 |
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 |