Support for humidifier entity (#19)

Includes additional fixes:
* Fix YAML schema
* Style fixes

Author: oyvindwe

custom_components/connectlife/__init__.py

@@ -10,7 +10,14 @@
 from .const import DOMAIN
 from .coordinator import ConnectLifeCoordinator
 
-PLATFORMS: list[Platform] = [Platform.BINARY_SENSOR, Platform.CLIMATE, Platform.SENSOR, Platform.SELECT, Platform.SWITCH]
+PLATFORMS: list[Platform] = [
+    Platform.BINARY_SENSOR,
+    Platform.CLIMATE,
+    Platform.HUMIDIFIER,
+    Platform.SENSOR,
+    Platform.SELECT,
+    Platform.SWITCH
+]
 
 
 async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:

custom_components/connectlife/binary_sensor.py

@@ -51,11 +51,11 @@ def __init__(
         self.status = status
         self.entity_description = BinarySensorEntityDescription(
             key=self._attr_unique_id,
-            entity_registry_visible_default = not dd_entry.hide,
+            entity_registry_visible_default=not dd_entry.hide,
             icon=dd_entry.icon,
             name=status.replace("_", " "),
-            translation_key = status,
-            device_class = dd_entry.binary_sensor.device_class
+            translation_key=status,
+            device_class=dd_entry.binary_sensor.device_class
         )
         self.update_state()
 
@@ -68,4 +68,4 @@ def update_state(self):
             else:
                 self._attr_is_on = None
                 _LOGGER.warning("Unknown value %d for %s", value, self.status)
-        self._attr_available = self.coordinator.appliances[self.device_id]._offline_state == 1
+        self._attr_available = self.coordinator.appliances[self.device_id].offline_state == 1

custom_components/connectlife/climate.py

@@ -24,7 +24,7 @@
     TEMPERATURE_UNIT,
 )
 from .coordinator import ConnectLifeCoordinator
-from .dictionaries import Dictionaries, Property, Climate
+from .dictionaries import Dictionaries, Property
 from .entity import ConnectLifeEntity
 from connectlife.appliance import ConnectLifeAppliance
 
@@ -47,8 +47,8 @@ async def async_setup_entry(
 
 
 def is_climate(dictionary: dict[str, Property]):
-    for property in dictionary.values():
-        if hasattr(property, Platform.CLIMATE):
+    for prop in dictionary.values():
+        if hasattr(prop, Platform.CLIMATE):
             return True
     return False
 
@@ -64,7 +64,7 @@ class ConnectLifeClimate(ConnectLifeEntity, ClimateEntity):
     target_map = {}
     fan_mode_map: dict[int, str] = {}
     fan_mode_reverse_map: dict[str, int] = {}
-    hvac_action_map: dict[int, HVACMode] = {}
+    hvac_action_map: dict[int, HVACAction] = {}
     swing_mode_map: dict[int, str] = {}
     swing_mode_reverse_map: dict[str, int] = {}
     temperature_unit_map: dict[int, UnitOfTemperature] = {}
@@ -146,7 +146,7 @@ def update_state(self) -> None:
                     if value in self.hvac_action_map:
                         self._attr_hvac_action = self.hvac_action_map[value]
                     else:
-                        # Map to None as we canot add custom HVAC actions.
+                        # Map to None as we cannot add custom HVAC actions.
                         self._attr_hvac_action = None
                 elif target == FAN_MODE:
                     if value in self.fan_mode_map:
@@ -167,7 +167,7 @@ def update_state(self) -> None:
                         _LOGGER.warning("Got unexpected value %d for %s", value, status)
                 else:
                     setattr(self, f"_attr_{target}", value)
-        self._attr_available = self.coordinator.appliances[self.device_id]._offline_state == 1
+        self._attr_available = self.coordinator.appliances[self.device_id].offline_state == 1
 
     async def async_set_humidity(self, humidity):
         """Set new target humidity."""
@@ -180,22 +180,28 @@ async def async_set_temperature(self, **kwargs) -> None:
         """Set new target temperature."""
         if ATTR_TEMPERATURE in kwargs and TARGET_TEMPERATURE in self.target_map:
             target_temperature = round(kwargs[ATTR_TEMPERATURE])
-            await self.coordinator.api.update_appliance(self.puid, {self.target_map[TARGET_TEMPERATURE]: target_temperature})
+            await self.coordinator.api.update_appliance(
+                self.puid,
+                {
+                    self.target_map[TARGET_TEMPERATURE]:
+                        target_temperature
+                }
+            )
             self._attr_target_temperature = target_temperature
             self.async_write_ha_state()
 
     async def async_turn_on(self):
         """Turn the entity on."""
         # TODO: Support value mapping
         await self.coordinator.api.update_appliance(self.puid, {self.target_map[IS_ON]: 1})
-        self.hvac_mode = HVACMode.AUTO
+        self._attr_hvac_mode = HVACMode.AUTO
         self.async_write_ha_state()
 
     async def async_turn_off(self):
         """Turn the entity off."""
         # TODO: Support value mapping
         await self.coordinator.api.update_appliance(self.puid, {self.target_map[IS_ON]: 0})
-        self.hvac_mode = HVACMode.OFF
+        self._attr_hvac_mode = HVACMode.OFF
         self.async_write_ha_state()
 
     async def async_set_hvac_mode(self, hvac_mode: HVACMode) -> None:
@@ -208,7 +214,7 @@ async def async_set_hvac_mode(self, hvac_mode: HVACMode) -> None:
 
     async def async_set_fan_mode(self, fan_mode: str) -> None:
         """Set the fan mode."""
-        await  self.coordinator.api.update_appliance(self.puid, {
+        await self.coordinator.api.update_appliance(self.puid, {
             self.target_map[FAN_MODE]: self.fan_mode_reverse_map[fan_mode]
         })
         self._attr_fan_mode = fan_mode

custom_components/connectlife/const.py

@@ -6,9 +6,11 @@
 ATTR_DESC = "desc"
 ATTR_KEY = "key"
 
+ACTION = "action"
 HVAC_ACTION = "hvac_action"
 FAN_MODE = "fan_mode"
 IS_ON = "is_on"
+MODE = "mode"
 SWING_MODE = "swing_mode"
 TARGET_HUMIDITY = "target_humidity"
 TARGET_TEMPERATURE = "target_temperature"

custom_components/connectlife/data_dictionaries/007-400.yaml

@@ -28,23 +28,24 @@ properties:
     binary_sensor:
       device_class: problem
   - property: f_humidity
-    climate:
+    humidifier:
       target: current_humidity
   - property: t_fan_speed
-    climate:
-      target: fan_mode
+    select:
       options:
         0: low
         1: high
         2: auto
   - property: t_humidity
-    climate:
+    humidifier:
       target: target_humidity
+      device_class: dehumidifier
   - property: t_power
-    climate:
+    humidifier:
       target: is_on
   - property: t_work_mode
-    select:
+    humidifier:
+      target: mode
       options:
         0: continuous
         1: manual

custom_components/connectlife/data_dictionaries/009-109.yaml

@@ -1,17 +1,14 @@
-device_type: aircondition
+device_type: airconditioner
 properties:
   - property: f_temp_in
     climate:
       target: current_temperature
-  - property: oem_host_version
-    sensor:
-      hide: true
   - property: t_beep
-    switch:
+    switch: {}
   - property: t_eco
-    switch:
+    switch: {}
   - property: t_fan_mute
-    switch:
+    switch: {}
   - property: t_fan_speed
     climate:
       target: fan_mode

custom_components/connectlife/data_dictionaries/README.md

@@ -7,7 +7,7 @@ To make a property visible by default, just add the property to the list (withou
 
 File name: `<deviceTypeCode>-<deviceFeatureCode>.yaml`
 
-The file containse to top level items:
+The file contains two top level items:
 - `device_type`: string
 - `properties`: list of [`Property`](#property):
 
@@ -20,11 +20,12 @@ The file containse to top level items:
 | `icon`          | `mdi:eye`, etc.                    | Icon to use for the entity.                                                                       |
 | `binary_sensor` | [BinarySensor](#type-binarysensor) | Create a binary sensor of the property.                                                           |
 | `climate`       | [Climate](#type-climate)           | Map the property to a climate entity for the device.                                              |
+| `humidifier`    | [Humidifier](#type-climate)        | Map the property to a humidifier entity for the device.                                           |
 | `select`        | [Select](#type-select)             | Create a selector of the property.                                                                |
 | `sensor`        | [Sensor](#type-sensor)             | Create a sensor of the property. This is the default.                                             |
 | `switch`        | [Switch](#type-switch)             | Create a Switch of the property.                                                                  |
 
-If a entity mapping is not given, the property is mapped to a sensor entity.
+If an entity mapping is not given, the property is mapped to a sensor entity.
 
 It is not necessary to include items with empty values. A [JSON schema](properties-schema.json) is provided so data dictionaries can be
 validated.
@@ -41,21 +42,34 @@ Domain `binary_sensor` can be used for read only properties where `0` is not ava
 
 ## Type `Climate`:
 
-Domain `climate` can be used to map the property to a target propery in a climate entity. If at least one property has
+Domain `climate` can be used to map the property to a target property in a climate entity. If at least one property has
 type `climate`, a climate entity is created for the appliance.
 
-| Item      | Type                            | Description                                                                                                                                                                                                                                          |
-|-----------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `target`  | string                          | Any  of these [climate entity](https://developers.home-assistant.io/docs/core/entity/climate#properties) attributes: `fan_mode`, `hvac_action`, `swing_mode`, `temperature`, `target_temperature`, `temperature_unit`, or the special target `is_on` |
-| `options` | dictionary of integer to string | Required for `fan_mode`, `hvac_action`, `swing_mode`, and `temperature_unit`                                                                                                                                                                         |
+| Item      | Type                            | Description                                                                                                                                                                                                                                                                                         |
+|-----------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `target`  | string                          | Any  of these [climate entity](https://developers.home-assistant.io/docs/core/entity/climate#properties) attributes: `current_humidity`, `fan_mode`, `hvac_action`, `swing_mode`, `current_temperature`, `target_humidity`, `target_temperature`, `temperature_unit`, or the special target `is_on` |
+| `options` | dictionary of integer to string | Required for `fan_mode`, `hvac_action`, `swing_mode`, and `temperature_unit`                                                                                                                                                                                                                        |
 
 `temperature_unit` defaults to Celsius.
 
 Note that `hvac_action` can only be mapped to [pre-defined actions](https://developers.home-assistant.io/docs/core/entity/climate#hvac-action).
 If a value does not have a sensible mapping, leave it out to set `hvac_action` to `None` for that value, or consider
 mapping to a sensor `enum` instead.
 
-For `fan_mode` and `swing_mode`, remember to add [transalation string](#translation-strings).
+For `fan_mode` and `swing_mode`, remember to add [translation string](#translation-strings).
+
+## Type `Humidifier`:
+
+Domain `humidifier` can be used to map the property to a target property in a humidifier entity. If at least one property has
+type `humidifier`, a humidifier entity is created for the appliance.
+
+| Item           | Type                            | Description                                                                                                                                                               |
+|----------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `target`       | string                          | Any  of these [climate entity](https://developers.home-assistant.io/docs/core/entity/humidifier#properties) attributes: `is_on`, `current_humidity`, or `target_humidity` |
+| `options`      | dictionary of integer to string |                                                                                                                                                                           |
+| `device_class` | string                          | Name of any [HumidifierDeviceClass enum](https://developers.home-assistant.io/docs/core/entity/humidifier#available-device-classes)                                       |                                                                                                                         
+
+It is sufficient to set `device_class` on one property. The value of the first encountered property is used.
 
 ## Type `Select`
 
@@ -123,7 +137,7 @@ This goes into  [strings.json](../strings.json) and  [en.json](../translations/e
 }
 ```
 
-Climate modes must be registered as `state_attributes`.  
+Climate and humidifier modes must be registered as `state_attributes`.  
 
 For example, given the following data dictionary:
 ```yaml