Digi XBee User Manual download pdf

©2010DigiInternational,Inc. 128

10.XBeeCommandReferenceTables

Addressing

Nodetypesthatsupportthecommand :C=Coordinator,R=Router,E=EndDevice

AddressingCommands

AT

Command

Name and Description

Node

Type

Parameter Range Default

Destination Address High.Set/Get the upper 32 bits of the 64-bit destination address.

When combined with DL, it defines the 64-bit destination address for data transmission.

Special definitions for DH and DL include 0x000000000000FFFF (broadcast) and

0x0000000000000000 (coordinator).

CRE 0 - 0xFFFFFFFF 0

Destination Address Low. Set/Get the lower 32 bits of the 64-bit destination address.

When combined with DH, it defines the 64-bit destination address for data

transmissions. Special definitions for DH and DL include 0x000000000000FFFF

(broadcast) and 0x0000000000000000 (coordinator).

CRE 0 - 0xFFFFFFFF

0xFFFF(Coordinator)

0 (Router/End Device)

16-bit Network Address. Read the 16-bit network address of the module. A value of

0xFFFE means the module has not joined a ZigBee network

CRE

0 - 0xFFFE

[read-only]

0xFFFE

16-bit Parent Network Address. Read the 16-bit network address of the module's

parent. A value of 0xFFFE means the module does not have a parent.

0 - 0xFFFE

[read-only]

0xFFFE

Number of Remaining Children. Read the number of end device children that can join

the device. If NC returns 0, then the device cannot allow any more end device children

to join.

0 - MAX_CHILDREN

(maximum varies)

read-only

SH Serial Number High. Read the high 32 bits of the module's unique 64-bit address. CRE

0 - 0xFFFFFFFF 

[read-only]

factory-set

SL Serial Number Low. Read the low 32 bits of the module's unique 64-bit address. CRE

0 - 0xFFFFFFFF

[read-only]

factory-set

Node Identifier. Stores a string identifier. The register only accepts printable ASCII

data. In AT Command Mode, a string can not start with a space. A carriage return ends

the command. Command will automatically end when maximum bytes for the string

have been entered. This string is returned as part of the ND (Node Discover) command.

This identifier is also used with the DN (Destination Node) command. In AT command

mode, an ASCII comma (0x2C) cannot be used in the NI string

CRE

20-Byte printable 

ASCII string

ASCII space

character (0x20)

Source Endpoint. Set/read the ZigBee application layer source endpoint value. This

value will be used as the source endpoint for all data transmissions. SE is only

supported in AT firmware.The default value 0xE8 (Data endpoint) is the Digi data

endpoint

CRE 0 - 0xFF 0xE8

Destination Endpoint. Set/read Zigbee application layer destination ID value. This

value will be used as the destination endpoint all data transmissions. DE is only

supported in AT firmware.The default value (0xE8) is the Digi data endpoint.

CRE 0 - 0xFF 0xE8

Cluster Identifier. Set/read Zigbee application layer cluster ID value. This value will be

used as the cluster ID for all data transmissions. CI is only supported in AT

firmware.The default value0x11 (Transparent data cluster ID).

CRE 0 - 0xFFFF 0x11

Maximum RF Payload Bytes. This value returns the maximum number of RF payload

bytes that can be sent in a unicast transmission. If APS encryption is used (API transmit

option bit enabled), the maximum payload size is reduced by 9 bytes. If source routing

is used (AR < 0xFF), the maximum payload size is reduced further.

Note: NP returns a hexadecimal value. (e.g. if NP returns 0x54, this is equivalent to 84

bytes)

CRE 0 - 0xFFFF [read-only]

Device Type Identifier. Stores a device type value. This value can be used to

differentiate different XBee-based devices. Digi reserves the range 0 - 0xFFFFFF.

For example, Digi currently uses the following DD values to identify various ZigBee

products:

0x30001 - ConnectPort X8 Gateway

0x30002 - ConnectPort X4 Gateway

0x30003 - ConnectPort X2 Gateway

0x30005 - RS-232 Adapter

0x30006 - RS-485 Adapter

0x30007 - XBee Sensor Adapter

0x30008 - Wall Router

0x3000A - Digital I/O Adapter

0x3000B - Analog I/O Adapter

0x3000C - XStick

0x3000F - Smart Plug

0x30011 - XBee Large Display

0x30012 - XBee Small Display

CRE 0 - 0xFFFFFFFF 0x30000

1 2 3 4 5 6 7 8 9 10

Summary of Contents

Page 1

©2010DigiInternational,Inc. 12810.XBeeCommandReferenceTablesAddressingNodetypesthatsupportthecommand :C=Coordinator,R=Router,E=E

Page 2

XBee®/XBee‐PRO®ZBRFModules©2010DigiInternational,Inc. 137Nodetypesthatsupportthecommand :C= Coordinator,R=Router,E=EndDevi

Page 3

XBee®/XBee‐PRO®ZBRFModules©2010DigiInternational,Inc. 129NetworkingNetworkingCommandsATCommandName and DescriptionNode Type1Parameter R

Page 4

XBee®/XBee‐PRO®ZBRFModules©2010DigiInternational,Inc. 130NJNode Join Time. Set/Read the time that a Coordinator/Router allows nodes to jo

Page 5

XBee®/XBee‐PRO®ZBRFModules©2010DigiInternational,Inc. 131Security RF Interfacing 1.Nodetypesthatsupportthecommand:C=Coordinator,

Page 6

XBee®/XBee‐PRO®ZBRFModules©2010DigiInternational,Inc. 132Serial Interfacing (I/O)1.Nodetypesthatsupportthecommand:C=Coordinator,

Page 7

XBee®/XBee‐PRO®ZBRFModules©2010DigiInternational,Inc. 133I/O CommandsI/OCommandsATCommandName and DescriptionNode Type1Parameter Range

Page 8

XBee®/XBee‐PRO®ZBRFModules©2010DigiInternational,Inc. 134D3AD3/DIO3 Configuration. Select/Read function for AD3/DIO3.CRE0, 2-50 – Disable

Page 9

XBee®/XBee‐PRO®ZBRFModules©2010DigiInternational,Inc. 135Diagnostics1.Nodetypesthatsupportthecommand:C=Coordinator,R=Router,E

Page 10

XBee®/XBee‐PRO®ZBRFModules©2010DigiInternational,Inc. 136Sleep CommandsExecution CommandsWhere most AT commands set or query register val