Component: UART Free (Peripheral CAL): Difference between revisions
Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd |- | width="20%" style="color:gray;" | Version | 1.3 |- | width="20%" style="color:gray..." |
No edit summary |
||
| Line 20: | Line 20: | ||
==Detailed description== | ==Detailed description== | ||
| Line 36: | Line 38: | ||
==Examples== | ==Examples== | ||
Revision as of 14:43, 16 January 2023
| Author | Matrix Ltd |
| Version | 1.3 |
| Category | Peripheral CAL |
UART Free component
A low level implementation giving direct access to the CAL
Component Source Code
Please click here for the component source code: FC_Comp_Source_UART_Free.fcfx
Detailed description
No detailed description exists yet for this component
Examples
Example showing how to build a component using a CAL component Using CAL Components.
Downloadable macro reference
|
UpdateBaud |
| Changes the UART Baud rate. 0 = 1200 / 1 = 2400 / 3 = 4800 / 3 = 9600 / 4 = 19200 / 5 = 38400 6 = 57600 / 7 = 115200 | |
 - BYTE
|
new_baud |
| The new baud rate (0=1200, 7=115200) | |
 - VOID
|
Return |
|
|
GetValue |
| Get Value of Named property | |
 - STRING
|
Name |
| - STRING
|
Return |
|
|
Receive |
| Receive a Character | |
| - BYTE
|
Timeout |
| Period to wait for the character to be received | |
 - INT
|
Return |
|
|
Send |
| Send the Character | |
 - UINT
|
Char |
| The Character to send | |
| - VOID
|
Return |
|
|
GetConsoleHandle |
 - HANDLE
|
Return |
|
|
Init |
| Initialize the component with the specified properties | |
| - VOID
|
Return |
|
|
Delay |
| Software UART Bit Delay | |
| - VOID
|
Return |
|
|
SetValue |
| set Value of Named property | |
| - STRING
|
Name |
| - STRING
|
Value |
| - VOID
|
Return |
|
|
Uninit |
| Un-initialize the UART and release the resources | |
| - VOID
|
Return |
|
|
GetList |
| Gets Named property List | |
| - STRING
|
Name |
| - STRING
|
Return |
Property reference
|
Properties |
|
Channel |
| UART Channel selector | |
|
TX |
| Pin to be used for Transmit data | |
|
|
RX |
| Pin to be used for Receive data | |
|
|
Baud Options |
| Baud rate option selector | |
|
Baud Rate |
|
|
Data Bits |
| Number of data bits | |
|
|
Return |
| Return data width from Receive macro | |
|
|
Echo |
| Echo selection | |
|
|
Interrupt |
| Interrupt mode enable or disable | |
|
|
Flow Control |
| Flow Control (Handshake) enable or disable | |
|
Simulation |
|
Scope Traces |
| Selects if the scope traces are automatically generated or not | |
|
|
Console Data |
| Selects if the console data is automatically generated or not | |