2GIG Plugin Scripts


scripts/add_device

Add 2GIG device

request:

Field Type Required Description
serial int + Device serial number (7-digit TXID)
model string - Device model (case insensitive). List of supported devices
device_type string - Device type

response:

empty result

Broadcast Description
add_device Device added or not added

Example

request:

{
    "method": "hub.extensions.plugin.run",
    "id": "_ID_",
    "params": {
        "script": "HUB:2gig/scripts/add_device",
        "scriptParams": {
            "model": "2GIG-PANIC1-345",
            "serial": 571480
        }
    }
}

response:

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

scripts/start_device_discovering

Start listening for transmissions from devices not currently added. Note that transmissions from already added devices are still handled during this time.

request:

no params

response:

empty result

Broadcast Description
new_device_discovered New device discovered
device_discovering Operation status updated

Example

request:

{
    "method": "hub.extensions.plugin.run",
    "id": "_ID_",
    "params": {
        "script": "HUB:2gig/scripts/start_device_discovering"
    }
}

response:

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

scripts/stop_device_discovering

Stop listening for transmissions from devices not currently added.

request:

no params

response:

empty result

Broadcast Description
device_discovering Operation status updated

Example

request:

{
    "method": "hub.extensions.plugin.run",
    "id": "_ID_",
    "params": {
        "script": "HUB:2gig/scripts/stop_device_discovering"
    }
}

response:

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

scripts/reset

Remove all 2GIG devices and clear all 2GIG gateway specific data.

request:

no params

response:

empty result

Example

request:

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

response:

{
    "error": null,
    "id": "_ID_",
    "method": "hub.extensions.plugin.run",
    "result": {},
    "sender": {
        "conn_id": "41ef658f-e2ab-43a1-b981-d6a11fd1c06e",
        "type": "ui"
    }
}