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
|
/**
@page BLE_MeshLightingLPN example
@verbatim
******************** (C) COPYRIGHT 2020 STMicroelectronics *******************
* @file BLE/BLE_MeshLightingLPN/readme.txt
* @author MCD Application Team
* @brief Description of the BLE Mesh Lighting Low Power Node demo example.
******************************************************************************
*
* Copyright (c) 2020 STMicroelectronics. All rights reserved.
*
* This software component is licensed by ST under Ultimate Liberty license
* SLA0044, the "License"; You may not use this file except in compliance with
* the License. You may obtain a copy of the License at:
* www.st.com/SLA0044
*
******************************************************************************
@endverbatim
@par Example Description
This is the implementation of the BLE Mesh Low Power Node profile as specified by the BLE SIG.
@note Care must be taken when using HAL_Delay(), this function provides accurate delay (in milliseconds)
based on variable incremented in SysTick ISR. This implies that if HAL_Delay() is called from
a peripheral ISR process, then the SysTick interrupt must have higher priority (numerically lower)
than the peripheral interrupt. Otherwise the caller ISR process will be blocked.
To change the SysTick interrupt priority you have to use HAL_NVIC_SetPriority() function.
@note The application needs to ensure that the SysTick time base is always set to 1 millisecond
to have correct HAL operation.
@par Keywords
Connectivity, BLE, IPCC, HSEM, RTC, UART, PWR, BLE protocol, BLE mesh, Dual core
@par Directory contents
mesh_lighting_demo
- BLE/BLE_MeshLightingLPN/Core/Inc/app_common.h Header for all modules with common definition
- BLE/BLE_MeshLightingLPN/Core/Inc/app_conf.h Parameters configuration file of the application
- BLE/BLE_MeshLightingLPN/Core/Inc/app_debug.h Interface to support debug in the application
- BLE/BLE_MeshLightingLPN/Core/Inc/app_entry.h Parameters configuration file of the application
- BLE/BLE_MeshLightingLPN/Core/Inc/hw_conf.h Configuration file of the HW
- BLE/BLE_MeshLightingLPN/Core/Inc/hw_flash.h Configuration file of the FLASH driver needed by EE module
- BLE/BLE_MeshLightingLPN/Core/Inc/hw_if.h Configuration file of the Hardware Iterface
- BLE/BLE_MeshLightingLPN/Core/Inc/lp_timer.h Configuration file of the Low power timer to be used within Mesh Application.
- BLE/BLE_MeshLightingLPN/Core/Inc/main.h Header for main.c module
- BLE/BLE_MeshLightingLPN/Core/Inc/stm32wbxx_hal_conf.h HAL configuration file
- BLE/BLE_MeshLightingLPN/Core/Inc/stm32_lpm_if.h Configuration file of the Low layer function to enter/exit low power modes (stop, sleep).
- BLE/BLE_MeshLightingLPN/Core/Inc/stm32wbxx_it.h Interrupt handlers header file
- BLE/BLE_MeshLightingLPN/Core/Inc/utilities_conf.h Configuration file of the utilities
- BLE/BLE_MeshLightingLPN/Core/Inc/vcp_conf.h Configuration file of Virtual Com Port Interface
- BLE/BLE_MeshLightingLPN/Core/Src/app_debug.c Interface to support debug in the application
- BLE/BLE_MeshLightingLPN/Core/Src/app_entry.c Initialization of the application
- BLE/BLE_MeshLightingLPN/Core/Src/hw_flash.c FLASH driver needed by EE module
- BLE/BLE_MeshLightingLPN/Core/Src/hw_timerserver.c Timer Server based on RTC
- BLE/BLE_MeshLightingLPN/Core/Src/hw_uart.c UART Driver
- BLE/BLE_MeshLightingLPN/Core/Src/lp_timer.c Low power timer to be used within Mesh Application.
- BLE/BLE_MeshLightingLPN/Core/Src/main.c Main program
- BLE/BLE_MeshLightingLPN/Core/Src/stm32_lpm_if.c Low Power Manager Interface
- BLE/BLE_MeshLightingLPN/Core/Src/stm32wbxx_it.c Interrupt handlers
- BLE/BLE_MeshLightingLPN/Core/Src/system_stm32wbxx.c stm32wbxx system source file
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/app_ble.c BLE Profile implementation
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/app_ble.h Header of BLE Profile implementation
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/appli_generic.c Application interface for Generic Mesh Models
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/appli_generic.h Header of Application interface for Generic Mesh Models
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/appli_light.c BLE Mesh Light Profile implementation
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/appli_light.h Header of BLE Mesh Light Profile implementation
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/appli_light_lc.c BLE Mesh Light Lightness Controller Profile implementation
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/appli_light_lc.h Header of BLE Mesh Light Lightness Controller Profile implementation
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/appli_mesh.c BLE Mesh application implementation
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/appli_mesh.h Header of BLE Mesh application implementation
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/appli_nvm.c BLE Mesh NVM application implementation
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/appli_nvm.h Header of BLE Mesh NVM application implementation
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/appli_sensor.c BLE Mesh Sensor Profile implementation
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/appli_sensor.h Header of BLE Mesh Sensor Profile implementation
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/appli_vendor.c BLE Mesh Vendor Profile implementation
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/appli_vendor.h Header of BLE Mesh Vendor Profile implementation
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/ble_conf.h BLE Services configuration
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/ble_dbg_conf.h BLE Traces configuration of the BLE services
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/hal_common.h Header for common function of HAL file
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/mesh_cfg.h Header for Mesh configuration
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/mesh_cfg_usr.h Header for user Mesh configuration
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/models_if.h Header for the BLE Mesh Models Interface file
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/models_if.c BLE Mesh Models Interface file
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/pal_nvm.c BLE Mesh NVM management implementation
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/pal_nvm.h Header of BLE Mesh NVM management implementation
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/PWM_config.c Pulse Width Modulation configuration
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/PWM_config.h Header of Pulse Width Modulation configuration
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/PWM_handlers.c Pulse Width Modulation handlers
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/PWM_handlers.h Header of Pulse Width Modulation handlers
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/svcctl_conf.c Service Controller configuration API
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/tl_conf.h Configuration file of the Transport layer
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/tl_if.c Transport Layer interface
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/user_if.h Header file for User interface file
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/user_if.c User interface file
- BLE/BLE_MeshLightingLPN/STM32_WPAN/App/vcp_conf.h Configuration of the vcp interface
- BLE/BLE_MeshLightingLPN/STM32_WPAN/Target/hw_ipcc.c IPCC Driver
@par Hardware and Software environment
- This example runs on STM32WB55xx devices.
- This example has been tested with an STMicroelectronics USB DONGLE board (MB1293C)
and can be easily tailored to any other supported device and development board.
@par How to use it ?
This application requires 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 preferred toolchain
- Rebuild all files and load your 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
Low Power Node
Low Power feature support is defined in mesh_cfg_usr.h by hte predefinition of ENABLE_LOW_POWER_FEATURE.
Note: A Low Power feature-enabled node does not support any other feature: all the other features should be
undefined.
@Demo setup based on USB DONGLE board (MB1293C)
General default setting defined in mesh_cfg_usr.h:
ENABLE_GENERIC_MODEL_SERVER_ONOFF (1) /* GENERIC SERVER ONOFF MODEL ON FIRST ELEMENT */
APPLICATION_NUMBER_OF_ELEMENTS 1 /* NUMBER OF ELEMENT SUPPORTED */
APPLICATION_SIG_MODELS_MAX_COUNT 20 /* TOTAL NUMBER OF MODELS SUPPORTED */
APPLICATION_VENDOR_MODELS_MAX_COUNT 2 /* 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 USB DONGLE board (MB1293C) has been set up using one board as a Friend node and two
boards as Low Power nodes.
Low Power node setup:
Step 1. Configure LPN parameters.
Change only if required ohterwise skip this step (use example parameters defined in mesh_cfg_usr.h)
LPN_RSSI_FACTOR_LEVEL 1
LPN_RECIVE_WINDOW_FACTOR_LEVEL 1
LPN_MINIMUM_QUEUE_SIZE_LOG 2
LPN_RECEIVE_DELAY 150 ms
LPN_POLL_TIMEOUT 2000 (*100 ms)
LPN_RECEIVE_WINDOW_SIZE 55 ms
LPN_SUBSCR_LIST_SIZE 2
LPN_FRIEND_REQUEST_FREQUENCY 50 (*100 ms)
LPN_FRIEND_POLL_FREQUENCY 25 (*100 ms)
LPN_MINIMUM_RSSI -100
LPN_NO_OF_RETRIES 10
Step 2. Generate and flash binary in 2 boards (LPN1, LPN2)
Friend Node setup (use the Proxy Relay Friend Node BLE_MeshLightingPRFNode project):
Step 1. Generate and flash binary in a board (FN)
Step 2. Provision the 3 boards with the default parameters, using BLE-Mesh Android (https://play.google.com/store/apps/details?id=com.st.bluenrgmesh&hl=en) or
BLE-Mesh iOS (https://apps.apple.com/us/app/st-ble-mesh/id1348645067) smartphone application (subscribe and publish to default group)
Demo operation
After provisioning, it might take a few seconds for Friendship to be established between FN and LPNs.
In this demo, the FN establishes Friendship with LPN1 and LPN2, LPN2 is optional.
Any packet targeted to LPN1/LPN2 or to a group address subscribed by LPN1 or LPN2 is put in queue by the FN
that forwards packets to LPN1/LPN2 as soon as it receives a Friend Poll from the respective LPN.
The LPN is free to send packets (generate traffic) any time.
By pressing [SW1] button on the Friend Node:
1. FN publishes a LED ON command to the default group and the FN blue LED immediately turns on (when the
FN belongs to the default group).
2. FN forwards a LED ON command to the LPNs subscribed to the default group. As soon as the FN receives
poll from an LPN, it sends LED ON to the respective LPN.
FN LPN1 LPN2
| | |
SW1 PUSH->| | |
Blue LED on->| | |
|<--Friend Poll--| |
| | |
|-----LED on---->|<-Blue LED on |
| |
|<----------Friend Poll----------|
| |
|-------------LED on------------>|<-Blue LED on
| |
By pressing [SW1] button on the Low Power Node 1:
1. LPN1 publishes an LED OFF command to the default group. LPN1 blue LED tunrs off.
LPN1 immediately forwards LED OFF command to the default group.
2. FN receives an LED OFF command (as it is subscribed to the default group) and the FN blue LED turns off.
3. FN also sends an LED OFF command to LPN2 (subscribed to the default group) as soon as FN receives
poll from LPN2.
FN LPN1 LPN2
| | |
| SW1 PUSH->|<-Blue LED off |
Blue LED off->|<----LED off----| |
| |
|<----------Friend Poll----------|
| |
|------------LED off------------>|<-Blue LED off
| |
=> Getting traces:
To get the traces, you have to enable CFG_USB_INTERFACE_ENABLE, with CFG_DEBUG_BLE_TRACE for BLE services traces
or with CFG_DEBUG_APP_TRACE for application traces.
You need also to connect your Board to the Hyperterminal (through USB STVirtual COM Port).
The UART must be configured as follows:
- BaudRate = 115200 baud
- Word Length = 8 Bits
- Stop Bit = 1 bit
- Parity = none
- Flow control = none
=> Running the application
* <h3><center>© COPYRIGHT STMicroelectronics</center></h3>
*/
|
