Use EntityDescription - sensehat (#54995)

This commit is contained in:
Marc Mueller 2021-08-23 22:35:59 +02:00 committed by GitHub
parent 4a1906a833
commit c7926e56b8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 45 additions and 43 deletions

View File

@ -126,9 +126,7 @@ SENSOR_KEYS: list[str] = [desc.key for desc in SENSOR_TYPES]
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend( PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
{ {
vol.Required(CONF_DISPLAY_OPTIONS, default=list(SENSOR_KEYS)): [ vol.Required(CONF_DISPLAY_OPTIONS, default=SENSOR_KEYS): [vol.In(SENSOR_KEYS)],
vol.In(SENSOR_KEYS)
],
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string, vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
vol.Optional(CONF_USE_LEDS, default=False): cv.boolean, vol.Optional(CONF_USE_LEDS, default=False): cv.boolean,
} }

View File

@ -1,4 +1,6 @@
"""Support for Sense HAT sensors.""" """Support for Sense HAT sensors."""
from __future__ import annotations
from datetime import timedelta from datetime import timedelta
import logging import logging
from pathlib import Path from pathlib import Path
@ -6,7 +8,11 @@ from pathlib import Path
from sense_hat import SenseHat from sense_hat import SenseHat
import voluptuous as vol import voluptuous as vol
from homeassistant.components.sensor import PLATFORM_SCHEMA, SensorEntity from homeassistant.components.sensor import (
PLATFORM_SCHEMA,
SensorEntity,
SensorEntityDescription,
)
from homeassistant.const import ( from homeassistant.const import (
CONF_DISPLAY_OPTIONS, CONF_DISPLAY_OPTIONS,
CONF_NAME, CONF_NAME,
@ -24,17 +30,30 @@ CONF_IS_HAT_ATTACHED = "is_hat_attached"
MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=60) MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=60)
SENSOR_TYPES = { SENSOR_TYPES: tuple[SensorEntityDescription, ...] = (
"temperature": ["temperature", TEMP_CELSIUS, DEVICE_CLASS_TEMPERATURE], SensorEntityDescription(
"humidity": ["humidity", PERCENTAGE, None], key="temperature",
"pressure": ["pressure", "mb", None], name="temperature",
} native_unit_of_measurement=TEMP_CELSIUS,
device_class=DEVICE_CLASS_TEMPERATURE,
),
SensorEntityDescription(
key="humidity",
name="humidity",
native_unit_of_measurement=PERCENTAGE,
),
SensorEntityDescription(
key="pressure",
name="pressure",
native_unit_of_measurement="mb",
),
)
SENSOR_KEYS: list[str] = [desc.key for desc in SENSOR_TYPES]
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend( PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
{ {
vol.Required(CONF_DISPLAY_OPTIONS, default=list(SENSOR_TYPES)): [ vol.Required(CONF_DISPLAY_OPTIONS, default=SENSOR_KEYS): [vol.In(SENSOR_KEYS)],
vol.In(SENSOR_TYPES)
],
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string, vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
vol.Optional(CONF_IS_HAT_ATTACHED, default=True): cv.boolean, vol.Optional(CONF_IS_HAT_ATTACHED, default=True): cv.boolean,
} }
@ -61,39 +80,23 @@ def get_average(temp_base):
def setup_platform(hass, config, add_entities, discovery_info=None): def setup_platform(hass, config, add_entities, discovery_info=None):
"""Set up the Sense HAT sensor platform.""" """Set up the Sense HAT sensor platform."""
data = SenseHatData(config.get(CONF_IS_HAT_ATTACHED)) data = SenseHatData(config.get(CONF_IS_HAT_ATTACHED))
dev = [] display_options = config[CONF_DISPLAY_OPTIONS]
for variable in config[CONF_DISPLAY_OPTIONS]: entities = [
dev.append(SenseHatSensor(data, variable)) SenseHatSensor(data, description)
for description in SENSOR_TYPES
if description.key in display_options
]
add_entities(dev, True) add_entities(entities, True)
class SenseHatSensor(SensorEntity): class SenseHatSensor(SensorEntity):
"""Representation of a Sense HAT sensor.""" """Representation of a Sense HAT sensor."""
def __init__(self, data, sensor_types): def __init__(self, data, description: SensorEntityDescription):
"""Initialize the sensor.""" """Initialize the sensor."""
self.entity_description = description
self.data = data self.data = data
self._name = SENSOR_TYPES[sensor_types][0]
self._unit_of_measurement = SENSOR_TYPES[sensor_types][1]
self.type = sensor_types
self._state = None
self._attr_device_class = SENSOR_TYPES[sensor_types][2]
@property
def name(self):
"""Return the name of the sensor."""
return self._name
@property
def native_value(self):
"""Return the state of the sensor."""
return self._state
@property
def native_unit_of_measurement(self):
"""Return the unit the value is expressed in."""
return self._unit_of_measurement
def update(self): def update(self):
"""Get the latest data and updates the states.""" """Get the latest data and updates the states."""
@ -102,12 +105,13 @@ class SenseHatSensor(SensorEntity):
_LOGGER.error("Don't receive data") _LOGGER.error("Don't receive data")
return return
if self.type == "temperature": sensor_type = self.entity_description.key
self._state = self.data.temperature if sensor_type == "temperature":
if self.type == "humidity": self._attr_native_value = self.data.temperature
self._state = self.data.humidity elif sensor_type == "humidity":
if self.type == "pressure": self._attr_native_value = self.data.humidity
self._state = self.data.pressure elif sensor_type == "pressure":
self._attr_native_value = self.data.pressure
class SenseHatData: class SenseHatData: