hub.device.setting.added

Broadcast after a new setting is registered on a device. This can only be sent as part of a device.added sequence.

Example
Parameters

Edit

				
					{
    "id": "ui_broadcast",
    "msg_subclass": "hub.device.setting.added",
    "result": {
        "_id": "5ef177ff7f0000258f9f8c33",
        "description": {
            "lang_tag": "zwave_config_descr_335_20548_13619_13",
            "text": "The rate at which the energy readings are reported"
        },
        "deviceId": "5ef177ff7f0000258f9f8c27",
        "info": {
            "zwave.parameter_number": 13,
            "zwave.parameter_size": 2
        },
        "label": {
            "lang_tag": "zwave_config_label_335_20548_13619_13",
            "text": "Energy monitoring"
        },
        "status": "synced",
        "value": 0,
        "valueDefault": 0,
        "valueMax": 255,
        "valueMin": 0,
        "valueType": "int"
    }
}

Edit

Fields	Type	Required	Description
_id	string	+	Identifies which setting was added.
deviceId	string	+	Identifies the device to which the setting applies.
deviceName	string	+	The name of the device to which the item applies
label	text	+	Name of the setting.
description	text	+	Explanation of the new setting
info	object	–	Implementation details.
status	string	+	Synchronization status (synced, pending or failed)
valueType	string	+	The setting type
elementType	string	–	The type of a single element of a dictionary/array setting type (for example, zwave_configuration )
value	The setting implemented. The settings for each parameter are usually explained in the device’s user guide.	+
valueDefault		–
valueMin	int : scalable	–	Lower limit of an item’s value field if it is an integer or scalable setting type.
valueMax	int : scalable	–	Upper limit of an item’s value field if it is an integer or scalable setting type.
enum	dictionary.text	–	Dictionary text.
elementsMaxNumber	int	–	Maximum allowed elements of a dictionary value.

info field

Fields	Type	Required	Description
zwave.parameter_number	int	+	The number of the Z-Wave parameter that was registered. Parameters are special settings you can apply to a Z-Wave device. These parameters can include things such as the length of time a Z-Wave siren remains active or for the type of manual switch connected to a Z-Wave light controller. Each device manufacturer sets up different parameters which are usually listed in the device’s user guide. Every parameter has a number, size and value.
zwave.parameter_size	int	+	The size (or length) of the value that has been added. This is a number which represents size in bytes (usually between 1 – 4).