Zigbee Plugin Scripts


scripts/start_include

Start including Zigbee device process( joining device into Zigbee network )

request:

no params

response:

empty result

Broadcast Description
include_device Include process status changed

Example

request:

{
    "method": "hub.extensions.plugin.run",
    "id": "_ID_",
    "params": {
        "script": "HUB:zigbee/scripts/start_include"
    }
}

response:

{
    "error": null,
    "id": "_ID_",
    "result": {}
}

scripts/stop_include

Stop including Zigbee device process( adding device in Zigbee network )

request:

no params

response:

empty result

Broadcast Description
include_device Include process status changed

Example

request:

{
    "method": "hub.extensions.plugin.run",
    "id": "_ID_",
    "params": {
        "script": "HUB:zigbee/scripts/stop_include"
    }
}

response:

{
    "error": null,
    "id": "_ID_",
    "result": {}
}

scripts/reset

Resets current Zigbee network and starts new one. Zigbee network parameters, information reseted. All Zigbee gateway specific data wiped out

request:

no params

response:

empty result

Broadcast Description
module_reset Module reset status changed

Example

request:

{
    "method": "hub.extensions.plugin.run",
    "id": "_ID_",
    "params": {
        "script": "HUB:zigbee/scripts/reset"
    }
}

response:

{
    "error": null,
    "id": "_ID_",
    "method": "hub.extensions.plugin.run",
    "result": {},
    "sender": {
        "conn_id": "635c4514-f764-49d7-a1b4-5c5b7b35c745",
        "type": "ui"
    }
}

scripts/device_remove

Remove Zigbee device

request:

Field Type Required Description
deviceId string + device ID to remove

response:

empty result

Example

request:

{
    "method": "hub.extensions.plugin.run",
    "id": "_ID_",
    "params": {
        "script": "HUB:zigbee/scripts/device_remove"
        "scriptParams": {
            "deviceId": "<DEVICE_ID>"
        }
    }
}

response:

{
    "error": null,
    "id": "_ID_",
    "method": "hub.extensions.plugin.run",
    "result": {},
    "sender": {
        "conn_id": "635c4514-f764-49d7-a1b4-5c5b7b35c745",
        "type": "ui"
    }
}