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

From Flowcode Help
Jump to navigationJump to search
(XML import - Pre 8.0 release)
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| MatrixTSL
 
| MatrixTSL
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.0 (Release)
+
| 1.0
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Wireless
 
| Wireless
 
|}
 
|}
  
  
−
 
+
==SRF (WirelessThings) component==
−
==[[File:Component Icon cd5898bf_3a23_455e_b4e0_cddc1eec1d62.png|Image]] 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.
 
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==
+
==Component Pack==
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
COMMSB
  
−
==Downloadable macro reference==
+
==Detailed description==
  
−
===<span style="font-weight: normal;"><u><tt>SendString</tt></u></span>===
 
−
Send a string of data using the SRF Module
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|STRING]] ''Data''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>Wake</tt></u></span>===
 
−
Wake the SRF module. Includes a 10ms delay to allow radio to wake.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
 +
''No detailed description exists yet for this component''
  
−
'''Return value'''
+
==Examples==
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>SendChar</tt></u></span>===
 
−
''<span style="color:red;">No additional information</span>''
 
  
  
  
−
'''Parameters'''
 
  
−
:[[Variable Types|INT]] ''Char''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>Sleep</tt></u></span>===
+
''<span style="color:red;">No additional examples</span>''
−
Sets the SRF module to sleep mode. (Includes a 10mS delay to allow any data to finish sending)
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
+
==Downloadable macro reference==
  
 +
{| 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'''
 +
|-
 +
| colspan="2" | Send a string of data using the SRF Module&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
+
{| 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'''
 +
|-
 +
| colspan="2" | Wake the SRF module. Includes a 10ms delay to allow radio to wake.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
===<span style="font-weight: normal;"><u><tt>SRFInitialise</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Initialise the SRF Module. Activate device through 'enable' pin, and wake device to ensure it is not sleeping.
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SendChar'''
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
 +
| width="90%" | Char
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
+
{| 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'''
 +
|-
 +
| 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" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
'''Return value'''
+
{| 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;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
:''This call does not return a value''
 
  
−
 
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
===<span style="font-weight: normal;"><u><tt>ReceiveString</tt></u></span>===
+
|-
−
Send a string of data using the SRF Module
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveString'''
−
'''Parameters'''
+
|-
−
 
+
| colspan="2" | Send a string of data using the SRF Module&nbsp;
−
:[[Variable Types|BYTE]] ''Timeout''
+
|-
−
 
+
|-
−
:[[Variable Types|BYTE]] ''NumBytes''
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
 
+
| width="90%" | Timeout
−
 
+
|-
−
'''Return value'''
+
| colspan="2" | &nbsp;
−
 
+
|-
−
:[[Variable Types|STRING]]
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
 
+
| width="90%" | NumBytes
−
 
+
|-
−
===<span style="font-weight: normal;"><u><tt>ReceiveChar</tt></u></span>===
+
| colspan="2" | &nbsp;
−
''<span style="color:red;">No additional information</span>''
+
|-
−
 
+
| 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''
−
 
+
|}
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|BYTE]] ''Timeout''
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:[[Variable Types|INT]]
 
  
  
 +
{| 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''
 +
|}
  
−
==Simulation macro reference==
 
  
−
''This component does not contain any simulation macros''
 
  
  
 
==Property reference==
 
==Property reference==
−
<span style="font-weight: normal;"><u>Sleep Mode (ATSM)</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''ATSM''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Defines which sleep mode will be used when calling the Sleep component macro.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
<span style="font-weight: normal;"><u>Baud Rate</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Baud_Rate''.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Sleep Mode (ATSM)
−
Serial comms data rate specified in bits per second.
+
|-
−
 
+
| colspan="2" | Defines which sleep mode will be used when calling the Sleep component macro.&nbsp;
−
<span style="font-weight: normal;"><u>Channel</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''CHANNEL''.
+
| width="90%" | Baud Rate
−
 
+
|-
−
Onboard UART peripheral to use to perform serial commands.
+
| colspan="2" | Serial comms data rate specified in bits per second.&nbsp;
−
 
+
|-
−
Software mode available but not recommended for receive applications unless combined with a pin interrupt.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
−
<span style="font-weight: normal;"><u>TX</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''TxPin''.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Channel
−
Serial data transmit pin, output from the target microcontroller and should be connected to the RX pin of the module.
+
|-
−
 
+
| colspan="2" | Onboard UART peripheral to use to perform serial commands. Software mode available but not recommended for receive applications unless combined with a pin interrupt.&nbsp;
−
<span style="font-weight: normal;"><u>RX</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''RxPin''.
+
| width="90%" | TX
−
 
+
|-
−
Serial data receive pin, input to the target microcontroller and should be connected to the TX pin of the module.
+
| colspan="2" | Serial data transmit pin, output from the target microcontroller and should be connected to the RX pin of the module.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Sleep</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | RX
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''Sleep_Pin''.
+
|-
−
 
+
| colspan="2" | Serial data receive pin, input to the target microcontroller and should be connected to the TX pin of the module.&nbsp;
−
''<span style="color:red;">No additional information</span>''
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | Sleep
−
 
+
|-
−
<span style="font-weight: normal;"><u>Scope Traces</u></span>
+
| colspan="2" | &nbsp;
−
 
+
|-
−
This property is of type ''True or false'' and can be referenced with the variable name ''ScopeTraces''.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
−
Selects if the scope traces are automatically generated or not
+
|-
−
 
+
|-
−
<span style="font-weight: normal;"><u>Console Data</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Scope Traces
−
This property is of type ''True or false'' and can be referenced with the variable name ''ConsoleData''.
+
|-
−
 
+
| colspan="2" | Selects if the scope traces are automatically generated or not&nbsp;
−
Selects if the console data is automatically generated or not
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
<span style="font-weight: normal;"><u>Data Source</u></span>
+
| width="90%" | Console Data
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''DataSource''.
+
| colspan="2" | Selects if the console data is automatically generated or not&nbsp;
−
 
+
|-
−
Simulation data source used to allow the component to connect to COM port hardware or the the data injector components.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Data Source
−
<span style="font-weight: normal;"><u>COM Port</u></span>
+
|-
−
 
+
| colspan="2" | Simulation data source used to allow the component to connect to COM port hardware or the the data API components.&nbsp;
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''com_port''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
Lists all the current available COM port hardware on your PC.
+
| width="90%" | COM Port
 +
|-
 +
| colspan="2" | Lists all the current available COM port hardware on your PC.&nbsp;
 +
|}

Latest revision as of 17:22, 9 November 2022

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 Pack

COMMSB

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png SendString
Send a string of data using the SRF Module 
Fc9-string-icon.png - STRING Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Wake
Wake the SRF module. Includes a 10ms delay to allow radio to wake. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SendChar
 
Fc9-s16-icon.png - INT Char
 
Fc9-void-icon.png - VOID Return


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


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


Fc9-comp-macro.png ReceiveString
Send a string of data using the SRF Module 
Fc9-u8-icon.png - BYTE Timeout
 
Fc9-u8-icon.png - BYTE NumBytes
 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png ReceiveChar
 
Fc9-u8-icon.png - BYTE Timeout
 
Fc9-s16-icon.png - INT Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Sleep Mode (ATSM)
Defines which sleep mode will be used when calling the Sleep component macro. 
Fc9-type-16-icon.png Baud Rate
Serial comms data rate specified in bits per second. 
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png 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. 
Fc9-type-5-icon.png TX
Serial data transmit pin, output from the target microcontroller and should be connected to the RX pin of the module. 
Fc9-type-5-icon.png RX
Serial data receive pin, input to the target microcontroller and should be connected to the TX pin of the module. 
Fc9-type-5-icon.png Sleep
 
Fc9-conn-icon.png Simulation
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically generated or not 
Fc9-type-7-icon.png Console Data
Selects if the console data is automatically generated or not 
Fc9-type-16-icon.png Data Source
Simulation data source used to allow the component to connect to COM port hardware or the the data API components. 
Fc9-type-16-icon.png COM Port
Lists all the current available COM port hardware on your PC. 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_SRF_(WirelessThings)_(SRF)_(Wireless)&oldid=28748"