Merge pull request #125 from mariusz-ostoja-swierczynski/feat_96

✨ Add zone alarm state

custom_components/tech/const.py

@@ -24,6 +24,7 @@
 INCLUDE_HUB_IN_NAME = "include_hub_in_name"
 WINDOW_SENSORS = "windowsSensors"
 WINDOW_STATE = "windowState"
+ZONE_STATE = "zoneState"
 
 DEFAULT_ICON = "mdi:eye"
 

custom_components/tech/sensor.py

@@ -58,6 +58,7 @@
     WINDOW_SENSORS,
     WINDOW_STATE,
     WORKING_STATUS,
+    ZONE_STATE,
 )
 from .coordinator import TechCoordinator
 from .entity import TileEntity
@@ -136,6 +137,7 @@ async def async_setup_entry(
 
     battery_devices = map_to_battery_sensors(zones, coordinator, config_entry)
     temperature_sensors = map_to_temperature_sensors(zones, coordinator, config_entry)
+    zone_state_sensors = map_to_zone_state_sensors(zones, coordinator, config_entry)
     humidity_sensors = map_to_humidity_sensors(zones, coordinator, config_entry)
     actuator_sensors = map_to_actuator_sensors(zones, coordinator, config_entry)
     window_sensors = map_to_window_sensors(zones, coordinator, config_entry)
@@ -148,6 +150,7 @@ async def async_setup_entry(
         itertools.chain(
             battery_devices,
             temperature_sensors,
+            zone_state_sensors,
             humidity_sensors,  # , tile_sensors
             actuator_sensors,
             window_sensors,
@@ -227,6 +230,41 @@ def is_temperature_operating_device(device) -> bool:
     return device[CONF_ZONE]["currentTemperature"] is not None
 
 
+def map_to_zone_state_sensors(zones, coordinator, config_entry):
+    """Map the zones to zone state sensors using the provided API and config entry.
+
+    Args:
+    zones (list): List of zones
+    coordinator (object): The API object
+    config_entry (object): The config entry object
+    model: device model
+
+    Returns:
+    list: List of ZoneStateSensor objects
+
+    """
+    devices = filter(
+        lambda deviceIndex: is_zone_state_operating_device(zones[deviceIndex]), zones
+    )
+    return (
+        ZoneStateSensor(zones[deviceIndex], coordinator, config_entry)
+        for deviceIndex in devices
+    )
+
+
+def is_zone_state_operating_device(device) -> bool:
+    """Check if the device's current zone state is available.
+
+    Args:
+        device (dict): The device information.
+
+    Returns:
+        bool: True if the current zone state is available, False otherwise.
+
+    """
+    return device[CONF_ZONE][ZONE_STATE] is not None
+
+
 def map_to_humidity_sensors(zones, coordinator, config_entry):
     """Map zones to humidity sensors.
 
@@ -1166,6 +1204,55 @@ def update_properties(self, device):
             self._attr_native_value = None
 
 
+class ZoneStateSensor(BinarySensorEntity, ZoneSensor):
+    """Representation of a Zone State (alarm) Sensor."""
+
+    _attr_device_class = BinarySensorDeviceClass.PROBLEM
+
+    def __init__(self, device, coordinator, config_entry) -> None:
+        """Initialize the sensor.
+
+        These are needed before the call to super, as ZoneSensor class
+        calls update_properties in its init, which actually calls this class
+        update_properties, which does not know attrs and _window_index already.
+
+        """
+        self._attr_is_on = device[CONF_ZONE][ZONE_STATE] != "noAlarm"
+        self.attrs: dict[str, Any] = {}
+        super().__init__(device, coordinator, config_entry)
+        self._attr_translation_key = "zone_state_entity"
+        self._attr_is_on = device[CONF_ZONE][ZONE_STATE] != "noAlarm"
+
+    @property
+    def unique_id(self) -> str:
+        """Return a unique ID."""
+        return f"{self._unique_id}_zone_state"
+
+    @property
+    def extra_state_attributes(self) -> dict[str, Any]:
+        """Return the state attributes."""
+        attributes = {}
+        attributes.update(self.attrs)
+        return attributes
+
+    def update_properties(self, device):
+        """Update the properties of the ZoneStateSensor object.
+
+        Args:
+        device (dict): The device information.
+
+        Returns:
+        None
+
+        """
+        # Update the name of the device
+        self._name = device[CONF_DESCRIPTION][CONF_NAME]
+
+        self.attrs[ZONE_STATE] = device[CONF_ZONE][ZONE_STATE]
+
+        self._attr_is_on = device[CONF_ZONE][ZONE_STATE] != "noAlarm"
+
+
 class TileSensor(TileEntity, CoordinatorEntity):
     """Representation of a TileSensor."""
 

custom_components/tech/strings.json

@@ -80,6 +80,9 @@
       },
       "signal_strength_entity": {
         "name": "{entity_name} signal strength"
+      },
+      "zone_state_entity": {
+        "name": "{entity_name} alarm state"
       }
     }
   }

custom_components/tech/translations/cs.json

@@ -50,6 +50,9 @@
             },
             "signal_strength_entity": {
                 "name": "{entity_name} Síla signálu"
+            },
+            "zone_state_entity": {
+                "name": "{entity_name} Stav alarmu"
             }
         }
     },

custom_components/tech/translations/de.json

@@ -50,6 +50,9 @@
             },
             "signal_strength_entity": {
                 "name": "{entity_name} Signalstärke"
+            },
+            "zone_state_entity": {
+                "name": "{entity_name} Alarmzustand"
             }
         }
     },

custom_components/tech/translations/en.json

@@ -50,6 +50,9 @@
           },
           "signal_strength_entity": {
             "name": "{entity_name} Signal strength"
+          },
+          "zone_state_entity": {
+            "name": "{entity_name} Alarm state"
           }
         }
       },

custom_components/tech/translations/es.json

@@ -50,6 +50,9 @@
             },
             "signal_strength_entity": {
                 "name": "Intensidad de señal de {entity_name}"
+            },
+            "zone_state_entity": {
+                "name": "{entity_name} Estado de alarma"
             }
         }
     },

custom_components/tech/translations/et.json

@@ -50,6 +50,9 @@
             },
             "signal_strength_entity": {
                 "name": "{entity_name} Signaali tugevus"
+            },
+            "zone_state_entity": {
+                "name": "{entity_name} Häire olek"
             }
         }
     },

custom_components/tech/translations/fr.json

@@ -50,6 +50,9 @@
             },
             "signal_strength_entity": {
                 "name": "Force du signal {entity_name}"
+            },
+            "zone_state_entity": {
+                "name": "{entity_name} État d'alarme"
             }
         }
     },

custom_components/tech/translations/hr.json

@@ -50,6 +50,9 @@
             },
             "signal_strength_entity": {
                 "name": "{entity_name} Jačina signala"
+            },
+            "zone_state_entity": {
+                "name": "{entity_name} Alarmno stanje"
             }
         }
     },

custom_components/tech/translations/hu.json

@@ -50,6 +50,9 @@
             },
             "signal_strength_entity": {
                 "name": "{entity_name} Jel erősség"
+            },
+            "zone_state_entity": {
+                "name": "{entity_name} Riasztási állapot"
             }
         }
     },

custom_components/tech/translations/it.json

@@ -50,6 +50,9 @@
             },
             "signal_strength_entity": {
                 "name": "{entity_name} Intensità del segnale"
+            },
+            "zone_state_entity": {
+                "name": "{entity_name} Stato di allarme"
             }
         }
     },

custom_components/tech/translations/lt.json

@@ -50,6 +50,9 @@
             },
             "signal_strength_entity": {
                 "name": "{entity_name} Signalas"
+            },
+            "zone_state_entity": {
+                "name": "{entity_name} Signalizacijos būsena"
             }
         }
     },

custom_components/tech/translations/nl.json

@@ -50,6 +50,9 @@
             },
             "signal_strength_entity": {
                 "name": "{entity_name} Signaalsterkte"
+            },
+            "zone_state_entity": {
+                "name": "{entity_name} Alarmstatus"
             }
         }
     },

custom_components/tech/translations/pl.json

@@ -50,6 +50,9 @@
           },
           "signal_strength_entity": {
             "name": "{entity_name} Siła sygnału"
+          },
+          "zone_state_entity": {
+            "name": "{entity_name} Stan alarmu"
           }
         }
       },

custom_components/tech/translations/ro.json

@@ -50,6 +50,9 @@
             },
             "signal_strength_entity": {
                 "name": "{entity_name} Putere semnal"
+            },
+            "zone_state_entity": {
+                "name": "{entity_name} Stare de alarmă"
             }
         }
     },

custom_components/tech/translations/ru.json

@@ -50,6 +50,9 @@
             },
             "signal_strength_entity": {
                 "name": "{entity_name} Уровень сигнала"
+            },
+            "zone_state_entity": {
+                "name": "{entity_name} Состояние тревоги"
             }
         }
     },

custom_components/tech/translations/si.json

@@ -50,6 +50,9 @@
             },
             "signal_strength_entity": {
                 "name": "{entity_name} Moč signala"
+            },
+            "zone_state_entity": {
+                "name": "{entity_name} Stanje alarma"
             }
         }
     },

custom_components/tech/translations/sk.json

@@ -50,6 +50,9 @@
           },
           "signal_strength_entity": {
             "name": "{entity_name} Intenzita signálu"
+          },
+          "zone_state_entity": {
+            "name": "{entity_name} Stav alarmu"
           }
         }
       },