Author
|
MatrixTSL
|
Version
|
1.0
|
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.
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
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
|
SendString
|
Send a string of data using the SRF Module
|
- STRING
|
Data
|
|
- VOID
|
Return
|
|
Wake
|
Wake the SRF module. Includes a 10ms delay to allow radio to wake.
|
- VOID
|
Return
|
|
SendChar
|
|
- INT
|
Char
|
|
- VOID
|
Return
|
|
Sleep
|
Sets the SRF module to sleep mode. (Includes a 10mS delay to allow any data to finish sending)
|
- VOID
|
Return
|
|
SRFInitialise
|
Initialise the SRF Module. Activate device through 'enable' pin, and wake device to ensure it is not sleeping.
|
- VOID
|
Return
|
|
ReceiveString
|
Send a string of data using the SRF Module
|
- BYTE
|
Timeout
|
|
- BYTE
|
NumBytes
|
|
- STRING
|
Return
|
|
ReceiveChar
|
|
- BYTE
|
Timeout
|
|
- INT
|
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.
|
|
TX
|
Serial data transmit pin, output from the target microcontroller and should be connected to the RX pin of the module.
|
|
RX
|
Serial data receive pin, input to the target microcontroller and should be connected to the TX pin of the module.
|
|
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.
|
==Macro reference==
|
SendString
|
Send a string of data using the SRF Module
|
- STRING
|
Data
|
|
- VOID
|
Return
|
|
Wake
|
Wake the SRF module. Includes a 10ms delay to allow radio to wake.
|
- VOID
|
Return
|
|
SendChar
|
|
- INT
|
Char
|
|
- VOID
|
Return
|
|
Sleep
|
Sets the SRF module to sleep mode. (Includes a 10mS delay to allow any data to finish sending)
|
- VOID
|
Return
|
|
SRFInitialise
|
Initialise the SRF Module. Activate device through 'enable' pin, and wake device to ensure it is not sleeping.
|
- VOID
|
Return
|
|
ReceiveString
|
Send a string of data using the SRF Module
|
- BYTE
|
Timeout
|
|
- BYTE
|
NumBytes
|
|
- STRING
|
Return
|
|
ReceiveChar
|
|
- BYTE
|
Timeout
|
|
- INT
|
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.
|
|
TX
|
Serial data transmit pin, output from the target microcontroller and should be connected to the RX pin of the module.
|
|
RX
|
Serial data receive pin, input to the target microcontroller and should be connected to the TX pin of the module.
|
|
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.
|
==Macro reference==
|
SendString
|
Send a string of data using the SRF Module
|
- STRING
|
Data
|
|
- VOID
|
Return
|
|
Wake
|
Wake the SRF module. Includes a 10ms delay to allow radio to wake.
|
- VOID
|
Return
|
|
SendChar
|
|
- INT
|
Char
|
|
- VOID
|
Return
|
|
Sleep
|
Sets the SRF module to sleep mode. (Includes a 10mS delay to allow any data to finish sending)
|
- VOID
|
Return
|
|
SRFInitialise
|
Initialise the SRF Module. Activate device through 'enable' pin, and wake device to ensure it is not sleeping.
|
- VOID
|
Return
|
|
ReceiveString
|
Send a string of data using the SRF Module
|
- BYTE
|
Timeout
|
|
- BYTE
|
NumBytes
|
|
- STRING
|
Return
|
|
ReceiveChar
|
|
- BYTE
|
Timeout
|
|
- INT
|
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.
|
|
TX
|
Serial data transmit pin, output from the target microcontroller and should be connected to the RX pin of the module.
|
|
RX
|
Serial data receive pin, input to the target microcontroller and should be connected to the TX pin of the module.
|
|
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.
|