From b184f31d6345b5b07376264710bb0d41e2c1a58e Mon Sep 17 00:00:00 2001 From: s-hadinger <49731213+s-hadinger@users.noreply.github.com> Date: Thu, 7 Nov 2019 21:12:18 +0100 Subject: [PATCH] Updated Zigbee Sandbox (markdown) --- Zigbee-Sandbox.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/Zigbee-Sandbox.md b/Zigbee-Sandbox.md index 867d4fee..dfeec790 100644 --- a/Zigbee-Sandbox.md +++ b/Zigbee-Sandbox.md @@ -6,5 +6,9 @@ Sandbox for wiki commands ZigbeePermitJoin|Enables or disables pairing of new devices, see below.

`ZigbeePermitjoin 1` enables pairing for 60 seconds
`ZigbeePermitJoin 99` enables pairing until next boot
`ZigbeePermitJoin 0` disables pairing

Keep in mind that leaving your Zigbee network open to PermitJoin will allow any Zigbee device to connect, and retrieve your network encryption key, potentially leading to a compromise of your Zigbee network. ZigbeeSend|`ZigbeeSend { "Device":"", "Endpoint":"", "Send":{"":} }`

`` the short address of the Zigbee device on the network.
`` the target endpoint on the device (see below how to know the correct endpoint)
`"":` the actual command and parameters to send (see below)

Ex:
`ZigbeeSend { "Device":"0x1234", "Endpoint":"0x03", "Send":{"Power":"on"} }`

Note: there is a low-level variant of `ZigbeeSend` if you need to send a specific or unsupported message, see below. ZigbeeReset|Does a factory reset and reconfiguration of the CC2530. Warning: you will need to re-pair all Zigbee devices

Ex: `ZigbeeReset 1` -ZigbeeStatus|Shows data collected from connected Zigbee devices, see examples below.

`ZigbeeStatus` shows the list of all Zigbee devices seen on the network until last boot, with their short address and friendly name.
`ZigbeeStatus 1` adds Manufacturer ID and Model ID of each devices
`ZigbeeStatus 2` adds list of endpoints of each device and the clusterIds supported in each endpoint.
Ex: ```{"ZigbeeStatus":{"Status":1,"Message":"CC2530 booted","RestartReason":"Watchdog","MajorRel":2,"MinorRel":6}}```
  • `Status` contains a numeric code about the status message
    • `0`: initialization complete, **Z2T is running normally**
    • `1`: booting
    • `2`: resetting CC2530 configuration
    • `3`: starting Zigbee coordinator
    • `20`: disabling Permit Join
    • `21`: allowing Permit Join for 60 seconds
    • `22`: allowing Permit Join until next boot
    • `30`: Zigbee device connects or reconnects
    • `31`: Received Node Descriptor information for a Zigbee device
    • `32`: Received the list of active endpoints for a Zigbee device
    • `33`: Received the simple Descriptor with active ZCL clusters for a Zigbee device
    • `50`: reporting CC2530 firmware version
    • `51`: reporting CC2530 device information and associated devices
    • `98`: error, unsupported CC2530 firmware
    • `99`: general error, **Z2T was unable to start**
  • `Message` (optional) a human-readable message
  • other fields depending on the message (e.g., Status=`50` or Status=`51`)
    • +ZigbeeStatus|Shows data collected from connected Zigbee devices, see examples below.

    `ZigbeeStatus` shows the list of all Zigbee devices seen on the network until last boot, with their short address and friendly name.
    `ZigbeeStatus 1` adds Manufacturer ID and Model ID of each devices
    `ZigbeeStatus 2` adds list of endpoints of each device and the clusterIds supported in each endpoint.
    ZigbeeZCLSend|**Do not use unless you know exactly what you are doing.**
    Send a raw ZCL message to a Zigbee device. This is a low-level command, and requires to manually build the ZCL parameters. Most common usage will be provided as high-level functions. + +#### ZigbeeStatus + +Ex: ```{"ZigbeeStatus":{"Status":1,"Message":"CC2530 booted","RestartReason":"Watchdog","MajorRel":2,"MinorRel":6}}```
  • `Status` contains a numeric code about the status message
    • `0`: initialization complete, **Z2T is running normally**
    • `1`: booting
    • `2`: resetting CC2530 configuration
    • `3`: starting Zigbee coordinator
    • `20`: disabling Permit Join
    • `21`: allowing Permit Join for 60 seconds
    • `22`: allowing Permit Join until next boot
    • `30`: Zigbee device connects or reconnects
    • `31`: Received Node Descriptor information for a Zigbee device
    • `32`: Received the list of active endpoints for a Zigbee device
    • `33`: Received the simple Descriptor with active ZCL clusters for a Zigbee device
    • `50`: reporting CC2530 firmware version
    • `51`: reporting CC2530 device information and associated devices
    • `98`: error, unsupported CC2530 firmware
    • `99`: general error, **Z2T was unable to start**
  • `Message` (optional) a human-readable message
  • other fields depending on the message (e.g., Status=`50` or Status=`51`)
    • \ No newline at end of file