diff options
Diffstat (limited to 'Projects/NUCLEO-WB15CC/Applications/BLE/BLE_MeshLightingLPN/readme.txt')
| -rw-r--r-- | Projects/NUCLEO-WB15CC/Applications/BLE/BLE_MeshLightingLPN/readme.txt | 245 |
1 files changed, 245 insertions, 0 deletions
diff --git a/Projects/NUCLEO-WB15CC/Applications/BLE/BLE_MeshLightingLPN/readme.txt b/Projects/NUCLEO-WB15CC/Applications/BLE/BLE_MeshLightingLPN/readme.txt new file mode 100644 index 000000000..d2be02698 --- /dev/null +++ b/Projects/NUCLEO-WB15CC/Applications/BLE/BLE_MeshLightingLPN/readme.txt @@ -0,0 +1,245 @@ +/** + @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-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. + * + ****************************************************************************** + @endverbatim + +@par Example Description +This is the implementation of the BLE Mesh Low Power Node profile as specified by the BLE SIG, +a Low Power Node with the capacity to be associated to a Proxy-Relay-Friend Node for Friendship. + +@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 Interface + - 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_config.c Application interface for Config Server Mesh Model + - BLE/BLE_MeshLightingLPN/STM32_WPAN/App/appli_config.h Header of Application interface for Config Server Mesh Model + - BLE/BLE_MeshLightingLPN/STM32_WPAN/App/appli_config_client.c Application interface for Config CLient Mesh Model + - BLE/BLE_MeshLightingLPN/STM32_WPAN/App/appli_config_client.h Header of Application interface for Config CLient Mesh Model + - 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_generic_client.c Application interface for Client Generic Mesh Models + - BLE/BLE_MeshLightingLPN/STM32_WPAN/App/appli_generic_client.h Header of Application interface for Client 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_client.c Application interface for Client Light Mesh Models + - BLE/BLE_MeshLightingLPN/STM32_WPAN/App/appli_light_client.h Header of Application interface for Client Light Mesh Models + - 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 Server Sensor Profile implementation + - BLE/BLE_MeshLightingLPN/STM32_WPAN/App/appli_sensor.h Header of BLE Mesh Server Sensor Profile implementation + - BLE/BLE_MeshLightingLPN/STM32_WPAN/App/appli_sensor_client.c BLE Mesh Client Sensor Profile implementation + - BLE/BLE_MeshLightingLPN/STM32_WPAN/App/appli_sensor_client.h Header of BLE Mesh Client 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/sensor_cfg_usr.c Header for user Mesh Sensor Model configuration + - 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_dbg_conf.h Debug configuration file for stm32wpan transport layer interface. + - 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 STM32WB15xx devices. + + - This example has been tested with an STMicroelectronics STM32WB15CC-Nucleo + board and can be easily tailored to any other supported device + and development board. + +@par How to use it ? + +This application requires having the stm32wb1x_BLE_Stack_basic_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 the 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 STM32WB15CC-Nucleo + +General default setting defined in mesh_cfg_usr.h: + ENABLE_GENERIC_MODEL_SERVER_ONOFF (1) /* GENERIC SERVER ONOFF MODEL ON FIRST ELEMENT */ + ENABLE_VENDOR_MODEL_SERVER (1) /* VENDOR SERVER MODEL ON FIRST ELEMENT */ + APPLICATION_NUMBER_OF_ELEMENTS 1 /* NUMBER OF ELEMENT SUPPORTED */ + APPLICATION_SIG_MODELS_MAX_COUNT 1 /* TOTAL NUMBER OF MODELS SUPPORTED */ + APPLICATION_VENDOR_MODELS_MAX_COUNT 1 /* TOTAL NIMBER OF VENDOR MODELS SUPPORTED */ + ENABLE_LOW_POWER_FEATURE /* LOW POWER SUPPORT */ + ENABLE_PB_ADV /* Provisioning Bearer over advertising channels support */ + ENABLE_PB_GATT /* Provisioning Bearer over GATT proxy support */ + +The following demo based on STM32WB15CC-Nucleo 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 otherwise 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 + | | + +* <h3><center>© COPYRIGHT STMicroelectronics</center></h3> + */ +
\ No newline at end of file |