XbeeCore

Use the XbeeCore web service to display a current list of ZigBee nodes in your account or refresh (discover) the node list. You can also use PUT to associate text with a specified node.

URI

http://<hostname>/ws/XbeeCore

Formats

HTTP method Format Description
GET /ws/XbeeCore[?param1&param2…&paramn] List all nodes in your account.
PUT /ws/XbeeCore/{xpExtAddr}/{xpUserMetaData} Add user-defined text metadata to a node.

Elements

cstId

Remote Manager customer identifier of the gateway owner.

grpId

Remote Manager customer group identifier of the gateway owner.

grpPath

Path of the specified Remote Manager group.

devConnectwareId

Device identifier of the node gateway.

xpExtAddr

ZigBee 64-bit extended address of node.

xpNetAddr

ZigBee 16-bit network address of the node.

xpNodeType

ZigBee node type:

Node type Description
0 Coordinator
1 Router
2 Endnode

xpParentAddr

For an endnode (xpNodeType = 2), the network address of the connecting router. For a router (xpNodeType = 1), the value is 0xFFFE.

xpProfileId

ZigBee device profile identifier of the node.

xpMfgId

ZigBee manufacturing identifier of the node.

xpDeviceType

Device type of the node.

  • Product type: Low order 16 bits.
  • Module type: High order 16 bits.

Text descriptions for product and module types are returned by xmtModuleTypeDesc and xptProductTypeDesc.

xpNodeId

ZigBee node identifier.

xpDiscoveryIndex

Index within the list of nodes discovered on the home area network (HAN).

xmtModuleTypeDesc

Text description of the module type defined in xpDeviceType.

xptProductTypeDesc

Text description of the product type defined in xpDeviceType.

xpStatus

For Smart Energy nodes only. Connection status of the node: 0 for disconnected or 1 for connected.

xpUpdateTime

Time the node was last discovered.

xpUserMetaData

User-defined free-form text associated with a specified node.

Parameters

Use the following parameters to determine the data to be retrieved by a GET operation.

Parameter Description
cache Boolean value that indicates whether to use the cached node list.true: Return the cached list of discovered nodes.false: Return the current list of discovered nodes.
clear Boolean value that specifies whether to clear the current node list.true: Clear the current node list and discover/refresh the list.false: Use the current node information.