Difference between revisions of "Component: UART SCADA (CAL) (Misc)"
From Flowcode Help
Jump to navigationJump to search (Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 2.1 |- | width="20%" style="color:gray...") |
|||
| Line 15: | Line 15: | ||
CAL = Code Abstraction Layer - Allows one code base to run on a wide range of chips. A low level implementation giving direct access to the UART peripheral. Includes simulation functionality to commmunicate via a COM port or an Injector component. Also includes timestamped logging via the console and Data Recorder trace monitoring support. | CAL = Code Abstraction Layer - Allows one code base to run on a wide range of chips. A low level implementation giving direct access to the UART peripheral. Includes simulation functionality to commmunicate via a COM port or an Injector component. Also includes timestamped logging via the console and Data Recorder trace monitoring support. | ||
| − | ==Component | + | ==Component Source Code== |
| − | + | Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_UART_SCADA.fcfx FC_Comp_Source_UART_SCADA.fcfx] | |
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 32: | Line 34: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 251: | Line 255: | ||
|- | |- | ||
| colspan="2" | A global flag to enable or disable the UART component from producing code. Useful for generating components with multiple communications options. | | colspan="2" | A global flag to enable or disable the UART component from producing code. Useful for generating components with multiple communications options. | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Runtime | ||
| + | |- | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| Line 286: | Line 294: | ||
|- | |- | ||
| colspan="2" | COM port data rate in bits per second | | colspan="2" | COM port data rate in bits per second | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|} | |} | ||
Revision as of 17:52, 9 November 2022
| Author | Matrix TSL |
| Version | 2.1 |
| Category | Misc |
Contents
UART SCADA component
CAL = Code Abstraction Layer - Allows one code base to run on a wide range of chips. A low level implementation giving direct access to the UART peripheral. Includes simulation functionality to commmunicate via a COM port or an Injector component. Also includes timestamped logging via the console and Data Recorder trace monitoring support.
Component Source Code
Please click here for the component source code: FC_Comp_Source_UART_SCADA.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Downloadable macro reference
|
SendString |
| Transmits a string of bytes via the UART peripheral | |
 - STRING
|
Data |
| Data String to transmit | |
 - VOID
|
Return |
|
|
Receive |
| Receive a Character | |
 - UINT
|
Timeout |
| Period to wait for the character to be received | |
 - INT
|
Return |
|
|
ScanForDeviceID |
| Checks to see if a device VID/PID string is present and returns the COM port number. Returns 0 if device not found. | |
| - STRING
|
HWID |
| Example: "VID_12BF&PID_0101" | |
 - BYTE
|
Return |
|
|
Send |
| Send the Character | |
| - UINT
|
Char |
| The Character to send | |
| - VOID
|
Return |
|
|
GetConsoleHandle |
 - HANDLE
|
Return |
|
|
SendByteArray |
| Transmits an array of bytes via the UART peripheral | |
| - BYTE
|
Data |
| Data to transmit | |
| - UINT
|
NumBytes |
| Number of bytes to send from the array | |
| - VOID
|
Return |
|
|
Init |
| Initialize the component with the specified properties | |
| - VOID
|
Return |
|
|
Uninit |
| Un-initialize the UART and release the resources | |
| - VOID
|
Return |
|
|
ReceiveByteArray |
| Receives an array of bytes and returns the number of bytes received. | |
| - BYTE
|
Data |
| A byte array variable to hold the received data | |
| - UINT
|
NumBytes |
| Maximum number of bytes to try and receive | |
| - UINT
|
Timeout |
| Max amount of time in ms to wait between bytes | |
| - UINT
|
Return |
|
|
ReceiveString |
| Receives a string of bytes and returns the number of bytes received. | |
| - STRING
|
StringData |
| - UINT
|
NumBytes |
| Maximum number of bytes to try and receive | |
| - UINT
|
Timeout |
| Max amount of time in ms to wait between bytes | |
| - BYTE
|
Return |
Property reference
|
Properties |
|
Component Enable |
| A global flag to enable or disable the UART component from producing code. Useful for generating components with multiple communications options. | |
|
Runtime |
|
|
Console Data |
| Selects if the console data is automatically generated or not | |
|
Console Columns |
| Number of characters that can be displayed on a single line of the console. | |
|
|
Auto Close |
| Auto close the port on Sim stop event | |
|
Data Source |
| Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port Injector - Routes the communication data via a data injector component on the Panel. | |
|
|
COM Port |
| Lists all the current available COM port hardware on your PC. | |
|
|
Refresh Ports |
|
|
Baud Rate |
| COM port data rate in bits per second | |
