Jump to content

Component: UART Software (Timer) (Comms: Interface): Difference between revisions

From Flowcode Help
← Older edit

SteveT (talk | contribs)

4 user groups
6,424 edits
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(24 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{| style="width:50%"
 
{| width="50%"
|-
|-
| width="20%" style="color: gray;" | Author
| width="20%" style="color:gray;" | Author
| MatrixTSL
| MatrixTSL
|-
|-
| width="20%" style="color: gray;" | Version
| width="20%" style="color:gray;" | Version
| 1.0 (Release)
| 1.0
|-
|-
| width="20%" style="color: gray;" | Category
| width="20%" style="color:gray;" | Category
| Comms: Interface
| 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.
==Detailed description==




==[[File:Component Icon 743ea495_34e7_47ee_bd79_3bfdc067b01c.png|Image]] 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.


==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


{{Fcfile|UART_Timer_Example.fcfx|UART_Timer_Example}}




==Downloadable macro reference==


===<span style="font-weight: normal;"><u><tt>SendString</tt></u></span>===
Sends an string to the transmit buffer


'''Parameters'''


:[[Variable Types|<- STRING]] ''Data''
::''This parameter may be returned back to the caller''




'''Return value'''


:''This call does not return a value''




===<span style="font-weight: normal;"><u><tt>ReceiveArray</tt></u></span>===
Gets an array of values from the receive buffer.


Returns number of values received.


'''Parameters'''


:[[Variable Types|UINT]] ''Values''


:[[Variable Types|UINT]] ''NumValues''


:[[Variable Types|UINT]] ''Timeout''
::Time in milliseconds to wait for data




'''Return value'''


:[[Variable Types|UINT]]
''No detailed description exists yet for this component''


==Examples==


===<span style="font-weight: normal;"><u><tt>SendArray</tt></u></span>===
Sends an array of values to the transmit buffer


'''Parameters'''


:[[Variable Types|UINT]] ''Values''


:[[Variable Types|UINT]] ''NumValues''




'''Return value'''


:''This call does not return a value''




===<span style="font-weight: normal;"><u><tt>UART_Timer_Process</tt></u></span>===
Called as part of a timer interrupt at the specific UART baud rate.


'''Parameters'''


:''This macro has no parameters''




'''Return value'''


:''This call does not return a value''




===<span style="font-weight: normal;"><u><tt>ReceiveValue</tt></u></span>===
Gets a single value from the receive buffer


'''Parameters'''


:[[Variable Types|UINT]] ''Timeout''
::Time in milliseconds to wait for data




'''Return value'''


:[[Variable Types|UINT]]




===<span style="font-weight: normal;"><u><tt>SendValue</tt></u></span>===
Sends a single value to the transmit buffer


'''Parameters'''


:[[Variable Types|UINT]] ''Value''
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


{{Fcfile|UART_Timer_Example.fcfx|UART_Timer_Example}}


'''Return value'''


:''This call does not return a value''




===<span style="font-weight: normal;"><u><tt>CheckBuffer</tt></u></span>===
Returns the number of values in the transmit or receive buffer


'''Parameters'''


:[[Variable Types|BOOL]] ''Buffer''
::0=Transmit / 1=Receive




'''Return value'''


:[[Variable Types|UINT]]




===<span style="font-weight: normal;"><u><tt>ReceiveString</tt></u></span>===
Gets a string from the receive buffer


'''Parameters'''


:[[Variable Types|UINT]] ''MaxChars''


:[[Variable Types|UINT]] ''Timeout''
::Time in milliseconds to wait for data




'''Return value'''
==Macro reference==


:[[Variable Types|STRING]]
===CheckBuffer===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''CheckBuffer'''
|-
| colspan="2" | Returns the number of values in the transmit or receive buffer&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Buffer
|-
| colspan="2" | 0=Transmit / 1=Receive&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
 
 
===Initialise===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''Initialise'''
|-
| colspan="2" | Initialises the UART component pins ready to send and receive data&nbsp;
|-
|-
| 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''
|}
 
 
===ReceiveBinary16Bit===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReceiveBinary16Bit'''
|-
| colspan="2" | Receives a binary 16-bit value split across two bytes.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | MSBfirst
|-
| colspan="2" | 0=Least significant byte first, 1=Most significant byte first&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Timeout
|-
| colspan="2" | Max amount of time in ms to wait between bytes&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
 
 
===ReceiveBinary32Bit===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReceiveBinary32Bit'''
|-
| colspan="2" | Receives a binary 32-bit value split across four bytes.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | MSBfirst
|-
| colspan="2" | 0=Least significant byte first, 1=Most significant byte first&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Timeout
|-
| colspan="2" | Max amount of time in ms to wait between bytes&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
 
 
===ReceiveBinaryFloat===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReceiveBinaryFloat'''
|-
| colspan="2" | Receives a binary 32-bit floating point value split across four bytes.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | MSBfirst
|-
| colspan="2" | 0=Least significant byte first, 1=Most significant byte first&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Timeout
|-
| colspan="2" | Max amount of time in ms to wait between bytes&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
 
 
===ReceiveBytetArray===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReceiveBytetArray'''
|-
| colspan="2" | Gets an array of values from the receive buffer. Returns number of values received.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Values
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | NumValues
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Timeout
|-
| colspan="2" | Time in milliseconds to wait for data&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>===
===ReceiveChar===
Initialises the UART component pins ready to send and receive data
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReceiveChar'''
|-
| colspan="2" | Attempts to receive a single packet from the UART interface.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Timeout
|-
| colspan="2" | Time to wait in milliseconds for valid data before returning, 0=Dont wait, 255=Wait forever.&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


'''Parameters'''


:''This macro has no parameters''
===ReceiveFloat===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReceiveFloat'''
|-
| colspan="2" | Attempts to receive a floating point number as ASCII characters and convert back into a numeric value. Note this function will receive until a timeout or a none numeric char is received, the none numeric char will be lost.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Timeout
|-
| colspan="2" | Max time in ms to wait in between bytes&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | IgnoreData
|-
| colspan="2" | 0=Dont ignore any data, 1=Ignore any initial none numeric data&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




'''Return value'''
===ReceiveHexNumber===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReceiveHexNumber'''
|-
| colspan="2" | Attempts to receive a hex number as ASCII characters and convert back into a numeric value. Note this function will receive until a timeout or a none hexadecimal char is received, the none numeric char will be lost.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Timeout
|-
| colspan="2" | Max time in ms to wait in between bytes&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | IgnoreData
|-
| colspan="2" | 0=Dont ignore any data, 1=Ignore any initial none numeric data&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Prefix
|-
| colspan="2" | Look for prefix before receiving, 1=0xFF, 0=FF&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:''This call does not return a value''


===ReceiveINTArray===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReceiveINTArray'''
|-
| colspan="2" | Receives an array of 16-bit INT/UINT values and returns the number of values received.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Data
|-
| colspan="2" | Array to store the incoming data&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | NumValues
|-
| colspan="2" | Maximum number of values to try and receive&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | MSBfirst
|-
| colspan="2" | 0=Least significant byte first, 1=Most significant byte first&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Timeout
|-
| colspan="2" | Max amount of time in ms to wait between bytes&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




==Simulation macro reference==
===ReceiveNumber===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReceiveNumber'''
|-
| colspan="2" | Attempts to receive a number as ASCII characters and convert back into a numeric value. Note this function will receive until a timeout or a none numeric char is received, the none numeric char will be lost.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Timeout
|-
| colspan="2" | Max time in ms to wait in between bytes&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | IgnoreData
|-
| colspan="2" | 0=Dont ignore any data, 1=Ignore any initial none numeric data&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


''This component does not contain any simulation macros''


===ReceiveString===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReceiveString'''
|-
| colspan="2" | Gets a string from the receive buffer&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | MaxChars
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Timeout
|-
| colspan="2" | Time in milliseconds to wait for data&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


==Property reference==
<span style="font-weight: normal;"><u>Data Bits</u></span>


This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''DataBits''.
===SendBinary16Bit===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SendBinary16Bit'''
|-
| colspan="2" | Sends out a 16-bit binary value split across two bytes.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Value
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | MSBfirst
|-
| colspan="2" | 0=Least significant byte first, 1=Most significant byte first&nbsp;
|-
| 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''
|}


Sets the number of data bits in a single packet, 7-bits provides values 0-127, 8-bits provides values 0-255 and 9-bits provides values 0-511.


9-bit data is often used for 8-bit plus a parity bit which is used for error detection.
===SendBinary32Bit===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SendBinary32Bit'''
|-
| colspan="2" | Sends out a 32-bit binary value split across four bytes.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Value
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | MSBfirst
|-
| colspan="2" | 0=Least significant byte first, 1=Most significant byte first&nbsp;
|-
| 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''
|}


<span style="font-weight: normal;"><u>Stop Bits</u></span>


This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''StopBits''.
===SendBinaryFloat===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SendBinaryFloat'''
|-
| colspan="2" | Sends out a 32-bit binary floating point value split across four bytes.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Value
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | MSBfirst
|-
| colspan="2" | 0=Least significant byte first, 1=Most significant byte first&nbsp;
|-
| 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''
|}


Number of stop bits at the end of each packet. Used to adjust the minimum spacing between packets.


<span style="font-weight: normal;"><u>Use TX</u></span>
===SendByteArray===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SendByteArray'''
|-
| colspan="2" | Sends an array of bytes to the transmit buffer&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Values
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | NumValues
|-
| colspan="2" | &nbsp;
|-
| 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''
|}


This property is of type ''True or false'' and can be referenced with the variable name ''UseTx''.


Allows the Transmit pin to be enabled / disabled
===SendChar===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SendChar'''
|-
| colspan="2" | Sends out a single packet from the UART interface.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" | Char
|-
| colspan="2" | &nbsp;
|-
| 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''
|}


<span style="font-weight: normal;"><u>Use RX</u></span>


This property is of type ''True or false'' and can be referenced with the variable name ''UseRx''.
===SendFloat===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SendFloat'''
|-
| colspan="2" | Sends a single float  to the transmit buffer&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Value
|-
| colspan="2" | &nbsp;
|-
| 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''
|}


Allows the Receive pin to be enabled / disabled


<span style="font-weight: normal;"><u>Transmit Pin</u></span>
===SendHexNumber===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SendHexNumber'''
|-
| colspan="2" | Sends out a number as an ASCII hexadecimal String from the UART interface.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Number
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | NumChars
|-
| colspan="2" | Number of characters in the string data, 0 for auto, 2 for 0x00, 4 for 0x0000&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Prefix
|-
| colspan="2" | Generate hexadecimal prefix 0x e.g. 1= 0xFF, 0= FF&nbsp;
|-
| 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''
|}


This property is of type ''Single digital pin'' and can be referenced with the variable name ''TXPin''.


Pin assigned to transmitting data
===SendIntArray===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SendIntArray'''
|-
| colspan="2" | Sends an array of ints to the transmit buffer&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" | Data
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | NumValues
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | MSBfirst
|-
| colspan="2" | 0=Least significant byte first, 1=Most significant byte first&nbsp;
|-
| 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''
|}


<span style="font-weight: normal;"><u>Transmit Buffer Size</u></span>


This property is of type ''Unsigned integer'' and can be referenced with the variable name ''TXBufferSize''.
===SendNumber===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SendNumber'''
|-
| colspan="2" | Sends out a number as an ASCII String to the transmit buffer&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" | Number
|-
| colspan="2" | &nbsp;
|-
| 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''
|}


Number of bytes that can be stored in the outgoing transmit buffer


<span style="font-weight: normal;"><u>Receive Pin</u></span>
===SendString===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SendString'''
|-
| colspan="2" | Sends an string to the transmit buffer&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Data
|-
| colspan="2" | &nbsp;
|-
| 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''
|}


This property is of type ''Single digital pin'' and can be referenced with the variable name ''RXPin''.


Pin assigned to receiving data
===UART_Timer_Process===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''UART_Timer_Process'''
|-
| colspan="2" | Called as part of a timer interrupt at the specific UART baud rate.&nbsp;
|-
|-
| 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''
|}


<span style="font-weight: normal;"><u>Receive Buffer Size</u></span>


This property is of type ''Unsigned integer'' and can be referenced with the variable name ''RXBufferSize''.
==Property reference==


Number of bytes that can be stored in the incoming receive buffer
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" class="mtx-class-macrohead" | '''Properties'''
|-
|-
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" class="mtx-class-propfolder" | Global Settings
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Data Bits
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Stop Bits
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Use TX
|-
| colspan="2" | Allows the Transmit pin to be enabled / disabled&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Use RX
|-
| colspan="2" | Allows the Receive pin to be enabled / disabled&nbsp;
|-
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" class="mtx-class-propfolder" | Transmit Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Transmit Pin
|-
| colspan="2" | Pin assigned to transmitting data&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Transmit Buffer Size
|-
| colspan="2" | Number of bytes that can be stored in the outgoing transmit buffer&nbsp;
|-
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" class="mtx-class-propfolder" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | API
|-
| colspan="2" | &nbsp;
|}


<span style="font-weight: normal;"><u>Injector</u></span>
==Component Source Code==


This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Injector''.
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_UART_Software_Timer.fcfx FC_Comp_Source_UART_Software_Timer.fcfx]


Points to an Injector component on the panel to provide a means to connect the simulation data to something useful such as another instance of Flowcode or real world hardware.
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_UART_Software_Timer.fcfx FC_Comp_Source_UART_Software_Timer.fcfx]

Latest revision as of 14:37, 13 July 2026

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.

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

UART_Timer_Example









Macro reference

CheckBuffer

CheckBuffer
Returns the number of values in the transmit or receive buffer 
- BOOL Buffer
0=Transmit / 1=Receive 
- UINT Return


Initialise

Initialise
Initialises the UART component pins ready to send and receive data 
- VOID Return


ReceiveBinary16Bit

ReceiveBinary16Bit
Receives a binary 16-bit value split across two bytes. 
- BOOL MSBfirst
0=Least significant byte first, 1=Most significant byte first 
- UINT Timeout
Max amount of time in ms to wait between bytes 
- UINT Return


ReceiveBinary32Bit

ReceiveBinary32Bit
Receives a binary 32-bit value split across four bytes. 
- BOOL MSBfirst
0=Least significant byte first, 1=Most significant byte first 
- UINT Timeout
Max amount of time in ms to wait between bytes 
- ULONG Return


ReceiveBinaryFloat

ReceiveBinaryFloat
Receives a binary 32-bit floating point value split across four bytes. 
- BOOL MSBfirst
0=Least significant byte first, 1=Most significant byte first 
- UINT Timeout
Max amount of time in ms to wait between bytes 
- FLOAT Return


ReceiveBytetArray

ReceiveBytetArray
Gets an array of values from the receive buffer. Returns number of values received. 
- BYTE Values
 
- BYTE NumValues
 
- UINT Timeout
Time in milliseconds to wait for data 
- BYTE Return


ReceiveChar

ReceiveChar
Attempts to receive a single packet from the UART interface. 
- UINT Timeout
Time to wait in milliseconds for valid data before returning, 0=Dont wait, 255=Wait forever. 
- INT Return


ReceiveFloat

ReceiveFloat
Attempts to receive a floating point number as ASCII characters and convert back into a numeric value. Note this function will receive until a timeout or a none numeric char is received, the none numeric char will be lost. 
- UINT Timeout
Max time in ms to wait in between bytes 
- BOOL IgnoreData
0=Dont ignore any data, 1=Ignore any initial none numeric data 
- FLOAT Return


ReceiveHexNumber

ReceiveHexNumber
Attempts to receive a hex number as ASCII characters and convert back into a numeric value. Note this function will receive until a timeout or a none hexadecimal char is received, the none numeric char will be lost. 
- UINT Timeout
Max time in ms to wait in between bytes 
- BOOL IgnoreData
0=Dont ignore any data, 1=Ignore any initial none numeric data 
- BOOL Prefix
Look for prefix before receiving, 1=0xFF, 0=FF 
- ULONG Return


ReceiveINTArray

ReceiveINTArray
Receives an array of 16-bit INT/UINT values and returns the number of values received. 
- UINT Data
Array to store the incoming data 
- UINT NumValues
Maximum number of values to try and receive 
- BOOL MSBfirst
0=Least significant byte first, 1=Most significant byte first 
- UINT Timeout
Max amount of time in ms to wait between bytes 
- BYTE Return


ReceiveNumber

ReceiveNumber
Attempts to receive a number as ASCII characters and convert back into a numeric value. Note this function will receive until a timeout or a none numeric char is received, the none numeric char will be lost. 
- UINT Timeout
Max time in ms to wait in between bytes 
- BOOL IgnoreData
0=Dont ignore any data, 1=Ignore any initial none numeric data 
- LONG Return


ReceiveString

ReceiveString
Gets a string from the receive buffer 
- UINT MaxChars
 
- UINT Timeout
Time in milliseconds to wait for data 
- STRING Return


SendBinary16Bit

SendBinary16Bit
Sends out a 16-bit binary value split across two bytes. 
- UINT Value
 
- BOOL MSBfirst
0=Least significant byte first, 1=Most significant byte first 
- VOID Return


SendBinary32Bit

SendBinary32Bit
Sends out a 32-bit binary value split across four bytes. 
- ULONG Value
 
- BOOL MSBfirst
0=Least significant byte first, 1=Most significant byte first 
- VOID Return


SendBinaryFloat

SendBinaryFloat
Sends out a 32-bit binary floating point value split across four bytes. 
- FLOAT Value
 
- BOOL MSBfirst
0=Least significant byte first, 1=Most significant byte first 
- VOID Return


SendByteArray

SendByteArray
Sends an array of bytes to the transmit buffer 
- BYTE Values
 
- BYTE NumValues
 
- VOID Return


SendChar

SendChar
Sends out a single packet from the UART interface. 
- INT Char
 
- VOID Return


SendFloat

SendFloat
Sends a single float to the transmit buffer 
- FLOAT Value
 
- VOID Return


SendHexNumber

SendHexNumber
Sends out a number as an ASCII hexadecimal String from the UART interface. 
- ULONG Number
 
- BYTE NumChars
Number of characters in the string data, 0 for auto, 2 for 0x00, 4 for 0x0000 
- BOOL Prefix
Generate hexadecimal prefix 0x e.g. 1= 0xFF, 0= FF 
- VOID Return


SendIntArray

SendIntArray
Sends an array of ints to the transmit buffer 
- INT Data
 
- BYTE NumValues
 
- BOOL MSBfirst
0=Least significant byte first, 1=Most significant byte first 
- VOID Return


SendNumber

SendNumber
Sends out a number as an ASCII String to the transmit buffer 
- LONG Number
 
- VOID Return


SendString

SendString
Sends an string to the transmit buffer 
- STRING Data
 
- VOID Return


UART_Timer_Process

UART_Timer_Process
Called as part of a timer interrupt at the specific UART baud rate. 
- 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 
Simulation
API
 

Component Source Code

Please click here to download the component source project: FC_Comp_Source_UART_Software_Timer.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_UART_Software_Timer.fcfx

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_UART_Software_(Timer)_(Comms:_Interface)&oldid=48248"