Objects

Objects shortlist


Item

Item table

fields type description
id string an unique id of item
device_id string an id of a device the item is being registering for
name string a type of the item
value_type string [int : bool : float : string : rgb : scalable : userCode : buttonState : token : dictionary.#subtype : array.#subtype] a type of an item's value
has_getter bool whether the item provides an ability to get a value
has_setter bool whether the item provides an ability to set a value
show bool whether the item should be shown on UI
enum table [opt] set of values for value type 'token'
value int : bool : float : string : rgb : scalable : userCode : buttonState : token : dictionary.#subtype : array.#subtype an item's value
value_min int : float : scalable [opt] lower limit of item's value
value_max int : float : scalable [opt] upper limit of item's value
elements_max_number int [opt] max allowed elements of a dictionary or an array value
elements_max_number_%number% int [opt] max allowed elements of a dictionary or an array subtypes value. %number% must be more 1. E.g. elements_max_number_2 means max size of array if value type is dictionary.array
string_restriction string [opt] Regexp restriction for a value in item of value type string
user_code_restriction string [opt] Regexp restriction for a field code in any value of userCode value type. E.g. it's used in item user_codes.
user_code_modes array of strings [opt] List of available pin code modes. It's used in user_codes item.
elements_max_number_per_array int [opt] max allowed elements of each array ( if array is subtype of dictionary or another array )
one_week_day_cost int [opt] cost of one week day in item weekly_user_code_intervals
one_shifted_week_day_cost int [opt] cost of one shifted (startTime > stopTime) week day in item weekly_user_code_intervals

Device

Device table

fields type description
id string an unique id of the device
gateway_id string [deprecated] an id of a gateway the device is being registering for
name string a name displayed by the UI
category string a device category
subcategory string a device subcategory
type string
device_type_id string
room_id string [opt] an id of a room this device belongs to
parent_device_id string [opt] id of parent device
info [opt] some additional information for this device
battery_powered bool whether the device is battery powered
reachable bool [opt] whether the device is reachable
persistent bool [opt] whether the device is persistent. False by default.
security string [opt] Security level how the device is connected. Possible options: no, low, middle, high. no by default.
ready bool [opt] Ready status of device. true value means device is ready to any changes. false value means device is busy.
status string [opt] Possible options: idle, broken. idle - device is in normal mode, broken - device has invalid data.
Possible info key Required Description
manufacturer + Name of device manufacturer
model + Name of device model
firmware Firmware version
hardware Harware version

Setting

Setting table

fields type description
id string an unique id of the setting
deviceId string an id of a device the setting is registered for
label text name
description text [opt] description
info object [opt] implementation details
status string synchronization status (synced, pending or failed)
value_type string setting type
value int : bool : string : text : rgb : scalable : dictionary.zwave_device_configuration
value_default [opt]
value_min int : scalable [opt] minimal value for int and scalable setting types
value_max int : scalable [opt] maximal value for int and scalable setting types
enum dictionary.text [opt]
elements_max_number int [opt] maximum list or dictionary

info field

fields type description
zwave.parameter_number int corresponding parameter number
zwave.parameter_size int size of the corresponding parameter's value

Gateway

Gateway table

fields type description
id string an id of the gateway
name string a name obtained from a plugin's config
plugin_id string an id of a plugin this gateway is a part of
label string a public name of the gateway
reason string a public reason of not 'ready' status
unreachable_reasons
unreachable_actions