flan
551d3240a2
The to-do list exists so Home Assistant's own conversation agent can manage the order through HassListAddItem rather than through anything bespoke. Skip is a switch because skipped/not-skipped is state worth reading back; donate is a button because it cannot be undone. Un-skip raises rather than guessing at an endpoint that has never been observed. Fixes subscription parsing, which matched the heading row and so reported zero on an account that has one.
97 lines
3.5 KiB
Python
97 lines
3.5 KiB
Python
"""Skip control for the upcoming delivery.
|
|
|
|
A switch rather than a button: skipped/not-skipped is state the conversation
|
|
agent can read back and reverse, where a button would be fire-and-forget.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
from typing import Any
|
|
|
|
from homeassistant.components.switch import SwitchEntity, SwitchEntityDescription
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.exceptions import HomeAssistantError
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
|
|
from . import FreshHarvestConfigEntry
|
|
from .api import FreshHarvestError
|
|
from .const import DOMAIN, EVENT_ACTION
|
|
from .coordinator import FreshHarvestCoordinator
|
|
from .entity import FreshHarvestEntity
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
DESCRIPTION = SwitchEntityDescription(
|
|
key="skip_open_order",
|
|
translation_key="skip_open_order",
|
|
icon="mdi:calendar-remove",
|
|
)
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
entry: FreshHarvestConfigEntry,
|
|
async_add_entities: AddEntitiesCallback,
|
|
) -> None:
|
|
"""Set up the switch platform."""
|
|
async_add_entities([FreshHarvestSkip(entry.runtime_data, entry)])
|
|
|
|
|
|
class FreshHarvestSkip(FreshHarvestEntity, SwitchEntity):
|
|
"""On means the next changeable delivery is skipped."""
|
|
|
|
entity_description = DESCRIPTION
|
|
|
|
def __init__(
|
|
self, coordinator: FreshHarvestCoordinator, entry: FreshHarvestConfigEntry
|
|
) -> None:
|
|
super().__init__(coordinator, entry, DESCRIPTION.key)
|
|
self._entry = entry
|
|
|
|
@property
|
|
def available(self) -> bool:
|
|
"""Only meaningful while there is an order that can still be changed."""
|
|
return super().available and self.coordinator.data.open_order is not None
|
|
|
|
@property
|
|
def is_on(self) -> bool:
|
|
"""A skipped order stops offering a shopping window."""
|
|
order = self.coordinator.data.open_order
|
|
return order is not None and not order.is_open
|
|
|
|
async def async_turn_on(self, **kwargs: Any) -> None:
|
|
"""Skip the next changeable delivery."""
|
|
order = self.coordinator.data.open_order
|
|
if order is None or order.delivery_date is None:
|
|
raise HomeAssistantError("no delivery is currently skippable")
|
|
try:
|
|
result = await self.coordinator.actions.async_skip(
|
|
order.delivery_date, dry_run=False
|
|
)
|
|
except FreshHarvestError as err:
|
|
self._fire("skip", False, str(order.delivery_date), str(err))
|
|
raise HomeAssistantError(f"could not skip: {err}") from err
|
|
self._fire("skip", True, str(order.delivery_date), result.detail)
|
|
await self.coordinator.async_request_refresh()
|
|
|
|
async def async_turn_off(self, **kwargs: Any) -> None:
|
|
"""Un-skip — deliberately not implemented.
|
|
|
|
The portal's restore control only appears once an order is already
|
|
skipped, so its endpoint has never been observed. Guessing at the way
|
|
back from a skip is exactly the kind of thing that should fail loudly
|
|
rather than post something plausible at a real order.
|
|
"""
|
|
raise HomeAssistantError(
|
|
"un-skipping is not supported yet: the restore endpoint has not "
|
|
"been confirmed. Restore it on freshharvest.com for now."
|
|
)
|
|
|
|
def _fire(self, action: str, ok: bool, target: str, detail: str) -> None:
|
|
self.hass.bus.async_fire(
|
|
EVENT_ACTION,
|
|
{"domain": DOMAIN, "entry_id": self._entry.entry_id, "action": action,
|
|
"success": ok, "target": target, "detail": detail},
|
|
)
|