kettle

Last updated on May 25, 2023

Kettle.

Available device functions

The device can have all the functions listed below or some of them. E.g. if the kettle is not able to use child lock, there is no need in including the child_lock function in its model description.

The device has two mandatory functions: online, on_off. All kettles must have them.

Function	Mandatory?	Description
child_lock		Child lock
kitchen_water_level		The amount of water in the device in liters
kitchen_water_low_level		Whether the device has run out of water
kitchen_water_temperature		Current water temperature in the device
kitchen_water_temperature_set		The temperature to which the water needs to be heated
on_off	✔︎	Turning the device on and off remotely
online	✔︎	Device availability: offline or online

Kettle model description example

The model shall be described in accordance with the model structure. The example describes an kettle equipped with all functions.

Besides, allowed values for the kitchen_water_temperature_set function (the temperature to which the water needs to be heated) of the model are changed: this model has a minimum heating temperature of 60 C, and the temperature change step is 10 C.

{
   "id": "QWERTY124",
   "manufacturer": "Xiaqara",
   "model": "SM1123456789",
   "hw_version": "3.1",
   "sw_version": "5.6",
   "description": "Xiaqara Smart Kettle",
   "category": "kettle",
   "features": [
      "child_lock",
      "kitchen_water_level",
      "kitchen_water_low_level",
      "kitchen_water_temperature",
      "kitchen_water_temperature_set",
      "on_off",
      "online",
   ],
   "allowed_values": {
      "kitchen_water_temperature_set": {
         "type": "INTEGER",
         "integer_values": {
            "min": "60",
            "max": "100",
            "step": "10"
         }
      }
   }
}

User's kettle description example

The device shall be describe in accordance with the device structure. The example contains no kettle model description as we believe that models are described independently and the model ID will be enough (in this case, QWERTY124).

{
   "id": "ABCD_004",
   "name": "My kettle",
   "default_name": "Smart kettle",
   "nicknames": ["Clever kettle", "Manageable kettle"],
   "home": "My home",
   "room": "Kitchen",
   "groups": ["Breakfast", "Kitchen appliances"],
   "model_id": "QWERTY124",
   "hw_version": "3.1",
   "sw_version": "5.6",
   "partner_meta": {
      "internal-id": 1234,
      "specificity": "microchip 2A"
   },
}