core/homeassistant/components/ondilo_ico/sensor.py

166 lines
4.7 KiB
Python

"""Platform for sensor integration."""
from datetime import timedelta
import logging
from ondilo import OndiloError
from homeassistant.components.sensor import SensorEntity
from homeassistant.const import (
CONCENTRATION_PARTS_PER_MILLION,
DEVICE_CLASS_BATTERY,
DEVICE_CLASS_SIGNAL_STRENGTH,
DEVICE_CLASS_TEMPERATURE,
PERCENTAGE,
TEMP_CELSIUS,
)
from homeassistant.helpers.update_coordinator import (
CoordinatorEntity,
DataUpdateCoordinator,
UpdateFailed,
)
from .const import DOMAIN
SENSOR_TYPES = {
"temperature": [
"Temperature",
TEMP_CELSIUS,
None,
DEVICE_CLASS_TEMPERATURE,
],
"orp": ["Oxydo Reduction Potential", "mV", "mdi:pool", None],
"ph": ["pH", "", "mdi:pool", None],
"tds": ["TDS", CONCENTRATION_PARTS_PER_MILLION, "mdi:pool", None],
"battery": ["Battery", PERCENTAGE, None, DEVICE_CLASS_BATTERY],
"rssi": [
"RSSI",
PERCENTAGE,
None,
DEVICE_CLASS_SIGNAL_STRENGTH,
],
"salt": ["Salt", "mg/L", "mdi:pool", None],
}
SCAN_INTERVAL = timedelta(hours=1)
_LOGGER = logging.getLogger(__name__)
async def async_setup_entry(hass, entry, async_add_entities):
"""Set up the Ondilo ICO sensors."""
api = hass.data[DOMAIN][entry.entry_id]
async def async_update_data():
"""Fetch data from API endpoint.
This is the place to pre-process the data to lookup tables
so entities can quickly look up their data.
"""
try:
return await hass.async_add_executor_job(api.get_all_pools_data)
except OndiloError as err:
raise UpdateFailed(f"Error communicating with API: {err}") from err
coordinator = DataUpdateCoordinator(
hass,
_LOGGER,
# Name of the data. For logging purposes.
name="sensor",
update_method=async_update_data,
# Polling interval. Will only be polled if there are subscribers.
update_interval=SCAN_INTERVAL,
)
# Fetch initial data so we have data when entities subscribe
await coordinator.async_refresh()
entities = []
for poolidx, pool in enumerate(coordinator.data):
for sensor_idx, sensor in enumerate(pool["sensors"]):
if sensor["data_type"] in SENSOR_TYPES:
entities.append(OndiloICO(coordinator, poolidx, sensor_idx))
async_add_entities(entities)
class OndiloICO(CoordinatorEntity, SensorEntity):
"""Representation of a Sensor."""
def __init__(
self, coordinator: DataUpdateCoordinator, poolidx: int, sensor_idx: int
) -> None:
"""Initialize sensor entity with data from coordinator."""
super().__init__(coordinator)
self._poolid = self.coordinator.data[poolidx]["id"]
pooldata = self._pooldata()
self._data_type = pooldata["sensors"][sensor_idx]["data_type"]
self._unique_id = f"{pooldata['ICO']['serial_number']}-{self._data_type}"
self._device_name = pooldata["name"]
self._name = f"{self._device_name} {SENSOR_TYPES[self._data_type][0]}"
self._device_class = SENSOR_TYPES[self._data_type][3]
self._icon = SENSOR_TYPES[self._data_type][2]
self._unit = SENSOR_TYPES[self._data_type][1]
def _pooldata(self):
"""Get pool data dict."""
return next(
(pool for pool in self.coordinator.data if pool["id"] == self._poolid),
None,
)
def _devdata(self):
"""Get device data dict."""
return next(
(
data_type
for data_type in self._pooldata()["sensors"]
if data_type["data_type"] == self._data_type
),
None,
)
@property
def name(self):
"""Name of the sensor."""
return self._name
@property
def state(self):
"""Last value of the sensor."""
return self._devdata()["value"]
@property
def icon(self):
"""Icon to use in the frontend, if any."""
return self._icon
@property
def device_class(self):
"""Return the device class of the sensor."""
return self._device_class
@property
def unit_of_measurement(self):
"""Return the Unit of the sensor's measurement."""
return self._unit
@property
def unique_id(self):
"""Return the unique ID of this entity."""
return self._unique_id
@property
def device_info(self):
"""Return the device info for the sensor."""
pooldata = self._pooldata()
return {
"identifiers": {(DOMAIN, pooldata["ICO"]["serial_number"])},
"name": self._device_name,
"manufacturer": "Ondilo",
"model": "ICO",
"sw_version": pooldata["ICO"]["sw_version"],
}