Welcome to mirror list, hosted at ThFree Co, Russian Federation.

readme.txt « Zigbee_OnOff_Router_NVM « Zigbee « Applications « P-NUCLEO-WB55.Nucleo « Projects - github.com/Flipper-Zero/STM32CubeWB.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 4c49001bebec4492e14034883221af43cf24a014 (plain)
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
/**
  @page Zigbee_OnOff_Router_NVM application
  
  @verbatim
  ******************************************************************************
  * @file    Zigbee/Zigbee_OnOff_Router_NVM/readme.txt 
  * @author  MCD Application Team
  * @brief   Description of the Zigbee OnOff Cluster application using   
  *          persistent data and acting as Router. 
  ******************************************************************************
  *
  * 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 Application Description 

How to use the OnOff cluster with persistent data activated on a device acting as Router within 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 
in order to make the LED toggling and with a restart from persistence of remote device. 

For this application it is requested to have:

- 1 STM32WB55xx board loaded with: 
    - wireless coprocessor : stm32wb5x_Zigbee_FFD_fw.bin
    - application : Zigbee_OnOff_Coord_NVM
    
- 1 or more STM32WB55xx board loaded with: 
    - wireless coprocessor : stm32wb5x_Zigbee_FFD_fw.bin
    - application : Zigbee_OnOff_Router_NVM
    

                  Device 1                                       Device 2
                  (Router)                                    (Coordinator)
           Zigbee_OnOff_Router_NVM                        Zigbee_OnOff_Coord_NVM
        
                 ---------                                      ---------
                 |       |       ZbZclOnOffClientToggleReq      |       |
      PushB SW1=>|Client | -----------------------------------> |Server | =>LED3 (RED)
    LED3 (RED)<= |Server | <----------------------------------- |Client | <= PushB SW1
                 |       |       ZbZclOnOffClientToggleReq      |       |
                 |       |                                      |       |
      PushB SW2=>|Delete |                                      |Delete |<= PushB SW2
                 |NVM    |                                      |NVM    | 
                 |       |                                      |       |
      PushB SW3=>|Diag   |                                      |  Diag |<= PushB SW3
                 |       |                                      |       |
                 --------                                       ---------
  
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_Coord_NVM application (Device2 in the above diagram).
      If the device starts from persistent data, the GREEN LED should light ON.
      If the device doesn't start from persistent data, the BLUE LED should light ON.
      Note: By pressing on SW2, it is possible at any time to delete the persistent data. At this stage, fresh start will be done 
            on the next restart. 
      
      Start the second board. This board is configured as Zigbee router with persistence and will attached to the network created 
      by the coordinator. Do the same for the other boards if applicable.
      
            
  b)  At this stage the second board tries to start from persistence this leads to two choices:

        - Persistent Data read from NVM are valid -> the router takes back is role in the network and restore the on/off cluster
          attribute saved in NVM (RED LED on or off). GREEN LED is ON indicating a restart form persistence.
          
        - No Persistent data found or wrong data,a fresh start is performed, the Zigbee network is automatically created 
          and BLUE LED is ON.
        
          
     It is now possible to send OnOff Cluster commands from the client to the server in multicast mode 
     by pressing on the SW1 push button. 
     You must see the RED LED toggling on the server side. (this for all devices). Persistence Data are updated in NVM. Stack and cluster 
     attribute (RED LED state).
     
   c)  If the user power cycle the Device 1, Persistent Data are read back and cluster attribute (RED LED state) restored.
       The device start from persistence and GREEN LED is on.
       Pushing SW1 on any boards toggle RED LED.
   
   d)  Push Button SW2 is used to delete NVM (fresh start will be done on next start up ,reproduce a))
   
   e)  Push Button SW3 is used to run a NVM diagnostics (flash test)

 Note: when LED1, LED2 and LED3 are toggling it is indicating an error has occurred on application.

@par Keywords

Zigbee
 
@par Hardware and Software environment

  - This example runs on STM32WB55xx devices.
  
  - This example has been tested with an STMicroelectronics STM32WB55RG_Nucleo 
    board and can be easily tailored to any other supported device 
    and development board.
    
  - On STM32WB55RG_Nucleo, the jumpers must be configured as described
    in this section. Starting from the top left position up to the bottom 
    right position, the jumpers on the Board must be set as follows: 

     CN11:    GND         [OFF]
     JP4:     VDDRF       [ON]
     JP6:     VC0         [ON]
     JP2:     +3V3        [ON] 
     JP1:     USB_STL     [ON]   All others [OFF]
     CN12:    GND         [OFF]
     CN7:     <All>       [OFF]
     JP3:     VDD_MCU     [ON]
     JP5:     GND         [OFF]  All others [ON]
     CN10:    <All>       [OFF]


@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:

    - BaudRate = 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>&copy; COPYRIGHT STMicroelectronics</center></h3>
*/