sensor.py

Go to the documentation of this file.

"""Support for showing values from Dweet.io."""
 
from __future__ import annotations
 
from datetime import timedelta
import json
import logging
 
import dweepy
import voluptuous as vol
 
from homeassistant.components.sensor import (
    PLATFORM_SCHEMA as SENSOR_PLATFORM_SCHEMA,
    SensorEntity,
)
from homeassistant.const import (
    CONF_DEVICE,
    CONF_NAME,
    CONF_UNIT_OF_MEASUREMENT,
    CONF_VALUE_TEMPLATE,
)
from homeassistant.core import HomeAssistant
import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
_LOGGER = logging.getLogger(__name__)
 
DEFAULT_NAME = "Dweet.io Sensor"
 
SCAN_INTERVAL = timedelta(minutes=1)
 
PLATFORM_SCHEMA = SENSOR_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_DEVICE): cv.string,
        vol.Required(CONF_VALUE_TEMPLATE): cv.template,
        vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
        vol.Optional(CONF_UNIT_OF_MEASUREMENT): cv.string,
    }
)
 
 
def setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up the Dweet sensor."""
    name = config.get(CONF_NAME)
    device = config.get(CONF_DEVICE)
    value_template = config.get(CONF_VALUE_TEMPLATE)
    unit = config.get(CONF_UNIT_OF_MEASUREMENT)
 
    try:
        content = json.dumps(dweepy.get_latest_dweet_for(device)[0]["content"])
    except dweepy.DweepyError:
        _LOGGER.error("Device/thing %s could not be found", device)
        return
 
    if value_template and value_template.render_with_possible_json_value(content) == "":
        _LOGGER.error("%s was not found", value_template)
        return
 
    dweet = DweetData(device)
 
    add_entities([DweetSensor(hass, dweet, name, value_template, unit)], True)
 
 
class DweetSensor(SensorEntity):
    """Representation of a Dweet sensor."""
 
    def __init__(self, hass, dweet, name, value_template, unit_of_measurement):
        """Initialize the sensor."""
        self.hasshasshass = hass
        self.dweetdweet = dweet
        self._name_name = name
        self._value_template_value_template = value_template
        self._state_state = None
        self._unit_of_measurement_unit_of_measurement = unit_of_measurement
 
    @property
    def name(self):
        """Return the name of the sensor."""
        return self._name_name
 
    @property
    def native_unit_of_measurement(self):
        """Return the unit the value is expressed in."""
        return self._unit_of_measurement_unit_of_measurement
 
    @property
    def native_value(self):
        """Return the state."""
        return self._state_state
 
    def update(self) -> None:
        """Get the latest data from REST API."""
        self.dweetdweet.update()
 
        if self.dweetdweet.data is None:
            self._state_state = None
        else:
            values = json.dumps(self.dweetdweet.data[0]["content"])
            self._state_state = self._value_template_value_template.render_with_possible_json_value(
                values, None
            )
 
 
class DweetData:
    """The class for handling the data retrieval."""
 
    def __init__(self, device):
        """Initialize the sensor."""
        self._device_device = device
        self.datadata = None
 
    def update(self):
        """Get the latest data from Dweet.io."""
        try:
            self.datadata = dweepy.get_latest_dweet_for(self._device_device)
        except dweepy.DweepyError:
            _LOGGER.warning("Device %s doesn't contain any data", self._device_device)
            self.datadata = None