mirrors
/
Tasmota
mirror of https://github.com/arendst/Tasmota.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated Zigbee Sandbox (markdown)

s-hadinger 2019-11-07 21:12:18 +01:00
parent ce9a2b9994
commit b184f31d63
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Zigbee-Sandbox.md

@ -6,5 +6,9 @@ Sandbox for wiki commands
ZigbeePermitJoin<a id="ZigbeePermitJoin"></a>|Enables or disables pairing of new devices, see below.<BR><BR>`ZigbeePermitjoin 1` enables pairing for 60 seconds<BR>`ZigbeePermitJoin 99` enables pairing until next boot<BR>`ZigbeePermitJoin 0` disables pairing<BR><BR>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":"<shortaddr>", "Endpoint":"<endpoint>", "Send":{"<sendcmd>":<sendparam>} }`<BR><BR>`<shortaddr>` the short address of the Zigbee device on the network.<BR>`<endpoint>` the target endpoint on the device (see below how to know the correct endpoint)<BR>`"<sendcmd>":<sendparam>` the actual command and parameters to send (see below)<BR><BR>Ex:<BR>`ZigbeeSend { "Device":"0x1234", "Endpoint":"0x03", "Send":{"Power":"on"} }`<BR><BR>Note: there is a low-level variant of `ZigbeeSend` if you need to send a specific or unsupported message, see below.
ZigbeeReset<a id="ZigbeeReset"></a>|Does a factory reset and reconfiguration of the CC2530. Warning: you will need to re-pair all Zigbee devices<BR><BR>Ex: `ZigbeeReset 1`
ZigbeeStatus<a id="ZigbeeStatus"></a>|Shows data collected from connected Zigbee devices, see examples below.<BR><BR>`ZigbeeStatus` shows the list of all Zigbee devices seen on the network until last boot, with their short address and friendly name.<BR>`ZigbeeStatus 1` adds Manufacturer ID and Model ID of each devices<BR>`ZigbeeStatus 2` adds list of endpoints of each device and the clusterIds supported in each endpoint.<BR>Ex: ```{"ZigbeeStatus":{"Status":1,"Message":"CC2530 booted","RestartReason":"Watchdog","MajorRel":2,"MinorRel":6}}```<BR><li>`Status` contains a numeric code about the status message<ul><li>`0`: initialization complete, **Z2T is running normally**</li><li>`1`: booting</li><li>`2`: resetting CC2530 configuration</li><li>`3`: starting Zigbee coordinator</li><li>`20`: disabling Permit Join</li><li>`21`: allowing Permit Join for 60 seconds</li><li>`22`: allowing Permit Join until next boot</li><li>`30`: Zigbee device connects or reconnects</li><li>`31`: Received Node Descriptor information for a Zigbee device</li><li>`32`: Received the list of active endpoints for a Zigbee device</li><li>`33`: Received the simple Descriptor with active ZCL clusters for a Zigbee device</li><li>`50`: reporting CC2530 firmware version</li><li>`51`: reporting CC2530 device information and associated devices</li><li>`98`: error, unsupported CC2530 firmware</li><li>`99`: general error, **Z2T was unable to start**</li></ul></li><li>`Message` (optional) a human-readable message</li><li>other fields depending on the message (e.g., Status=`50` or Status=`51`)</li>
ZigbeeStatus<a id="ZigbeeStatus"></a>|Shows data collected from connected Zigbee devices, see examples below.<BR><BR>`ZigbeeStatus` shows the list of all Zigbee devices seen on the network until last boot, with their short address and friendly name.<BR>`ZigbeeStatus 1` adds Manufacturer ID and Model ID of each devices<BR>`ZigbeeStatus 2` adds list of endpoints of each device and the clusterIds supported in each endpoint.<BR>
ZigbeeZCLSend<a id="ZigbeeZCLSend"></a>|**Do not use unless you know exactly what you are doing.**<BR>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}}```<BR><li>`Status` contains a numeric code about the status message<ul><li>`0`: initialization complete, **Z2T is running normally**</li><li>`1`: booting</li><li>`2`: resetting CC2530 configuration</li><li>`3`: starting Zigbee coordinator</li><li>`20`: disabling Permit Join</li><li>`21`: allowing Permit Join for 60 seconds</li><li>`22`: allowing Permit Join until next boot</li><li>`30`: Zigbee device connects or reconnects</li><li>`31`: Received Node Descriptor information for a Zigbee device</li><li>`32`: Received the list of active endpoints for a Zigbee device</li><li>`33`: Received the simple Descriptor with active ZCL clusters for a Zigbee device</li><li>`50`: reporting CC2530 firmware version</li><li>`51`: reporting CC2530 device information and associated devices</li><li>`98`: error, unsupported CC2530 firmware</li><li>`99`: general error, **Z2T was unable to start**</li></ul></li><li>`Message` (optional) a human-readable message</li><li>other fields depending on the message (e.g., Status=`50` or Status=`51`)</li>