Plugin Commands: Test Harness

Zigbee Application Framework Command Line Interface (CLI)

plugin test-harness add-child [ShortId:2] [EUI:-1] [nodeType:1]

• Adds a child to the child table.
  • ShortId - INT16U - The shortId of the child device.
  • EUI - OCTET_STRING - The EUI64 of the child (big endian).
  • nodeType - INT8U - The node type of the child device.

plugin test-harness aps-sec-for-cluster off

• Turns off automatic APS security for the previously specified cluster.

plugin test-harness aps-sec-for-cluster on [clusterId:2]

• Turns on automatic APS security for the specified cluster.
  • clusterId - INT16U - The cluster ID to add APS security to automatically.

plugin test-harness attr options [type:1] [timeout:2]

• Set the options for the attributes tests.
  • type - INT8U
  • timeout - INT16U

plugin test-harness attr set-dest [addr:2] [endpoint:1]

• Set the destination for the attributes tests.
  • addr - INT16U
  • endpoint - INT8U

plugin test-harness attr start-test [clusterId:2] [attrStartId:2] [attrEndId:2] [clientToServer:1]

• Start the attributes test.
  • clusterId - INT16U
  • attrStartId - INT16U
  • attrEndId - INT16U
  • clientToServer - BOOLEAN

plugin test-harness concentrator start

• Starts the concentrator's periodic broadcasts.

plugin test-harness concentrator stop

• Starts the concentrator's periodic broadcasts.

plugin test-harness endpoint cluster-endpoint-index [endpoint:1] [clusterId:2] [mask:1]

• Get cluster endpoint index
  • endpoint - INT8U - The local endpoint of the cluster.
  • clusterId - INT16U - The cluster whose index is needed.
  • mask - INT8U - 0 for client-side attributes or 1 for server-side attributes.

plugin test-harness endpoint disable [endpoint:1]

• Disables the endpont to receive messages and be discovered
  • endpoint - INT8U - The endpoint number.

plugin test-harness endpoint enable [endpoint:1]

• Enables the endpont to receive messages and be discovered
  • endpoint - INT8U - The endpoint number.

plugin test-harness endpoint status

• Disables the endpont to receive messages and be discovered

plugin test-harness hash-the-flash

• Runs the AES-CCM algorithm over the contents of the software image to calcalute the image stamp.

plugin test-harness key-establishment adv-aps-fc

• Advances the local device's outgoing APS FC by 4096.

plugin test-harness key-establishment cert-mangle change-byte [byteIndex:1] [byteValue:1]

• Changes a single byte in the cert
  • byteIndex - INT8U - The index of the certificate byte to change
  • byteValue - INT8U - The new value of the certificate byte

plugin test-harness key-establishment cert-mangle corrupt [corruptionIndex:1]

• Corrupts a single byte in the cert
  • corruptionIndex - INT8U - The index of the certificate byte to corrupt

plugin test-harness key-establishment cert-mangle issuer [issuer:-1]

• Changes the issuer in the certificate.
  • issuer - OCTET_STRING - The EUI64 of the issuer (big endian).

plugin test-harness key-establishment cert-mangle length [lengthModifier:1]

• Mangles the length of the certificate
  • lengthModifier - INT8S - The positive or negative change in length.

plugin test-harness key-establishment cert-mangle subject [subject:-1]

• Changes the subject (EUI64) of the cert
  • subject - OCTET_STRING - The EUI64 of the subject (big endian).

plugin test-harness key-establishment default-resp

• Sends a default response error message in response to initate KE.

plugin test-harness key-establishment delay-cbke [actualDelay:2] [advertisedDelay:2]

• Changes the advertised delays by the local device for CBKE.
  • actualDelay - INT16U - Set the actual delay that occurs.
  • advertisedDelay - INT16U - Sets the advertised delay sent to the partner of key establishment

plugin test-harness key-establishment key-mangle [lengthModifier:1]

• Mangles the length of the empheral key.
  • lengthModifier - INT8S - The positive or negative change in length.

plugin test-harness key-establishment new-key-policy [allowKeyEstablishmentPolicy:1]

• Sets the policy of whether the TC allows new KE requests.
  • allowKeyEstablishmentPolicy - INT8U - Allows / disallows new key establishment requests.

plugin test-harness key-establishment no-resources

• All received KE requests will be responded with 'no resources'.

plugin test-harness key-establishment normal-mode

• Sets the key establishment mode to normal.

plugin test-harness key-establishment out-of-sequence [commandId:1]

• All received KE requests will be responded with 'no resources'.
  • commandId - INT8U - The out-of-sequence command ID to send.

plugin test-harness key-establishment reset-aps-fc

• Forces the local device to reset its outgoing APS FC.

plugin test-harness key-establishment set-available-suite [suite:2]

• Selects between the CBKE 163k1 and 283k1 suites.
  • suite - INT16U - This field holds the type of key establishment suite. It can be EMBER_AF_CBKE_KEY_ESTABLISHMENT_SUITE_163K1, EMBER_AF_CBKE_KEY_ESTABLISHMENT_SUITE_283K1, or EMBER_AF_INVALID_KEY_ESTABLISHMENT_SUITE

plugin test-harness key-establishment suite [suite:2]

• Selects between the CBKE 163k1 and 283k1 suites.
  • suite - INT16U - This field holds the type of key establishment suite. It can be EMBER_AF_CBKE_KEY_ESTABLISHMENT_SUITE_163K1, EMBER_AF_CBKE_KEY_ESTABLISHMENT_SUITE_283K1, or EMBER_AF_INVALID_KEY_ESTABLISHMENT_SUITE

plugin test-harness key-establishment timeout

• Artificially creates a timeout by delaying an outgoing message.

plugin test-harness key-update broadcast

• Changes TC NWK key update mechanism to broadcast.

plugin test-harness key-update now

• Starts a TC NWK key update now

plugin test-harness key-update unicast

• Changes TC NWK key update mechanism to unicast with APS security.

plugin test-harness ota image-mangle [index:2]

• Mangles the Simple Storage RAM OTA image.
  • index - INT16U - The byte index into the OTA image that will be mangled.

plugin test-harness price send-new-fields [sendNewFields:1]

• Controls whether the new SE 1.1 price fields are included.
  • sendNewFields - INT8U - Boolean indicating whether to send new fields.

plugin test-harness price send-se10-fields [sendNewFields:1]

• Controls whether the new SE 1.1 price fields are included.
  • sendNewFields - INT8U - Boolean indicating whether to send new fields.

plugin test-harness radio off

• Turns off the radio so that no messages are sent.

plugin test-harness radio on

• Turns on the radio if it was previously turned off

plugin test-harness registration off

• Turns off automatic SE registration.

plugin test-harness registration on

• Turns on automatic SE registration.

plugin test-harness set-compliance-revision [version:1]

• Setting a compliance revision for a device such that the device can act as pre-R21 or R21+ for testing purposes. The reason for doing this is because the end device may send a node descriptor request and the hub will respond with the node descriptor response which will include the hub's compliance revision. If the compliance revision of the hub is R21+, only then will the TC link key request be made by the end device.
  • version - INT8U - The compliance version

plugin test-harness set-max-children [version:1]

• Sets the maximum children supported by the local node.
  • version - INT8U - The maximum number of children to support

plugin test-harness set-radio-power [power:1]

• Sets the radio power.
  • power - INT8U - The radio power to set.

plugin test-harness stack limit-beacons off

• Disables a limit to the max number of outgoing beacons.

plugin test-harness stack limit-beacons on

• Enables a limit to the max number of outgoing beacons.

plugin test-harness status

• Display the current status of the test harness.

plugin test-harness tc-keepalive send

• Sends a Trust Center Keepalive.

plugin test-harness tc-keepalive start

• Starts the TC keepalive state machine.

plugin test-harness tc-keepalive stop

• Stops the TC keepalive state machine.