|  Developer
Updated on November 22, 2021

hub.item.updated

  • This broadcast is sent when an item is modified on a device.
Edit
Field Type Required Description
_id string + Identifies which item has changed.
deviceId string + The identity of the device to which this item belongs.
deviceName string + The name of the device to which the item applies.
deviceCategory string + Top-level grouping of the device affected by the item change. View full list of device categories
deviceSubcategory string + The specific type of device affected by the item change. View full list of device sub-categories
parentDeviceId string The identifier of the device’s parent device. This could be another smart device (e.g. one motion detector might have other motion detectors as its children), or the parent could be the hub itself. This field is empty is the device has no parent.
roomName string + States the room to which this device is assigned (if any). You can assign devices to rooms in the Ezlo app.
userNotification bool + Special flag which allows you to convert this broadcast into a user notification.
notifications JsonArray + List of user ids to whom the notification should be sent. ‘null’ = all users. ‘–‘ = no users.
name string + The type of item. See full list of item names.
deviceArmed bool States whether or not the device is switched on because a specific house mode is currently active. View full list of house modes
elementsMaxNumber int Maximum quantity of a dictionary value.
stringRestriction string Regexp restriction for an item value of the type ‘string’.
userCodeRestriction string Regexp restriction for a field ‘code’ in any value of the ‘usercode’ value type. For example, this is used in the ‘user_codes’ item in the Item names page.
userCodeModes JsonArray List of available pin code mode. This is used in the ‘user_codes’ item in the Item names page.
protectService string A Ezlo Protect service associated with the device. This will only appear if the Ezlo Protect service is on, the device is an armed panic button, and an item is a ‘security_threat’. One of: ‘police’, ‘fire’, ‘medical’.
__ITEM_CHANGEABLE_FIELD any + A field with variable content. See below
  Item fields which may be updated (__ITEM_CHANGEABLE_FIELD):
Field Type Description
show bool States whether the item is shown on the UI of the connected interface (for example, phone app).
valueFormatted string The item’s formatted value.
value object The current value of the item. This may be a number or array.
minValue number Lower limit of the numeric part of an item’s value field.
maxValue number Upper limit of the numeric part of an item’s value field.
valueIndent JsonObject Defines the minimum indentation between different items.
valueIndent.item string Item id of another item
valueIndent.minIndent float Minimum indentation between the current item and another item
Edit
				
					{
          "id": "ui_broadcast",
          "msg_subclass": "hub.item.updated",
          "result": {
            "_id": "588b7eb528b12d03be86f36f",
            "deviceId": "<DEVICE_ID>",
            "deviceName": "<DEVICE_NAME>",
            "deviceCategory" : "<DEVICE_CATEGORY>",
            "deviceSubcategory" : "<DEVICE_SUBCATEGORY>",
            "roomName" : "<DEVICE_ROOM_NAME>",
            "userNotification": false,
            "parentDeviceId": "<OPTIONAL_PARENT_DEVICE_ID>",
            "serviceNotification":false,
            "syncNotification":false,
            "notifications": [ "12314324", "978343" ],
            "deviceArmed": false,
            "name": "alarm_water",
            "elementsMaxNumber": 2,
            "userCodeRestriction": "\d{4}",
            "<ITEM_CHANGEABLE_FIELD>": "<FIELD_VALUE>"
          }
        }