1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
|
/**
@page BLE_Mesh_ThermometerSensor example
@verbatim
******************************************************************************
* @file BLE/BLE_Mesh_ThermometerSensor/readme.txt
* @author MCD Application Team
* @brief Description of the BLE Mesh Thermometer Vendor Node demo example.
******************************************************************************
*
* Copyright (c) 2021 STMicroelectronics.
* All rights reserved.
*
* This software is licensed under terms that can be found in the LICENSE file
* in the root directory of this software component.
* If no LICENSE file comes with this software, it is provided AS-IS.
*
******************************************************************************
@par Application Description
This is the implementation of a BLE Mesh Vendor model as specified by the BLE SIG.
This example is to demonstrate the BLE Mesh Vendor model by using a STM32WB5MM Discovery Kit as BLE Mesh Vendor Node
in order to send measured temperature over BLE Mesh Network through vendor command.
@par Keywords
Connectivity, BLE, Mesh, Thermometer, Vendor, BLE protocol, BLE profile, Dual core
@par Directory contents
- BLE/BLE_Mesh_ThermometerSensor/Core/Inc/app_common.h Header for all modules with common definition
- BLE/BLE_Mesh_ThermometerSensor/Core/Inc/app_conf.h Parameters configuration file of the application
- BLE/BLE_Mesh_ThermometerSensor/Core/Inc/app_debug.h Header for app_debug.c module
- BLE/BLE_Mesh_ThermometerSensor/Core/Inc/app_entry.h Parameters configuration file of the application
- BLE/BLE_Mesh_ThermometerSensor/Core/Inc/app_stts221.h Header for app_stts221.c module
- BLE/BLE_Mesh_ThermometerSensor/Core/Inc/app_vl53l0x.h Header for app_vl53l0x.c module
- BLE/BLE_Mesh_ThermometerSensor/Core/Inc/hw_conf.h Configuration file of the HW
- BLE/BLE_Mesh_ThermometerSensor/Core/Inc/hw_flash.h Header for hw_flash.c module
- BLE/BLE_Mesh_ThermometerSensor/Core/Inc/hw_if.h HW interface
- BLE/BLE_Mesh_ThermometerSensor/Core/Inc/lp_timer.h Header for lp_timer.c module
- BLE/BLE_Mesh_ThermometerSensor/Core/Inc/main.h Header for main.c module
- BLE/BLE_Mesh_ThermometerSensor/Core/Inc/stm32_lpm_if.h Header for stm32_lpm_if.c module (LP management)
- BLE/BLE_Mesh_ThermometerSensor/Core/Inc/stm32wb5mm_dk_conf.h Configuration file of the Discovery board
- BLE/BLE_Mesh_ThermometerSensor/Core/Inc/stm32wbxx_hal_conf.h HAL configuration file
- BLE/BLE_Mesh_ThermometerSensor/Core/Inc/stm32wbxx_it.h Interrupt handlers header file
- BLE/BLE_Mesh_ThermometerSensor/Core/Inc/utilities_conf.h Configuration file of the utilities
- BLE/BLE_Mesh_ThermometerSensor/Core/Inc/vcp_conf.h Configuration of the vcp interface
- BLE/BLE_Mesh_ThermometerSensor/Core/Src/app_debug.c Debug capabilities source file for STM32WPAN Middleware
- BLE/BLE_Mesh_ThermometerSensor/Core/Src/app_entry.c Initialization of the application
- BLE/BLE_Mesh_ThermometerSensor/Core/Src/app_stts221.c Temperature Application file
- BLE/BLE_Mesh_ThermometerSensor/Core/Src/app_vl53l0x.c Proximity Application file
- BLE/BLE_Mesh_ThermometerSensor/Core/Src/hw_flash.c FLASH drive file
- BLE/BLE_Mesh_ThermometerSensor/Core/Src/hw_timerserver.c Timer Server based on RTC
- BLE/BLE_Mesh_ThermometerSensor/Core/Src/hw_uart.c hardware access
- BLE/BLE_Mesh_ThermometerSensor/Core/Src/lp_timer.c Low power timer
- BLE/BLE_Mesh_ThermometerSensor/Core/Src/main.c Main program
- BLE/BLE_Mesh_ThermometerSensor/Core/Src/stm32_lpm_if.c Low Power Manager Interface
- BLE/BLE_Mesh_ThermometerSensor/Core/Src/stm32wbxx_it.c Interrupt handlers
- BLE/BLE_Mesh_ThermometerSensor/Core/Src/system_stm32wbxx.c stm32wbxx system source file
- BLE/BLE_Mesh_ThermometerSensor/Core/Src/vl53l0x/ Proximity sensor files
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/app_ble.h Header for app_ble.c module
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/ble_conf.h BLE Services configuration
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/ble_dbg_conf.h BLE Traces configuration of the BLE services
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/app_ble.c BLE Profile implementation
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_config.c Config Model APIs callback from ST BLE Mesh Library
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_config.h Header file for the application config file
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_config_client.c Config Client Model APIs callback from ST BLE Mesh Library
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_config_client.h Header file for the application config Client file
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_generic.c Application interface for Generic Mesh Models
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_generic.h Header of Application interface for Generic Mesh Models
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_generic_client.c Application interface for Generic Client Mesh Models
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_generic_client.h Header of Application interface for Generic Client Mesh Models
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_light.c BLE Mesh Light Model implementation
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_light.h Header of BLE Mesh Light Model implementation
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_light_client.c BLE Mesh Light Client Model implementation
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_light_client.h Header of BLE Mesh Light Client Model implementation
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_light_lc.c BLE Mesh Light Lightness Controller Model implementation
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_light_lc.h Header of BLE Mesh Light Lightness Controller Model implementation
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_mesh.c BLE Mesh application implementation
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_mesh.h Header of BLE Mesh application implementation
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_nvm.c BLE Mesh NVM application implementation
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_nvm.h Header of BLE Mesh NVM application implementation
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_sensor.c BLE Mesh Sensor Model implementation
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_sensor.h Header of BLE Mesh Sensor Model implementation
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_sensor_client.c BLE Mesh Sensor Client Model implementation
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_sensor_client.h Header of BLE Mesh Sensor Client Model implementation
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_vendor.c BLE Mesh Vendor Model implementation
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/appli_vendor.h Header of BLE Mesh Vendor Model implementation
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/hal_common.h Header for common function of HAL file
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/mesh_cfg.h Header for Mesh configuration
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/mesh_cfg_usr.h Header for user Mesh configuration
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/models_if.h Header for the BLE Mesh Models Interface file
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/models_if.c BLE Mesh Models Interface file
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/pal_nvm.c BLE Mesh NVM management implementation
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/pal_nvm.h Header of BLE Mesh NVM management implementation
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/svcctl_conf.c Service Controller configuration API
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/PWM_config.c Pulse Width Modulation configuration
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/PWM_config.h Header of Pulse Width Modulation configuration
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/PWM_handlers.c Pulse Width Modulation handlers
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/PWM_handlers.h Header of Pulse Width Modulation handlers
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/tl_conf.h Configuration file of the Transport layer
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/tl_if.c Transport Layer interface
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/user_if.h Header file for User interface file
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/user_if.c User interface file
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/App/vcp_conf.h Configuration of the vcp interface
- BLE/BLE_Mesh_ThermometerSensor/STM32_WPAN/Target/hw_ipcc.c IPCC Driver
@par Hardware and Software environment
- This application runs on STM32WB5MM Discovery Kit devices
- STM32WB5MM Discovery Kit board Set-up
- Connect the Board to your PC with a USB cable type A to mini-B to ST-LINK connector (USB_STLINK).
@par How to use it ?
This application requests having the stm32wb5x_BLE_Stack_full_fw.bin binary flashed on the Wireless Coprocessor.
If it is not the case, you need to use STM32CubeProgrammer to load the appropriate binary.
All available binaries are located under /Projects/STM32_Copro_Wireless_Binaries directory.
Refer to UM2237 to learn how to use/install STM32CubeProgrammer.
Refer to /Projects/STM32_Copro_Wireless_Binaries/ReleaseNote.html for the detailed procedure to change the
Wireless Coprocessor binary.
In order to make the program work, you must do the following :
- Open your IAR toolchain
- Rebuild all files and load the image into Target memory
- Run the example
For more details refer to the Application Note:
AN5292_STM32WB_How_to_build_BLE_Mesh_Application
@Introduction
The ST BLE-Mesh library supports all of the following features in a Mesh node:
1. Relay: to forward received network PDUs on advertising or GATT bearer, if the Proxy feature is enabled
2. Proxy: to forward received network PDUs between GATT and advertising bearers
3. Friend: can perform duties such as scanning for other associated nodes that are usually Low Power mode
4. Low Power: consumes much less power as the node usually does not perform any scanning
A typical BLE Mesh node radio should always be in scanning mode to avoid missing packets over the air, but this kind of
operation is not supported by many devices due to continuous energy requirements.
To enable low power operation, BLE Mesh Profile v1.0 defines the concept of Friendship.
In a Mesh network, a Low Power feature-enabled Mesh node (LPN) offloads its packet receiving (scanning) duty to an adjacent
Friend feature-enabled Mesh node (FN). The LPN is not always scanning and remains inactive (or sleeps) for most of its life
cycle, significantly reducing its energy requirements. Nodes running on batteries or energy harvesting techniques usually
support the Low Power feature.
Once connected to each other, the FN and LPN are considered friends and their connection is known as a Friendship. At least
one FN must be in the direct radio range of an LPN to establish Friendship.
@Configuration
The Thermometer project supports Proxy, Relay and Friend features.
@Demo setup based on STM32WB5MM-DK board
General default setting defined in mesh_cfg_usr.h:
ENABLE_VENDOR_MODEL_SERVER (1) /* VENDOR SERVER ONOFF MODEL ON FIRST ELEMENT */
APPLICATION_NUMBER_OF_ELEMENTS 1 /* NUMBER OF ELEMENT SUPPORTED */
APPLICATION_SIG_MODELS_MAX_COUNT 10 /* TOTAL NUMBER OF MODELS SUPPORTED */
APPLICATION_VENDOR_MODELS_MAX_COUNT 1 /* TOTAL NIMBER OF VENDOR MODELS SUPPORTED */
ENABLE_PB_ADV /* Provisioning Bearer over advertising channels support */
ENABLE_PB_GATT /* Provisioning Bearer over GATT proxy support */
The following demo based on STM32WB5MM-DK has been set up using one board as a Thermometer Sensor and one or more boards as Temperature Indicators.
THERMOMETER NODE Setup:
Step 1. Configure the THERMOMETER Node.
To select the THERMOMETER Node code, you need to add THERMOMETER_NODE symbol definition into project settings.
This mode is enabled by default.
Step 2. Generate and flash binary in the first board.
Once flashed, the Node Type (Thermometer/Indicator), the distance and temperature measured by the board are displayed on the LCD screen.
INDICATOR NODE Setup:
Step 1. Configure the INDICATOR Node.
To select the INDICATOR Node code, you need to replace the thermometer symbol definition by the INDICATOR_NODE symbol definition into project settings.
Step 2. Generate and flash binary in the other boards.
Once flashed the distance measured by the board is displayed on the LCD screen.
Demo operation
Step 3. Connect an HyperTerminal to each board (e.g Tera Term):
- Setup the Serial port as follow:
Speed: 115 200
Data: 8 bit
Parity: none
Stop bits: 1 bits
Flow Control: none
- Select the Serial Port corresponding to your first board
- Repeat the operation for the second board
Note: You can identify which board is connected to which HyperTerminal window by pushing reset button on one board.
The associated Terminal windows displays reset logs.
Step 4. Verify the boards are correctly unprovisioned, by keeping pressed User Button 1 (B1) and Reset button,
releasing the Reset button while keeping B1 pressed until the Blue LED is blinking.
You can see "Unprovisioned device" message on the HyperTerminal logs of the board.
Step 5. Setup the BLE-mesh network using the ST BLE-Mesh Android (https://play.google.com/store/apps/details?id=com.st.bluenrgmesh&hl=en) or
iOS (https://apps.apple.com/us/app/st-ble-mesh/id1348645067) smartphone application.
The following instructions are based on the Android version of the application, buttons and menus may differ in the iOS version.
In case of doubts or for further information, you can refer to:
Android User Manual: UM2180 (https://www.st.com/content/ccc/resource/technical/document/user_manual/group0/7e/bb/bd/40/66/0f/46/54/DM00369109/files/DM00369109.pdf/jcr:content/translations/en.DM00369109.pdf)
iOS User Manual : UM2361 https://www.st.com/content/ccc/resource/technical/document/user_manual/group0/7e/ea/19/73/31/3e/43/1a/DM00477323/files/DM00477323.pdf/jcr:content/translations/en.DM00477323.pdf
- Launch the application and select the "device" interface in the top left corner.
- Your devices should be visible in this interface, click on the (+) button next to one of the devices to begin the provisioning and configuration process of this device.
If your Unpvorisioned devices are not visible from this interface, try to reproduce the Step 4.
- Select "Fast Provisioning" button.
The green LED of your board switches ON to indicate the board is currently used as Proxy by smartphone, this means the smartphone use this board to setup and communicate with the BLE mesh Network.
- Click on "Go with Quick Configuration" button.
In the pop-up, check the circle in front of "App Key 0", the AppKey binding is now done.
- Let Default Group Subscription and Publish Target selection and click on "Add Configuration" button.
The application is now on the Node interface. (click on "Nodes" button in bottom menu).
- You can rename your node by clicking on the setting button next to (P)(R)(F) icons.
Click on the Pen icon in Node Name line and rename your Node:
"Thermometer Node"
"Indicator Node"
Depending on your node.
- Come back to the "Devices" interface (on bottom bar menu) and reproduce previous steps for your second board.
Step 6. Modify publication address of your Thermometer Node to publish his vendor commands to the Indicator Node:
- Go to the "Nodes" interface (on bottom bar menu)
- Open Element 1 settings of the Thermometer Node. The Settings button is situated on the right of Element 1 line of the Thermometer Node.
- Select Indicator Node/Element 1 in "Set Publish Address" list.
- Save settings
Now the Thermometer Node publish to the Indicator Node.
Step 7. Once the Thermometer and Indicator Nodes are provisioned, you can close the smartphone application.
The Green LED of your Proxy node should switch OFF as it is no longer connected to the Smartphone.
Step 8. The Thermometer send Vendor command to change the RGB LED color of the Indicator Node depending on the temperature he is measuring.
Blue = low temperature
Green = medium temperature
Red = High temperature
NOTE: The actual code manage temperature between 20 and 30 degrees Celsius.
You can change it by modifying min_temp, max_temp.
into PublishTemp_Task() function
* <h3><center>© COPYRIGHT STMicroelectronics</center></h3>
*/
|
