overseer
2b6b7431b5
The integration will consume the NestQuest API service (Feature 16) over HTTP instead of reading the database. This adds the one module that speaks the panel plane: api_client.py with get_snapshot() and complete_instance(), a typed NestQuestApiError for transport failures and non-2xx responses (carrying the HTTP status so 401/404 are distinguishable), one timeout per request and no retry loops. The HTTP session is injected, so tests exercise the client against a stub transport with no network and no aiohttp; the production factory hands in HA's shared aiohttp session and resolves the base URL and panel service token off the config entry (options, then entry data, then defaults). The two new settings are wired into the options flow like every other section (validation mirrored with the client's constructor rules); the token is a secret and is never logged or echoed into error messages. Coordinator wiring is the next task.
145 lines
6.2 KiB
Python
145 lines
6.2 KiB
Python
"""Constants for the NestQuest integration."""
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
import re
|
|
|
|
DOMAIN = "nestquest"
|
|
LOGGER_NAME = "custom_components.nestquest"
|
|
LOGGER = logging.getLogger(LOGGER_NAME)
|
|
|
|
#: Strict 24-hour ``HH:MM`` pattern shared by the options flow and the
|
|
#: settings object's time validation, so a stored option and a freshly
|
|
#: validated form submit parse the same way. Defined here (HA-free) so
|
|
#: both the integration's options flow and the core settings module
|
|
#: import ONE pattern instead of re-copying it.
|
|
TIME_PATTERN = re.compile(r"(?:[01]\d|2[0-3]):[0-5]\d")
|
|
|
|
# Platforms set up per config entry (Feature 10): the per-child day
|
|
# sensors and binary sensors.
|
|
PLATFORMS: list[str] = ["sensor", "binary_sensor"]
|
|
|
|
# Home Assistant bus events (design/ENTITIES-AND-SERVICES.md §3). The
|
|
# panel and admin cards listen for these; Feature 10 fires completed,
|
|
# uncompleted, and child_day_complete from the service paths, and
|
|
# Feature 11's nightly sweep fires quest_missed.
|
|
EVENT_QUEST_COMPLETED = "nestquest_quest_completed"
|
|
EVENT_QUEST_UNCOMPLETED = "nestquest_quest_uncompleted"
|
|
EVENT_QUEST_MISSED = "nestquest_quest_missed"
|
|
EVENT_CHILD_DAY_COMPLETE = "nestquest_child_day_complete"
|
|
|
|
#: Canonical domain-global service names (design/ENTITIES-AND-SERVICES.md §2
|
|
#: plus the existing Feature 07 regenerate service).
|
|
SERVICE_COMPLETE_QUEST = "complete_quest"
|
|
SERVICE_UNCOMPLETE_QUEST = "uncomplete_quest"
|
|
SERVICE_CREATE_QUEST_DEFINITION = "create_quest_definition"
|
|
SERVICE_UPDATE_QUEST_DEFINITION = "update_quest_definition"
|
|
SERVICE_SET_QUEST_DEFINITION_ACTIVE = "set_quest_definition_active"
|
|
SERVICE_SET_PRESENCE_PATTERN = "set_presence_pattern"
|
|
SERVICE_CREATE_PRESENCE_OVERRIDE = "create_presence_override"
|
|
SERVICE_DELETE_PRESENCE_OVERRIDE = "delete_presence_override"
|
|
SERVICE_EXPORT_HISTORY_CSV = "export_history_csv"
|
|
SERVICE_MANAGE_CHILD = "manage_child"
|
|
SERVICE_REGENERATE = "regenerate"
|
|
|
|
DOMAIN_SERVICES: tuple[str, ...] = (
|
|
SERVICE_COMPLETE_QUEST,
|
|
SERVICE_UNCOMPLETE_QUEST,
|
|
SERVICE_CREATE_QUEST_DEFINITION,
|
|
SERVICE_UPDATE_QUEST_DEFINITION,
|
|
SERVICE_SET_QUEST_DEFINITION_ACTIVE,
|
|
SERVICE_SET_PRESENCE_PATTERN,
|
|
SERVICE_CREATE_PRESENCE_OVERRIDE,
|
|
SERVICE_DELETE_PRESENCE_OVERRIDE,
|
|
SERVICE_EXPORT_HISTORY_CSV,
|
|
SERVICE_MANAGE_CHILD,
|
|
SERVICE_REGENERATE,
|
|
)
|
|
|
|
SQLITE_DB_FILENAME = "nestquest.db"
|
|
|
|
# Configuration keys and default values
|
|
CONF_HORIZON_DAYS = "horizon_days"
|
|
DEFAULT_HORIZON_DAYS = 14
|
|
|
|
CONF_DAY_ROLLOVER_TIME = "day_rollover_time"
|
|
DEFAULT_DAY_ROLLOVER_TIME = "00:00"
|
|
|
|
CONF_PANEL_IDLE_TIMEOUT = "panel_idle_timeout"
|
|
DEFAULT_PANEL_IDLE_TIMEOUT = 300
|
|
|
|
# Admin allowlist (Feature 03): HA user IDs permitted to call admin-only
|
|
# services. Stored as IDs, never usernames (feature guardrail). The
|
|
# database allowlist is authoritative; the config entry carries the same
|
|
# list as a disaster-recovery copy so a lost database can be re-seeded.
|
|
CONF_ADMIN_USER_IDS = "admin_user_ids"
|
|
|
|
# Shared coordinator refresh interval (Feature 10), in SECONDS. Every
|
|
# entity reads one snapshot per refresh; completions push an immediate
|
|
# refresh so this poll is only the fallback cadence.
|
|
CONF_UPDATE_INTERVAL = "update_interval"
|
|
DEFAULT_UPDATE_INTERVAL = 300
|
|
MIN_UPDATE_INTERVAL = 30
|
|
|
|
# Notification automations (Feature 11). The notify target is a free-text
|
|
# Home Assistant service name (e.g. "notify.mobile_app_dads_phone") the
|
|
# household fills in — never a hard-coded personal target; the times are
|
|
# strict HH:MM local; each of the four automations has an independent
|
|
# enable toggle. Per the owner-settled resolution the end-of-day report
|
|
# defaults to 20:00 — deliberately BEFORE the midnight missed sweep —
|
|
# and never defaults to the rollover time.
|
|
CONF_NOTIFY_TARGET = "notify_target"
|
|
CONF_MORNING_SUMMARY_TIME = "morning_summary_time"
|
|
DEFAULT_MORNING_SUMMARY_TIME = "08:00"
|
|
CONF_AFTERNOON_REMINDER_TIME = "afternoon_reminder_time"
|
|
DEFAULT_AFTERNOON_REMINDER_TIME = "15:00"
|
|
CONF_END_OF_DAY_REPORT_TIME = "end_of_day_report_time"
|
|
DEFAULT_END_OF_DAY_REPORT_TIME = "20:00"
|
|
CONF_MORNING_SUMMARY_ENABLED = "morning_summary_enabled"
|
|
CONF_AFTERNOON_REMINDER_ENABLED = "afternoon_reminder_enabled"
|
|
CONF_END_OF_DAY_REPORT_ENABLED = "end_of_day_report_enabled"
|
|
CONF_CELEBRATION_ENABLED = "celebration_enabled"
|
|
DEFAULT_AUTOMATION_ENABLED = True
|
|
|
|
# Panel-plane API client (Feature 18): the integration reaches the
|
|
# NestQuest API service (Feature 16) over HTTP instead of the database.
|
|
# The base URL points at the API service host serving ``/api/v1/panel/*``
|
|
# (uvicorn's default host/port is the sensible starting point); the panel
|
|
# service token is the static Bearer credential the panel plane requires
|
|
# (``NESTQUEST_PANEL_TOKEN`` on the API side). Both are stored on the
|
|
# entry like every other setting — options first, then the entry-data
|
|
# copy, then defaults. The TOKEN IS A SECRET: it is never logged, never
|
|
# echoed into error messages, and never committed. No invented default
|
|
# token ships (an empty stored token means "not configured yet", and the
|
|
# panel plane answers 401 until a real one is saved) — mirroring the API
|
|
# service's fail-closed stance (api/config.py: no default token exists).
|
|
CONF_API_BASE_URL = "api_base_url"
|
|
DEFAULT_API_BASE_URL = "http://127.0.0.1:8000"
|
|
CONF_PANEL_TOKEN = "panel_token"
|
|
DEFAULT_PANEL_TOKEN = ""
|
|
|
|
# Quest windows (D-008): a definition may declare several day windows;
|
|
# each produces its own instance per day and groups the panel's Quest
|
|
# Log into three columns. The clock ranges are stored here so they stay
|
|
# configurable later. Boundaries: a window's end equals the next
|
|
# window's start; classification (Feature 07 materialisation) treats a
|
|
# due time exactly on the boundary as belonging to the LATER window, so
|
|
# 12:00 is afternoon (not morning) and 17:00 is evening (not
|
|
# afternoon). Times after 21:00 belong to no window.
|
|
WINDOW_MORNING = "morning"
|
|
WINDOW_AFTERNOON = "afternoon"
|
|
WINDOW_EVENING = "evening"
|
|
|
|
QUEST_WINDOWS: tuple[str, ...] = (
|
|
WINDOW_MORNING,
|
|
WINDOW_AFTERNOON,
|
|
WINDOW_EVENING,
|
|
)
|
|
|
|
#: Inclusive "HH:MM" bounds per window, in 24-hour local time.
|
|
WINDOW_CLOCK_RANGES: dict[str, tuple[str, str]] = {
|
|
WINDOW_MORNING: ("00:00", "11:59"),
|
|
WINDOW_AFTERNOON: ("12:00", "17:00"),
|
|
WINDOW_EVENING: ("17:00", "21:00"),
|
|
}
|