From 38f9d766e53d2413ade5c653edbf03037caa40c7 Mon Sep 17 00:00:00 2001 From: sebastiandraus <45386907+sebastiandraus@users.noreply.github.com> Date: Thu, 27 Jun 2019 09:13:48 +0200 Subject: [PATCH] Update zigbee part documentation to latest changes (#230) * Updated README.md to reflect latest Zigbee developments * Add info about min and max zigbee hw version --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1dfee7c..3782cbc 100644 --- a/README.md +++ b/README.md @@ -212,8 +212,12 @@ Update packages of external applications, e.g. updates that are intended for a t The boolean option `--zigbee` enables the generation of Zigbee update file in addition to the zip package. The following example demonstrates the generation of such update file: ``` -nrfutil pkg generate --hw-version 52 --sd-req 0 --application-version 0x01020101 --application nrf52840_xxaa.hex --key-file ../priv.pem app_dfu_package.zip --zigbee True --manufacturer-id 0xCAFE --image-type 0x1234 --comment good_image +nrfutil pkg generate --hw-version 52 --sd-req 0 --application-version 0x01020101 --application nrf52840_xxaa.hex --key-file ../priv.pem --app-boot-validation VALIDATE_ECDSA_P256_SHA256 app_dfu_package.zip --zigbee True --zigbee-manufacturer-id 0xCAFE --zigbee-image-type 0x1234 --zigbee-comment good_image --zigbee-ota-hw-version 52 --zigbee-ota-fw-version 0x01020101 --zigbee-ota-min-hw-version 52 --zigbee-ota-max-hw-version 52 ``` +The options `--zigbee-ota-hw-version` and `--zigbee-ota-fw-version`refer to the image which is generated to be distributed to the Zigbee OTA Server to be disseminated later into the network. `--zigbee-ota-hw-version` states the hardware version of the Zigbee OTA Server and `--zigbee-ota-fw-version` states the firmware version of this OTA Server accordingly. Everytime the Zigbee OTA Server receives the image for the dissemination its firmware version is updated. This is done to protect from a malicious attack, where the attacker could wear down the Server flash memory by sending the full Zigbee image to be distributed over and over again (thus wearing down the memory). Thus, in order for the OTA Server to accept the image for dissemination, the value passed as a `--zigbee-ota-fw-version` has to be incremented with every transfer of the image. + +The options `--zigbee-ota-min-hw-version` and `--zigbee-ota-max-hw-version` refer to the fields in Zigbee OTA header, which determine the range of OTA Client's hardware version for which the image is suitable. Both `--zigbee-ota-min-hw-version` and `--zigbee-ota-max-hw-version` are optional and if used, both must be given. + **Note 4:** The generated Zigbee update file is named according to the recommendation of the Zigbee Specification ([Zigbee Cluster Library Specification 11.5 - Zigbee Document 07-5123-06](http://www.zigbee.org/~zigbeeor/wp-content/uploads/2014/10/07-5123-06-zigbee-cluster-library-specification.pdf)), so the user doesn't provide the name of the Update file. ##### display @@ -272,6 +276,7 @@ Below is an example of the execution of a DFU procedure using a file generated a ``` nrfutil dfu zigbee -f CAFE-1234-good_image.zigbee -snr 683604699 -chan 20 ``` +**Note**: OTA Server stays on the network after disseminating the OTA DFU image. However, if power-cycled/reset, the node shall not automatically reconnect, and another issuing of command is needed. ##### Serial