mirror of
https://github.com/natekspencer/hacs-oasis_mini.git
synced 2025-12-06 18:44:14 -05:00
Swap out direct HTTP connection with server MQTT connection to handle firmware 2.60+ (#98)
* Switch to using mqtt * Better mqtt handling when connection is interrupted * Get track info from the cloud when playlist or index changes * Add additional helpers * Dynamically handle devices and other enhancements * 📝 Add docstrings to `mqtt` Docstrings generation was requested by @natekspencer. * https://github.com/natekspencer/hacs-oasis_mini/pull/98#issuecomment-3568450288 The following files were modified: * `custom_components/oasis_mini/__init__.py` * `custom_components/oasis_mini/binary_sensor.py` * `custom_components/oasis_mini/button.py` * `custom_components/oasis_mini/config_flow.py` * `custom_components/oasis_mini/coordinator.py` * `custom_components/oasis_mini/entity.py` * `custom_components/oasis_mini/helpers.py` * `custom_components/oasis_mini/image.py` * `custom_components/oasis_mini/light.py` * `custom_components/oasis_mini/media_player.py` * `custom_components/oasis_mini/number.py` * `custom_components/oasis_mini/pyoasiscontrol/clients/cloud_client.py` * `custom_components/oasis_mini/pyoasiscontrol/clients/http_client.py` * `custom_components/oasis_mini/pyoasiscontrol/clients/mqtt_client.py` * `custom_components/oasis_mini/pyoasiscontrol/clients/transport.py` * `custom_components/oasis_mini/pyoasiscontrol/device.py` * `custom_components/oasis_mini/pyoasiscontrol/utils.py` * `custom_components/oasis_mini/select.py` * `custom_components/oasis_mini/sensor.py` * `custom_components/oasis_mini/switch.py` * `custom_components/oasis_mini/update.py` * `update_tracks.py` * Fix formatting in transport.py * Replace tabs with spaces * Use tuples instead of sets for descriptors * Encode svg in image entity * Fix iot_class * Fix tracks list url * Ensure update_tracks closes the connection * Fix number typing and docstring * Fix docstring in update_tracks * Cache playlist based on type * Fix formatting in device.py * Add missing async_send_auto_clean_command to http client * Propagate UnauthenticatedError from async_get_track_info * Adjust exceptions * Move create_client outside of try block in config_flow * Formatting * Address PR comments * Formatting * Add noqa: ARG001 on unused hass * Close cloud/MQTT clients if initial coordinator refresh fails. * Address PR again * PR fixes * Pass config entry to coordinator * Remove async_timeout (thanks ChatGPT... not) * Address PR * Replace magic numbers for status code * Update autoplay wording/ordering --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
This commit is contained in:
Nathan Spencer
@@ -0,0 +1,7 @@
|
||||
"""Oasis control clients."""
|
||||
|
||||
from .cloud_client import OasisCloudClient
|
||||
from .http_client import OasisHttpClient
|
||||
from .mqtt_client import OasisMqttClient
|
||||
|
||||
__all__ = ["OasisCloudClient", "OasisHttpClient", "OasisMqttClient"]
|
||||
@@ -0,0 +1,390 @@
|
||||
"""Oasis cloud client."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
from datetime import timedelta
|
||||
import logging
|
||||
from typing import Any
|
||||
from urllib.parse import urljoin
|
||||
|
||||
from aiohttp import ClientResponseError, ClientSession
|
||||
|
||||
from ..exceptions import UnauthenticatedError
|
||||
from ..utils import now
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
BASE_URL = "https://app.grounded.so"
|
||||
PLAYLISTS_REFRESH_LIMITER = timedelta(minutes=5)
|
||||
SOFTWARE_REFRESH_LIMITER = timedelta(hours=1)
|
||||
|
||||
|
||||
class OasisCloudClient:
|
||||
"""Cloud client for Oasis.
|
||||
|
||||
Responsibilities:
|
||||
- Manage aiohttp session (optionally owned)
|
||||
- Manage access token
|
||||
- Provide async_* helpers for:
|
||||
* login/logout
|
||||
* user info
|
||||
* devices
|
||||
* tracks/playlists
|
||||
* latest software metadata
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
*,
|
||||
session: ClientSession | None = None,
|
||||
access_token: str | None = None,
|
||||
) -> None:
|
||||
"""
|
||||
Initialize the OasisCloudClient.
|
||||
|
||||
Sets the optional aiohttp session and access token, records whether the client owns the session, and initializes caches and asyncio locks for playlists and software metadata.
|
||||
|
||||
Parameters:
|
||||
session (ClientSession | None): Optional aiohttp ClientSession to use. If None, the client will create and own a session later.
|
||||
access_token (str | None): Optional initial access token for authenticated requests.
|
||||
"""
|
||||
self._session = session
|
||||
self._owns_session = session is None
|
||||
self._access_token = access_token
|
||||
|
||||
now_dt = now()
|
||||
|
||||
# playlists cache
|
||||
self._playlists_cache: dict[bool, list[dict[str, Any]]] = {False: [], True: []}
|
||||
self._playlists_next_refresh = {False: now_dt, True: now_dt}
|
||||
self._playlists_lock = asyncio.Lock()
|
||||
|
||||
# software metadata cache
|
||||
self._software_details: dict[str, int | str] | None = None
|
||||
self._software_next_refresh = now()
|
||||
self._software_lock = asyncio.Lock()
|
||||
|
||||
@property
|
||||
def playlists(self) -> list[dict]:
|
||||
"""Return all cached playlists, deduplicated by ID."""
|
||||
seen = set()
|
||||
merged: list[dict] = []
|
||||
|
||||
for items in self._playlists_cache.values():
|
||||
for pl in items:
|
||||
if (pid := pl.get("id")) not in seen:
|
||||
seen.add(pid)
|
||||
merged.append(pl)
|
||||
|
||||
return merged
|
||||
|
||||
@property
|
||||
def session(self) -> ClientSession:
|
||||
"""
|
||||
Get the active aiohttp ClientSession, creating and owning a new session if none exists or the existing session is closed.
|
||||
|
||||
Returns:
|
||||
ClientSession: The active aiohttp ClientSession; a new session is created and marked as owned by this client when necessary.
|
||||
"""
|
||||
if self._session is None or self._session.closed:
|
||||
self._session = ClientSession()
|
||||
self._owns_session = True
|
||||
return self._session
|
||||
|
||||
async def async_close(self) -> None:
|
||||
"""
|
||||
Close the aiohttp ClientSession owned by this client if it exists and is open.
|
||||
|
||||
This should be called during teardown when the client is responsible for the session.
|
||||
"""
|
||||
if self._session and not self._session.closed and self._owns_session:
|
||||
await self._session.close()
|
||||
|
||||
@property
|
||||
def access_token(self) -> str | None:
|
||||
"""
|
||||
Access token used for authenticated requests or None if not set.
|
||||
|
||||
Returns:
|
||||
The current access token string, or `None` if no token is stored.
|
||||
"""
|
||||
return self._access_token
|
||||
|
||||
@access_token.setter
|
||||
def access_token(self, value: str | None) -> None:
|
||||
"""
|
||||
Set the access token used for authenticated requests.
|
||||
|
||||
Parameters:
|
||||
value (str | None): The bearer token to store; pass None to clear the stored token.
|
||||
"""
|
||||
self._access_token = value
|
||||
|
||||
async def async_login(self, email: str, password: str) -> None:
|
||||
"""
|
||||
Log in to the Oasis cloud and store the received access token on the client.
|
||||
|
||||
Performs an authentication request using the provided credentials and saves the returned access token to self.access_token for use in subsequent authenticated requests.
|
||||
"""
|
||||
response = await self._async_request(
|
||||
"POST",
|
||||
urljoin(BASE_URL, "api/auth/login"),
|
||||
json={"email": email, "password": password},
|
||||
)
|
||||
token = response.get("access_token") if isinstance(response, dict) else None
|
||||
self.access_token = token
|
||||
_LOGGER.debug("Cloud login succeeded, token set: %s", bool(token))
|
||||
|
||||
async def async_logout(self) -> None:
|
||||
"""
|
||||
End the current authenticated session with the Oasis cloud.
|
||||
|
||||
Performs a logout request and clears the stored access token on success.
|
||||
"""
|
||||
await self._async_auth_request("GET", "api/auth/logout")
|
||||
self.access_token = None
|
||||
|
||||
async def async_get_user(self) -> dict:
|
||||
"""
|
||||
Return information about the currently authenticated user.
|
||||
|
||||
Returns:
|
||||
dict: A mapping containing the user's details as returned by the cloud API.
|
||||
|
||||
Raises:
|
||||
UnauthenticatedError: If no access token is available or the request is unauthorized.
|
||||
"""
|
||||
return await self._async_auth_request("GET", "api/auth/user")
|
||||
|
||||
async def async_get_devices(self) -> list[dict[str, Any]]:
|
||||
"""
|
||||
Retrieve the current user's devices from the cloud API.
|
||||
|
||||
Returns:
|
||||
list[dict[str, Any]]: A list of device objects as returned by the API.
|
||||
"""
|
||||
return await self._async_auth_request("GET", "api/user/devices")
|
||||
|
||||
async def async_get_playlists(
|
||||
self, personal_only: bool = False
|
||||
) -> list[dict[str, Any]]:
|
||||
"""
|
||||
Retrieve playlists from the Oasis cloud, optionally limited to the authenticated user's personal playlists.
|
||||
|
||||
The result is cached and will be refreshed according to PLAYLISTS_REFRESH_LIMITER to avoid frequent network requests.
|
||||
|
||||
Parameters:
|
||||
personal_only (bool): If True, return only playlists owned by the authenticated user; otherwise return all available playlists.
|
||||
|
||||
Returns:
|
||||
list[dict[str, Any]]: A list of playlist objects represented as dictionaries; an empty list if no playlists are available.
|
||||
"""
|
||||
now_dt = now()
|
||||
|
||||
def _is_cache_valid() -> bool:
|
||||
"""
|
||||
Determine whether the playlists cache is still valid.
|
||||
|
||||
Returns:
|
||||
`true` if the playlists cache contains data and the next refresh timestamp is later than the current time, `false` otherwise.
|
||||
"""
|
||||
cache = self._playlists_cache[personal_only]
|
||||
next_refresh = self._playlists_next_refresh[personal_only]
|
||||
return bool(cache) and next_refresh > now_dt
|
||||
|
||||
if _is_cache_valid():
|
||||
return self._playlists_cache[personal_only]
|
||||
|
||||
async with self._playlists_lock:
|
||||
# Double-check in case another task just refreshed it
|
||||
now_dt = now()
|
||||
if _is_cache_valid():
|
||||
return self._playlists_cache[personal_only]
|
||||
|
||||
params = {"my_playlists": str(personal_only).lower()}
|
||||
playlists = await self._async_auth_request(
|
||||
"GET", "api/playlist", params=params
|
||||
)
|
||||
|
||||
if not isinstance(playlists, list):
|
||||
playlists = []
|
||||
|
||||
self._playlists_cache[personal_only] = playlists
|
||||
self._playlists_next_refresh[personal_only] = (
|
||||
now_dt + PLAYLISTS_REFRESH_LIMITER
|
||||
)
|
||||
|
||||
return playlists
|
||||
|
||||
async def async_get_track_info(self, track_id: int) -> dict[str, Any] | None:
|
||||
"""
|
||||
Retrieve information for a single track from the cloud.
|
||||
|
||||
Returns:
|
||||
dict: Track detail dictionary. If the track is not found (HTTP 404), returns a dict with keys `id` and `name` where `name` is "Unknown Title (#{id})". Returns `None` on other failures.
|
||||
"""
|
||||
try:
|
||||
return await self._async_auth_request("GET", f"api/track/{track_id}")
|
||||
except ClientResponseError as err:
|
||||
if err.status == 404:
|
||||
return {"id": track_id, "name": f"Unknown Title (#{track_id})"}
|
||||
raise
|
||||
except UnauthenticatedError:
|
||||
raise
|
||||
except Exception:
|
||||
_LOGGER.exception("Error fetching track %s", track_id)
|
||||
return None
|
||||
|
||||
async def async_get_tracks(
|
||||
self, tracks: list[int] | None = None
|
||||
) -> list[dict[str, Any]]:
|
||||
"""
|
||||
Retrieve track details for the given track IDs, following pagination until all pages are fetched.
|
||||
|
||||
Parameters:
|
||||
tracks (list[int] | None): Optional list of track IDs to request. If omitted or None, an empty list is sent to the API.
|
||||
|
||||
Returns:
|
||||
list[dict[str, Any]]: A list of track detail dictionaries returned by the cloud, aggregated across all pages (may be empty).
|
||||
"""
|
||||
response = await self._async_auth_request(
|
||||
"GET",
|
||||
"api/track",
|
||||
params={"ids[]": tracks or []},
|
||||
)
|
||||
if not response:
|
||||
return []
|
||||
track_details = response.get("data", [])
|
||||
while next_page_url := response.get("next_page_url"):
|
||||
response = await self._async_auth_request("GET", next_page_url)
|
||||
track_details += response.get("data", [])
|
||||
return track_details
|
||||
|
||||
async def async_get_latest_software_details(
|
||||
self, *, force_refresh: bool = False
|
||||
) -> dict[str, int | str] | None:
|
||||
"""
|
||||
Retrieve the latest software metadata from the cloud, using an internal cache to limit requests.
|
||||
|
||||
Parameters:
|
||||
force_refresh (bool): If True, bypass the cache and fetch fresh metadata from the cloud.
|
||||
|
||||
Returns:
|
||||
details (dict[str, int | str] | None): A mapping of software metadata keys to integer or string values, or `None` if no metadata is available.
|
||||
"""
|
||||
now_dt = now()
|
||||
|
||||
def _is_cache_valid() -> bool:
|
||||
"""
|
||||
Determine whether the cached software metadata should be used instead of fetching fresh data.
|
||||
|
||||
Returns:
|
||||
True if the software cache exists, has not expired, and a force refresh was not requested; False otherwise.
|
||||
"""
|
||||
return (
|
||||
not force_refresh
|
||||
and self._software_details is not None
|
||||
and self._software_next_refresh > now_dt
|
||||
)
|
||||
|
||||
if _is_cache_valid():
|
||||
return self._software_details
|
||||
|
||||
async with self._software_lock:
|
||||
# Double-check in case another task just refreshed it
|
||||
now_dt = now()
|
||||
if _is_cache_valid():
|
||||
return self._software_details
|
||||
|
||||
details = await self._async_auth_request("GET", "api/software/last-version")
|
||||
|
||||
if not isinstance(details, dict):
|
||||
details = {}
|
||||
|
||||
self._software_details = details
|
||||
self._software_next_refresh = now_dt + SOFTWARE_REFRESH_LIMITER
|
||||
|
||||
return self._software_details
|
||||
|
||||
async def _async_auth_request(self, method: str, url: str, **kwargs: Any) -> Any:
|
||||
"""
|
||||
Perform a cloud API request using the stored access token.
|
||||
|
||||
If `url` is relative it will be joined with the module `BASE_URL`. The method will
|
||||
inject an `Authorization: Bearer <token>` header into the request.
|
||||
|
||||
Parameters:
|
||||
method (str): HTTP method (e.g., "GET", "POST").
|
||||
url (str): Absolute URL or path relative to `BASE_URL`.
|
||||
**kwargs: Passed through to the underlying request helper.
|
||||
|
||||
Returns:
|
||||
The parsed response value (JSON object, text, or None) as returned by the underlying request helper.
|
||||
|
||||
Raises:
|
||||
UnauthenticatedError: If no access token is set.
|
||||
"""
|
||||
if not self.access_token:
|
||||
raise UnauthenticatedError("Unauthenticated")
|
||||
|
||||
headers = kwargs.pop("headers", {}) or {}
|
||||
headers["Authorization"] = f"Bearer {self.access_token}"
|
||||
|
||||
return await self._async_request(
|
||||
method,
|
||||
url if url.startswith("http") else urljoin(BASE_URL, url),
|
||||
headers=headers,
|
||||
**kwargs,
|
||||
)
|
||||
|
||||
async def _async_request(self, method: str, url: str, **kwargs: Any) -> Any:
|
||||
"""
|
||||
Perform a single HTTP request and return a normalized response value.
|
||||
|
||||
Performs the request using the client's session and:
|
||||
- If the response status is 200:
|
||||
- returns parsed JSON for `application/json`.
|
||||
- returns text for `text/plain`.
|
||||
- if `text/html` and the URL targets the cloud base URL and contains a login page, raises UnauthenticatedError.
|
||||
- returns `None` for other content types.
|
||||
- If the response status is 401, raises UnauthenticatedError.
|
||||
- For other non-200 statuses, re-raises the response's HTTP error.
|
||||
|
||||
Parameters:
|
||||
method: HTTP method to use (e.g., "GET", "POST").
|
||||
url: Request URL or path.
|
||||
**kwargs: Passed through to the session request (e.g., `params`, `json`, `headers`).
|
||||
|
||||
Returns:
|
||||
The parsed JSON object, response text, or `None` depending on the response content type.
|
||||
|
||||
Raises:
|
||||
UnauthenticatedError: when the server indicates the client is unauthenticated (401) or a cloud login page is returned.
|
||||
aiohttp.ClientResponseError: for other non-success HTTP statuses raised by `response.raise_for_status()`.
|
||||
"""
|
||||
session = self.session
|
||||
_LOGGER.debug(
|
||||
"%s %s",
|
||||
method,
|
||||
session._build_url(url).update_query( # pylint: disable=protected-access
|
||||
kwargs.get("params"),
|
||||
),
|
||||
)
|
||||
response = await session.request(method, url, **kwargs)
|
||||
|
||||
if response.status == 200:
|
||||
if response.content_type == "application/json":
|
||||
return await response.json()
|
||||
if response.content_type == "text/plain":
|
||||
return await response.text()
|
||||
if response.content_type == "text/html" and BASE_URL in url:
|
||||
text = await response.text()
|
||||
if "login-page" in text:
|
||||
raise UnauthenticatedError("Unauthenticated")
|
||||
return None
|
||||
|
||||
if response.status == 401:
|
||||
raise UnauthenticatedError("Unauthenticated")
|
||||
|
||||
response.raise_for_status()
|
||||
@@ -0,0 +1,349 @@
|
||||
"""Oasis HTTP client (per-device)."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import logging
|
||||
from typing import Any
|
||||
|
||||
from aiohttp import ClientSession
|
||||
|
||||
from ..device import OasisDevice
|
||||
from .transport import OasisClientProtocol
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class OasisHttpClient(OasisClientProtocol):
|
||||
"""HTTP-based Oasis transport.
|
||||
|
||||
This client is typically used per-device (per host/IP).
|
||||
It implements the OasisClientProtocol so OasisDevice can delegate
|
||||
all commands through it.
|
||||
"""
|
||||
|
||||
def __init__(self, host: str, session: ClientSession | None = None) -> None:
|
||||
"""
|
||||
Initialize the HTTP client for a specific device host.
|
||||
|
||||
Parameters:
|
||||
host (str): Hostname or IP address of the target device (used to build the base HTTP URL).
|
||||
session (ClientSession | None): Optional aiohttp ClientSession to reuse for requests. If omitted, a new session will be created and owned by this client.
|
||||
"""
|
||||
self._host = host
|
||||
self._session: ClientSession | None = session
|
||||
self._owns_session: bool = session is None
|
||||
|
||||
@property
|
||||
def session(self) -> ClientSession:
|
||||
"""
|
||||
Ensure and return a usable aiohttp ClientSession for this client.
|
||||
|
||||
If no session exists or the existing session is closed, a new ClientSession is created and the client records ownership of that session so it can be closed later.
|
||||
|
||||
Returns:
|
||||
An active aiohttp ClientSession instance associated with this client.
|
||||
"""
|
||||
if self._session is None or self._session.closed:
|
||||
self._session = ClientSession()
|
||||
self._owns_session = True
|
||||
return self._session
|
||||
|
||||
async def async_close(self) -> None:
|
||||
"""
|
||||
Close the client's owned HTTP session if one exists and is open.
|
||||
|
||||
Does nothing when there is no session, the session is already closed, or the client does not own the session.
|
||||
"""
|
||||
if self._session and not self._session.closed and self._owns_session:
|
||||
await self._session.close()
|
||||
|
||||
@property
|
||||
def url(self) -> str:
|
||||
# These devices are plain HTTP, no TLS
|
||||
"""
|
||||
Base HTTP URL for the target device.
|
||||
|
||||
Returns:
|
||||
The device base URL using plain HTTP (no TLS), including a trailing slash (e.g. "http://{host}/").
|
||||
"""
|
||||
return f"http://{self._host}/"
|
||||
|
||||
async def _async_request(self, method: str, url: str, **kwargs: Any) -> Any:
|
||||
"""
|
||||
Perform an HTTP request using the client's session and decode the response.
|
||||
|
||||
Logs the request URL and query parameters. If the response status is 200, returns the response body as a string for `text/plain`, the parsed JSON for `application/json`, or `None` for other content types. On non-200 responses, raises the client response error.
|
||||
|
||||
Returns:
|
||||
The response body as `str` for `text/plain`, the parsed JSON value for `application/json`, or `None` for other content types.
|
||||
|
||||
Raises:
|
||||
aiohttp.ClientResponseError: If the response status is not 200.
|
||||
"""
|
||||
session = self.session
|
||||
_LOGGER.debug(
|
||||
"%s %s",
|
||||
method,
|
||||
session._build_url(url).update_query( # pylint: disable=protected-access
|
||||
kwargs.get("params"),
|
||||
),
|
||||
)
|
||||
resp = await session.request(method, url, **kwargs)
|
||||
|
||||
if resp.status == 200:
|
||||
if resp.content_type == "text/plain":
|
||||
return await resp.text()
|
||||
if resp.content_type == "application/json":
|
||||
return await resp.json()
|
||||
return None
|
||||
|
||||
resp.raise_for_status()
|
||||
|
||||
async def _async_get(self, **kwargs: Any) -> str | None:
|
||||
"""
|
||||
Perform a GET request to the client's base URL using the provided request keyword arguments.
|
||||
|
||||
Parameters:
|
||||
**kwargs: Additional request keyword arguments forwarded to the underlying request (for example `params`, `headers`, `timeout`).
|
||||
|
||||
Returns:
|
||||
`str` response text when the server responds with `text/plain`, `None` otherwise.
|
||||
"""
|
||||
return await self._async_request("GET", self.url, **kwargs)
|
||||
|
||||
async def _async_command(self, **kwargs: Any) -> str | None:
|
||||
"""
|
||||
Execute a device command by issuing a GET request with the provided query parameters and return the parsed response.
|
||||
|
||||
Parameters:
|
||||
**kwargs: Mapping of query parameter names to values sent with the GET request.
|
||||
|
||||
Returns:
|
||||
str | None: The device response as a string, a parsed JSON value, or None when the response has an unsupported content type.
|
||||
"""
|
||||
result = await self._async_get(**kwargs)
|
||||
_LOGGER.debug("Result: %s", result)
|
||||
return result
|
||||
|
||||
async def async_get_mac_address(self, device: OasisDevice) -> str | None:
|
||||
"""
|
||||
Fetch the device MAC address using the device's HTTP GETMAC endpoint.
|
||||
|
||||
Returns:
|
||||
str: The MAC address with surrounding whitespace removed, or `None` if it could not be retrieved.
|
||||
"""
|
||||
try:
|
||||
mac = await self._async_get(params={"GETMAC": ""})
|
||||
if isinstance(mac, str):
|
||||
return mac.strip()
|
||||
except Exception:
|
||||
_LOGGER.exception(
|
||||
"Failed to get MAC address via HTTP for %s", device.serial_number
|
||||
)
|
||||
return None
|
||||
|
||||
async def async_send_auto_clean_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
auto_clean: bool,
|
||||
) -> None:
|
||||
"""
|
||||
Enable or disable the device's auto-clean mode.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): The target Oasis device to send the command to.
|
||||
auto_clean (bool): `True` to enable auto-clean mode, `False` to disable it.
|
||||
"""
|
||||
await self._async_command(
|
||||
params={"WRIAUTOCLEAN": 1 if auto_clean else 0},
|
||||
)
|
||||
|
||||
async def async_send_ball_speed_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
speed: int,
|
||||
) -> None:
|
||||
"""
|
||||
Send a ball speed command to the specified device.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target device for the command.
|
||||
speed (int): Speed value to set for the device's ball mechanism.
|
||||
"""
|
||||
await self._async_command(params={"WRIOASISSPEED": speed})
|
||||
|
||||
async def async_send_led_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
led_effect: str,
|
||||
color: str,
|
||||
led_speed: int,
|
||||
brightness: int,
|
||||
) -> None:
|
||||
"""
|
||||
Send an LED control command to the device.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target device to receive the command.
|
||||
led_effect (str): Effect name or identifier to apply to the LEDs.
|
||||
color (str): Color value recognized by the device (e.g., hex code or device color name).
|
||||
led_speed (int): Animation speed value; larger values increase animation speed.
|
||||
brightness (int): Brightness level for the LEDs.
|
||||
"""
|
||||
payload = f"{led_effect};0;{color};{led_speed};{brightness}"
|
||||
await self._async_command(params={"WRILED": payload})
|
||||
|
||||
async def async_send_sleep_command(self, device: OasisDevice) -> None:
|
||||
"""
|
||||
Send a sleep command to the device.
|
||||
|
||||
Requests the device to enter sleep mode.
|
||||
"""
|
||||
await self._async_command(params={"CMDSLEEP": ""})
|
||||
|
||||
async def async_send_move_job_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
from_index: int,
|
||||
to_index: int,
|
||||
) -> None:
|
||||
"""
|
||||
Move a job in the device's playlist from one index to another.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target device whose job list will be modified.
|
||||
from_index (int): Zero-based index of the job to move.
|
||||
to_index (int): Zero-based destination index where the job will be placed.
|
||||
"""
|
||||
await self._async_command(params={"MOVEJOB": f"{from_index};{to_index}"})
|
||||
|
||||
async def async_send_change_track_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
index: int,
|
||||
) -> None:
|
||||
"""
|
||||
Change the device's current track to the specified track index.
|
||||
|
||||
Parameters:
|
||||
index (int): Zero-based index of the track to select.
|
||||
"""
|
||||
await self._async_command(params={"CMDCHANGETRACK": index})
|
||||
|
||||
async def async_send_add_joblist_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
tracks: list[int],
|
||||
) -> None:
|
||||
# The old code passed the list directly; if the device expects CSV:
|
||||
"""
|
||||
Send an "add joblist" command to the device with a list of track indices.
|
||||
|
||||
The provided track indices are serialized as a comma-separated string and sent to the device using the `ADDJOBLIST` parameter.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target device to receive the command.
|
||||
tracks (list[int]): Track indices to add; these are sent as a CSV string (e.g., [1,2,3] -> "1,2,3").
|
||||
"""
|
||||
await self._async_command(params={"ADDJOBLIST": ",".join(map(str, tracks))})
|
||||
|
||||
async def async_send_set_playlist_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
playlist: list[int],
|
||||
) -> None:
|
||||
"""
|
||||
Set the device's playlist on the target device and optimistically update the local device state.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target device to receive the playlist command; its state will be updated optimistically.
|
||||
playlist (list[int]): Ordered list of track indices to set as the device's playlist.
|
||||
"""
|
||||
await self._async_command(params={"WRIJOBLIST": ",".join(map(str, playlist))})
|
||||
# optional: optimistic state update
|
||||
device.update_from_status_dict({"playlist": playlist})
|
||||
|
||||
async def async_send_set_repeat_playlist_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
repeat: bool,
|
||||
) -> None:
|
||||
"""
|
||||
Set the device's playlist repeat flag.
|
||||
|
||||
Parameters:
|
||||
repeat (bool): `True` to enable playlist repeat, `False` to disable it.
|
||||
"""
|
||||
await self._async_command(params={"WRIREPEATJOB": 1 if repeat else 0})
|
||||
|
||||
async def async_send_set_autoplay_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
option: str,
|
||||
) -> None:
|
||||
"""
|
||||
Set the device's autoplay (wait-after) option.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target device whose autoplay option will be updated.
|
||||
option (str): The value for the device's wait-after/autoplay setting as expected by the device firmware.
|
||||
"""
|
||||
await self._async_command(params={"WRIWAITAFTER": option})
|
||||
|
||||
async def async_send_upgrade_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
beta: bool,
|
||||
) -> None:
|
||||
"""
|
||||
Send a firmware upgrade command to the specified device.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target device to receive the upgrade command.
|
||||
beta (bool): If True, request the beta firmware; if False, request the stable firmware.
|
||||
"""
|
||||
await self._async_command(params={"CMDUPGRADE": 1 if beta else 0})
|
||||
|
||||
async def async_send_play_command(self, device: OasisDevice) -> None:
|
||||
"""
|
||||
Send the play command to the device.
|
||||
"""
|
||||
await self._async_command(params={"CMDPLAY": ""})
|
||||
|
||||
async def async_send_pause_command(self, device: OasisDevice) -> None:
|
||||
"""
|
||||
Send a pause command to the device.
|
||||
"""
|
||||
await self._async_command(params={"CMDPAUSE": ""})
|
||||
|
||||
async def async_send_stop_command(self, device: OasisDevice) -> None:
|
||||
"""
|
||||
Sends the device stop command to halt playback or activity.
|
||||
|
||||
Sends an HTTP command to request the device stop its current operation.
|
||||
"""
|
||||
await self._async_command(params={"CMDSTOP": ""})
|
||||
|
||||
async def async_send_reboot_command(self, device: OasisDevice) -> None:
|
||||
"""
|
||||
Send a reboot command to the device.
|
||||
|
||||
Sends a reboot request to the target device using the CMDBOOT control parameter.
|
||||
"""
|
||||
await self._async_command(params={"CMDBOOT": ""})
|
||||
|
||||
async def async_get_status(self, device: OasisDevice) -> None:
|
||||
"""
|
||||
Retrieve the device status from the device and apply it to the given OasisDevice.
|
||||
|
||||
If the device does not return a status, the device object is not modified.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Device instance to update with the fetched status.
|
||||
"""
|
||||
raw_status = await self._async_get(params={"GETSTATUS": ""})
|
||||
if raw_status is None:
|
||||
return
|
||||
|
||||
_LOGGER.debug("Status for %s: %s", device.serial_number, raw_status)
|
||||
device.update_from_status_string(raw_status)
|
||||
@@ -0,0 +1,834 @@
|
||||
"""Oasis MQTT client (multi-device)."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
import base64
|
||||
from datetime import UTC, datetime
|
||||
import logging
|
||||
import ssl
|
||||
from typing import Any, Final, Iterable
|
||||
|
||||
import aiomqtt
|
||||
|
||||
from ..device import OasisDevice
|
||||
from ..utils import _bit_to_bool, _parse_int
|
||||
from .transport import OasisClientProtocol
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
# mqtt connection parameters
|
||||
HOST: Final = "mqtt.grounded.so"
|
||||
PORT: Final = 8084
|
||||
PATH: Final = "mqtt"
|
||||
USERNAME: Final = "YXBw"
|
||||
PASSWORD: Final = "RWdETFlKMDczfi4t"
|
||||
RECONNECT_INTERVAL: Final = 4
|
||||
|
||||
# Command queue behaviour
|
||||
MAX_PENDING_COMMANDS: Final = 10
|
||||
|
||||
|
||||
class OasisMqttClient(OasisClientProtocol):
|
||||
"""MQTT-based Oasis transport using WSS.
|
||||
|
||||
Responsibilities:
|
||||
- Maintain a single MQTT connection to:
|
||||
wss://mqtt.grounded.so:8084/mqtt
|
||||
- Subscribe only to <serial>/STATUS/# for devices it knows about.
|
||||
- Publish commands to <serial>/COMMAND/CMD
|
||||
- Map MQTT payloads to OasisDevice.update_from_status_dict()
|
||||
"""
|
||||
|
||||
def __init__(self) -> None:
|
||||
# MQTT connection state
|
||||
"""
|
||||
Initialize internal state for the MQTT transport client.
|
||||
|
||||
Sets up connection state, per-device registries and events, subscription bookkeeping, and a bounded pending command queue capped by MAX_PENDING_COMMANDS.
|
||||
|
||||
Attributes:
|
||||
_client: Active aiomqtt client or None.
|
||||
_loop_task: Background MQTT loop task or None.
|
||||
_connected_at: Timestamp of last successful connection or None.
|
||||
_connected_event: Event signaled when a connection is established.
|
||||
_stop_event: Event signaled to request the loop to stop.
|
||||
_devices: Mapping of device serial to OasisDevice instances.
|
||||
_first_status_events: Per-serial events signaled on receiving the first STATUS message.
|
||||
_mac_events: Per-serial events signaled when a device MAC address is received.
|
||||
_subscribed_serials: Set of serials currently subscribed to STATUS topics.
|
||||
_subscription_lock: Lock protecting subscribe/unsubscribe operations.
|
||||
_command_queue: Bounded queue of pending (serial, payload) commands.
|
||||
"""
|
||||
self._client: aiomqtt.Client | None = None
|
||||
self._loop_task: asyncio.Task | None = None
|
||||
self._connected_at: datetime | None = None
|
||||
|
||||
self._connected_event: asyncio.Event = asyncio.Event()
|
||||
self._stop_event: asyncio.Event = asyncio.Event()
|
||||
|
||||
# Known devices by serial
|
||||
self._devices: dict[str, OasisDevice] = {}
|
||||
|
||||
# Per-device events
|
||||
self._first_status_events: dict[str, asyncio.Event] = {}
|
||||
self._mac_events: dict[str, asyncio.Event] = {}
|
||||
|
||||
# Subscription bookkeeping
|
||||
self._subscribed_serials: set[str] = set()
|
||||
self._subscription_lock = asyncio.Lock()
|
||||
|
||||
# Pending command queue: (serial, payload)
|
||||
self._command_queue: asyncio.Queue[tuple[str, str]] = asyncio.Queue(
|
||||
maxsize=MAX_PENDING_COMMANDS
|
||||
)
|
||||
|
||||
def register_device(self, device: OasisDevice) -> None:
|
||||
"""
|
||||
Register an OasisDevice so MQTT messages for its serial are routed to that device.
|
||||
|
||||
Ensures the device has a serial_number (raises ValueError if not), stores the device in the client's registry, creates per-device asyncio.Events for first-status and MAC-address arrival, attaches this client to the device if it has no client, and schedules a subscription for the device's STATUS topics if the MQTT client is currently connected.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): The device instance to register.
|
||||
|
||||
Raises:
|
||||
ValueError: If `device.serial_number` is not set.
|
||||
"""
|
||||
if not device.serial_number:
|
||||
raise ValueError("Device must have serial_number set before registration")
|
||||
|
||||
serial = device.serial_number
|
||||
self._devices[serial] = device
|
||||
|
||||
# Ensure we have per-device events
|
||||
self._first_status_events.setdefault(serial, asyncio.Event())
|
||||
self._mac_events.setdefault(serial, asyncio.Event())
|
||||
|
||||
# Attach ourselves as the client if the device doesn't already have one
|
||||
if not device.client:
|
||||
device.attach_client(self)
|
||||
|
||||
# If we're already connected, subscribe to this device's topics
|
||||
if self._client is not None:
|
||||
try:
|
||||
loop = asyncio.get_running_loop()
|
||||
loop.create_task(self._subscribe_serial(serial))
|
||||
except RuntimeError:
|
||||
# No running loop (unlikely in HA), so just log
|
||||
_LOGGER.debug(
|
||||
"Could not schedule subscription for %s (no running loop)", serial
|
||||
)
|
||||
|
||||
def register_devices(self, devices: Iterable[OasisDevice]) -> None:
|
||||
"""
|
||||
Register multiple OasisDevice instances with the client.
|
||||
|
||||
Parameters:
|
||||
devices (Iterable[OasisDevice]): Iterable of devices to register.
|
||||
"""
|
||||
for device in devices:
|
||||
self.register_device(device)
|
||||
|
||||
def unregister_device(self, device: OasisDevice) -> None:
|
||||
"""
|
||||
Unregisters a device from MQTT routing and cleans up related per-device state.
|
||||
|
||||
Removes the device's registration, first-status and MAC events. If there is an active MQTT client and the device's serial is currently subscribed, schedules an asynchronous unsubscription task. If the device has no serial_number, the call is a no-op.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): The device to unregister; must have `serial_number` set.
|
||||
"""
|
||||
serial = device.serial_number
|
||||
if not serial:
|
||||
return
|
||||
|
||||
self._devices.pop(serial, None)
|
||||
self._first_status_events.pop(serial, None)
|
||||
self._mac_events.pop(serial, None)
|
||||
|
||||
# If connected and we were subscribed, unsubscribe
|
||||
if self._client is not None and serial in self._subscribed_serials:
|
||||
try:
|
||||
loop = asyncio.get_running_loop()
|
||||
loop.create_task(self._unsubscribe_serial(serial))
|
||||
except RuntimeError:
|
||||
_LOGGER.debug(
|
||||
"Could not schedule unsubscription for %s (no running loop)",
|
||||
serial,
|
||||
)
|
||||
|
||||
async def _subscribe_serial(self, serial: str) -> None:
|
||||
"""
|
||||
Subscribe to the device's STATUS topic pattern and mark the device as subscribed.
|
||||
|
||||
Subscribes to "<serial>/STATUS/#" with QoS 1 and records the subscription; does nothing if the MQTT client is not connected or the serial is already subscribed.
|
||||
"""
|
||||
if not self._client:
|
||||
return
|
||||
|
||||
async with self._subscription_lock:
|
||||
if not self._client or serial in self._subscribed_serials:
|
||||
return
|
||||
|
||||
topic = f"{serial}/STATUS/#"
|
||||
await self._client.subscribe([(topic, 1)])
|
||||
self._subscribed_serials.add(serial)
|
||||
_LOGGER.info("Subscribed to %s", topic)
|
||||
|
||||
async def _unsubscribe_serial(self, serial: str) -> None:
|
||||
"""
|
||||
Unsubscribe from the device's STATUS topic and update subscription state.
|
||||
|
||||
If there is no active MQTT client or the serial is not currently subscribed, this is a no-op.
|
||||
Parameters:
|
||||
serial (str): Device serial used to build the topic "<serial>/STATUS/#".
|
||||
"""
|
||||
if not self._client:
|
||||
return
|
||||
|
||||
async with self._subscription_lock:
|
||||
if not self._client or serial not in self._subscribed_serials:
|
||||
return
|
||||
|
||||
topic = f"{serial}/STATUS/#"
|
||||
await self._client.unsubscribe(topic)
|
||||
self._subscribed_serials.discard(serial)
|
||||
_LOGGER.info("Unsubscribed from %s", topic)
|
||||
|
||||
async def _resubscribe_all(self) -> None:
|
||||
"""Resubscribe to all known devices after (re)connect."""
|
||||
self._subscribed_serials.clear()
|
||||
for serial, device in self._devices.items():
|
||||
await self._subscribe_serial(serial)
|
||||
await self.async_get_all(device)
|
||||
|
||||
def start(self) -> None:
|
||||
"""Start MQTT connection loop."""
|
||||
if self._loop_task is None or self._loop_task.done():
|
||||
self._stop_event.clear()
|
||||
loop = asyncio.get_running_loop()
|
||||
self._loop_task = loop.create_task(self._mqtt_loop())
|
||||
|
||||
async def async_close(self) -> None:
|
||||
"""Close connection loop and MQTT client."""
|
||||
await self.stop()
|
||||
|
||||
async def stop(self) -> None:
|
||||
"""
|
||||
Stop the MQTT client and clean up resources.
|
||||
|
||||
Signals the background MQTT loop to stop, cancels the loop task, disconnects the MQTT client if connected, and clears any pending commands from the internal command queue.
|
||||
"""
|
||||
self._stop_event.set()
|
||||
|
||||
if self._loop_task:
|
||||
self._loop_task.cancel()
|
||||
try:
|
||||
await self._loop_task
|
||||
except asyncio.CancelledError:
|
||||
pass
|
||||
|
||||
if self._client:
|
||||
try:
|
||||
await self._client.disconnect()
|
||||
except Exception:
|
||||
_LOGGER.exception("Error disconnecting MQTT client")
|
||||
finally:
|
||||
self._client = None
|
||||
|
||||
# Drop pending commands on stop
|
||||
while not self._command_queue.empty():
|
||||
try:
|
||||
self._command_queue.get_nowait()
|
||||
self._command_queue.task_done()
|
||||
except asyncio.QueueEmpty:
|
||||
break
|
||||
|
||||
async def wait_until_ready(
|
||||
self, device: OasisDevice, timeout: float = 10.0, request_status: bool = True
|
||||
) -> bool:
|
||||
"""
|
||||
Block until the MQTT client is connected and the device has emitted at least one STATUS message.
|
||||
|
||||
If `request_status` is True, a status request is sent after the client is connected to prompt the device to report its state.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): The device to wait for; must have `serial_number` set.
|
||||
timeout (float): Maximum seconds to wait for connection and for the first STATUS message.
|
||||
request_status (bool): If True, issue a status refresh after connection to encourage a STATUS update.
|
||||
|
||||
Returns:
|
||||
bool: `True` if the device's first STATUS message was observed within the timeout, `False` otherwise.
|
||||
|
||||
Raises:
|
||||
RuntimeError: If the provided device does not have a `serial_number`.
|
||||
"""
|
||||
serial = device.serial_number
|
||||
if not serial:
|
||||
raise RuntimeError("Device has no serial_number set")
|
||||
|
||||
first_status_event = self._first_status_events.setdefault(
|
||||
serial, asyncio.Event()
|
||||
)
|
||||
|
||||
# Wait for MQTT connection
|
||||
try:
|
||||
await asyncio.wait_for(self._connected_event.wait(), timeout=timeout)
|
||||
except asyncio.TimeoutError:
|
||||
_LOGGER.debug(
|
||||
"Timeout (%.1fs) waiting for MQTT connection (device %s)",
|
||||
timeout,
|
||||
serial,
|
||||
)
|
||||
return False
|
||||
|
||||
# Optionally request a status refresh
|
||||
if request_status:
|
||||
try:
|
||||
first_status_event.clear()
|
||||
await self.async_get_status(device)
|
||||
except Exception: # noqa: BLE001
|
||||
_LOGGER.debug(
|
||||
"Could not request status for %s (not fully connected yet?)",
|
||||
serial,
|
||||
)
|
||||
|
||||
# Wait for first status
|
||||
try:
|
||||
await asyncio.wait_for(first_status_event.wait(), timeout=timeout)
|
||||
return True
|
||||
except asyncio.TimeoutError:
|
||||
_LOGGER.debug(
|
||||
"Timeout (%.1fs) waiting for first STATUS message from %s",
|
||||
timeout,
|
||||
serial,
|
||||
)
|
||||
return False
|
||||
|
||||
async def async_get_mac_address(self, device: OasisDevice) -> str | None:
|
||||
"""
|
||||
Request a device's MAC address via an MQTT STATUS refresh and return it if available.
|
||||
|
||||
If the device already has a MAC address, it is returned immediately. Otherwise the function requests a status update (which causes the device to publish MAC_ADDRESS) and waits up to 3 seconds for the MAC to arrive.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): The device whose MAC address will be requested.
|
||||
|
||||
Returns:
|
||||
str | None: The device MAC address if obtained, `None` if the wait timed out and no MAC was received.
|
||||
|
||||
Raises:
|
||||
RuntimeError: If the provided device has no serial_number set.
|
||||
"""
|
||||
# If already known on the device, return it
|
||||
if device.mac_address:
|
||||
return device.mac_address
|
||||
|
||||
serial = device.serial_number
|
||||
if not serial:
|
||||
raise RuntimeError("Device has no serial_number set")
|
||||
|
||||
mac_event = self._mac_events.setdefault(serial, asyncio.Event())
|
||||
mac_event.clear()
|
||||
|
||||
# Ask device to refresh status (including MAC_ADDRESS)
|
||||
await self.async_get_status(device)
|
||||
|
||||
try:
|
||||
await asyncio.wait_for(mac_event.wait(), timeout=3.0)
|
||||
except asyncio.TimeoutError:
|
||||
_LOGGER.debug("Timed out waiting for MAC_ADDRESS for %s", serial)
|
||||
|
||||
return device.mac_address
|
||||
|
||||
async def async_send_auto_clean_command(
|
||||
self, device: OasisDevice, auto_clean: bool
|
||||
) -> None:
|
||||
"""
|
||||
Set the device's automatic cleaning mode.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target Oasis device to send the command to.
|
||||
auto_clean (bool): True to enable automatic cleaning, False to disable.
|
||||
"""
|
||||
payload = f"WRIAUTOCLEAN={1 if auto_clean else 0}"
|
||||
await self._publish_command(device, payload)
|
||||
|
||||
async def async_send_ball_speed_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
speed: int,
|
||||
) -> None:
|
||||
"""
|
||||
Set the device's ball speed.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target device.
|
||||
speed (int): Speed value to apply.
|
||||
"""
|
||||
payload = f"WRIOASISSPEED={speed}"
|
||||
await self._publish_command(device, payload)
|
||||
|
||||
async def async_send_led_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
led_effect: str,
|
||||
color: str,
|
||||
led_speed: int,
|
||||
brightness: int,
|
||||
) -> None:
|
||||
"""
|
||||
Send an LED configuration command to the device.
|
||||
|
||||
If `brightness` is greater than zero, the device is woken before sending the command.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target device (must have a serial number).
|
||||
led_effect (str): LED effect identifier to apply.
|
||||
color (str): Color value for the LED effect (format expected by device).
|
||||
led_speed (int): Speed/tempo for the LED effect.
|
||||
brightness (int): Brightness level to set; also used to determine wake behavior.
|
||||
"""
|
||||
payload = f"WRILED={led_effect};0;{color};{led_speed};{brightness}"
|
||||
await self._publish_command(device, payload, bool(brightness))
|
||||
|
||||
async def async_send_sleep_command(self, device: OasisDevice) -> None:
|
||||
"""
|
||||
Send the sleep command to the specified Oasis device.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target device; must have a valid serial_number. If the MQTT client is not connected, the command may be queued for delivery when a connection is available.
|
||||
"""
|
||||
await self._publish_command(device, "CMDSLEEP")
|
||||
|
||||
async def async_send_move_job_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
from_index: int,
|
||||
to_index: int,
|
||||
) -> None:
|
||||
"""
|
||||
Move a job in the device's playlist from one index to another.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target device to receive the command.
|
||||
from_index (int): Source index of the job in the playlist.
|
||||
to_index (int): Destination index where the job should be placed.
|
||||
"""
|
||||
payload = f"MOVEJOB={from_index};{to_index}"
|
||||
await self._publish_command(device, payload)
|
||||
|
||||
async def async_send_change_track_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
index: int,
|
||||
) -> None:
|
||||
"""
|
||||
Change the device's current track to the specified track index.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target Oasis device.
|
||||
index (int): Track index to switch to (zero-based).
|
||||
"""
|
||||
payload = f"CMDCHANGETRACK={index}"
|
||||
await self._publish_command(device, payload)
|
||||
|
||||
async def async_send_add_joblist_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
tracks: list[int],
|
||||
) -> None:
|
||||
"""
|
||||
Send an ADDJOBLIST command to add multiple tracks to the device's job list.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target device to receive the command.
|
||||
tracks (list[int]): List of track indices to add; elements will be joined as a comma-separated list in the command payload.
|
||||
"""
|
||||
track_str = ",".join(map(str, tracks))
|
||||
payload = f"ADDJOBLIST={track_str}"
|
||||
await self._publish_command(device, payload)
|
||||
|
||||
async def async_send_set_playlist_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
playlist: list[int],
|
||||
) -> None:
|
||||
"""
|
||||
Set the device's playlist to the specified ordered list of track indices.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target Oasis device to receive the playlist command.
|
||||
playlist (list[int]): Ordered list of track indices to apply as the device's playlist.
|
||||
"""
|
||||
track_str = ",".join(map(str, playlist))
|
||||
payload = f"WRIJOBLIST={track_str}"
|
||||
await self._publish_command(device, payload)
|
||||
|
||||
async def async_send_set_repeat_playlist_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
repeat: bool,
|
||||
) -> None:
|
||||
"""
|
||||
Send a command to enable or disable repeating the device's playlist.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target device; must have a serial number.
|
||||
repeat (bool): True to enable playlist repeat, False to disable it.
|
||||
"""
|
||||
payload = f"WRIREPEATJOB={1 if repeat else 0}"
|
||||
await self._publish_command(device, payload)
|
||||
|
||||
async def async_send_set_autoplay_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
option: str,
|
||||
) -> None:
|
||||
"""
|
||||
Set the device's wait-after-job / autoplay option.
|
||||
|
||||
Publishes a "WRIWAITAFTER=<option>" command for the specified device to configure how long the device waits after a job or to adjust autoplay behavior.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target device (must have a serial_number).
|
||||
option (str): Value accepted by the device firmware for the wait-after-job/autoplay setting (typically a numeric string or predefined option token).
|
||||
"""
|
||||
payload = f"WRIWAITAFTER={option}"
|
||||
await self._publish_command(device, payload)
|
||||
|
||||
async def async_send_upgrade_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
beta: bool,
|
||||
) -> None:
|
||||
"""
|
||||
Request a firmware upgrade for the given device.
|
||||
|
||||
Sends an upgrade command to the device and selects the beta channel when requested.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target device.
|
||||
beta (bool): If `True`, request a beta firmware upgrade; if `False`, request the stable firmware.
|
||||
"""
|
||||
payload = f"CMDUPGRADE={1 if beta else 0}"
|
||||
await self._publish_command(device, payload)
|
||||
|
||||
async def async_send_play_command(self, device: OasisDevice) -> None:
|
||||
"""
|
||||
Send a "play" command to the given device and wake it if the device is sleeping.
|
||||
"""
|
||||
await self._publish_command(device, "CMDPLAY", True)
|
||||
|
||||
async def async_send_pause_command(self, device: OasisDevice) -> None:
|
||||
"""
|
||||
Sends a pause command to the specified Oasis device.
|
||||
|
||||
Publishes the "CMDPAUSE" command to the device's command topic.
|
||||
"""
|
||||
await self._publish_command(device, "CMDPAUSE")
|
||||
|
||||
async def async_send_stop_command(self, device: OasisDevice) -> None:
|
||||
"""
|
||||
Send the "stop" command to the given Oasis device.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target device to receive the stop command; must be registered with a valid serial number.
|
||||
"""
|
||||
await self._publish_command(device, "CMDSTOP")
|
||||
|
||||
async def async_send_reboot_command(self, device: OasisDevice) -> None:
|
||||
"""
|
||||
Send a reboot command to the specified Oasis device.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target device to receive the reboot command; must have a valid serial_number.
|
||||
"""
|
||||
await self._publish_command(device, "CMDBOOT")
|
||||
|
||||
async def async_get_all(self, device: OasisDevice) -> None:
|
||||
"""Request FULLSTATUS + SCHEDULE (compact snapshot)."""
|
||||
await self._publish_command(device, "GETALL")
|
||||
|
||||
async def async_get_status(self, device: OasisDevice) -> None:
|
||||
"""
|
||||
Request the device to publish its current STATUS topics.
|
||||
"""
|
||||
await self._publish_command(device, "GETSTATUS")
|
||||
|
||||
async def _enqueue_command(self, serial: str, payload: str) -> None:
|
||||
"""Queue a command to be sent when connected.
|
||||
|
||||
If the queue is full, drop the oldest command to make room.
|
||||
"""
|
||||
if self._command_queue.full():
|
||||
try:
|
||||
dropped = self._command_queue.get_nowait()
|
||||
self._command_queue.task_done()
|
||||
_LOGGER.debug(
|
||||
"Command queue full, dropping oldest command: %s", dropped
|
||||
)
|
||||
except asyncio.QueueEmpty:
|
||||
# race: became empty between full() and get_nowait()
|
||||
pass
|
||||
|
||||
await self._command_queue.put((serial, payload))
|
||||
_LOGGER.debug("Queued command for %s: %s", serial, payload)
|
||||
|
||||
async def _flush_pending_commands(self) -> None:
|
||||
"""
|
||||
Flush queued commands by publishing them to each device's COMMAND/CMD topic.
|
||||
|
||||
This consumes all entries from the internal command queue, skipping entries for devices that are no longer registered, publishing each payload to "<serial>/COMMAND/CMD" with QoS 1, and marking queue tasks done. If a publish fails, the failed command is re-queued and flushing stops so remaining queued commands will be retried on the next reconnect.
|
||||
"""
|
||||
if not self._client:
|
||||
return
|
||||
|
||||
while not self._command_queue.empty():
|
||||
try:
|
||||
serial, payload = self._command_queue.get_nowait()
|
||||
except asyncio.QueueEmpty:
|
||||
break
|
||||
|
||||
try:
|
||||
# Skip commands for unknown devices
|
||||
if serial not in self._devices:
|
||||
_LOGGER.debug(
|
||||
"Skipping queued command for unknown device %s: %s",
|
||||
serial,
|
||||
payload,
|
||||
)
|
||||
self._command_queue.task_done()
|
||||
continue
|
||||
|
||||
topic = f"{serial}/COMMAND/CMD"
|
||||
_LOGGER.debug("Flushing queued MQTT command %s => %s", topic, payload)
|
||||
await self._client.publish(topic, payload.encode(), qos=1)
|
||||
except Exception: # noqa: BLE001
|
||||
_LOGGER.debug(
|
||||
"Failed to flush queued command for %s, re-queuing", serial
|
||||
)
|
||||
# Put it back and break; we'll try again on next reconnect
|
||||
await self._enqueue_command(serial, payload)
|
||||
self._command_queue.task_done()
|
||||
break
|
||||
|
||||
self._command_queue.task_done()
|
||||
|
||||
async def _publish_command(
|
||||
self, device: OasisDevice, payload: str, wake: bool = False
|
||||
) -> None:
|
||||
"""
|
||||
Publish a command payload to the device's MQTT COMMAND topic, queueing it if the client is not connected.
|
||||
|
||||
If `wake` is True and the device reports it is sleeping, requests a full status refresh before publishing. If the MQTT client is not connected or publish fails, the command is enqueued for later delivery.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target device; must have a valid `serial_number`.
|
||||
payload (str): Command payload to send to the device.
|
||||
wake (bool): If True, refresh the device state when the device is sleeping before sending the command.
|
||||
|
||||
Raises:
|
||||
RuntimeError: If the provided device has no serial number set.
|
||||
"""
|
||||
serial = device.serial_number
|
||||
if not serial:
|
||||
raise RuntimeError("Device has no serial number set")
|
||||
|
||||
if wake and device.is_sleeping:
|
||||
await self.async_get_all(device)
|
||||
|
||||
# If not connected, just queue the command
|
||||
if not self._client or not self._connected_event.is_set():
|
||||
_LOGGER.debug(
|
||||
"MQTT not connected, queueing command for %s: %s", serial, payload
|
||||
)
|
||||
await self._enqueue_command(serial, payload)
|
||||
return
|
||||
|
||||
topic = f"{serial}/COMMAND/CMD"
|
||||
try:
|
||||
_LOGGER.debug("MQTT publish %s => %s", topic, payload)
|
||||
await self._client.publish(topic, payload.encode(), qos=1)
|
||||
except Exception: # noqa: BLE001
|
||||
_LOGGER.debug(
|
||||
"MQTT publish failed, queueing command for %s: %s", serial, payload
|
||||
)
|
||||
await self._enqueue_command(serial, payload)
|
||||
|
||||
async def _mqtt_loop(self) -> None:
|
||||
"""
|
||||
Run the MQTT WebSocket connection loop that maintains connection, subscriptions, and message handling.
|
||||
|
||||
This background coroutine establishes a persistent WSS MQTT connection to the configured broker, sets connection state on successful connect, resubscribes to known device STATUS topics, flushes any queued outbound commands, and dispatches incoming MQTT messages to the status handler. On disconnect or error it clears connection state and subscription tracking, and retries connecting after the configured backoff interval until the client is stopped.
|
||||
"""
|
||||
loop = asyncio.get_running_loop()
|
||||
tls_context = await loop.run_in_executor(None, ssl.create_default_context)
|
||||
|
||||
while not self._stop_event.is_set():
|
||||
try:
|
||||
_LOGGER.info("Connecting MQTT WSS to wss://%s:%s/%s", HOST, PORT, PATH)
|
||||
|
||||
async with aiomqtt.Client(
|
||||
hostname=HOST,
|
||||
port=PORT,
|
||||
transport="websockets",
|
||||
tls_context=tls_context,
|
||||
username=base64.b64decode(USERNAME).decode(),
|
||||
password=base64.b64decode(PASSWORD).decode(),
|
||||
keepalive=30,
|
||||
websocket_path=f"/{PATH}",
|
||||
) as client:
|
||||
self._client = client
|
||||
self._connected_event.set()
|
||||
self._connected_at = datetime.now(UTC)
|
||||
_LOGGER.info("Connected to MQTT broker")
|
||||
|
||||
# Subscribe only to STATUS topics for known devices
|
||||
await self._resubscribe_all()
|
||||
|
||||
# Flush any queued commands now that we're connected
|
||||
await self._flush_pending_commands()
|
||||
|
||||
async for msg in client.messages:
|
||||
if self._stop_event.is_set():
|
||||
break
|
||||
await self._handle_status_message(msg)
|
||||
|
||||
except asyncio.CancelledError:
|
||||
break
|
||||
except Exception: # noqa: BLE001
|
||||
_LOGGER.info("MQTT connection error")
|
||||
|
||||
finally:
|
||||
if self._connected_event.is_set():
|
||||
self._connected_event.clear()
|
||||
if self._connected_at:
|
||||
_LOGGER.info(
|
||||
"MQTT was connected for %s",
|
||||
datetime.now(UTC) - self._connected_at,
|
||||
)
|
||||
self._connected_at = None
|
||||
self._client = None
|
||||
self._subscribed_serials.clear()
|
||||
|
||||
if not self._stop_event.is_set():
|
||||
_LOGGER.info(
|
||||
"Disconnected from broker, retrying in %.1fs", RECONNECT_INTERVAL
|
||||
)
|
||||
await asyncio.sleep(RECONNECT_INTERVAL)
|
||||
|
||||
async def _handle_status_message(self, msg: aiomqtt.Message) -> None:
|
||||
"""
|
||||
Map an incoming MQTT STATUS message to an OasisDevice state update.
|
||||
|
||||
Expects msg.topic in the form "<serial>/STATUS/<STATUS_NAME>" and decodes msg.payload as text.
|
||||
If the topic corresponds to a registered device, extracts the relevant status field and calls
|
||||
the device's update_from_status_dict with a mapping of the parsed values. For the "MAC_ADDRESS"
|
||||
status, sets the per-device MAC event to signal arrival of the MAC address. Always sets the
|
||||
per-device first-status event once any status is processed for that serial.
|
||||
|
||||
Parameters:
|
||||
msg (aiomqtt.Message): Incoming MQTT message; topic identifies device serial and status.
|
||||
"""
|
||||
topic_str = str(msg.topic) if msg.topic is not None else ""
|
||||
payload = msg.payload.decode(errors="replace")
|
||||
|
||||
parts = topic_str.split("/")
|
||||
# Expect: "<serial>/STATUS/<STATUS_NAME>"
|
||||
if len(parts) < 3:
|
||||
return
|
||||
|
||||
serial, _, status_name = parts[:3]
|
||||
|
||||
device = self._devices.get(serial)
|
||||
if not device:
|
||||
_LOGGER.debug("Received MQTT for unknown device %s: %s", serial, topic_str)
|
||||
return
|
||||
|
||||
data: dict[str, Any] = {}
|
||||
|
||||
try:
|
||||
if status_name == "OASIS_STATUS":
|
||||
data["status_code"] = int(payload)
|
||||
elif status_name == "OASIS_ERROR":
|
||||
data["error"] = int(payload)
|
||||
elif status_name == "OASIS_SPEEED":
|
||||
data["ball_speed"] = int(payload)
|
||||
elif status_name == "JOBLIST":
|
||||
data["playlist"] = [int(x) for x in payload.split(",") if x]
|
||||
elif status_name == "CURRENTJOB":
|
||||
data["playlist_index"] = int(payload)
|
||||
elif status_name == "CURRENTLINE":
|
||||
data["progress"] = int(payload)
|
||||
elif status_name == "LED_EFFECT":
|
||||
data["led_effect"] = payload
|
||||
elif status_name == "LED_EFFECT_COLOR":
|
||||
data["led_color_id"] = payload
|
||||
elif status_name == "LED_SPEED":
|
||||
data["led_speed"] = int(payload)
|
||||
elif status_name == "LED_BRIGHTNESS":
|
||||
data["brightness"] = int(payload)
|
||||
elif status_name == "LED_MAX":
|
||||
data["brightness_max"] = int(payload)
|
||||
elif status_name == "LED_EFFECT_PARAM":
|
||||
data["color"] = payload if payload.startswith("#") else None
|
||||
elif status_name == "SYSTEM_BUSY":
|
||||
data["busy"] = payload in ("1", "true", "True")
|
||||
elif status_name == "DOWNLOAD_PROGRESS":
|
||||
data["download_progress"] = int(payload)
|
||||
elif status_name == "REPEAT_JOB":
|
||||
data["repeat_playlist"] = payload in ("1", "true", "True")
|
||||
elif status_name == "WAIT_AFTER_JOB":
|
||||
data["autoplay"] = _parse_int(payload)
|
||||
elif status_name == "AUTO_CLEAN":
|
||||
data["auto_clean"] = payload in ("1", "true", "True")
|
||||
elif status_name == "SOFTWARE_VER":
|
||||
data["software_version"] = payload
|
||||
elif status_name == "MAC_ADDRESS":
|
||||
data["mac_address"] = payload
|
||||
mac_event = self._mac_events.setdefault(serial, asyncio.Event())
|
||||
mac_event.set()
|
||||
elif status_name == "WIFI_SSID":
|
||||
data["wifi_ssid"] = payload
|
||||
elif status_name == "WIFI_IP":
|
||||
data["wifi_ip"] = payload
|
||||
elif status_name == "WIFI_PDNS":
|
||||
data["wifi_pdns"] = payload
|
||||
elif status_name == "WIFI_SDNS":
|
||||
data["wifi_sdns"] = payload
|
||||
elif status_name == "WIFI_GATE":
|
||||
data["wifi_gate"] = payload
|
||||
elif status_name == "WIFI_SUB":
|
||||
data["wifi_sub"] = payload
|
||||
elif status_name == "WIFI_STATUS":
|
||||
data["wifi_connected"] = _bit_to_bool(payload)
|
||||
elif status_name == "SCHEDULE":
|
||||
data["schedule"] = payload
|
||||
elif status_name == "ENVIRONMENT":
|
||||
data["environment"] = payload
|
||||
elif status_name == "FULLSTATUS":
|
||||
if parsed := device.parse_status_string(payload):
|
||||
data = parsed
|
||||
else:
|
||||
_LOGGER.warning(
|
||||
"Unknown status received for %s: %s=%s",
|
||||
serial,
|
||||
status_name,
|
||||
payload,
|
||||
)
|
||||
except Exception:
|
||||
_LOGGER.exception(
|
||||
"Error parsing MQTT payload for %s %s: %r", serial, status_name, payload
|
||||
)
|
||||
return
|
||||
|
||||
if data:
|
||||
device.update_from_status_dict(data)
|
||||
|
||||
first_status_event = self._first_status_events.setdefault(
|
||||
serial, asyncio.Event()
|
||||
)
|
||||
if not first_status_event.is_set():
|
||||
first_status_event.set()
|
||||
222
custom_components/oasis_mini/pyoasiscontrol/clients/transport.py
Normal file
222
custom_components/oasis_mini/pyoasiscontrol/clients/transport.py
Normal file
@@ -0,0 +1,222 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Protocol, runtime_checkable
|
||||
|
||||
from ..device import OasisDevice
|
||||
|
||||
|
||||
@runtime_checkable
|
||||
class OasisClientProtocol(Protocol):
|
||||
"""Transport/client interface for an Oasis device.
|
||||
|
||||
Concrete implementations:
|
||||
- MQTT client (remote connection)
|
||||
- HTTP client (direct LAN)
|
||||
"""
|
||||
|
||||
async def async_get_mac_address(self, device: OasisDevice) -> str | None:
|
||||
"""
|
||||
Retrieve the MAC address of the specified Oasis device.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): The target device to query.
|
||||
|
||||
Returns:
|
||||
str | None: The device's MAC address as a string, or `None` if the MAC address is unavailable.
|
||||
"""
|
||||
|
||||
async def async_send_auto_clean_command(
|
||||
self, device: OasisDevice, auto_clean: bool
|
||||
) -> None:
|
||||
"""
|
||||
Enable or disable the device's auto-clean mode.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): The target Oasis device to send the command to.
|
||||
auto_clean (bool): `True` to enable auto-clean mode, `False` to disable it.
|
||||
"""
|
||||
|
||||
async def async_send_ball_speed_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
speed: int,
|
||||
) -> None:
|
||||
"""
|
||||
Set the device's ball speed to the specified value.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target Oasis device to send the command to.
|
||||
speed (int): Desired ball speed value for the device.
|
||||
"""
|
||||
|
||||
async def async_send_led_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
led_effect: str,
|
||||
color: str,
|
||||
led_speed: int,
|
||||
brightness: int,
|
||||
) -> None:
|
||||
"""
|
||||
Configure the device's LED effect, color, speed, and brightness.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target Oasis device to receive the LED command.
|
||||
led_effect (str): Name or identifier of the LED effect to apply.
|
||||
color (str): Color for the LED effect (format depends on implementation, e.g., hex code or color name).
|
||||
led_speed (int): Effect speed; larger values increase the animation speed.
|
||||
brightness (int): Brightness level as a percentage from 0 to 100.
|
||||
"""
|
||||
|
||||
async def async_send_sleep_command(self, device: OasisDevice) -> None:
|
||||
"""
|
||||
Put the specified Oasis device into sleep mode.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): The target Oasis device to send the sleep command to.
|
||||
"""
|
||||
|
||||
async def async_send_move_job_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
from_index: int,
|
||||
to_index: int,
|
||||
) -> None:
|
||||
"""
|
||||
Move a job within the device's job list from one index to another.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target Oasis device.
|
||||
from_index (int): Source index of the job in the device's job list.
|
||||
to_index (int): Destination index to move the job to.
|
||||
"""
|
||||
|
||||
async def async_send_change_track_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
index: int,
|
||||
) -> None:
|
||||
"""
|
||||
Change the device's current track to the specified track index.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): The target Oasis device to receive the command.
|
||||
index (int): The index of the track to select on the device.
|
||||
"""
|
||||
|
||||
async def async_send_add_joblist_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
tracks: list[int],
|
||||
) -> None:
|
||||
"""
|
||||
Add the given sequence of track indices to the device's job list.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target Oasis device to receive the new jobs.
|
||||
tracks (list[int]): Ordered list of track indices to append to the device's job list.
|
||||
"""
|
||||
|
||||
async def async_send_set_playlist_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
playlist: list[int],
|
||||
) -> None:
|
||||
"""
|
||||
Set the device's current playlist to the provided sequence of track indices.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): The target Oasis device to receive the playlist.
|
||||
playlist (list[int]): Sequence of track indices in the desired playback order.
|
||||
"""
|
||||
|
||||
async def async_send_set_repeat_playlist_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
repeat: bool,
|
||||
) -> None:
|
||||
"""
|
||||
Set whether the device should repeat the current playlist.
|
||||
|
||||
Parameters:
|
||||
repeat (bool): True to enable repeating the current playlist, False to disable it.
|
||||
"""
|
||||
|
||||
async def async_send_set_autoplay_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
option: str,
|
||||
) -> None:
|
||||
"""
|
||||
Send a command to configure the device's autoplay behavior.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target Oasis device to receive the command.
|
||||
option (str): Autoplay option to set (e.g., "on", "off", "shuffle", or other device-supported mode).
|
||||
"""
|
||||
|
||||
async def async_send_upgrade_command(
|
||||
self,
|
||||
device: OasisDevice,
|
||||
beta: bool,
|
||||
) -> None:
|
||||
"""
|
||||
Initiates a firmware upgrade on the given Oasis device.
|
||||
|
||||
If `beta` is True, requests the device to use the beta upgrade channel; otherwise requests the stable channel.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target device to upgrade.
|
||||
beta (bool): Whether to use the beta upgrade channel (`True`) or the stable channel (`False`).
|
||||
"""
|
||||
|
||||
async def async_send_play_command(self, device: OasisDevice) -> None:
|
||||
"""
|
||||
Send a play command to the specified Oasis device.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): The target device to instruct to start playback.
|
||||
"""
|
||||
|
||||
async def async_send_pause_command(self, device: OasisDevice) -> None:
|
||||
"""
|
||||
Pause playback on the specified Oasis device.
|
||||
|
||||
This sends a pause command to the device so it stops current playback.
|
||||
"""
|
||||
|
||||
async def async_send_stop_command(self, device: OasisDevice) -> None:
|
||||
"""
|
||||
Send a stop command to the specified Oasis device to halt playback.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): The target Oasis device to receive the stop command.
|
||||
"""
|
||||
|
||||
async def async_send_reboot_command(self, device: OasisDevice) -> None:
|
||||
"""
|
||||
Send a reboot command to the specified Oasis device.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): The target Oasis device to reboot.
|
||||
"""
|
||||
|
||||
async def async_get_all(self, device: OasisDevice) -> None:
|
||||
"""
|
||||
Fetch comprehensive device data for the specified Oasis device.
|
||||
|
||||
This method triggers retrieval of all relevant information (configuration, status, and runtime data) for the given device so the client's representation of that device can be refreshed.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): Target device whose data should be fetched and refreshed.
|
||||
"""
|
||||
|
||||
async def async_get_status(self, device: OasisDevice) -> None:
|
||||
"""
|
||||
Retrieve the current runtime status for the specified Oasis device.
|
||||
|
||||
Implementations should query the device for its current state (for example: playback, LED settings, job/track lists, and connectivity) and update any client-side representation or caches as needed.
|
||||
|
||||
Parameters:
|
||||
device (OasisDevice): The target device to query.
|
||||
"""
|
||||
Reference in New Issue
Block a user