Component: SRF (WirelessThings) (SRF) (Wireless)
| Author | MatrixTSL |
| Version | 1.0 (Release) |
| Category | Wireless |
Contents
SRF (WirelessThings) (SRF) 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.
Examples
No additional examples
Downloadable macro reference
SendString
Send a string of data using the SRF Module
Parameters
- STRING Data
Return value
- This call does not return a value
Wake
Wake the SRF module. Includes a 10ms delay to allow radio to wake.
Parameters
- This macro has no parameters
Return value
- This call does not return a value
SendChar
No additional information
Parameters
- INT Char
Return value
- This call does not return a value
Sleep
Sets the SRF module to sleep mode. (Includes a 10mS delay to allow any data to finish sending)
Parameters
- This macro has no parameters
Return value
- This call does not return a value
SRFInitialise
Initialise the SRF Module. Activate device through 'enable' pin, and wake device to ensure it is not sleeping.
Parameters
- This macro has no parameters
Return value
- This call does not return a value
ReceiveString
Send a string of data using the SRF Module
Parameters
- BYTE Timeout
- BYTE NumBytes
Return value
ReceiveChar
No additional information
Parameters
- BYTE Timeout
Return value
Simulation macro reference
This component does not contain any simulation macros
Property reference
Sleep Mode (ATSM)
This property is of type Fixed list of ints and can be referenced with the variable name ATSM.
Defines which sleep mode will be used when calling the Sleep component macro.
Baud Rate
This property is of type Fixed list of ints and can be referenced with the variable name Baud_Rate.
Serial comms data rate specified in bits per second.
Channel
This property is of type Fixed list of ints and can be referenced with the variable name 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
This property is of type Single digital pin and can be referenced with the variable name TxPin.
Serial data transmit pin, output from the target microcontroller and should be connected to the RX pin of the module.
RX
This property is of type Single digital pin and can be referenced with the variable name RxPin.
Serial data receive pin, input to the target microcontroller and should be connected to the TX pin of the module.
Sleep
This property is of type Single digital pin and can be referenced with the variable name Sleep_Pin.
No additional information
Scope Traces
This property is of type True or false and can be referenced with the variable name ScopeTraces.
Selects if the scope traces are automatically generated or not
Console Data
This property is of type True or false and can be referenced with the variable name ConsoleData.
Selects if the console data is automatically generated or not
Data Source
This property is of type Fixed list of ints and can be referenced with the variable name DataSource.
Simulation data source used to allow the component to connect to COM port hardware or the the data injector components.
COM Port
This property is of type Fixed list of ints and can be referenced with the variable name com_port.
Lists all the current available COM port hardware on your PC.
