Difference between revisions of "Component: UART Software (Timer) (Comms: Interface)"
From Flowcode Help
Jump to navigationJump to search| Line 16: | Line 16: | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
''No detailed description exists yet for this component'' | ''No detailed description exists yet for this component'' | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 198: | Line 202: | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| Line 261: | Line 237: | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Start''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Startup routine required by the hardware device. Automatically clears the display after initialising. |
|- | |- | ||
|- | |- | ||
| Line 274: | Line 250: | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLEDState''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Sets the state of a single LED |
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE |
| − | | width="90%" | | + | | width="90%" | Port |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | 0 = PortA, 1 = PortB |
|- | |- | ||
| − | | width="10%" align="center | + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE |
| − | | width="90% | + | | width="90%" | LED |
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| − | | | + | | colspan="2" | 0 = LED0, 7 = LED7 |
| − | |||
| − | |||
| − | |||
|- | |- | ||
| − | + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | |
| − | + | | width="90%" | State | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | | width="10%" align="center" | [[File:Fc9- | ||
| − | | width="90%" | | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 328: | Line 278: | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRxIdent''' |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Gets the Rx ID as a Integer Standard and Extended IDs. |
|- | |- | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| − | | width="90%" | | + | | width="90%" | Buffer |
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| − | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| Line 387: | Line 296: | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Must be called before any other CAN component macros to enable and initialise the CAN peripheral. |
|- | |- | ||
|- | |- | ||
| − | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
Revision as of 10:35, 17 November 2021
| Author | MatrixTSL |
| Version | 1.0 |
| Category | Comms: Interface |
Contents
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.
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
Downloadable 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 | |
| [[File:]] - | 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 |
|
|
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 |
|
|
Start |
| Startup routine required by the hardware device. Automatically clears the display after initialising. | |
| - VOID
|
Return |
|
|
SetLEDState |
| Sets the state of a single LED | |
| - BYTE
|
Port |
| 0 = PortA, 1 = PortB | |
| - BYTE
|
LED |
| 0 = LED0, 7 = LED7 | |
| - BYTE
|
State |
| - VOID
|
Return |
|
|
GetRxIdent |
| Gets the Rx ID as a Integer Standard and Extended IDs. | |
| - BYTE
|
Buffer |
 - ULONG
|
Return |
|
|
Initialise |
| Must be called before any other CAN component macros to enable and initialise the CAN peripheral. | |
| - VOID
|
Return |
Property reference
|
Properties |
|
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 Pin |
| Pin assigned to transmitting data | |
|
Transmit Buffer Size |
| Number of bytes that can be stored in the outgoing transmit buffer | |
|
|
Receive Pin |
| Pin assigned to receiving data | |
|
|
Receive Buffer Size |
| Number of bytes that can be stored in the incoming receive buffer | |
|
Connections |
|
|
Simulations |
|
|
API |
