SWRA671 June   2020 CC1312R , CC1312R , CC1314R10 , CC1314R10 , CC1352P , CC1352P , CC1352R , CC1352R , CC1354P10 , CC1354P10 , CC1354R10 , CC1354R10 , CC2652P , CC2652P , CC2652R , CC2652R , CC2652R7 , CC2652R7 , CC2652RB , CC2652RB , CC2652RSIP , CC2652RSIP

 

  1.   Cloning Z-Stack Network Properties Using the SimpleLink Wireless MCU Family
    1.     Trademarks
    2. Introduction
    3. Abbreviations and Acronyms
    4. Tool Versions
      1. 3.1 Command Line Interface (CLI)
      2. 3.2 MAC OS Application
      3. 3.3 Windows Executable
    5. Trust Center and Non-Volatile Memory
    6. Multi-Page NVM
    7. MT Interface
    8. Zigbee Coordinator Setup Procedure
    9. Zigbee Coordinator Cloning Procedure
      1. 8.1 Cloning: Method One
      2. 8.2 Cloning: Method Two
    10. Zigbee Coordinator Cloning Procedure Example
    11. 10 Other Application Considerations
    12. 11 Summary
    13. 12 References
  2.   A TI Zigbee Network Properties Cloning Tool Guide
    1.     A.1 Tool Layout
    2.     A.2 Configuration File
    3.     A.3 Content File
    4.     A.4 Application Selection
    5.     A.5 COM Ports
    6.     A.6 Read Settings
    7.     A.7 Write Settings
    8.     A.8 Output Settings
    9.     A.9 Save/Load Settings
    10.     A.10 Help
  3.   B Establishing a Serial Connection
    1.     B.1 Serial Connections
    2.     B.2 Detecting COM Ports

Zigbee Coordinator Setup Procedure

In order to clone the network properties of a ZC, there needs to be a way to communicate with the device. This is similar to a Zigbee Network Processor where the Zigbee device just executes commands specific to the network, but the application is hosted on another MCU. In this case, the coordinator needs to be able to read in MT commands and respond accordingly. To do this the coordinator project that is flashed onto the device needs to include the MT and Network Processor Interface (NPI) APIs. The NPI is needed so that a host microcontroller (MCU) or platform is able to control the CC13xx/CC26xx device by sending serial commands. This section explains the required steps needed in order to use the TI Zigbee Network Properties Cloning Tool. The setup procedure is to be done on a fresh device before installation or network setup.

Refer to the ‘Adding MT to a SimpleLink CC13x2/26x2 SDK Zigbee 3.0 Project’ for detailed steps on incorporating the MT and NPI APIs into an existing Z-Stack Coordinator project. As a modification to the documentation, for the purpose of accomplishing this task the following change is made to step 3, Include Predefined Symbols and Options: along with the already stated predefined symbols the symbols in Table 6 also need to be incorporated. Ensure the project also contains the 'NV_RESTORE' predefine for the NV items to be retained after a reset.

Table 6. Predefined Symbols for MT/NPI APIs

Predefined Symbol Purpose
FEATURE_NVEXID Required in order to use the extended MT API commands.
MT_SYS_KEY_MANAGEMENT Grants access to the security key data

After completing step 3, the project is ready to be flashed onto the device. Ensure to erase all of the NVM before flashing projects onto the device to avoid strange behavior based on old stored NV data. To erase the contents in the device use UniFlash. Once the project has been flashed onto the ZC device, start the BDB commissioning process. If using a LaunchPad device, pressing (BTN-1) will automatically start the BDB commissioning process. As soon as the network is formed other ZED/ZR devices may join the newly formed NWK.

In the case that the ZC has fallen off the network and the user wishes to clone it then the tools attached to this application report can be used. Note that the coordinator that will replace the pre-existing coordinator must also have its NVM erased and then have the same project file flashed with the inclusion of the MT and NPI APIs. The TI Zigbee Network Properties Cloning Tool will only detect devices with these APIs included.