Component: UART Software (Timer) (Comms: Interface)
| Author | MatrixTSL |
| Version | 1.0 |
| Category | Comms: Interface |
UART Software (Timer) component
Creates a reliable software UART that can be driven using a timer interrupt setup by the user. The timer interrupt must be interrupting at the required baud rate. e.g 9600Hz.
Component Source Code
Please click here for the component source code: FC_Comp_Source_UART_Software_Timer.fcfx
Detailed description
No detailed description exists yet for this component
Examples
Simple example showing how to enable a timer interrupt at the desired baud rate then receive a string. If anything is received then it will be echoed back out and displayed on a LCD
Macro reference
|
SendString |
| Sends an string to the transmit buffer | |
 - STRING
|
Data |
 - VOID
|
Return |
|
|
ReceiveArray |
| Gets an array of values from the receive buffer. Returns number of values received. | |
 - UINT
|
Values |
| - UINT
|
NumValues |
| - UINT
|
Timeout |
| Time in milliseconds to wait for data | |
| - UINT
|
Return |
|
|
SendArray |
| Sends an array of values to the transmit buffer | |
| - UINT
|
Values |
| - UINT
|
NumValues |
| - VOID
|
Return |
|
|
UART_Timer_Process |
| Called as part of a timer interrupt at the specific UART baud rate. | |
| - VOID
|
Return |
|
|
ReceiveValue |
| Gets a single value from the receive buffer | |
| - UINT
|
Timeout |
| Time in milliseconds to wait for data | |
| - UINT
|
Return |
|
|
SendValue |
| Sends a single value to the transmit buffer | |
| - UINT
|
Value |
| - VOID
|
Return |
|
|
CheckBuffer |
| Returns the number of values in the transmit or receive buffer | |
 - BOOL
|
Buffer |
| 0=Transmit / 1=Receive | |
| - UINT
|
Return |
|
|
ReceiveString |
| Gets a string from the receive buffer | |
| - UINT
|
MaxChars |
| - UINT
|
Timeout |
| Time in milliseconds to wait for data | |
| - STRING
|
Return |
|
|
Initialise |
| Initialises the UART component pins ready to send and receive data | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Global Settings |
|
Data Bits |
|
|
Stop Bits |
|
Use TX |
| Allows the Transmit pin to be enabled / disabled | |
|
|
Use RX |
| Allows the Receive pin to be enabled / disabled | |
|
|
Transmit Properties |
|
Transmit Pin |
| Pin assigned to transmitting data | |
|
Transmit Buffer Size |
| Number of bytes that can be stored in the outgoing transmit buffer | |
|
|
Receive Properties |
|
|
Receive Pin |
| Pin assigned to receiving data | |
|
|
Receive Buffer Size |
| Number of bytes that can be stored in the incoming receive buffer | |
|
|
Simulation |
|
|
API |