Gateways commands
hub.gateways.list
Connection type: UI
Permissions: EZLO: READ/VIEW
Provides a list of registered gateways on the hub.
request:
no params
response:
Field | Type | Required | Description |
---|---|---|---|
_id | string | + | an id of the gateway |
label | string | + | a public name of the gateway |
name | string | + | a name specified within a plugin's config which provides this gateway |
pluginId | string | + | an id (name, not a db's id) of a plugin this gateway is a part of |
reason | string | + | a public reason of not 'ready' status |
ready (Deprecated) | bool | + | whether gateway is ready for work |
status | string | + | gateway initialization status |
unreachableActions | object | - | |
unreachableReasons | object | - | |
operations | object | + | a gateway external API |
settings | object | + | a section with custom setting templates for the gateway |
setItemValueCommand | string | + | DO WE NEED TO EXPOSE SUCH INFO TO THE UI??? |
Possible "status" field values |
---|
not_started |
starting |
ready |
Examples
request:
{
"method": "hub.gateways.list",
"id": "_ID_",
"params": {}
}
response:
{
"api": "1.0",
"error": null,
"id": "_ID_",
"result": {
"gateways": [
{
"_id": "588b7eb528b12d03be86f36f",
"label": "ZWave",
"name": "zwave",
"pluginId": "zwave",
"ready": true,
"status": "ready",
}
]
}
}