Posts Tagged ‘ZigBee Operator’

Send Remote AT Command in API Mode with ZigBee Operator

Thursday, October 17th, 2013

ZigBee Operator is a professional tool to learn, research, develop and test Digi’s ZigBee/XBee module. It implements both API encoder and decoder for Digi’s XBee & ZigBee Mesh and 802.15.4. Both AT and API commands are supported.

It’s so easy to send AT commands in API mode with ZigBee Operator comparing with X-CTU software. You don’t need input the long command packet and calculate the checksum. You only input the short command text and parameter according to the XBee Command Reference Tables. ZigBee Operator makes it so easy to configure, develop or test for XBee, ZigBee, 802.15.4 modules.

Download ZigBee Operator

Here are the sample steps for how to send Remote AT command for DIO4 Configuration:

1. Download and install ZigBee Operator.

2. Connect two XBee 802.15.4 modules with your computer by ZigBee to Serial Port adapters.

XBee 802.15.4 module 1     XBee 802.15.4 module 2

3. Run two ZigBee Operator applications, open the COM Port connected with above two XBee modules separately, and select the right baud rate for them. Here Module 1 is connected with COM 7, and Module 2 is connected with COM 8.

ZigBee Operator -XBee Module 1   ZigBee Operator -XBee Module 2

4. On both of ZigBee Operator (M1 and M2), click “AT Terminal” button to show Terminal Window. Type the AT Commands to make sure it’s in API mode.

ZigBee Operator - AT Ternimal - AT Command

5.  Click “Device Properties” icon on ZigBee Operator-M2 to show Device Properties dialog. You can read the address of Module 2 directly. The address of Module 1 can also be read like this on ZigBee Operator (M1). Here, we will use Module 2 to remote control Module 1, the destination address already be selected from the Device Data Base form on Device Properties dialog below.

ZigBee Operator - Device Protperties

Module 1 address: Module 2 address:
SH = 0013A200 SH = 0013A200
SL = 4033DD15 SL = 4092F15C

6.  On ZigBee Operator – M1, click “802.15.4” button  to show Quick Send – XBee & XBee –PRO 802.15.4 panel, and select AT Command for command type.

ZigBee Operator - 802.15.4 - AT Command

7. On ZigBee Operator – M2, click “802.15.4” button  to show Quick Send – XBee & XBee –PRO 802.15.4 panel, and select  Remote AT Command for command type. Click Edit button to input or select address of remote XBee module (M1).

ZigBee Operator - 802.15.4 - Remote AT Command

8. “D4” is the AT Command for DIO4 Configuration.  On ZigBee Operator – M1, input D4 for the command and click Send button. You will see all Send and Receive information in Log Data panel.  Here, the current DIO4 parameter of Module 1 is 5, that means DIO 4 digital output is high. At this moment, the LED5 on the adapter of Module 1 is off.

ZigBee Operator - 802.15.4 - I/O AT Command

LED5 off

9. On ZigBee Operator – M2,  input D4 command with parameter 4 to set DIO4 digital output of Module 1 to low remotely.

ZigBee Operator - 802.15.4 - Remote  I/O AT Command

The Remote AT Command is sent successfully. However, the LED5 on adapter of Module 1 has no any change.  After sending AC command you will see the LED5 is on now.

ZigBee Operator - 802.15.4 - Remote  AC AT Command

LED5 on

10. On ZigBee Operator – M1, send the D4 command again to make sure the current parameter of DIO4 has been changed to 4 remotely.

ZigBee Operator - 802.15.4 - D4 AT Command

Following above steps, you can send other remote AT commands in API mode with ZigBee Operator.

Back to ZigBee Operator homepage

About ZigBee Operator

Thursday, July 25th, 2013

ZigBee Operator is developed by Serial Port Tool. It is a professional tool for Digi’s ZigBee/XBee module researching, learning, developing and testing. It implements both API coder and decoder for Digi’s XBee & ZigBee Mesh and 802.15.4. Both AT and API command are supported.

ZigBee Operator

It’s free to try all functions within 30 days.

Download the latest ZigBee Operator to Try!

 Features

  • Support all Digi’s ZigBee/XBee firmware
  • Support both AT and API module
  • Decode API frame in details
  • Work with Digi’s ZigBee/XBee remotely through network
  • Store ZigBee/XBee module’s properties in database
  • Read & Write most used properties of ZigBee/XBee
  • Select destination address from database
  • Explorer all modules in searching range
  • Show mesh’s topology in graphic mode
  • List all available serial port on computer with friendly name
  • Show data in Text, Hex and Decimal mode
  • View data Sent & Received in list
  • Multi list view supported
  • Load & Save list data in file

Back to ZigBee Operator homepage

AO Command

Sunday, December 5th, 2010

AO Command  is for “API Options”. It query/configures options for API.

0 – Default receive API indicators enabled
1 – Explicit Rx data indicator API frame enabled (0×91)
3 – enable ZDO passthrough of ZDO requests to the UART which are not supported by the stack, as well as Simple_Desc_req, Active_EP_req, and Match_Desc_req.

To send AO command in ZigBee Operator, switch to XBee/XBee Pro ZB ZiBee Profile.

image

Input “AO” in command field and click “Send” button. It will query the value of AO.

Here are message in Log window.

Send:(21:59:47) 7E 00 04 08 01 41 4F 66

Data Parsed: 7E 00 04 08 01 41 4F 66
AT Command
Frame ID: 0×01
Command: AO
Para(Hex):
Para(Text):

Rec:(21:59:47)7E 00 06 88 01 41 4F 00 00 E6
Data Parsed: 7E 00 06 88 01 41 4F 00 00 E6
AT Command Response
Frame ID: 1
Command: AO
Status: 0 = OK
Para: 00 

To change the value of “AO”, input the value in “Parameters” field. The value are in hex.

image

Send:(22:00:55) 7E 00 05 08 01 41 4F 03 63

Data Parsed: 7E 00 05 08 01 41 4F 03 63
AT Command
Frame ID: 0×01
Command: AO
Para(Hex):03
Para(Text):

Rec:(22:00:55)7E 00 05 88 01 41 4F 00 E6
Data Parsed: 7E 00 05 88 01 41 4F 00 E6
AT Command Response
Frame ID: 1
Command: AO
Status: 0 = OK
Para: 

Tip

You can send a “WR” command to write the value to flash memory.

How to Run AT command in API mode

Sunday, December 5th, 2010

In ZigBee Operator, it is very easy to run AT command in API mode.

Here are the examples for run get firmware AT command “VR”.

In XBee/XBee-Pro ZB profile.

Steps:

Switch to XBee/XBee Pro ZB Profile.

Input ASCII characters “VR” in command field and click button “Send” will send the command.

Here is screenshot of the quick send panel.

image

Here is the message in log window.

Send:(21:25:54) 7E 00 04 08 01 56 52 4E

Data Parsed: 7E 00 04 08 01 56 52 4E
AT Command
Frame ID: 0×01
Command: VR
Para(Hex):
Para(Text):

Rec:(21:25:54)7E 00 07 88 01 56 52 00 21 70 3D
Data Parsed: 7E 00 07 88 01 56 52 00 21 70 3D
AT Command Response
Frame ID: 1
Command: VR
Status: 0 = OK
Para: 21 70

ZigBee Operator will send a data frame to module. It starts with “7E” and “08” is the flag for AT command. The “0×56 0×52” are ASCII code for character “VR”. The command are not case sensitive. Both “VR” and “vr” works.

The module will send a “AT Command Response” data frame to ZigBee Operator. The last line “Para” is the command result. In this sample, it is “21 70”, means the firmware is 2170, the firmware for API Zigbee coordinator.

To run a command with a parameters, like “SN”command, which  sets the number of sleep periods to not assert the On/Sleep pin on wakeup if no RF data is waiting for the end device. The default value for this command is 1. Send “SN” command without any parameter like example above will return the value.

Here are the message in Log window.

Send:(21:39:51) 7E 00 04 08 01 53 4E 55

Data Parsed: 7E 00 04 08 01 53 4E 55
AT Command
Frame ID: 0×01
Command: SN
Para(Hex):
Para(Text):

Rec:(21:39:51)7E 00 07 88 01 53 4E 00 00 01 D4
Data Parsed: 7E 00 07 88 01 53 4E 00 00 01 D4
AT Command Response
Frame ID: 1
Command: SN
Status: 0 = OK
Para: 00 01 

The value of SN is 1.

To set a value for SN, input the value in Parameters field. The value are in hex. Input “20” in parameters will set the value to 20.

image

Here are the message in Log window.

Send:(21:46:06) 7E 00 05 08 01 53 4E 20 35

Data Parsed: 7E 00 05 08 01 53 4E 20 35
AT Command
Frame ID: 0×01
Command: SN
Para(Hex):20
Para(Text):

Rec:(21:46:06)7E 00 05 88 01 53 4E 00 D5
Data Parsed: 7E 00 05 88 01 53 4E 00 D5
AT Command Response
Frame ID: 1
Command: SN
Status: 0 = OK
Para: 

It showed that command are run success.

Run “SN” command and leave parameters field blank will query the value of SN again.

Here are the message in Log window.

Send:(21:48:34) 7E 00 04 08 01 53 4E 55

Data Parsed: 7E 00 04 08 01 53 4E 55
AT Command
Frame ID: 0×01
Command: SN
Para(Hex):
Para(Text):

Rec:(21:48:34)7E 00 07 88 01 53 4E 00 00 20 B5
Data Parsed: 7E 00 07 88 01 53 4E 00 00 20 B5
AT Command Response
Frame ID: 1
Command: SN
Status: 0 = OK
Para: 00 20 

The value of SN is 20 now.

It is same for 802.15.4 devices, just switch to 802.15.4 profile and send command there.

image

ZigBee Link Testing with ZigBee Operator

Thursday, November 18th, 2010

ZigBee Operator support “Explicit Addressing ZigBee Command”. We can use Explicit Addressing ZigBee Command for link testing with API firmware.

image

Steps for Link Testing

Prepare the mesh network. The minimum requirement for a mesh network is a coordinator and an end device. We use a end device with API firmware.

Power on both coordinator and end devices. Connect the coordinator to the computer.

Open the ZigBee Operator and connect with serial port of XBee modules.

Go to “Tools-XBee Devices Properties” or “image ” icon to open Properties window and check “API” check box. Click “Read” button to make sure the computer can talk to device correctly.

image

Go to “Tools->Search XBee Devices” or click “image”icon to open “Search Device” window and check “API Mode”. Click “Search Network” button to search the network to make sure the end device are connected with Coordinator.

image

Click “Add To Database” button to add all XBee modules’ information to database.

Close the search window.

Click “View->XBee & XBee Pro ZB ZigBee” or “image” icon to switch to “Mesh Network” panel. 

image

Select “Explicit Addressing ZigBee Command” in type

Select Coordinator’s address in Address

Set “Cluster ID” to 12 and “Source Endpoint” to E8 and “Destination Endpoint” to E8.

Set “Profile ID” to C105

Select “TEXT” in format and input “Echo” in RF Data. It can be any text as long as it is not empty.

Click “Send” button.

It will send the data to coordinator endpoint E8 from  source endpoint using cluster ID 12. This is setting for Loopback data. When coordinator received data from end point E8, it will send the data back.

Here is the data in log window.

Send:(09:03:46) 7E 00 18 11 01 00 13 A2 00 40 0A 2A 94 FF FE E8 E8 00 12 C1 05 00 00 45 63 68 6F 0C

Data Parsed: 7E 00 18 11 01 00 13 A2 00 40 0A 2A 94 FF FE E8 E8 00 12 C1 05 00 00 45 63 68 6F 0C
Explicit Addressing ZigBee Command
Frame ID: 0×01
64 Bits Address: 0013:A200-400A:2A94
16 Bits Network Address: FFFE
Source Endpoint: 0xE8
Destination Endpoint: 0xE8
Cluster ID: 0×0012
Profile ID: 0xC105
Broadcast Radius: 0×00
Options: 0×00
Data(Hex):45 63 68 6F
Data(Text):Echo

Rec:(09:03:47)7E 00 07 8B 01 85 BB 00 00 00 33 7E 00 10 90 00 13 A2 00 40 0A 2A 94 85 BB 41
Data Parsed: 7E 00 07 8B 01 85 BB 00 00 00 33
Transmit Status
Frame ID: 1
Network Address :0x85BB
Retries: 0×00
Delivery Status: 0×0 = Success
Discovery Status: 0×0 = No Discovery Overhead

45 63 68 6F B2
Data Parsed: 7E 00 10 90 00 13 A2 00 40 0A 2A 94 85 BB 41 45 63 68 6F B2
ZigBee Receive Packet
64 Bits Address: 0013:A200-400A:2A94
16 Bits Network Address: 85BB
Options: 0×41
Packet Acknowledged
Data(Hex):45 63 68 6F
Data(Text):Echo

Sometimes, the data send won’t be echo back. Please keep sending until you get the data back. Some times you need reset the end devices.

To check the signal strength on the remote module.

Switch to “Remote AT Command”, and select the address of the remote module and send “DB” Command. It will return the signal strength of last hop.

image

Here is the data in log window.

Send:(09:04:51) 7E 00 0F 17 01 00 13 A2 00 40 0A 2A 94 FF FE 00 64 62 67

Data Parsed: 7E 00 0F 17 01 00 13 A2 00 40 0A 2A 94 FF FE 00 64 62 67
Remote AT Command
Frame ID: 0×01
64Bits Destination Address: 0013:A200-400A:2A94
16Bits Destination Network Address: FFFE
Command Options: 0×00
Command: db
Para(Hex):
Para(Text):

Rec:(09:04:51)7E 00 10 97 01 00 13 A2 00 40 0A 2A 94 85 BB 64 62 00 24 80
Data Parsed: 7E 00 10 97 01 00 13 A2 00 40 0A 2A 94 85 BB 64 62 00 24 80
Remote AT Command Response
Frame ID: 0×01
64Bits Remote Module Address: 0013:A200-400A:2A94
16Bits Remote Module Network Address: 85BB
Command: db
Status: 0×00 = OK
Para: 24 

The signal strength on remote module is 24.

To Check the signal strength on the local module.

Switch to “AT Command” and send “DB” command. It will return the strength of the last hop.

image

Here is the data in log window.

Send:(09:09:55) 7E 00 04 08 01 64 62 30

Data Parsed: 7E 00 04 08 01 64 62 30
AT Command
Frame ID: 0×01
Command: db
Para(Hex):
Para(Text):

Rec:(09:09:55)7E 00 06 88 01 64 62 00 25 8B
Data Parsed: 7E 00 06 88 01 64 62 00 25 8B
AT Command Response
Frame ID: 1
Command: db
Status: 0 = OK
Para: 25 

The signal strength of local module for last hop is 25.

ZigBee Operator is released!

Sunday, October 17th, 2010

We opened a new website for ZigBee Operator. 

http://www.zigbeeoperator.com 

ZigBee Operator is a professional tool for Digi’s ZigBee/XBee module researching, learning, developing and testing. It implements both API coder and decoder for Digi’s XBee & ZigBee Mesh and 802.15.4. Both AT and API command are supported. 

Features:

  • Support all Digi’s ZigBee/XBee firmware
  • Support both AT and API model
  • Decode API frame in details
  • Work with Digi’s ZigBee/XBee remotely through network
  • Store ZigBee/XBee module’s properties in database
  • Read & Write most used properties of ZigBee/XBee
  • Select destination address from database
  • Explorer all modules in searching range
  • Show mesh’s topology in graphic mode
  • List all available serial port on computer
  • Show data in Text, Hex and Decimal mode
  • View data sent & received in list
  • Multi list view supported
  • Load & Save list data in file

 

 

 ZigBee Operator Quick Start

 

Quick Start 

 

 ZigBee Operator Screenshot  

 

 

 

 

ZigBee Opertor Quick Start Video

Quick Start Part I 

Product Page: http://www.zigbeeoperator.com
Download link: http://www.zigbeeoperator.com/download/ZigBeeOperator.zip
E-Mail: zigbee@serialporttool.com