Network Explorer

The Network Explorer is a tool that allows you to perform various Zigbee functions with a command line interface. To make it easy, it also allows you to define whether the device is a Coordinator, Router, or End Device "on the fly" just with a simple command.

This example exceeds the 4kB code limit of the IAR Kickstart version. If you would like to compile it then use the 30 day evaluation, or purchase the full edition. We have provided precompiled binary files of the Network Explorer example for loading onto the microcontroller. These are located in the FactoryDefault directory of the firmware package. See Loading Binary Files into Stellaris and Loading Binary Files into MSP430 for instructions.

Starting
When the application starts, it prompts the user for which device type it should be. This message repeats every few seconds until the user presses C, R, or E. This in turn will start the module as the selected device type.



Once loaded, the menu is displayed:



Commands
This simple set of commands allows you to send/receive messages, find devices, etc.

Commands: ?                   Displays this N                   Display Network Information R                   Restart Zigbee Module S                   Send a message by Short Address L                   Send a message by Long Address H                   Find via short address J                   Find via long address (not for End Devices) V                   Display Module Version Information

Pressing the escape key will cause the current command to be cancelled and will exit back to the main menu.

Help
Typing '?' will display the list of commands.

Network Information
Displays information about the network, including configuration parameters and Device Information Properties.

Restart Zigbee Module
Prompts the user to enter the device type and then restarts the module with the selected device type.

Send a message by Short Address
Prompts the user to enter a valid Short Address and then sends the message.

Send a message by Long Address
Prompts the user to enter a valid Long Address and then sends the message.

Display Module Version Information
Displays information about the module firmware

New Commands
As of Version 1880 this list now includes the following, based on compile options. See code for details. Commands: ?                   Displays this A                   Turn ON Joining for short address B                   Turn OFF Joining for short address D                   Discover Networks (only when not on NWK) E                   Request Device to Leave N                   Display Network Information R                   Restart Zigbee Module S                   Send a message by Short Address L                   Send a message by Long Address H                   Find via short address & display children J                   Find via long address (not for End Devices) I                   Get Network Topology starting at short address V                   Display Module Version Information Compile options are used to reduce code size for the MSP430 version. The Stellaris/Tiva platform can support all options. The additional commands are described below:

Turn ON Joining
This command sets Joining ON for a particular node by using ZDO MGMT PERMIT JOIN REQ. If Joining is off then other devices will not be able to join the network through that node.

Turn OFF Joining
This command sets Joining OFF for a particular node by using ZDO MGMT PERMIT JOIN REQ.

Discover Networks
You must first Leave the network before using this command. This will search for all available networks using ZDO NWK DISCOVERY REQ and display them.

Request Device to Leave
This command asks a device to leave the network by using ZDO MGMT LEAVE REQ.

Get Network Topology
Recursively iterates through the network, displaying every child of every node. Allows you to "map out" the network.

Receiving Messages
Any messages received by the device will be displayed in a concise format.



The abbreviations are as follows. See AF INCOMING MSG for more information on each field.
 * Grp - Group Id
 * Clus - Cluster
 * SrcAd - Short Address of the device sending the message
 * SrcEnd - Endpoint of the device sending the message
 * DestEnd - Endpoint on the destination
 * Bc - whether the message was a Broadcast Message
 * Lqi - the Link Quality Indication of the received message
 * Sec - whether security was used to send the message
 * Len - the length of the messsage