Plugin Commands: ZigBee 3.0 Test Harness

Zigbee Application Framework Command Line Interface (CLI)

plugin test-harness packet-printing aps-printing disable

• Disable the printing of APS commands.

plugin test-harness packet-printing aps-printing enable

• Enable the printing of APS commands.

plugin test-harness packet-printing beacon-printing disable

• Disable the printing of beacon requests and received beacons.

plugin test-harness packet-printing beacon-printing enable

• Enable the printing of beacon requests and received beacons.

plugin test-harness packet-printing nwk-printing disable

• Disable the printing of network commands.

plugin test-harness packet-printing nwk-printing enable

• Enable the printing of network commands.

plugin test-harness packet-printing raw-printing disable

• Disable the printing of raw MAC commands.

plugin test-harness packet-printing raw-printing enable

• Enable the printing of raw MAC commands.

plugin test-harness packet-printing zdo-printing disable

• Disable the printing of ZDO commands.

plugin test-harness packet-printing zdo-printing enable

• Enable the printing of ZDO commands.

plugin test-harness z3 aps aps-remove-device [parentLongAddress:-1] [destinationLongAddress:-1] [options:4]

• Send an APS remove device command.
  • parentLongAddress - OCTET_STRING - The long address of the parent whose child will be removed.
  • destinationLongAddress - OCTET_STRING - The long address of the node which will be removed.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 aps aps-remove-device-config [options:4]

• Configures the APS remove device command handling.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 aps aps-request-key [destination:2] [keyType:1] [partnerAddress:-1] [options:4]

• Send an APS request key command.
  • destination - INT16U - The short address destination of the command.
  • keyType - INT8U - The key type in the command payload.
  • partnerAddress - OCTET_STRING - The partner address for the requested link key.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 beacon beacon-req

• Send a beacon request.

plugin test-harness z3 beacon beacons-config [options:4]

• Send a beacon.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 install-code clear

• Clear the install code from the device.

plugin test-harness z3 install-code set [installCode:-1]

• Clear the install code from the device.
  • installCode - OCTET_STRING - The install code for this device to use.

plugin test-harness z3 legacy-profile disable

• Disable using the legacy profile of 0xC05E for ZLL commands.

plugin test-harness z3 legacy-profile enable

• Enable using the legacy profile of 0xC05E for ZLL commands.

plugin test-harness z3 mgmt leave [destination:2] [removeChildren:1] [rejoin:1] [options:4]

• Unicast a permit joining command.
  • destination - INT16U - The destination address of the command.
  • removeChildren - BOOLEAN - Whether or not the leaving device should remove its children.
  • rejoin - BOOLEAN - Whether or not the destination node should rejoin the network.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 mgmt nwk-update-request [scanChannel:2] [scanDuration:2] [scanCount:1] [destination:2] [options:4]

• Unicast a network update command.
  • scanChannel - INT16U - The scan channel for the command.
  • scanDuration - INT16U - The scan duration for the command.
  • scanCount - INT8U - The scan count for the command.
  • destination - INT16U - The scan destination.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 mgmt permit-joining-req [permitDurationS:2] [destination:2] [options:4]

• Unicast a permit joining command.
  • permitDurationS - INT16U - The permit duration, in seconds.
  • destination - INT16U - The destination address of the command.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 nwk get-network-update-id

• Get the current network update id.

plugin test-harness z3 nwk ieee-addr-rsp-config issuer-nwk-address-remote-dev

• Configure the next outgoing IEEE address request.

plugin test-harness z3 nwk ieee-addr-rsp-config reset

• Configure the next outgoing IEEE address request.

plugin test-harness z3 nwk ieee-addr-rsp-config status-device-not-found

• Configure the next outgoing IEEE address request.

plugin test-harness z3 nwk nwk-key-supression off

• Do not supress network leave commands.

plugin test-harness z3 nwk nwk-key-supression on

• Supress network leave commands.

plugin test-harness z3 nwk nwk-leave [rejoin:1] [request:1] [removeChildren:1] [destination:2] [options:4]

• Send a Network Leave command.
  • rejoin - BOOLEAN - Whether or not the device should rejoin.
  • request - BOOLEAN - Whether or not this command is a request.
  • removeChildren - BOOLEAN - Whether or not the leaving device should remove its children.
  • destination - INT16U - The destination address of the command.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 nwk nwk-leave-supression off

• Do not supress network leave commands.

plugin test-harness z3 nwk nwk-leave-supression on

• Supress network leave commands.

plugin test-harness z3 nwk nwk-rejoin-request [destination:2]

• Send a Rejoin Request command.
  • destination - INT16U - The destination address of the command.

plugin test-harness z3 nwk nwk-rejoin-response [newAddress:2] [status:1] [destination:2]

• Send a Rejoin Response command.
  • newAddress - INT16U - The new short address of the destination node.
  • status - INT8U - The status of the rejoin.
  • destination - INT16U - The destination address of the command.

plugin test-harness z3 nwk set-network-update-id [updateId:1]

• Set the network update id in the current network parameters block.
  • updateId - INT8U - The new network update id.

plugin test-harness z3 ota-server activate [shortAddress:2] [destinationEndpoint:1] [manufacturerCode:2] [imageType:2] [fileVersion:4] [fileSize:4]

• Configuration command to set up OTA server.
  • shortAddress - INT16U - Short Address
  • destinationEndpoint - INT8U - Destination Endpoint
  • manufacturerCode - INT16U - Manufacturer Code.
  • imageType - INT16U - Image Type.
  • fileVersion - INT32U - File Version
  • fileSize - INT32U - File Size

plugin test-harness z3 ota-server deactivate

• Configuration command to set up OTA server.

plugin test-harness z3 platform

• Print the platform information for this device.

plugin test-harness z3 reset

• Resets the device to a factory new state (empty tables, attributes at default values, no events queued etc) without resetting the any of the physical hardware that could cause the device to not operate on the same serial connection.

plugin test-harness z3 set-device-mode [mode:1]

• Set the node ID to be used on the device.
  • mode - INT8U - The device mode.

plugin test-harness z3 set-pan-id [panId:2]

• Set the PAN ID to be used by the Network Creator plugin.
  • panId - INT16U - The PAN ID for the Network Creator plugin to use.

plugin test-harness z3 set-short-address [nodeId:2]

• Set the node ID to be used on the device.
  • nodeId - INT16U - The node ID to use as this device's short ID.

plugin test-harness z3 touchlink device-information-request [startIndex:1] [options:4]

• Send an device information request to the target found in the scan request process.
  • startIndex - INT8U - The start index in the device information request command
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 touchlink device-information-request-w-target [startIndex:1] [shortAddress:2] [options:4]

• Send an device information request to the target specefied with the short address in the command.
  • startIndex - INT8U - The start index in the device information request command
  • shortAddress - INT16U - The short address of the target
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 touchlink device-information-response-config [options:4]

• Configure the next device information response.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 touchlink get-endpoint-list-request [startIndex:1]

• Send a get endpoint list request.
  • startIndex - INT8U - The start index in the command payload.

plugin test-harness z3 touchlink get-group-identifiers-request [startIndex:1]

• Send a get group identifiers request.
  • startIndex - INT8U - The start index in the command payload.

plugin test-harness z3 touchlink identify-request [duration:2] [options:4]

• Send an identify request to the target found in the scan request process.
  • duration - INT16U - The duration length of the identify state.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 touchlink is-scanning

• Print out whether or not the device is currently performing the scan process for touchlinking.

plugin test-harness z3 touchlink network-join-end-device-request [networkAddress:2] [freeAddrBegin:2] [freeAddrEnd:2] [freeGroupBegin:2] [freeGroupEnd:2] [options:4]

• Send a network end device join request to the target found in the scan request process.
  • networkAddress - INT16U - The designated node ID for the target node.
  • freeAddrBegin - INT16U - The free address range begin.
  • freeAddrEnd - INT16U - The free address range end.
  • freeGroupBegin - INT16U - The free group range begin.
  • freeGroupEnd - INT16U - The free group range end.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 touchlink network-join-router-request [networkAddress:2] [freeAddrBegin:2] [freeAddrEnd:2] [freeGroupBegin:2] [freeGroupEnd:2] [options:4]

• Send a network router join request to the target found in the scan request process.
  • networkAddress - INT16U - The designated node ID for the target node.
  • freeAddrBegin - INT16U - The free address range begin.
  • freeAddrEnd - INT16U - The free address range end.
  • freeGroupBegin - INT16U - The free group range begin.
  • freeGroupEnd - INT16U - The free group range end.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 touchlink network-join-router-response-config [options:4]

• Configure the next outgoing network join router response command.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 touchlink network-start-request [networkAddress:2] [freeAddrBegin:2] [freeAddrEnd:2] [freeGroupBegin:2] [freeGroupEnd:2] [options:4]

• Send a network start request to the target found in the scan request process.
  • networkAddress - INT16U - The designated node ID for the target node.
  • freeAddrBegin - INT16U - The free address range begin.
  • freeAddrEnd - INT16U - The free address range end.
  • freeGroupBegin - INT16U - The free group range begin.
  • freeGroupEnd - INT16U - The free group range end.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 touchlink network-start-response-config [options:4]

• Configure the next outgoing network start response command.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 touchlink network-update-request [options:4]

• Send a network update request.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 touchlink reset-to-factory-new-request [options:4]

• Send a reset to factory new request to the target found in the scan request process.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 touchlink scan-request-process [linkInitiator:1] [unused:2] [options:4]

• Start the scan request process.
  • linkInitiator - INT8U - The link initiator bit in scan requests.
  • unused - INT16U - This argument is unsed.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 touchlink scan-response-config [options:4]

• Configure the next scan response.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 touchlink start-as-router [panId:2] [options:4]

• Start a distributed network on which to perform ZLL operations.
  • panId - INT16U - The PAN ID that will be used.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 zcl read [clusterId:2] [attributeId:2] [destination:2] [srcEndpoint:1] [dstEndpoint:1] [profileId:2]

• Send a ZCL ReadAttribute command.
  • clusterId - INT16U - The cluster ID in the command.
  • attributeId - INT16U - The attribute ID in the command.
  • destination - INT16U - The destination of the command.
  • srcEndpoint - INT8U - The source endpoint of the command.
  • dstEndpoint - INT8U - The destination endpoint of the command.
  • profileId - INT16U - The profile ID in the command.

plugin test-harness z3 zdo active-endpoint-request [destination:2] [networkAddressOfInterest:2] [options:4]

• Unicast an active endpoint request.
  • destination - INT16U - The destination address of the command.
  • networkAddressOfInterest - INT16U - The network address of interest.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 zdo bc-device-announce [shortAddress:2] [ieeeAddress:8]

• Rebroadcast a "fake" ZDO device announce. The device sets random frame counter values to appear as though the DeviceAnnounce has been rebroadcasted from another device on the network out of range of the DUT.
  • shortAddress - INT16U - Short address of the fake device announce
  • ieeeAddress - IEEE_ADDRESS - IEEE address of the fake device announce

plugin test-harness z3 zdo bind [destination:2] [source Endpoint:1] [destEndpoint:1] [cluster:2] [remoteEUI64:8] [destEUI64:8]

• Send a ZDO Bind command to a device specified in the command arguments.
  • destination - INT16U - Two byte destination node id
  • source Endpoint - INT8U - Remote device's source endpoint to bind
  • destEndpoint - INT8U - Remote endpoint to bind
  • cluster - INT16U - Cluster on which to bind
  • remoteEUI64 - IEEE_ADDRESS - Remote node EUI64
  • destEUI64 - IEEE_ADDRESS - Binding's dest EUI64. Usually the local node's EUI64

plugin test-harness z3 zdo bind-group [shortAddress:2] [sourceEndpoint:1] [destEndpoint:1] [destination:2] [cluster:2] [srcAddress:8]

• Send a ZDO bind command to a device specified to create a groupcast binding.
  • shortAddress - INT16U - The destination of the ZDO command
  • sourceEndpoint - INT8U - Remote device's source endpoint to bind
  • destEndpoint - INT8U - Remote endpoint to bind
  • destination - INT16U - Two byte destination address for the binding
  • cluster - INT16U - Cluster on which to bind
  • srcAddress - IEEE_ADDRESS - The source IEEE address for the binding

plugin test-harness z3 zdo ieee-addr-req [addrOfInterest:2] [type:1] [startIndex:1] [destination:2] [options:4]

• Send an IEEE address request.
  • addrOfInterest - INT16U - The short address of interest
  • type - INT8U - The request type.
  • startIndex - INT8U - The start index for the requested elements of the associated devices list if the type of this command is Extended response.
  • destination - INT16U - The destination address of the command.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 zdo in-cl-list add [clusterId:2]

• Add clusters to the known server (in) clusters on this device.
  • clusterId - INT16U - Server cluster id

plugin test-harness z3 zdo in-cl-list clear

• Clear the ZDO list of server (in) clusters.

plugin test-harness z3 zdo leave [target:2] [removeChildren:1] [rejoin:1]

• Send a ZDO Management Leave command to the target device.
  • target - INT16U - Target node ID
  • removeChildren - BOOLEAN - Remove children
  • rejoin - BOOLEAN - Rejoin after leave

plugin test-harness z3 zdo match-desc-req [destination:2] [networkAddressOfInterest:2] [profileId:2] [options:4]

• Unicast a match descriptor request.
  • destination - INT16U - The destination address of the command.
  • networkAddressOfInterest - INT16U - The network address of interest.
  • profileId - INT16U - The profile id in the APS header of the command.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 zdo match-desc-rsp-config [networkAddressOfInterest:2] [status:1] [options:4]

• Configure the next outgoing match descriptor response.
  • networkAddressOfInterest - INT16U - The network address of interest.
  • status - INT8U - The status for the response command.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 zdo mgmt-bind [target:2] [startIndex:1]

• Send a ZDO MGMT-Bind (Binding Table) Request to the target device.
  • target - INT16U - Target node ID
  • startIndex - INT8U - Starting index into table query

plugin test-harness z3 zdo mgmt-lqi [target:2] [startIndex:1]

• Send a ZDO MGMT-LQI (LQI Table) Request to the target device.
  • target - INT16U - Target node ID
  • startIndex - INT8U - Starting index into table query

plugin test-harness z3 zdo node [target:2]

• Sends a node descriptor request to a given target device
  • target - INT16U - Two byte address for the target device.

plugin test-harness z3 zdo node-desc-req [destination:2]

• Unicast a node descriptor request.
  • destination - INT16U - The destination address of the command.

plugin test-harness z3 zdo nwk-addr-req [ieeeAddress:8] [type:1] [startIndex:1] [destination:2] [options:4]

• Send a ZDO address request.
  • ieeeAddress - IEEE_ADDRESS - The long address of the destination.
  • type - INT8U - The type of the rejoin request.
  • startIndex - INT8U - The start index for the requested elements of the associated devices list if the type of this command is Extended response.
  • destination - INT16U - The destination address of the command.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 zdo out-cl-list add [clusterId:2]

• Add clusters to the known client (out) clusters on this device.
  • clusterId - INT16U - Client cluster ids

plugin test-harness z3 zdo out-cl-list clear

• Clear the ZDO list of client (out) clusters.

plugin test-harness z3 zdo power [target:2]

• Send a ZDO Power Descriptor Request to the target device.
  • target - INT16U - Target node ID

plugin test-harness z3 zdo route [target:2] [index:1]

• Send a ZDO route request command to the target.
  • target - INT16U - Target node ID
  • index - INT8U - The index of the remote node's routing table to request.

plugin test-harness z3 zdo simple-desc-req [destination:2] [endpoint:1] [networkAddressOfInterest:2] [options:4]

• Unicast a simple descriptor request.
  • destination - INT16U - The destination address of the command.
  • endpoint - INT8U - The endpoint for the simple descriptor request.
  • networkAddressOfInterest - INT16U - The network address of interest.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 zdo simple-desc-rsp-config [networkAddressOfInterest:2] [status:1] [length:1] [options:4]

• Configure the next outgoing simple descriptor response.
  • networkAddressOfInterest - INT16U - The network address of interest.
  • status - INT8U - The status for the response command.
  • length - INT8U - The trimmed length of the command.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 zdo unbind group [target:2] [source eui64:8] [source endpoint:1] [clusterID:2] [groupAddress:2]

• Sends an unbind request for a multicast binding to the target device.
  • target - INT16U - Target node ID
  • source eui64 - IEEE_ADDRESS - The source EUI64 of the binding (the remote device's EUI64)
  • source endpoint - INT8U - The source endpoint of the binding.
  • clusterID - INT16U - The cluster ID to unbind.
  • groupAddress - INT16U - The group address in the binding

plugin test-harness z3 zdo unbind unicast [target:2] [source eui64:8] [source endpoint:1] [clusterID:2] [destinationEUI64:8] [destEndpoint:1]

• Sends an unbind request for a unicast binding to the target device.
  • target - INT16U - Target node ID
  • source eui64 - IEEE_ADDRESS - The source EUI64 of the binding (the remote device's EUI64)
  • source endpoint - INT8U - The source endpoint of the binding.
  • clusterID - INT16U - The cluster ID to unbind.
  • destinationEUI64 - IEEE_ADDRESS - The destination EUI64 in the binding (usually the local node's EUI64
  • destEndpoint - INT8U - The destination endpoint of the binding

plugin test-harness z3 zdo zdo-node-desc-rsp-config [options:4]

• Configure the next outgoing node descriptor response.
  • options - INT32U - The negative behavior options for this command.

plugin test-harness z3 zdo zdo-reset

• Reset any pending negative ZDO behavior.