Component: MIAC AllCode API (dsPIC) (AllCode)
From Flowcode Help
Jump to navigationJump to searchAuthor | Matrix TSL |
Version | 1.1 |
Category | AllCode |
Contents
- 1 MIAC AllCode API (dsPIC) component
- 2 Component Source Code
- 3 Detailed description
- 4 Examples
- 5 Macro reference
- 5.1 CardCreate
- 5.2 CardDelete
- 5.3 CardInserted
- 5.4 CardOpen
- 5.5 CardReadByte
- 5.6 CardWriteByte
- 5.7 CommsBaud
- 5.8 CommsRead
- 5.9 CommsWrite
- 5.10 GetAPIVersion
- 5.11 LCDBacklight
- 5.12 LCDBitmap
- 5.13 LCDClear
- 5.14 LCDCursor
- 5.15 LCDLine
- 5.16 LCDNumber
- 5.17 LCDOptions
- 5.18 LCDPixel
- 5.19 LCDPrint
- 5.20 LCDRect
- 5.21 LCDVerbose
- 5.22 PWMConfig
- 5.23 PWMDuty
- 5.24 PWMEnable
- 5.25 ReadAnalogInput
- 5.26 ReadDigitalInput
- 5.27 ReadInputs
- 5.28 ReadKey
- 5.29 ReadRTC
- 5.30 WriteRTC
- 5.31 WriteRelay
- 5.32 WriteRelays
- 5.33 WriteTran
- 5.34 WriteTrans
- 6 Property reference
MIAC AllCode API (dsPIC) 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_Component_Source.fcsx
Please click here to view the component source code (Beta): FC_Comp_Source_MIAC_AllCode_Component_Source.fcsx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
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
PWMConfig
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
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 | |
API Connection Type | |
API connection mode. COM - Bluetooth / RS232 / RS485 WIFI - Network | |
Auto Detect | |
Baud | |