162 lines
4.8 KiB
Python
162 lines
4.8 KiB
Python
"""Support for Hydrawise cloud."""
|
|
from datetime import timedelta
|
|
import logging
|
|
|
|
from hydrawiser.core import Hydrawiser
|
|
from requests.exceptions import ConnectTimeout, HTTPError
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.binary_sensor import (
|
|
DEVICE_CLASS_CONNECTIVITY,
|
|
DEVICE_CLASS_MOISTURE,
|
|
)
|
|
from homeassistant.components.sensor import DEVICE_CLASS_TIMESTAMP
|
|
from homeassistant.components.switch import DEVICE_CLASS_SWITCH
|
|
from homeassistant.const import (
|
|
ATTR_ATTRIBUTION,
|
|
CONF_ACCESS_TOKEN,
|
|
CONF_SCAN_INTERVAL,
|
|
TIME_MINUTES,
|
|
)
|
|
from homeassistant.core import callback
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.dispatcher import async_dispatcher_connect, dispatcher_send
|
|
from homeassistant.helpers.entity import Entity
|
|
from homeassistant.helpers.event import track_time_interval
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
ALLOWED_WATERING_TIME = [5, 10, 15, 30, 45, 60]
|
|
|
|
ATTRIBUTION = "Data provided by hydrawise.com"
|
|
|
|
CONF_WATERING_TIME = "watering_minutes"
|
|
|
|
NOTIFICATION_ID = "hydrawise_notification"
|
|
NOTIFICATION_TITLE = "Hydrawise Setup"
|
|
|
|
DATA_HYDRAWISE = "hydrawise"
|
|
DOMAIN = "hydrawise"
|
|
DEFAULT_WATERING_TIME = 15
|
|
|
|
DEVICE_MAP_INDEX = [
|
|
"KEY_INDEX",
|
|
"ICON_INDEX",
|
|
"DEVICE_CLASS_INDEX",
|
|
"UNIT_OF_MEASURE_INDEX",
|
|
]
|
|
DEVICE_MAP = {
|
|
"auto_watering": ["Automatic Watering", None, DEVICE_CLASS_SWITCH, None],
|
|
"is_watering": ["Watering", None, DEVICE_CLASS_MOISTURE, None],
|
|
"manual_watering": ["Manual Watering", None, DEVICE_CLASS_SWITCH, None],
|
|
"next_cycle": ["Next Cycle", None, DEVICE_CLASS_TIMESTAMP, None],
|
|
"status": ["Status", None, DEVICE_CLASS_CONNECTIVITY, None],
|
|
"watering_time": ["Watering Time", "mdi:water-pump", None, TIME_MINUTES],
|
|
}
|
|
|
|
BINARY_SENSORS = ["is_watering", "status"]
|
|
|
|
SENSORS = ["next_cycle", "watering_time"]
|
|
|
|
SWITCHES = ["auto_watering", "manual_watering"]
|
|
|
|
SCAN_INTERVAL = timedelta(seconds=30)
|
|
|
|
SIGNAL_UPDATE_HYDRAWISE = "hydrawise_update"
|
|
|
|
CONFIG_SCHEMA = vol.Schema(
|
|
{
|
|
DOMAIN: vol.Schema(
|
|
{
|
|
vol.Required(CONF_ACCESS_TOKEN): cv.string,
|
|
vol.Optional(CONF_SCAN_INTERVAL, default=SCAN_INTERVAL): cv.time_period,
|
|
}
|
|
)
|
|
},
|
|
extra=vol.ALLOW_EXTRA,
|
|
)
|
|
|
|
|
|
def setup(hass, config):
|
|
"""Set up the Hunter Hydrawise component."""
|
|
conf = config[DOMAIN]
|
|
access_token = conf[CONF_ACCESS_TOKEN]
|
|
scan_interval = conf.get(CONF_SCAN_INTERVAL)
|
|
|
|
try:
|
|
hydrawise = Hydrawiser(user_token=access_token)
|
|
hass.data[DATA_HYDRAWISE] = HydrawiseHub(hydrawise)
|
|
except (ConnectTimeout, HTTPError) as ex:
|
|
_LOGGER.error("Unable to connect to Hydrawise cloud service: %s", str(ex))
|
|
hass.components.persistent_notification.create(
|
|
f"Error: {ex}<br />You will need to restart hass after fixing.",
|
|
title=NOTIFICATION_TITLE,
|
|
notification_id=NOTIFICATION_ID,
|
|
)
|
|
return False
|
|
|
|
def hub_refresh(event_time):
|
|
"""Call Hydrawise hub to refresh information."""
|
|
_LOGGER.debug("Updating Hydrawise Hub component")
|
|
hass.data[DATA_HYDRAWISE].data.update_controller_info()
|
|
dispatcher_send(hass, SIGNAL_UPDATE_HYDRAWISE)
|
|
|
|
# Call the Hydrawise API to refresh updates
|
|
track_time_interval(hass, hub_refresh, scan_interval)
|
|
|
|
return True
|
|
|
|
|
|
class HydrawiseHub:
|
|
"""Representation of a base Hydrawise device."""
|
|
|
|
def __init__(self, data):
|
|
"""Initialize the entity."""
|
|
self.data = data
|
|
|
|
|
|
class HydrawiseEntity(Entity):
|
|
"""Entity class for Hydrawise devices."""
|
|
|
|
def __init__(self, data, sensor_type):
|
|
"""Initialize the Hydrawise entity."""
|
|
self.data = data
|
|
self._sensor_type = sensor_type
|
|
self._name = f"{self.data['name']} {DEVICE_MAP[self._sensor_type][DEVICE_MAP_INDEX.index('KEY_INDEX')]}"
|
|
self._state = None
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the sensor."""
|
|
return self._name
|
|
|
|
async def async_added_to_hass(self):
|
|
"""Register callbacks."""
|
|
self.async_on_remove(
|
|
async_dispatcher_connect(
|
|
self.hass, SIGNAL_UPDATE_HYDRAWISE, self._update_callback
|
|
)
|
|
)
|
|
|
|
@callback
|
|
def _update_callback(self):
|
|
"""Call update method."""
|
|
self.async_schedule_update_ha_state(True)
|
|
|
|
@property
|
|
def extra_state_attributes(self):
|
|
"""Return the state attributes."""
|
|
return {ATTR_ATTRIBUTION: ATTRIBUTION, "identifier": self.data.get("relay")}
|
|
|
|
@property
|
|
def device_class(self):
|
|
"""Return the device class of the sensor type."""
|
|
return DEVICE_MAP[self._sensor_type][
|
|
DEVICE_MAP_INDEX.index("DEVICE_CLASS_INDEX")
|
|
]
|
|
|
|
@property
|
|
def icon(self):
|
|
"""Return the icon to use in the frontend, if any."""
|
|
return DEVICE_MAP[self._sensor_type][DEVICE_MAP_INDEX.index("ICON_INDEX")]
|