diff options
Diffstat (limited to 'Projects/STM32WB5MM-DK/Applications/Zigbee/Zigbee_OnOff_Server_Coord/readme.txt')
| -rw-r--r-- | Projects/STM32WB5MM-DK/Applications/Zigbee/Zigbee_OnOff_Server_Coord/readme.txt | 108 |
1 files changed, 108 insertions, 0 deletions
diff --git a/Projects/STM32WB5MM-DK/Applications/Zigbee/Zigbee_OnOff_Server_Coord/readme.txt b/Projects/STM32WB5MM-DK/Applications/Zigbee/Zigbee_OnOff_Server_Coord/readme.txt new file mode 100644 index 000000000..e67ae717b --- /dev/null +++ b/Projects/STM32WB5MM-DK/Applications/Zigbee/Zigbee_OnOff_Server_Coord/readme.txt @@ -0,0 +1,108 @@ +/** + @page Zigbee_OnOff_Server_Coord application + + @verbatim + ****************************************************************************** + * @file Zigbee/Zigbee_OnOff_Server_Coord/readme.txt + * @author MCD Application Team + * @brief Description of the Zigbee OnOff Cluster application as a client + * using a centralized network. + ****************************************************************************** + * + * 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 Application Description + +How to use OnOff cluster as a server on a centralized Zigbee network. + +The purpose of this application is to show how to create a Zigbee centralized network, and +how to communicate from one node to another one using the OnOff cluster. Once the Zigbee mesh +network is created, the user can send requests from the client to the server through the push button. +The reception of the message triggers a specific message 'O' which is displayed on the LCD. + +For this application it is requested to have: + +- 1 STM32WB5MMxx board loaded with: + - wireless coprocessor : stm32wb5x_Zigbee_FFD_fw.bin + - application : Zigbee_OnOff_Server_Coord + +- 1 or more STM32WB5MMxx board loaded with: + - wireless coprocessor : stm32wb5x_Zigbee_FFD_fw.bin + - application : Zigbee_OnOff_Client_Router + + + Device 1 Device 2 + + --------- --------- + | | ZbZclOnOffClientToggleReq | | + PushB1=>|Client | -----------------------------------> |Server | =>LCD message 'O' toggleling + | | | | + | | | | + -------- --------- + +To setup the application : + + a) Open the project, build it and load your generated application on your STM32WB devices. + + To run the application : + + a) Start the first board. It must be the coordinator of the Zigbee network so in this demo application it is + the device running Zigbee_OnOff_Server_Coord application (Device2 in the above diagram). + Wait for the message 'Join OK' being displayed on the LCD. + Start the second board. This board is configured as Zigbee router and will attached to the network created + by the coordinator. Do the same for the other boards if applicable. + + b) At this stage, the Zigbee network is automatically created and the message 'Join OK' should + appear on the LCD screen. + It is now possible to send OnOff Cluster commands from the client to the server in multicast mode + by pressing on the B1 push button. + You must see the message 'O' toggling on the LCD + + +@par Keywords + +Zigbee + +@par Hardware and Software environment + + - This example runs on STM32WB5MMxx devices. + + - This example has been tested with an STMicroelectronics STM32WB5MM-DK + board and can be easily tailored to any other supported device + and development board. + +@par How to use it ? + +=> Loading of the stm32wb5x_Zigbee_FFD_fw.bin binary + + This application requests having the stm32wb5x_Zigbee_FFD_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. + +=> Getting traces + To get the traces you need to connect your Board to the HyperTerminal (through the STLink Virtual COM Port). + The UART must be configured as follows: + + - Baud Rate = 115200 baud + - Word Length = 8 Bits + - Stop Bit = 1 bit + - Parity = none + - Flow control = none + +=> Running the application + + Refer to the Application description at the beginning of this readme.txt + + * <h3><center>© COPYRIGHT STMicroelectronics</center></h3> + |