Add SSID information as device sensor (FR #813)

Author: ollo69

custom_components/smartthinq_sensors/device_helpers.py

@@ -117,6 +117,11 @@ def power_state(self):
             return STATE_ON
         return STATE_OFF
 
+    @property
+    def ssid(self):
+        """The device network SSID."""
+        return self._api.device.device_info.ssid
+
     def get_features_attributes(self):
         """Return a dict with device features and name."""
         ret_val = {}

custom_components/smartthinq_sensors/diagnostics.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from homeassistant.components.diagnostics import async_redact_data
+from homeassistant.components.diagnostics import REDACTED, async_redact_data
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_TOKEN
 from homeassistant.core import HomeAssistant, callback
@@ -14,6 +14,7 @@
 
 TO_REDACT = {CONF_TOKEN}
 TO_REDACT_DEV = {"macAddress", "ssid", "userNo"}
+TO_REDACT_STATE = {"macAddress", "ssid"}
 
 
 async def async_get_config_entry_diagnostics(
@@ -137,6 +138,12 @@ def _async_device_ha_info(hass: HomeAssistant, lg_device_id: str) -> dict | None
             # The context doesn't provide useful information in this case.
             state_dict.pop("context", None)
 
+        if state_dict and "state" in state_dict:
+            for to_redact in TO_REDACT_STATE:
+                if entity_entry.entity_id.endswith(f"_{to_redact}"):
+                    state_dict["state"] = REDACTED
+                    break
+
         data["entities"][entity_entry.entity_id] = {
             "name": entity_entry.name,
             "original_name": entity_entry.original_name,

custom_components/smartthinq_sensors/sensor.py

@@ -533,6 +533,15 @@ class ThinQSensorEntityDescription(SensorEntityDescription):
     **{dev_type: WASH_DEV_SENSORS for dev_type in WASH_DEVICE_TYPES},
 }
 
+COMMON_SENSORS: tuple[ThinQSensorEntityDescription, ...] = (
+    ThinQSensorEntityDescription(
+        key="ssid",
+        name="SSID",
+        icon="mdi:access-point-network",
+        value_fn=lambda x: x.ssid,
+    ),
+)
+
 
 def _sensor_exist(
     lge_device: LGEDevice, sensor_desc: ThinQSensorEntityDescription
@@ -572,7 +581,14 @@ def _async_discover_device(lge_devices: dict) -> None:
             if _sensor_exist(lge_device, sensor_desc)
         ]
 
-        async_add_entities(lge_sensors)
+        lge_common_sensors = [
+            LGESensor(lge_device, sensor_desc, get_wrapper_device(lge_device, dev_type))
+            for sensor_desc in COMMON_SENSORS
+            for dev_type in lge_devices.keys()
+            for lge_device in lge_devices.get(dev_type, [])
+        ]
+
+        async_add_entities(lge_sensors + lge_common_sensors)
 
     _async_discover_device(lge_cfg_devices)
 

custom_components/smartthinq_sensors/wideq/device_info.py

@@ -251,6 +251,11 @@ def device_state(self) -> str | None:
         """Return the status associated to the device."""
         return self._data.get("deviceState")
 
+    @property
+    def ssid(self) -> str | None:
+        """Return the network ssid associated to the device."""
+        return self._data.get("ssid")
+
     @property
     def snapshot(self) -> dict[str, Any] | None:
         """Return the snapshot data associated to the device."""