Refactor RainMachine switch platform (#31148)
* Import constants sanely * Linting * Rename data constants for consistency * Refactor RainMachine switch platform * Comments * Cleanup * Refactor switch and sensor API calls to be separate * Linting * Make sure zones are updated in appropriate service calls * Correctly decrement * Linting * Don't do weird inheritance * Ensure service calls update data properly * Docstring * Docstring * Errors can be logged without string conversion * Code review comments
This commit is contained in:
1 parent
37d1cdc4cb
commit
4c4f726323
5 files changed
+295
-260
No files matched your search
@@ -27,23 +27,25 @@ from homeassistant.helpers.service import verify_domain_control
|
||||
from .config_flow import configured_instances
|
||||
from .const import (
|
||||
DATA_CLIENT,
|
||||
DATA_PROGRAMS,
|
||||
DATA_PROVISION_SETTINGS,
|
||||
DATA_RESTRICTIONS_CURRENT,
|
||||
DATA_RESTRICTIONS_UNIVERSAL,
|
||||
DATA_ZONES,
|
||||
DATA_ZONES_DETAILS,
|
||||
DEFAULT_PORT,
|
||||
DEFAULT_SCAN_INTERVAL,
|
||||
DEFAULT_SSL,
|
||||
DOMAIN,
|
||||
PROVISION_SETTINGS,
|
||||
RESTRICTIONS_CURRENT,
|
||||
RESTRICTIONS_UNIVERSAL,
|
||||
PROGRAM_UPDATE_TOPIC,
|
||||
SENSOR_UPDATE_TOPIC,
|
||||
ZONE_UPDATE_TOPIC,
|
||||
)
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
DATA_LISTENER = "listener"
|
||||
|
||||
PROGRAM_UPDATE_TOPIC = f"{DOMAIN}_program_update"
|
||||
SENSOR_UPDATE_TOPIC = f"{DOMAIN}_data_update"
|
||||
ZONE_UPDATE_TOPIC = f"{DOMAIN}_zone_update"
|
||||
|
||||
CONF_CONTROLLERS = "controllers"
|
||||
CONF_PROGRAM_ID = "program_id"
|
||||
CONF_SECONDS = "seconds"
|
||||
@@ -150,6 +152,9 @@ async def async_setup_entry(hass, config_entry):
|
||||
_LOGGER.error("An error occurred: %s", err)
|
||||
raise ConfigEntryNotReady
|
||||
|
||||
# Update the data object, which at this point (prior to any sensors registering
|
||||
# "interest" in the API), will focus on grabbing the latest program and zone data:
|
||||
await rainmachine.async_update()
|
||||
hass.data[DOMAIN][DATA_CLIENT][config_entry.entry_id] = rainmachine
|
||||
|
||||
for component in ("binary_sensor", "sensor", "switch"):
|
||||
@@ -161,37 +166,37 @@ async def async_setup_entry(hass, config_entry):
|
||||
async def disable_program(call):
|
||||
"""Disable a program."""
|
||||
await rainmachine.client.programs.disable(call.data[CONF_PROGRAM_ID])
|
||||
async_dispatcher_send(hass, PROGRAM_UPDATE_TOPIC)
|
||||
await rainmachine.async_update_programs_and_zones()
|
||||
|
||||
@_verify_domain_control
|
||||
async def disable_zone(call):
|
||||
"""Disable a zone."""
|
||||
await rainmachine.client.zones.disable(call.data[CONF_ZONE_ID])
|
||||
async_dispatcher_send(hass, ZONE_UPDATE_TOPIC)
|
||||
await rainmachine.async_update_programs_and_zones()
|
||||
|
||||
@_verify_domain_control
|
||||
async def enable_program(call):
|
||||
"""Enable a program."""
|
||||
await rainmachine.client.programs.enable(call.data[CONF_PROGRAM_ID])
|
||||
async_dispatcher_send(hass, PROGRAM_UPDATE_TOPIC)
|
||||
await rainmachine.async_update_programs_and_zones()
|
||||
|
||||
@_verify_domain_control
|
||||
async def enable_zone(call):
|
||||
"""Enable a zone."""
|
||||
await rainmachine.client.zones.enable(call.data[CONF_ZONE_ID])
|
||||
async_dispatcher_send(hass, ZONE_UPDATE_TOPIC)
|
||||
await rainmachine.async_update_programs_and_zones()
|
||||
|
||||
@_verify_domain_control
|
||||
async def pause_watering(call):
|
||||
"""Pause watering for a set number of seconds."""
|
||||
await rainmachine.client.watering.pause_all(call.data[CONF_SECONDS])
|
||||
async_dispatcher_send(hass, PROGRAM_UPDATE_TOPIC)
|
||||
await rainmachine.async_update_programs_and_zones()
|
||||
|
||||
@_verify_domain_control
|
||||
async def start_program(call):
|
||||
"""Start a particular program."""
|
||||
await rainmachine.client.programs.start(call.data[CONF_PROGRAM_ID])
|
||||
async_dispatcher_send(hass, PROGRAM_UPDATE_TOPIC)
|
||||
await rainmachine.async_update_programs_and_zones()
|
||||
|
||||
@_verify_domain_control
|
||||
async def start_zone(call):
|
||||
@@ -199,31 +204,31 @@ async def async_setup_entry(hass, config_entry):
|
||||
await rainmachine.client.zones.start(
|
||||
call.data[CONF_ZONE_ID], call.data[CONF_ZONE_RUN_TIME]
|
||||
)
|
||||
async_dispatcher_send(hass, ZONE_UPDATE_TOPIC)
|
||||
await rainmachine.async_update_programs_and_zones()
|
||||
|
||||
@_verify_domain_control
|
||||
async def stop_all(call):
|
||||
"""Stop all watering."""
|
||||
await rainmachine.client.watering.stop_all()
|
||||
async_dispatcher_send(hass, PROGRAM_UPDATE_TOPIC)
|
||||
await rainmachine.async_update_programs_and_zones()
|
||||
|
||||
@_verify_domain_control
|
||||
async def stop_program(call):
|
||||
"""Stop a program."""
|
||||
await rainmachine.client.programs.stop(call.data[CONF_PROGRAM_ID])
|
||||
async_dispatcher_send(hass, PROGRAM_UPDATE_TOPIC)
|
||||
await rainmachine.async_update_programs_and_zones()
|
||||
|
||||
@_verify_domain_control
|
||||
async def stop_zone(call):
|
||||
"""Stop a zone."""
|
||||
await rainmachine.client.zones.stop(call.data[CONF_ZONE_ID])
|
||||
async_dispatcher_send(hass, ZONE_UPDATE_TOPIC)
|
||||
await rainmachine.async_update_programs_and_zones()
|
||||
|
||||
@_verify_domain_control
|
||||
async def unpause_watering(call):
|
||||
"""Unpause watering."""
|
||||
await rainmachine.client.watering.unpause_all()
|
||||
async_dispatcher_send(hass, PROGRAM_UPDATE_TOPIC)
|
||||
await rainmachine.async_update_programs_and_zones()
|
||||
|
||||
for service, method, schema in [
|
||||
("disable_program", disable_program, SERVICE_ALTER_PROGRAM),
|
||||
@@ -265,7 +270,7 @@ class RainMachine:
|
||||
|
||||
def __init__(self, hass, client, default_zone_runtime, scan_interval):
|
||||
"""Initialize."""
|
||||
self._async_unsub_dispatcher_connect = None
|
||||
self._async_cancel_time_interval_listener = None
|
||||
self._scan_interval_seconds = scan_interval
|
||||
self.client = client
|
||||
self.data = {}
|
||||
@@ -274,48 +279,58 @@ class RainMachine:
|
||||
self.hass = hass
|
||||
|
||||
self._api_category_count = {
|
||||
PROVISION_SETTINGS: 0,
|
||||
RESTRICTIONS_CURRENT: 0,
|
||||
RESTRICTIONS_UNIVERSAL: 0,
|
||||
DATA_PROVISION_SETTINGS: 0,
|
||||
DATA_RESTRICTIONS_CURRENT: 0,
|
||||
DATA_RESTRICTIONS_UNIVERSAL: 0,
|
||||
}
|
||||
self._api_category_locks = {
|
||||
PROVISION_SETTINGS: asyncio.Lock(),
|
||||
RESTRICTIONS_CURRENT: asyncio.Lock(),
|
||||
RESTRICTIONS_UNIVERSAL: asyncio.Lock(),
|
||||
DATA_PROVISION_SETTINGS: asyncio.Lock(),
|
||||
DATA_RESTRICTIONS_CURRENT: asyncio.Lock(),
|
||||
DATA_RESTRICTIONS_UNIVERSAL: asyncio.Lock(),
|
||||
}
|
||||
|
||||
async def _async_fetch_from_api(self, api_category):
|
||||
"""Execute the appropriate coroutine to fetch particular data from the API."""
|
||||
if api_category == PROVISION_SETTINGS:
|
||||
data = await self.client.provisioning.settings()
|
||||
elif api_category == RESTRICTIONS_CURRENT:
|
||||
data = await self.client.restrictions.current()
|
||||
elif api_category == RESTRICTIONS_UNIVERSAL:
|
||||
data = await self.client.restrictions.universal()
|
||||
|
||||
return data
|
||||
|
||||
async def _async_update_listener_action(self, now):
|
||||
"""Define an async_track_time_interval action to update data."""
|
||||
await self.async_update()
|
||||
|
||||
@callback
|
||||
def async_deregister_api_interest(self, api_category):
|
||||
def async_deregister_sensor_api_interest(self, api_category):
|
||||
"""Decrement the number of entities with data needs from an API category."""
|
||||
# If this deregistration should leave us with no registration at all, remove the
|
||||
# time interval:
|
||||
if sum(self._api_category_count.values()) == 0:
|
||||
if self._async_unsub_dispatcher_connect:
|
||||
self._async_unsub_dispatcher_connect()
|
||||
self._async_unsub_dispatcher_connect = None
|
||||
if self._async_cancel_time_interval_listener:
|
||||
self._async_cancel_time_interval_listener()
|
||||
self._async_cancel_time_interval_listener = None
|
||||
return
|
||||
self._api_category_count[api_category] += 1
|
||||
|
||||
async def async_register_api_interest(self, api_category):
|
||||
self._api_category_count[api_category] -= 1
|
||||
|
||||
async def async_fetch_from_api(self, api_category):
|
||||
"""Execute the appropriate coroutine to fetch particular data from the API."""
|
||||
if api_category == DATA_PROGRAMS:
|
||||
data = await self.client.programs.all(include_inactive=True)
|
||||
elif api_category == DATA_PROVISION_SETTINGS:
|
||||
data = await self.client.provisioning.settings()
|
||||
elif api_category == DATA_RESTRICTIONS_CURRENT:
|
||||
data = await self.client.restrictions.current()
|
||||
elif api_category == DATA_RESTRICTIONS_UNIVERSAL:
|
||||
data = await self.client.restrictions.universal()
|
||||
elif api_category == DATA_ZONES:
|
||||
data = await self.client.zones.all(include_inactive=True)
|
||||
elif api_category == DATA_ZONES_DETAILS:
|
||||
# This API call needs to be separate from the DATA_ZONES one above because,
|
||||
# maddeningly, the DATA_ZONES_DETAILS API call doesn't include the current
|
||||
# state of the zone:
|
||||
data = await self.client.zones.all(details=True, include_inactive=True)
|
||||
|
||||
self.data[api_category] = data
|
||||
|
||||
async def async_register_sensor_api_interest(self, api_category):
|
||||
"""Increment the number of entities with data needs from an API category."""
|
||||
# If this is the first registration we have, start a time interval:
|
||||
if not self._async_unsub_dispatcher_connect:
|
||||
self._async_unsub_dispatcher_connect = async_track_time_interval(
|
||||
if not self._async_cancel_time_interval_listener:
|
||||
self._async_cancel_time_interval_listener = async_track_time_interval(
|
||||
self.hass,
|
||||
self._async_update_listener_action,
|
||||
timedelta(seconds=self._scan_interval_seconds),
|
||||
@@ -323,19 +338,27 @@ class RainMachine:
|
||||
|
||||
self._api_category_count[api_category] += 1
|
||||
|
||||
# Lock API updates in case multiple entities are trying to call the same API
|
||||
# endpoint at once:
|
||||
# If a sensor registers interest in a particular API call and the data doesn't
|
||||
# exist for it yet, make the API call and grab the data:
|
||||
async with self._api_category_locks[api_category]:
|
||||
if api_category not in self.data:
|
||||
self.data[api_category] = await self._async_fetch_from_api(api_category)
|
||||
await self.async_fetch_from_api(api_category)
|
||||
|
||||
async def async_update(self):
|
||||
"""Update all RainMachine data."""
|
||||
tasks = [self.async_update_programs_and_zones(), self.async_update_sensors()]
|
||||
await asyncio.gather(*tasks)
|
||||
|
||||
async def async_update_sensors(self):
|
||||
"""Update sensor/binary sensor data."""
|
||||
_LOGGER.debug("Updating sensor data for RainMachine")
|
||||
|
||||
# Fetch an API category if there is at least one interested entity:
|
||||
tasks = {}
|
||||
for category, count in self._api_category_count.items():
|
||||
if count == 0:
|
||||
continue
|
||||
tasks[category] = self._async_fetch_from_api(category)
|
||||
tasks[category] = self.async_fetch_from_api(category)
|
||||
|
||||
results = await asyncio.gather(*tasks.values(), return_exceptions=True)
|
||||
for api_category, result in zip(tasks, results):
|
||||
@@ -344,10 +367,37 @@ class RainMachine:
|
||||
"There was an error while updating %s: %s", api_category, result
|
||||
)
|
||||
continue
|
||||
self.data[api_category] = result
|
||||
|
||||
async_dispatcher_send(self.hass, SENSOR_UPDATE_TOPIC)
|
||||
|
||||
async def async_update_programs_and_zones(self):
|
||||
"""Update program and zone data.
|
||||
|
||||
Program and zone updates always go together because of how linked they are:
|
||||
programs affect zones and certain combinations of zones affect programs.
|
||||
|
||||
Note that this call does not take into account interested entities when making
|
||||
the API calls; we make the reasonable assumption that switches will always be
|
||||
enabled.
|
||||
"""
|
||||
_LOGGER.debug("Updating program and zone data for RainMachine")
|
||||
|
||||
tasks = {
|
||||
DATA_PROGRAMS: self.async_fetch_from_api(DATA_PROGRAMS),
|
||||
DATA_ZONES: self.async_fetch_from_api(DATA_ZONES),
|
||||
DATA_ZONES_DETAILS: self.async_fetch_from_api(DATA_ZONES_DETAILS),
|
||||
}
|
||||
|
||||
results = await asyncio.gather(*tasks.values(), return_exceptions=True)
|
||||
for api_category, result in zip(tasks, results):
|
||||
if isinstance(result, RainMachineError):
|
||||
_LOGGER.error(
|
||||
"There was an error while updating %s: %s", api_category, result
|
||||
)
|
||||
|
||||
async_dispatcher_send(self.hass, PROGRAM_UPDATE_TOPIC)
|
||||
async_dispatcher_send(self.hass, ZONE_UPDATE_TOPIC)
|
||||
|
||||
|
||||
class RainMachineEntity(Entity):
|
||||
"""Define a generic RainMachine entity."""
|
||||
@@ -389,6 +439,16 @@ class RainMachineEntity(Entity):
|
||||
"""Return the name of the entity."""
|
||||
return self._name
|
||||
|
||||
@property
|
||||
def should_poll(self):
|
||||
"""Disable polling."""
|
||||
return False
|
||||
|
||||
@callback
|
||||
def _update_state(self):
|
||||
"""Update the state."""
|
||||
self.async_schedule_update_ha_state(True)
|
||||
|
||||
async def async_will_remove_from_hass(self):
|
||||
"""Disconnect dispatcher listener when removed."""
|
||||
for handler in self._dispatcher_handlers:
|
||||
|
||||
Reference in new issue
Block a user