Settings commands


hub.device.settings.list

Connection type: UI

Permissions: EZLO: READ/VIEW

Provides a list of registered device settings on the hub.

request:

{
    "method": "hub.device.settings.list",
    "id": "_ID_",
    "params": {}
}

request with filter by deviceId:

{
   "method":"hub.device.settings.list",
   "id":"_ID_",
   "params": {
      "deviceIds": [
         "5cef9bf17f00007937ab8015",
         "5cef9bf17f00007937ab8016"
      ]
   }
}
Field Type Required Description
deviceIds (optional) string[] - Device ID array to filter device settings list with.

response:

Fields Type Required Description
_id string + an id of the setting
deviceId string + an id of a device the setting is registered for
label text + name
description text + description
info object - implementation details
status string + synchronization status (synced, pending or failed)
valueType string + setting type
value int : action : bool : string : rgb : scalable : dictionary.zwave_device_configuration +
valueDefault -
valueMin int : scalable - minimal value for int and scalable setting types
valueMax int : scalable - maximal value for int and scalable setting types
enum dictionary.text -
elementsMaxNumber int - maximum list or dictionary

info field

Fields Type Required Description
zwave.parameter_number int + corresponding parameter number
zwave.parameter_size int + size of the corresponding parameter's value

hub.device.setting.value.set

Connection type: UI

Permissions: EZLO: WRITE/EDIT

Sets value of the specified setting

request:

{
    "method": "hub.device.setting.value.set",
    "id": "_ID_",
    "params": {
        "_id": "5ef177ff7f0000258f9f8c33",
        "value": 4
    }
}
Field Type Required Description
_id string + Setting Id
value - Value to be set for the setting (may be omitted for action settings)

hub.device.setting.dictionary.value.set

Connection type: UI

Permissions: EZLO: WRITE/EDIT

Sets new value for element/adds a new element/removes an element in the dictionary

request:

{
    "method": "hub.device.setting.dictionary.value.set",
    "id": "_ID_",
    "params": {
        "_id": "5ef177ff7f0000258f9f8c33",
        "key": "abc",
        "value": {
            "name": "Parameter 1",
            "description": "Parameter 1",
            "format": "dec",
            "number": 1,
            "size": 1,
            "value": 1
        }
    }
}
Field Type Required Description
_id string + Setting Id
key string + unique id (16 symbols max)
value object - Value to be set for the setting. If null, removes the element

value field

Fields Type Required Description
name string + name of the configuration parameter
description string + description of the configuration parameter
format string + value format (dec or hex)
number int + parameter number
size int + size of the value in bytes (1, 2 or 4)
value int + size of the corresponding parameter's value

hub.device.setting.reset

Connection type: UI

Permissions: EZLO: WRITE/EDIT

Resets the value of settings to the default one.

request:

{
    "method": "hub.device.setting.reset",
    "id": "_ID_",
    "params": {
        "_id": "5ef177ff7f0000258f9f8c33"
    }
}

request with filter by deviceId:

{
   "method":"hub.device.setting.reset",
   "id":"_ID_",
   "params":{
      "deviceId": "5cef9bf17f00007937ab8015"
   }
}
Field Type Required Description
_id string - Setting Id
deviceId string - Device Id. If specified, all settings of this device will be reset