sensor_device.py

Go to the documentation of this file.

"""Support for the Philips Hue sensor devices."""
 
from homeassistant.helpers import entity
from homeassistant.helpers.device_registry import DeviceInfo
 
from ..const import (
    CONF_ALLOW_UNREACHABLE,
    DEFAULT_ALLOW_UNREACHABLE,
    DOMAIN as HUE_DOMAIN,
)
 
 
class GenericHueDevice(entity.Entity):  # pylint: disable=hass-enforce-class-module
    """Representation of a Hue device."""
 
    def __init__(self, sensor, name, bridge, primary_sensor=None):
        """Initialize the sensor."""
        self.sensorsensor = sensor
        self._name_name = name
        self._primary_sensor_primary_sensor = primary_sensor
        self.bridgebridge = bridge
        self.allow_unreachableallow_unreachable = bridge.config_entry.options.get(
            CONF_ALLOW_UNREACHABLE, DEFAULT_ALLOW_UNREACHABLE
        )
 
    @property
    def primary_sensor(self):
        """Return the primary sensor entity of the physical device."""
        return self._primary_sensor_primary_sensor or self.sensorsensor
 
    @property
    def device_id(self):
        """Return the ID of the physical device this sensor is part of."""
        return self.unique_idunique_id[:23]
 
    @property
    def unique_id(self):
        """Return the ID of this Hue sensor."""
        return self.sensorsensor.uniqueid
 
    @property
    def name(self):
        """Return a friendly name for the sensor."""
        return self._name_name
 
    @property
    def swupdatestate(self):
        """Return detail of available software updates for this device."""
        return self.primary_sensorprimary_sensor.raw.get("swupdate", {}).get("state")
 
    @property
    def device_info(self) -> DeviceInfo:
        """Return the device info.
 
        Links individual entities together in the hass device registry.
        """
        return DeviceInfo(
            identifiers={(HUE_DOMAIN, self.device_iddevice_id)},
            manufacturer=self.primary_sensorprimary_sensor.manufacturername,
            model=(self.primary_sensorprimary_sensor.productname or self.primary_sensorprimary_sensor.modelid),
            name=self.primary_sensorprimary_sensor.name,
            sw_version=self.primary_sensorprimary_sensor.swversion,
            via_device=(HUE_DOMAIN, self.bridgebridge.api.config.bridgeid),
        )