|  Developer
Updated on November 20, 2021

hub.devices.list

Connection type:
Permissions:

  • Provides a list of registered devices on the hub.
  • Note: this request doesn’t take a gateway id, so it returns devices for ALL gateways.
Edit
Edit
Field Type Required Description
_id
string
+
An id of the device
parentDeviceId
string
+
An id of the parent device. Empty in case of main device
category
string
+
A device category
subcategory
string
+
A device subcategory
deviceTypeId
string
+
A device type id, generated from manufacturer info
gatewayId
string
+
An id of a gateway this device belongs to
name
string
+
A device name
type
string
+
batteryPowered
string
+
Is device battery powered
reachable
string
+
Is device reachable
armed
bool
-
is device armed by house mode
roomId
string
+
An id of a room this device is assigned to
persistent
string
-
Is device persistent. Persistent device can't be removed by force removing. False by default.
info
object
-
Some additional information for this device
firmware
object
-
Versions of each firmware of this device.
serviceNotification
bool
+
Special mark for forwarding all changes with this device and items to different Cloud services. Default value: false.
security
string
+
Security level how the device is connected. Possible options: , , , .
ready
bool
+
Ready status of device. value means device is ready to any changes. value means device is busy.
status
string
+
Edit

Get information about registered devices on the hub.

Edit
				
					{
    "method": "hub.devices.list",
    "id": "_ID_",
    "params": {}
}				
			
Edit
				
					{
    "api": "1.0",
    "error": null,
    "id": "<request_id>",
    "result": {
        "devices": [
            {
                "_id": "5cf0dc8c7f000068d223e889",
                "batteryPowered": false,
                "category": "switch",
                "deviceTypeId": "634_257_10",
                "gatewayId": "5ca480227f00004c03de3f1f",
                "info": {
                    "manufacturer": "Remotec",
                    "model": "ZTS-500",
                    "protocol": "zwave",
                    "firmware.stack": "4.24",
                    "hardware": "2"
                },
                "firmware": [
                    {
                        "id": "us.634.33136.0",
                        "version": "1.12"
                    },
                    {
                        "id": "us.634.33136.1",
                        "version": "1.16"
                    }
                ],
                "name": "Smart Plug",
                "parentDeviceId": "",
                "reachable": true,
                "armed": false,
                "serviceNotification": false,
                "roomId": "",
                "subcategory": "interior_plugin",
                "type": "device",
                "security": "no",
                "status": "idle"
            }
        ]
    }
}