Jump to content

Component: Bluetooth (ESP32 SPP) (Wireless): Difference between revisions

From Flowcode Help

SteveT (talk | contribs)

4 user groups
6,393 edits
XML import
 
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(33 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{| style="width:50%"
 
{| width="50%"
|-
|-
| width="20%" style="color: gray;" | Author
| width="20%" style="color:gray;" | Author
| Matrix TSL
| Matrix TSL
|-
|-
| 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
|}
|}




==Bluetooth (ESP32 SPP) component==
Bluetooth slave component designed to run on a ESP32 providing legacy SPP functionality. BT Legacy functionality must be switched on via the sdkconfig file.


==[[File:Component Icon 8be2ce64_4860_468a_aa8a_eac443274da3.png|Image]] Bluetooth (ESP32 SPP) component==
==Component Source Code==
Bluetooth slave component designed to run on a ESP32 providing legacy SPP functionality.
BT Legacy functionality must be switched on via the sdkconfig file.


Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Bluetooth_ESP32_SPP.fcfx FC_Comp_Source_Bluetooth_ESP32_SPP.fcfx]


==Examples==
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Bluetooth_ESP32_SPP.fcfx FC_Comp_Source_Bluetooth_ESP32_SPP.fcfx]
''<span style="color:red;">No additional examples</span>''


==Detailed description==


==Downloadable macro reference==
''No detailed description exists yet for this component''


===<span style="font-weight: normal;"><u><tt>ReceiveByte</tt></u></span>===
==Examples==
Attempts to receive a byte from the bluetooth serial port.


0-255 = a valid received value
A simple example file showing how to send and receive data using the ESP32 Bluetooth Serial Port Profile.


256 = a timeout has occured
{{Fcfile|ESP_BT.fcfx|ESP_BT}}


'''Parameters'''


:[[Variable Types|UINT]] ''Timeout''
The SPP legacy bluetooth mode must be enabled in the ESP32 config file to allow SSP to work. For details please see this [https://www.flowcode.co.uk/forums/viewtopic.php?p=12324#p12324 forum topic].
::Number of ms to wait for incoming data




'''Return value'''
For problems sending strings or missing data bytes, please see this [https://www.flowcode.co.uk/forums/viewtopic.php?p=4466#p4466 forum topic].


:[[Variable Types|UINT]]


==Macro reference==


===<span style="font-weight: normal;"><u><tt>SendString</tt></u></span>===
===CheckConnectionStatus===
Sends a string to the Bluetooth serial connection
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''CheckConnectionStatus'''
|-
| colspan="2" | Checks to see if the Bluetooth device is connected. Returns 1 if connected.&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


'''Parameters'''


:[[Variable Types|<- STRING]] ''Data''
===Initialise===
::Data Array to send
{| class="mtx-class-macrotable wikitable"
::''This parameter may be returned back to the caller''
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''Initialise'''
|-
| colspan="2" | Starts up the Bluetooth communications SPP service.&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'''
===ReceiveArray===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReceiveArray'''
|-
| colspan="2" | Attempts to receive an array of bytes from the bluetooth serial port. Returns the number of bytes received.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Data
|-
| colspan="2" | Buffer to place received data into&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | MaxBytes
|-
| colspan="2" | Max number of bytes to try and read within the time&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Timeout
|-
| colspan="2" | Number of ms to wait for incoming data&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:''This call does not return a value''


===ReceiveByte===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReceiveByte'''
|-
| colspan="2" | Attempts to receive a byte from the bluetooth serial port. 0-255 = a valid received value 256 = a timeout has occured&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Timeout
|-
| colspan="2" | Number of ms to wait for incoming data&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


===<span style="font-weight: normal;"><u><tt>CheckConnectionStatus</tt></u></span>===
Checks to see if the Bluetooth device is connected.


Returns 1 if connected.
===ReceiveCount===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReceiveCount'''
|-
| colspan="2" | Collects the number of bytes currently stored in the receive buffer.&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


'''Parameters'''


:''This macro has no parameters''
===ReceiveINTArray===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReceiveINTArray'''
|-
| colspan="2" | Receives an array of 16-bit INT/UINT values and returns the number of values received.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Data
|-
| colspan="2" | Array to store the incoming data&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | NumValues
|-
| colspan="2" | Maximum number of values to try and receive&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | MSBfirst
|-
| colspan="2" | 0=Least significant byte first, 1=Most significant byte first&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Timeout
|-
| colspan="2" | Max amount of time in ms to wait between bytes&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




'''Return value'''
===ReceiveString===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReceiveString'''
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | MaxBytes
|-
| colspan="2" | Max number of bytes to try and read within the time&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Timeout
|-
| colspan="2" | Number of ms to wait for incoming data&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''
|}


:[[Variable Types|BOOL]] : Returns true if the operation is a success, else false


===SendArray===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SendArray'''
|-
| colspan="2" | Sends a byte to the Bluetooth serial connection&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Data
|-
| colspan="2" | Data Array to send&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | NumBytes
|-
| colspan="2" | Number of bytes to send&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>ReceiveArray</tt></u></span>===
Attempts to receive an array of bytes from the bluetooth serial port.


Returns the number of bytes received.
===SendByte===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SendByte'''
|-
| colspan="2" | Sends a byte to the Bluetooth serial connection&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| 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''
|}


'''Parameters'''


:[[Variable Types|BYTE]] ''Data''
===SendINTArray===
::Buffer to place received data into
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SendINTArray'''
|-
| colspan="2" | Transmits an array of 16-bit INT/UINT values via the Bluetooth peripheral&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Data
|-
| colspan="2" | Data Array to send&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | NumValues
|-
| colspan="2" | Number of 16-bit values to send from the array&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | MSBfirst
|-
| colspan="2" | 0=Least significant byte first, 1=Most significant byte first&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''
|}


:[[Variable Types|UINT]] ''MaxBytes''
::Max number of bytes to try and read within the time


:[[Variable Types|UINT]] ''Timeout''
===SendString===
::Number of ms to wait for incoming data
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SendString'''
|-
| colspan="2" | Sends a string to the Bluetooth serial connection&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Data
|-
| colspan="2" | Data Array to send&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'''
===SetBTName===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SetBTName'''
|-
| colspan="2" | Overrides the current friendly name&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Name
|-
| colspan="2" | Name you want to use&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''
|}


:[[Variable Types|UINT]]


 
===Uninitialise===
===<span style="font-weight: normal;"><u><tt>SendArray</tt></u></span>===
{| class="mtx-class-macrotable wikitable"
Sends a byte to the Bluetooth serial connection
|-
 
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
'''Parameters'''
| width="90%" class="mtx-class-macrohead" | '''Uninitialise'''
 
|-
:[[Variable Types|BYTE]] ''Data''
| colspan="2" | Shots down the Bluetooth communications SPP service.&nbsp;
::Data Array to send
|-
 
|-
:[[Variable Types|UINT]] ''NumBytes''
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
::Number of bytes to send
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
'''Return value'''
 
:''This call does not return a value''
 
 
===<span style="font-weight: normal;"><u><tt>SendByte</tt></u></span>===
Sends a byte to the Bluetooth serial connection
 
'''Parameters'''
 
:[[Variable Types|BYTE]] ''Data''
 
 
'''Return value'''
 
:''This call does not return a value''
 
 
===<span style="font-weight: normal;"><u><tt>ReceiveString</tt></u></span>===
''<span style="color:red;">No additional information</span>''
 
 
 
'''Parameters'''
 
:[[Variable Types|UINT]] ''MaxBytes''
::Max number of bytes to try and read within the time
 
:[[Variable Types|UINT]] ''Timeout''
::Number of ms to wait for incoming data
 
 
'''Return value'''
 
:[[Variable Types|STRING]]
 
 
===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>===
Starts up the Bluetooth communications SPP service.
 
'''Parameters'''
 
:''This macro has no parameters''
 
 
'''Return value'''
 
:''This call does not return a value''
 
 
 
==Simulation macro reference==
 
''This component does not contain any simulation macros''




==Property reference==
==Property reference==
<span style="font-weight: normal;"><u>Device Name</u></span>


This property is of type ''Line of text'' and can be referenced with the variable name ''DevName''.
{| class="mtx-class-macrotable wikitable"
 
|-
Sets the Bluetooth device friendly name
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
 
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
<span style="font-weight: normal;"><u>Receive Buffer</u></span>
|-
 
|-
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''ReceiveBuffer''.
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
| width="90%" | Device Name
Configures the size of the receive buffer in bytes to store incoming data until we are ready to receive it.
|-
| colspan="2" | Sets the Bluetooth device friendly name&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Receive Buffer
|-
| colspan="2" | Configures the size of the receive buffer in bytes to store incoming data until we are ready to receive it.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Data Receive Interrupt
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Verbose Debug
|-
| colspan="2" | When enabled debug messages will be placed onto UART CH1 which is generally connected to  via a Serial to USB IC to pipe messages back to the host PC.&nbsp;
|-
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" class="mtx-class-propfolder" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | COM Port
|-
| colspan="2" | Selects which port to communicate with, only lists ports which are currently available. &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Refresh COM Ports
|-
| colspan="2" | When set to yes the COM port list is rescanned for newly connected or available ports. Note that refreshing the ports list may take a few seconds depending on the number of connected ports.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Baud
|-
| colspan="2" | Baud rate passed to the COM port to control the rate of data.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Console Data
|-
| colspan="2" | &nbsp;
|}

Latest revision as of 14:36, 13 July 2026

Author Matrix TSL
Version 1.0
Category Wireless


Bluetooth (ESP32 SPP) component

Bluetooth slave component designed to run on a ESP32 providing legacy SPP functionality. BT Legacy functionality must be switched on via the sdkconfig file.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

A simple example file showing how to send and receive data using the ESP32 Bluetooth Serial Port Profile.

ESP_BT


The SPP legacy bluetooth mode must be enabled in the ESP32 config file to allow SSP to work. For details please see this forum topic.


For problems sending strings or missing data bytes, please see this forum topic.


Macro reference

CheckConnectionStatus

CheckConnectionStatus
Checks to see if the Bluetooth device is connected. Returns 1 if connected. 
- BOOL Return


Initialise

Initialise
Starts up the Bluetooth communications SPP service. 
- VOID Return


ReceiveArray

ReceiveArray
Attempts to receive an array of bytes from the bluetooth serial port. Returns the number of bytes received. 
- BYTE Data
Buffer to place received data into 
- UINT MaxBytes
Max number of bytes to try and read within the time 
- UINT Timeout
Number of ms to wait for incoming data 
- UINT Return


ReceiveByte

ReceiveByte
Attempts to receive a byte from the bluetooth serial port. 0-255 = a valid received value 256 = a timeout has occured 
- UINT Timeout
Number of ms to wait for incoming data 
- UINT Return


ReceiveCount

ReceiveCount
Collects the number of bytes currently stored in the receive buffer. 
- UINT Return


ReceiveINTArray

ReceiveINTArray
Receives an array of 16-bit INT/UINT values and returns the number of values received. 
- UINT Data
Array to store the incoming data 
- BYTE NumValues
Maximum number of values to try and receive 
- BOOL MSBfirst
0=Least significant byte first, 1=Most significant byte first 
- BYTE Timeout
Max amount of time in ms to wait between bytes 
- BYTE Return


ReceiveString

ReceiveString
 
- UINT MaxBytes
Max number of bytes to try and read within the time 
- UINT Timeout
Number of ms to wait for incoming data 
- STRING Return


SendArray

SendArray
Sends a byte to the Bluetooth serial connection 
- BYTE Data
Data Array to send 
- UINT NumBytes
Number of bytes to send 
- VOID Return


SendByte

SendByte
Sends a byte to the Bluetooth serial connection 
- BYTE Data
 
- VOID Return


SendINTArray

SendINTArray
Transmits an array of 16-bit INT/UINT values via the Bluetooth peripheral 
- UINT Data
Data Array to send 
- BYTE NumValues
Number of 16-bit values to send from the array 
- BOOL MSBfirst
0=Least significant byte first, 1=Most significant byte first 
- VOID Return


SendString

SendString
Sends a string to the Bluetooth serial connection 
- STRING Data
Data Array to send 
- VOID Return


SetBTName

SetBTName
Overrides the current friendly name 
- STRING Name
Name you want to use 
- VOID Return


Uninitialise

Uninitialise
Shots down the Bluetooth communications SPP service. 
- VOID Return


Property reference

Properties
Device Name
Sets the Bluetooth device friendly name 
Receive Buffer
Configures the size of the receive buffer in bytes to store incoming data until we are ready to receive it. 
Data Receive Interrupt
 
Verbose Debug
When enabled debug messages will be placed onto UART CH1 which is generally connected to via a Serial to USB IC to pipe messages back to the host PC. 
Simulation
COM Port
Selects which port to communicate with, only lists ports which are currently available.  
Refresh COM Ports
When set to yes the COM port list is rescanned for newly connected or available ports. Note that refreshing the ports list may take a few seconds depending on the number of connected ports. 
Baud
Baud rate passed to the COM port to control the rate of data. 
Console Data
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Bluetooth_(ESP32_SPP)_(Wireless)&oldid=47799"