f5cbc9d208
* Add remote platform to hue integration
supporting ZGPSwitch, ZLLSwitch and ZLLRotary switches.
* Ported from custom component Hue-remotes-HASS from @robmarkcole
* Add options flow for hue, to toggle handling of sensors and remotes
* Sensors are enabled by default, and remotes are disabled,
to not generate any breaking change for existent users.
Also, when linking a new bridge these defaults are used,
so unless going explicitly to the Options menu,
the old behavior is preserved.
* SensorManager stores the enabled platforms and ignores everything else.
* Bridge is created with flags for `add_sensors` and `add_remotes`,
and uses them to forward entry setup to only the enabled platforms.
* Update listener removes disabled kinds of devices when options are changed,
so device list is in sync with options, and disabled kinds disappear from HA,
leaving the enable/disable entity option for individual devices.
* Fix hue bridge mock with new parameters
* Revert changes in hue bridge mock
* Remove OptionsFlow and platform flags
* Extract `GenericHueDevice` from `GenericHueSensor`
to use it as base class for all hue devices, including those without any entity,
like remotes without battery.
* Add `HueBattery` sensor for battery powered remotes
and generate entities for TYPE_ZLL_ROTARY and TYPE_ZLL_SWITCH remotes.
* Remove remote platform
* Add HueEvent class to fire events for button presses
* Use `sensor.lastupdated` string to control state changes
* Event data includes:
- "id", as pretty name of the remote
- "unique_id" of the remote device
- "event", with the raw code of the pressed button
('buttonevent' or 'rotaryevent' property)
- "last_updated", with the bridge timestamp for the button press
* Register ZGP_SWITCH, ZLL_SWITCH, ZLL_ROTARY remotes
* fix removal
* Exclude W0611
* Extract GenericHueDevice to its own module
and solve import tree, also fixing lint in CI
* Store registered events to do not repeat device reg
* Minor cleaning
* Add tests for hue_event and battery entities for hue remotes
137 lines
4 KiB
Python
137 lines
4 KiB
Python
"""Hue sensor entities."""
|
|
from aiohue.sensors import (
|
|
TYPE_ZLL_LIGHTLEVEL,
|
|
TYPE_ZLL_ROTARY,
|
|
TYPE_ZLL_SWITCH,
|
|
TYPE_ZLL_TEMPERATURE,
|
|
)
|
|
|
|
from homeassistant.const import (
|
|
DEVICE_CLASS_BATTERY,
|
|
DEVICE_CLASS_ILLUMINANCE,
|
|
DEVICE_CLASS_TEMPERATURE,
|
|
TEMP_CELSIUS,
|
|
UNIT_PERCENTAGE,
|
|
)
|
|
from homeassistant.helpers.entity import Entity
|
|
|
|
from .const import DOMAIN as HUE_DOMAIN
|
|
from .sensor_base import SENSOR_CONFIG_MAP, GenericHueSensor, GenericZLLSensor
|
|
|
|
LIGHT_LEVEL_NAME_FORMAT = "{} light level"
|
|
REMOTE_NAME_FORMAT = "{} battery level"
|
|
TEMPERATURE_NAME_FORMAT = "{} temperature"
|
|
|
|
|
|
async def async_setup_entry(hass, config_entry, async_add_entities):
|
|
"""Defer sensor setup to the shared sensor module."""
|
|
await hass.data[HUE_DOMAIN][
|
|
config_entry.entry_id
|
|
].sensor_manager.async_register_component("sensor", async_add_entities)
|
|
|
|
|
|
class GenericHueGaugeSensorEntity(GenericZLLSensor, Entity):
|
|
"""Parent class for all 'gauge' Hue device sensors."""
|
|
|
|
async def _async_update_ha_state(self, *args, **kwargs):
|
|
await self.async_update_ha_state(self, *args, **kwargs)
|
|
|
|
|
|
class HueLightLevel(GenericHueGaugeSensorEntity):
|
|
"""The light level sensor entity for a Hue motion sensor device."""
|
|
|
|
device_class = DEVICE_CLASS_ILLUMINANCE
|
|
unit_of_measurement = "lx"
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state of the device."""
|
|
if self.sensor.lightlevel is None:
|
|
return None
|
|
|
|
# https://developers.meethue.com/develop/hue-api/supported-devices/#clip_zll_lightlevel
|
|
# Light level in 10000 log10 (lux) +1 measured by sensor. Logarithm
|
|
# scale used because the human eye adjusts to light levels and small
|
|
# changes at low lux levels are more noticeable than at high lux
|
|
# levels.
|
|
return round(float(10 ** ((self.sensor.lightlevel - 1) / 10000)), 2)
|
|
|
|
@property
|
|
def device_state_attributes(self):
|
|
"""Return the device state attributes."""
|
|
attributes = super().device_state_attributes
|
|
attributes.update(
|
|
{
|
|
"lightlevel": self.sensor.lightlevel,
|
|
"daylight": self.sensor.daylight,
|
|
"dark": self.sensor.dark,
|
|
"threshold_dark": self.sensor.tholddark,
|
|
"threshold_offset": self.sensor.tholdoffset,
|
|
}
|
|
)
|
|
return attributes
|
|
|
|
|
|
class HueTemperature(GenericHueGaugeSensorEntity):
|
|
"""The temperature sensor entity for a Hue motion sensor device."""
|
|
|
|
device_class = DEVICE_CLASS_TEMPERATURE
|
|
unit_of_measurement = TEMP_CELSIUS
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state of the device."""
|
|
if self.sensor.temperature is None:
|
|
return None
|
|
|
|
return self.sensor.temperature / 100
|
|
|
|
|
|
class HueBattery(GenericHueSensor):
|
|
"""Battery class for when a batt-powered device is only represented as an event."""
|
|
|
|
@property
|
|
def unique_id(self):
|
|
"""Return a unique identifier for this device."""
|
|
return f"{self.sensor.uniqueid}-battery"
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state of the battery."""
|
|
return self.sensor.battery
|
|
|
|
@property
|
|
def device_class(self):
|
|
"""Return the class of the sensor."""
|
|
return DEVICE_CLASS_BATTERY
|
|
|
|
@property
|
|
def unit_of_measurement(self):
|
|
"""Return the unit of measurement of this entity."""
|
|
return UNIT_PERCENTAGE
|
|
|
|
|
|
SENSOR_CONFIG_MAP.update(
|
|
{
|
|
TYPE_ZLL_LIGHTLEVEL: {
|
|
"platform": "sensor",
|
|
"name_format": LIGHT_LEVEL_NAME_FORMAT,
|
|
"class": HueLightLevel,
|
|
},
|
|
TYPE_ZLL_TEMPERATURE: {
|
|
"platform": "sensor",
|
|
"name_format": TEMPERATURE_NAME_FORMAT,
|
|
"class": HueTemperature,
|
|
},
|
|
TYPE_ZLL_SWITCH: {
|
|
"platform": "sensor",
|
|
"name_format": REMOTE_NAME_FORMAT,
|
|
"class": HueBattery,
|
|
},
|
|
TYPE_ZLL_ROTARY: {
|
|
"platform": "sensor",
|
|
"name_format": REMOTE_NAME_FORMAT,
|
|
"class": HueBattery,
|
|
},
|
|
}
|
|
)
|