Difference between revisions of "Component: SRF (WirelessThings) (SRF) (Wireless)"

Revision as of 12:03, 3 February 2023

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_temp/SRF_Component_v2.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/SRF_Component_v2.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

ReceiveChar

	ReceiveChar

- BYTE	Timeout

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

SendChar

	SendChar

- INT	Char

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

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_SRF_Component_v2.fcfx FC_Comp_Source_SRF_Component_v2.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/SRF_Component_v2.fcfx FC_Comp_Source_temp/SRF_Component_v2.fcfx]
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_SRF_Component_v2.fcfx FC_Comp_Source_SRF_Component_v2.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/SRF_Component_v2.fcfx FC_Comp_Source_temp/SRF_Component_v2.fcfx]
 ==Detailed description==
@@ Line 73: / Line 73: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 81: / Line 83: @@
 ==Macro reference==
-===SendString===
+===ReceiveChar===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveChar'''
+|-
+| colspan="2" | &nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Timeout
+|-
+| colspan="2" | &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''
+|}
+===ReceiveString===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SendString'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveString'''
 |-
 | colspan="2" | Send a string of data using the SRF Module&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Data
+| width="90%" | Timeout
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | NumBytes
 |-
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| 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''
 |}
-===Wake===
+===SRFInitialise===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Wake'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SRFInitialise'''
 |-
-| colspan="2" | Wake the SRF module. Includes a 10ms delay to allow radio to wake.&nbsp;
+| colspan="2" | Initialise the SRF Module. Activate device through 'enable' pin, and wake device to ensure it is not sleeping.&nbsp;
 |-
 |-
@@ Line 133: / Line 159: @@
-===Sleep===
+===SendString===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Sleep'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SendString'''
 |-
-| colspan="2" | Sets the SRF module to sleep mode. (Includes a 10mS delay to allow any data to finish sending)&nbsp;
+| colspan="2" | Send a string of data using the SRF Module&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
+| width="90%" | Data
-|}
-===SRFInitialise===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SRFInitialise'''
-|-
-| colspan="2" | Initialise the SRF Module. Activate device through 'enable' pin, and wake device to ensure it is not sleeping.&nbsp;
 |-
+| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 161: / Line 178: @@
-===ReceiveString===
+===Sleep===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveString'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Sleep'''
 |-
-| colspan="2" | Send a string of data using the SRF Module&nbsp;
+| colspan="2" | Sets the SRF module to sleep mode. (Includes a 10mS delay to allow any data to finish sending)&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" | Timeout
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | NumBytes
-|-
-| colspan="2" | &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''
 |}
-===ReceiveChar===
+===Wake===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveChar'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Wake'''
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Wake the SRF module. Includes a 10ms delay to allow radio to wake.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" | Timeout
-|-
-| colspan="2" | &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''
 |}

Difference between revisions of "Component: SRF (WirelessThings) (SRF) (Wireless)"

Revision as of 12:03, 3 February 2023

Contents