The information in this KBA has been supplanted by AN1118: Certifying Zigbee 3.0 Devices. Please refer to that document for details about the Zigbee certification process.

AN1118: Certifying Zigbee 3.0 Devices

Question

How to setup OTA Server and OTA Client on WSTK+4162 radio boards?

Answer

Here are some instruction about how to setup an OTA Server and OTA Client by WSTK+4162 radio boards. The intention of this article is to setup an OTA Server and OTA Client quickly. We are using the v6.7.4 EmberZnet stack to do the test.More information about OTA setup please refer to AN728OTAClientServerSetup.

In this testing, OTA Server works in NCP mode, we use WSTK+4162 radio board as NCP, and build the Host by Cygwin in Windows OS. The OTA file is storage at Host side. The OTA Client works in SOC mode, it downloads the OTA file to external SPI flash after detect a newer image in OTA Server.

1. OTA Server: NCP mode

Firstly, download standalone Bootloader: bootloader-uart-xmodem.s37 and NCP firmware: ncp-uart-hw.s37 to a WSTK kit.

Then create the Host: Z3GatewayHost as follows:

• Create a Z3GatewayHost sample, then modify the Z3GatewayHost.isc file.
  1. In “ZCL clusters” tab.
     • In the Cluster List pane on the bottom left, expand the General group. Check the Over-the-Air Bootloading Cluster server checkbox.
  2. In “Pringting and CLI” tab.
     • In the Debug Printing section, check the “Enable Debug Printing” checkbox.
     • Expand the Cluster Debugging group.
     • Check the Compiled-in and Enabled at startup checkboxes for the Over-the-Air Bootloading cluster.
  3. In the “Plugins” tab. Make sure the following OTA plugins are checked.
     • OTA Bootload Cluster Common Code
     • OTA Bootload Cluster Server
     • OTA Bootload Cluster Server Policy
     • OTA Bootload Cluster Storage Common Codes
     • OTA POSIX Filesystem Storage Module

• Save your configuration (ISC) file.
• Click Generate.
• Build the Z3GatewayHost in Cygwin.
  1. cd C:\SimplicityStudio\v4_workspace\Z3GatewayHost
  2. make
• Flash bootloader and NCP firmware to the WSTK kit.
• Run Z3GatewayHost in Cygwin: ./build/exe/Z3GatewayHost.exe -p com37

1. OTA Client: SOC mode

Secondly, create an application as OTA Client.

• Create a Z3light sample, modify  the Z3light.isc file as follows.
  1. In “ZCL clusters” tab.
     • In the Cluster List pane on the bottom left, expand the General group. Check the Over-the-Air Bootloading Cluster client checkbox.
  2. In “Znet Stack” tab.
     • Select the “ZigBee Device Type” as Router. You can also select other Device Type.
  3. In “Pringting and CLI” tab.
     • In the Debug Printing section, check the “Enable Debug Printing” checkbox.
     • Expand the Cluster Debugging group.
     • Check the Compiled-in and Enabled at startup checkboxes for the Over-the-Air Bootloading cluster.
  4. In the “Plugins” tab. Make sure the following OTA plugins are checked.
     • OTA Bootload Cluster Client
       1. Unselect the “Set Image Attribute (35x SOC only)”
     • OTA Bootload Cluster Client Policy
       1. Check the Perform EBL Verification (SOC Only) checkbox.
       2. In the Firmware Version text entry box, set the value to 1.
     • OTA Bootload Cluster Common Code
     • OTA Bootload Cluster Storage Common Code
     • OTA Cluster Platform Bootloader
     • OTA Simple Storage EEPROM Driver
       1. Check the “SOC Bootloading Support” checkbox.
       2. Modify the “OTA Storage End Offset” from 204800 to 524288. Make sure it has enough space to storage OTA file.
       3. Set the “EEPROM Device Read-modify-write Support” to false.
     • EEPROM
     • OTA Simple Storage Module

• Save your configuration (ISC) file.
• Click Generate.
• Build the OTAClient in Appbuilder.
• Flash application bootloader(bootloader-storage-spiflash-single.s37) and Z3light.s37 (First Client Image) to another WSTK+4162 kit.
• Using the OTAClient.isc file to build the Second Client Image
  1. Modify the Firmware Version in “OTA Bootload Cluster Client Policy” plugin,
     • In the Firmware Version text entry box, set the value to 2.
  2. Click Generate.
  3. Build project.
  4. You can find an Z3light.ota in your build directory. This is the Second Client Image for OTA.

1. Form network and do OTA Test.

• Copy the Z3light.ota to Z3GatewayHost/build/exe/ota-files folder in Cygwin
• Lunch the Z3GatewayHost: ./build/exe/Z3GatewayHost.exe -p com37

• Form network and pjoin at Z3GatewayHost side
  1. plugin network-creator start 1
  2. plugin network-creator-security open-network
• Join the network at Z3light side

  1. plugin network-steering start 0

  2. After the Z3light join the network, it will discovery OTA Server and query the New Image for download.