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.

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