Zigbee packages

nRF Util

tags
nRF Util

The --zigbee boolean option generates the Zigbee update file in addition to the ZIP package.

For example, the following command uses the --zigbee True option and several Zigbee-specific options to generate the Zigbee update file in addition to the application file as part of a single ZIP package:

nrfutil nrf5sdk-tools pkg generate --hw-version 52 --sd-req 0x00 --application-version 0x01020101 --application nrf52840_xxaa.hex --key-file ../priv.pem --app-boot-validation VALIDATE_ECDSA_P256_SHA256 app_dfu_package.zip --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 --zigbee True

In this example:

  • The zigbee-manufacturer-id option refers to the manufacturer ID for the Zigbee OTA Server header.
  • The zigbee-image-type option refers to the image type for the Zigbee OTA Server header.
  • The zigbee-comment option provides the comment to be used in the Zigbee OTA Server header.
  • The --zigbee-ota-hw-version and --zigbee-ota-fw-version options refer to the generated image to be distributed to the Zigbee OTA Server and disseminated later into the network. Each time the Zigbee OTA Server receives the image for dissemination, its firmware version is updated. This is done to protect from a malicious attack that could wear down the Server flash memory by repeatedly sending the full Zigbee image.

    • --zigbee-ota-hw-version describes the hardware version of the Zigbee OTA Server.
    • --zigbee-ota-fw-version describes the firmware version of the Zigbee OTA Server. The value passed as --zigbee-ota-fw-version must be incremented with every transfer of the image for the OTA Server to accept it for dissemination.
  • The optional --zigbee-ota-min-hw-version and --zigbee-ota-max-hw-version` options refer to the fields in the Zigbee OTA eader. These options determine the range of the OTA Client's hardware ersion for which the image is suitable.

    • If used, both options must be given.

For description of other options used in the example, run nrfutil nrf5sdk-tools pkg generate --help.

Tip

You can also use the --external-app option to generate a package for external applications. See example.