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

readme.txt « Zigbee_IAS_WD_Client_Router « 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: 38fbe48c829a0d8d1c370e000e504053dbc1bbdf (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
155
156
157
158
159
160
/**
  @page Zigbee_IAS_WD_Client_Router application
  
  @verbatim
  ******************************************************************************
  * @file    Zigbee/Zigbee_IAS_WD_Client_Router/readme.txt 
  * @author  MCD Application Team
  * @brief   Description of the Zigbee IAS WD 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 IAS WD cluster as a client 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 IAS WD cluster. Once the Zigbee mesh 
network is created, the user can send requests from the client to the server through push buttons SW1 and SW2.

For this application it is requested to have:

- 1 STM32WB55xx board loaded with: 
    - wireless coprocessor : stm32wb5x_Zigbee_FFD_fw.bin
    - application : Zigbee_IAS_WD_Server_Coord
    
- 1 or more STM32WB55xx board loaded with: 
    - wireless coprocessor : stm32wb5x_Zigbee_FFD_fw.bin
    - application : Zigbee_IAS_WD_Client_Router
    
    
Demo use case :

This demo shows how to use IAS WD cluster.
The IAS WD Client remotely writes the MaxDuration IAS WD Server attribute (attribute set to 10sec).
The IAS WD Client can send the two IAS WD Cluster commands : StartWarning and Squawk.

StartWarning command:
=====================

- IAS WD StartWarning command is send to server.
    + Warning mode set to ZCL_IAS_WD_WARNING_MODE_BURGLAR.
    + Warning duration set to 15sec.
    + Siren level set to ZCL_IAS_WD_LEVEL_MEDIUM.
    + Strobe is enabled with the siren (ZCL_IAS_WD_STROBE_ON).
    + Strobe level set to ZCL_IAS_WD_LEVEL_MEDIUM.
    + Strobe dutycycle (in 1/100 of a sec) is set to 20.
- IAS WD Server activate the alarm for 10sec (MaxDuration IAS WD Server attribute value).


Squawk:
=======

IAS WD Squawk command is send to server.
    + Squawk mode set to ZCL_IAS_WD_SQUAWK_MODE_ARMED.
    + Squawk level set to ZCL_IAS_WD_LEVEL_MEDIUM.
    + Strobe is enabled with the siren (ZCL_IAS_WD_STROBE_ON).
    

              Device 1                                                                        Device 2
          
             +--------+                                                                      +--------+
             |        |                                                                      |        |                                       
             | Client |                                                                      | Server | 
             |        |             ZbZclWriteReq(ZCL_IAS_WD_SVR_ATTR_MAX_DURATION)          |        |
             |        | -------------------------------------------------------------------> |        |
             |        | <------------------------------------------------------------------- |        |
             |        |                                                                      |        |
             |        |         ZbZclIasWdClientStartWarningReq(ZCL_IAS_WD_STROBE_ON)        |        |
  PushB SW1=>|        | -------------------------------------------------------------------> |        |=>LED_GREEN
             |        | <------------------------------------------------------------------- |        |
             |        |                                                                      |        |
             |        |            ZbZclIasWdClientSquawkReq(ZCL_IAS_WD_STROBE_ON)           |        |
  PushB SW2=>|        | -------------------------------------------------------------------> |        |=>LED_RED
             |        | <------------------------------------------------------------------- |        |
             |        |                                                                      |        |
             +--------+                                                                      +--------+
  
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_IAS_WD_Server_Coord application (Device2 in the above diagram). 
      Wait for the Blue LED (LED1) ON. 
      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 BLUE LED (LED1) is ON on all devices.
      it is now possible to send IAS WD server commands to the client by pressing on 
      the SW1/SW2 push button. 

 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>