Component: SRF (WirelessThings) (SRF) (Wireless)

Author	MatrixTSL
Version	6.6
Category	Wireless

SRF (WirelessThings) component

The SRF is designed for wireless transmission and reception of serial data in an easy to use surface mounted module. It has an on-board balun and chip antenna, which can be detached for applications where an external antenna is required.

Version information

Library Version, Component Version, Date, Author, Info

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

ChangeHWBaud

	ChangeHWBaud
Changes the hardware UART baud rate allowing for dynamic speed changes.
- BYTE	NewBaud
0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200, 8=250000
- VOID	Return

ReceiveByteArray

	ReceiveByteArray
Receives an array of bytes and returns the number of bytes received.
- BYTE	Data
Array to store the incoming data
- UINT	NumBytes
Maximum number of bytes to try and receive
- BYTE	Timeout
Max amount of time in ms to wait between bytes
- BYTE	Return

ReceiveChar

	ReceiveChar
- BYTE	Timeout
- 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.
- BYTE	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

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.
- BYTE	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
Send a string of data using the SRF Module
- BYTE	Timeout
- BYTE	NumBytes
- STRING	Return

SRFInitialise

	SRFInitialise
Initialise the SRF Module. Activate device through 'enable' pin, and wake device to ensure it is not sleeping.
- VOID	Return

SendByteArray

	SendByteArray
Transmits an array of bytes via the UART peripheral
- BYTE	Data
Data to transmit
- UINT	NumBytes
Number of bytes to send from the array
- VOID	Return

SendChar

	SendChar
- INT	Char
- VOID	Return

SendFloat

	SendFloat
Sends out a floating point number as an ASCII String from the UART interface.
- FLOAT	Number
- VOID	Return

SendNumber

	SendNumber
Sends out a number as an ASCII String from the UART interface.
- LONG	Number
- VOID	Return

SendString

	SendString
Send a string of data using the SRF Module
- STRING	Data
- VOID	Return

Sleep

	Sleep
Sets the SRF module to sleep mode. (Includes a 10mS delay to allow any data to finish sending)
- VOID	Return

Wake

	Wake
Wake the SRF module. Includes a 10ms delay to allow radio to wake.
- VOID	Return

Property reference

	Properties
	Sleep Mode (ATSM)
Defines which sleep mode will be used when calling the Sleep component macro.
	Baud Rate
Serial comms data rate specified in bits per second.
	Connections
	Channel
Onboard UART peripheral to use to perform serial commands. Software mode available but not recommended for receive applications unless combined with a pin interrupt.
	Use TX
Selects if the Transmit pin is used by the component. Yes: The TX pin is active and used to transmit data for the UART. No: The TX pin is disabled and free to be used as general I/O.
	TX
Pin to be used for Transmit data
	TX Remap Pin
Allows the hardware transmit pin to be configured from a list of available pins based on your target device,
	Use RX
Selects if the Receive pin is used by the component. Yes: The RX pin is active and used to receive data for the UART. No: The RX pin is disabled and free to be used as general I/O.
	RX
Pin to be used for Receive data
	RX Remap Pin
Allows the hardware receive pin to be configured from a list of available pins based on your target device,
	Sleep
	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
	Data Source
Simulation data source used to allow the component to connect to COM port hardware or the the data API components.
	COM Port
Lists all the current available COM port hardware on your PC.

Component Source Code

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

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