aioamazondevices 9.0.2__py3-none-any.whl → 11.0.3__py3-none-any.whl

aioamazondevices/const/http.py

@@ -30,7 +30,8 @@ REFRESH_ACCESS_TOKEN = "access_token"  # noqa: S105
 REFRESH_AUTH_COOKIES = "auth_cookies"
 
 URI_DEVICES = "/api/devices-v2/device"
-URI_DND = "/api/dnd/device-status-list"
+URI_DND_STATUS_ALL = "/api/dnd/device-status-list"
+URI_DND_STATUS_DEVICE = "/api/dnd/status"
+URI_NEXUS_GRAPHQL = "/nexus/v1/graphql"
 URI_NOTIFICATIONS = "/api/notifications"
 URI_SIGNIN = "/ap/signin"
-URI_NEXUS_GRAPHQL = "/nexus/v1/graphql"

aioamazondevices/const/metadata.py

@@ -21,6 +21,12 @@ SENSORS: dict[str, dict[str, str | None]] = {
         "subkey": "value",
         "scale": None,
     },
+    "connectivity": {
+        "name": "reachability",
+        "key": "reachabilityStatusValue",
+        "subkey": None,
+        "scale": None,
+    },
 }
 
 ALEXA_INFO_SKILLS = [
@@ -42,3 +48,5 @@ ALEXA_INFO_SKILLS = [
     "Alexa.ImHome.Play",
     "Alexa.GoodNight.Play",
 ]
+
+MAX_CUSTOMER_ACCOUNT_RETRIES = 3

aioamazondevices/http_wrapper.py

@@ -4,7 +4,7 @@ import asyncio
 import base64
 import secrets
 from collections.abc import Callable, Coroutine
-from http import HTTPStatus
+from http import HTTPMethod, HTTPStatus
 from http.cookies import Morsel
 from typing import Any, cast
 
@@ -23,13 +23,17 @@ from . import __version__
 from .const.http import (
     AMAZON_APP_BUNDLE_ID,
     AMAZON_APP_ID,
+    AMAZON_APP_NAME,
     AMAZON_APP_VERSION,
+    AMAZON_CLIENT_OS,
     AMAZON_DEVICE_SOFTWARE_VERSION,
     ARRAY_WRAPPER,
     CSRF_COOKIE,
     DEFAULT_HEADERS,
     HTTP_ERROR_199,
     HTTP_ERROR_299,
+    REFRESH_ACCESS_TOKEN,
+    REFRESH_AUTH_COOKIES,
     REQUEST_AGENT,
     URI_SIGNIN,
 )
@@ -56,6 +60,7 @@ class AmazonSessionStateData:
         self._login_password: str = login_password
         self._login_stored_data: dict[str, Any] = login_data or {}
         self.country_specific_data(domain)
+        self._account_customer_id: str | None = None
 
     @property
     def country_code(self) -> str:
@@ -87,6 +92,21 @@ class AmazonSessionStateData:
         """Return login stored data."""
         return self._login_stored_data
 
+    @login_stored_data.setter
+    def login_stored_data(self, data: dict[str, Any]) -> None:
+        """Set login stored data."""
+        self._login_stored_data = data
+
+    @property
+    def account_customer_id(self) -> str | None:
+        """Return account customer id."""
+        return self._account_customer_id
+
+    @account_customer_id.setter
+    def account_customer_id(self, customer_id: str | None) -> None:
+        """Set account customer id."""
+        self._account_customer_id = customer_id
+
     def country_specific_data(self, domain: str) -> None:
         """Set country specific data."""
         # Force lower case
@@ -108,11 +128,6 @@ class AmazonSessionStateData:
             self._language,
         )
 
-    def load_login_stored_data(self, data: dict[str, Any]) -> dict[str, Any]:
-        """Load to Amazon using previously stored data."""
-        self._login_stored_data = data
-        return self._login_stored_data
-
 
 class AmazonHttpWrapper:
     """Amazon HTTP wrapper class."""
@@ -203,13 +218,66 @@ class AmazonHttpWrapper:
 
         return HTTPStatus(error).phrase
 
+    async def refresh_data(self, data_type: str) -> tuple[bool, dict]:
+        """Refresh data."""
+        if not self._session_state_data.login_stored_data:
+            _LOGGER.debug("No login data available, cannot refresh")
+            return False, {}
+
+        data = {
+            "app_name": AMAZON_APP_NAME,
+            "app_version": AMAZON_APP_VERSION,
+            "di.sdk.version": "6.12.4",
+            "source_token": self._session_state_data.login_stored_data["refresh_token"],
+            "package_name": AMAZON_APP_BUNDLE_ID,
+            "di.hw.version": "iPhone",
+            "platform": "iOS",
+            "requested_token_type": data_type,
+            "source_token_type": "refresh_token",
+            "di.os.name": "iOS",
+            "di.os.version": AMAZON_CLIENT_OS,
+            "current_version": "6.12.4",
+            "previous_version": "6.12.4",
+            "domain": f"www.amazon.{self._session_state_data.domain}",
+        }
+
+        _, raw_resp = await self.session_request(
+            method=HTTPMethod.POST,
+            url="https://api.amazon.com/auth/token",
+            input_data=data,
+            json_data=False,
+        )
+        _LOGGER.debug(
+            "Refresh data response %s with payload %s",
+            raw_resp.status,
+            orjson.dumps(data),
+        )
+
+        if raw_resp.status != HTTPStatus.OK:
+            _LOGGER.debug("Failed to refresh data")
+            return False, {}
+
+        json_response = await self.response_to_json(raw_resp, data_type)
+
+        if data_type == REFRESH_ACCESS_TOKEN and (
+            new_token := json_response.get(REFRESH_ACCESS_TOKEN)
+        ):
+            self._session_state_data.login_stored_data[REFRESH_ACCESS_TOKEN] = new_token
+            return True, json_response
+
+        if data_type == REFRESH_AUTH_COOKIES:
+            return True, json_response
+
+        _LOGGER.debug("Unexpected refresh data response")
+        return False, {}
+
     async def session_request(
         self,
         method: str,
         url: str,
         input_data: dict[str, Any] | list[dict[str, Any]] | None = None,
         json_data: bool = False,
-        agent: str = "Amazon",
+        extended_headers: dict[str, str] | None = None,
     ) -> tuple[BeautifulSoup, ClientResponse]:
         """Return request response context data."""
         _LOGGER.debug(
@@ -221,11 +289,15 @@ class AmazonHttpWrapper:
         )
 
         headers = DEFAULT_HEADERS.copy()
-        headers.update({"User-Agent": REQUEST_AGENT[agent]})
+        headers.update({"User-Agent": REQUEST_AGENT["Browser"]})
         headers.update({"Accept-Language": self._session_state_data.language})
         headers.update({"x-amzn-client": "github.com/chemelli74/aioamazondevices"})
         headers.update({"x-amzn-build-version": __version__})
 
+        if extended_headers:
+            _LOGGER.debug("Adding to headers: %s", extended_headers)
+            headers.update(extended_headers)
+
         if self._csrf_cookie:
             csrf = {CSRF_COOKIE: self._csrf_cookie}
             _LOGGER.debug("Adding to headers: %s", csrf)
@@ -299,6 +371,7 @@ class AmazonHttpWrapper:
             ]:
                 raise CannotAuthenticate(await self.http_phrase_error(resp.status))
             if not await self._ignore_ap_signin_error(resp):
+                _LOGGER.debug("Error response content: %s", await resp.text())
                 raise CannotRetrieveData(
                     f"Request failed: {await self.http_phrase_error(resp.status)}"
                 )

aioamazondevices/implementation/__init__.py

@@ -0,0 +1 @@
+"""aioamazondevices implementation package."""

aioamazondevices/implementation/dnd.py

@@ -0,0 +1,56 @@
+"""Module to handle Alexa do not disturb setting."""
+
+from http import HTTPMethod
+
+from aioamazondevices.const.http import URI_DND_STATUS_ALL, URI_DND_STATUS_DEVICE
+from aioamazondevices.http_wrapper import AmazonHttpWrapper, AmazonSessionStateData
+from aioamazondevices.structures import AmazonDevice, AmazonDeviceSensor
+
+
+class AmazonDnDHandler:
+    """Class to handle Alexa Do Not Disturb functionality."""
+
+    def __init__(
+        self,
+        http_wrapper: AmazonHttpWrapper,
+        session_state_data: AmazonSessionStateData,
+    ) -> None:
+        """Initialize AmazonDnDHandler class."""
+        self._domain = session_state_data.domain
+        self._http_wrapper = http_wrapper
+
+    async def get_do_not_disturb_status(self) -> dict[str, AmazonDeviceSensor]:
+        """Get do_not_disturb status for all devices."""
+        dnd_status: dict[str, AmazonDeviceSensor] = {}
+        _, raw_resp = await self._http_wrapper.session_request(
+            method=HTTPMethod.GET,
+            url=f"https://alexa.amazon.{self._domain}{URI_DND_STATUS_ALL}",
+        )
+
+        dnd_data = await self._http_wrapper.response_to_json(raw_resp, "dnd")
+
+        for dnd in dnd_data.get("doNotDisturbDeviceStatusList", {}):
+            dnd_status[dnd.get("deviceSerialNumber")] = AmazonDeviceSensor(
+                name="dnd",
+                value=dnd.get("enabled"),
+                error=False,
+                error_type=None,
+                error_msg=None,
+                scale=None,
+            )
+        return dnd_status
+
+    async def set_do_not_disturb(self, device: AmazonDevice, enable: bool) -> None:
+        """Set do_not_disturb flag."""
+        payload = {
+            "deviceSerialNumber": device.serial_number,
+            "deviceType": device.device_type,
+            "enabled": enable,
+        }
+        url = f"https://alexa.amazon.{self._domain}{URI_DND_STATUS_DEVICE}"
+        await self._http_wrapper.session_request(
+            method=HTTPMethod.PUT,
+            url=url,
+            input_data=payload,
+            json_data=True,
+        )

aioamazondevices/implementation/notification.py

@@ -0,0 +1,224 @@
+"""Module to handle Alexa notifications."""
+
+from datetime import datetime, timedelta
+from http import HTTPMethod
+from typing import Any
+
+from dateutil.parser import parse
+from dateutil.rrule import rrulestr
+
+from aioamazondevices.const.devices import DEVICE_TO_IGNORE
+from aioamazondevices.const.http import REQUEST_AGENT, URI_NOTIFICATIONS
+from aioamazondevices.const.schedules import (
+    COUNTRY_GROUPS,
+    NOTIFICATION_ALARM,
+    NOTIFICATION_MUSIC_ALARM,
+    NOTIFICATION_REMINDER,
+    NOTIFICATION_TIMER,
+    NOTIFICATIONS_SUPPORTED,
+    RECURRING_PATTERNS,
+    WEEKEND_EXCEPTIONS,
+)
+from aioamazondevices.exceptions import CannotRetrieveData
+from aioamazondevices.http_wrapper import AmazonHttpWrapper, AmazonSessionStateData
+from aioamazondevices.structures import AmazonSchedule
+from aioamazondevices.utils import _LOGGER
+
+
+class AmazonNotificationHandler:
+    """Class to handle Alexa notifications."""
+
+    def __init__(
+        self,
+        session_state_data: AmazonSessionStateData,
+        http_wrapper: AmazonHttpWrapper,
+    ) -> None:
+        """Initialize AmazonNotificationHandler class."""
+        self._session_state_data = session_state_data
+        self._http_wrapper = http_wrapper
+
+    async def get_notifications(self) -> dict[str, dict[str, AmazonSchedule]] | None:
+        """Get all notifications (alarms, timers, reminders)."""
+        final_notifications: dict[str, dict[str, AmazonSchedule]] = {}
+
+        try:
+            _, raw_resp = await self._http_wrapper.session_request(
+                HTTPMethod.GET,
+                url=f"https://alexa.amazon.{self._session_state_data.domain}{URI_NOTIFICATIONS}",
+                extended_headers={"User-Agent": REQUEST_AGENT["Browser"]},
+            )
+        except CannotRetrieveData:
+            _LOGGER.warning(
+                "Failed to obtain notification data.  Timers and alarms have not been updated"  # noqa: E501
+            )
+            return None
+
+        notifications = await self._http_wrapper.response_to_json(
+            raw_resp, "notifications"
+        )
+
+        for schedule in notifications["notifications"]:
+            schedule_type: str = schedule["type"]
+            schedule_device_type = schedule["deviceType"]
+            schedule_device_serial = schedule["deviceSerialNumber"]
+
+            if schedule_device_type in DEVICE_TO_IGNORE:
+                continue
+
+            if schedule_type not in NOTIFICATIONS_SUPPORTED:
+                _LOGGER.debug(
+                    "Unsupported schedule type %s for device %s",
+                    schedule_type,
+                    schedule_device_serial,
+                )
+                continue
+
+            if schedule_type == NOTIFICATION_MUSIC_ALARM:
+                # Structure is the same as standard Alarm
+                schedule_type = NOTIFICATION_ALARM
+                schedule["type"] = NOTIFICATION_ALARM
+            label_desc = schedule_type.lower() + "Label"
+            if (schedule_status := schedule["status"]) == "ON" and (
+                next_occurrence := await self._parse_next_occurrence(schedule)
+            ):
+                schedule_notification_list = final_notifications.get(
+                    schedule_device_serial, {}
+                )
+                schedule_notification_by_type = schedule_notification_list.get(
+                    schedule_type
+                )
+                # Replace if no existing notification
+                # or if existing.next_occurrence is None
+                # or if new next_occurrence is earlier
+                if (
+                    not schedule_notification_by_type
+                    or schedule_notification_by_type.next_occurrence is None
+                    or next_occurrence < schedule_notification_by_type.next_occurrence
+                ):
+                    final_notifications.update(
+                        {
+                            schedule_device_serial: {
+                                **schedule_notification_list
+                                | {
+                                    schedule_type: AmazonSchedule(
+                                        type=schedule_type,
+                                        status=schedule_status,
+                                        label=schedule[label_desc],
+                                        next_occurrence=next_occurrence,
+                                    ),
+                                }
+                            }
+                        }
+                    )
+
+        return final_notifications
+
+    async def _parse_next_occurrence(
+        self,
+        schedule: dict[str, Any],
+    ) -> datetime | None:
+        """Parse RFC5545 rule set for next iteration."""
+        # Local timezone
+        tzinfo = datetime.now().astimezone().tzinfo
+        # Current time
+        actual_time = datetime.now(tz=tzinfo)
+        # Reference start date
+        today_midnight = actual_time.replace(hour=0, minute=0, second=0, microsecond=0)
+        # Reference time (1 minute ago to avoid edge cases)
+        now_reference = actual_time - timedelta(minutes=1)
+
+        # Schedule data
+        original_date = schedule.get("originalDate")
+        original_time = schedule.get("originalTime")
+
+        recurring_rules: list[str] = []
+        if schedule.get("rRuleData"):
+            recurring_rules = schedule["rRuleData"]["recurrenceRules"]
+        if schedule.get("recurringPattern"):
+            recurring_rules.append(schedule["recurringPattern"])
+
+        # Recurring events
+        if recurring_rules:
+            next_candidates: list[datetime] = []
+            for recurring_rule in recurring_rules:
+                # Already in RFC5545 format
+                if "FREQ=" in recurring_rule:
+                    rule = await self._add_hours_minutes(recurring_rule, original_time)
+
+                    # Add date to candidates list
+                    next_candidates.append(
+                        rrulestr(rule, dtstart=today_midnight).after(
+                            now_reference, True
+                        ),
+                    )
+                    continue
+
+                if recurring_rule not in RECURRING_PATTERNS:
+                    _LOGGER.warning(
+                        "Unknown recurring rule <%s> for schedule type <%s>",
+                        recurring_rule,
+                        schedule["type"],
+                    )
+                    return None
+
+                # Adjust recurring rules for country specific weekend exceptions
+                recurring_pattern = RECURRING_PATTERNS.copy()
+                for group, countries in COUNTRY_GROUPS.items():
+                    if self._session_state_data.country_code in countries:
+                        recurring_pattern |= WEEKEND_EXCEPTIONS[group]
+                        break
+
+                rule = await self._add_hours_minutes(
+                    recurring_pattern[recurring_rule], original_time
+                )
+
+                # Add date to candidates list
+                next_candidates.append(
+                    rrulestr(rule, dtstart=today_midnight).after(now_reference, True),
+                )
+
+            return min(next_candidates) if next_candidates else None
+
+        # Single events
+        if schedule["type"] == NOTIFICATION_ALARM:
+            timestamp = parse(f"{original_date} {original_time}").replace(tzinfo=tzinfo)
+
+        elif schedule["type"] == NOTIFICATION_TIMER:
+            # API returns triggerTime in milliseconds since epoch
+            timestamp = datetime.fromtimestamp(
+                schedule["triggerTime"] / 1000, tz=tzinfo
+            )
+
+        elif schedule["type"] == NOTIFICATION_REMINDER:
+            # API returns alarmTime in milliseconds since epoch
+            timestamp = datetime.fromtimestamp(schedule["alarmTime"] / 1000, tz=tzinfo)
+
+        else:
+            _LOGGER.warning(("Unknown schedule type: %s"), schedule["type"])
+            return None
+
+        if timestamp > now_reference:
+            return timestamp
+
+        return None
+
+    async def _add_hours_minutes(
+        self,
+        recurring_rule: str,
+        original_time: str | None,
+    ) -> str:
+        """Add hours and minutes to a RFC5545 string."""
+        rule = recurring_rule.removesuffix(";")
+
+        if not original_time:
+            return rule
+
+        # Add missing BYHOUR, BYMINUTE if needed (Alarms only)
+        if "BYHOUR=" not in recurring_rule:
+            hour = int(original_time.split(":")[0])
+            rule += f";BYHOUR={hour}"
+        if "BYMINUTE=" not in recurring_rule:
+            minute = int(original_time.split(":")[1])
+            rule += f";BYMINUTE={minute}"
+
+        return rule

aioamazondevices/implementation/sequence.py

@@ -0,0 +1,159 @@
+"""Module to handle Alexa sequence operations."""
+
+from http import HTTPMethod
+from typing import Any
+
+import orjson
+
+from aioamazondevices.const.metadata import ALEXA_INFO_SKILLS
+from aioamazondevices.http_wrapper import AmazonHttpWrapper, AmazonSessionStateData
+from aioamazondevices.structures import (
+    AmazonDevice,
+    AmazonMusicSource,
+    AmazonSequenceType,
+)
+from aioamazondevices.utils import _LOGGER
+
+
+class AmazonSequenceHandler:
+    """Class to handle Alexa sequence operations."""
+
+    def __init__(
+        self,
+        http_wrapper: AmazonHttpWrapper,
+        session_state_data: AmazonSessionStateData,
+    ) -> None:
+        """Initialize AmazonSequenceHandler."""
+        self._http_wrapper = http_wrapper
+        self._session_state_data = session_state_data
+
+    async def send_message(
+        self,
+        device: AmazonDevice,
+        message_type: str,
+        message_body: str,
+        message_source: AmazonMusicSource | None = None,
+    ) -> None:
+        """Send message to specific device."""
+        if not self._session_state_data.login_stored_data:
+            _LOGGER.warning("No login data available, cannot send message")
+            return
+
+        base_payload = {
+            "deviceType": device.device_type,
+            "deviceSerialNumber": device.serial_number,
+            "locale": self._session_state_data.language,
+            "customerId": self._session_state_data.account_customer_id,
+        }
+
+        payload: dict[str, Any]
+        if message_type == AmazonSequenceType.Speak:
+            payload = {
+                **base_payload,
+                "textToSpeak": message_body,
+                "target": {
+                    "customerId": self._session_state_data.account_customer_id,
+                    "devices": [
+                        {
+                            "deviceSerialNumber": device.serial_number,
+                            "deviceTypeId": device.device_type,
+                        },
+                    ],
+                },
+                "skillId": "amzn1.ask.1p.saysomething",
+            }
+        elif message_type == AmazonSequenceType.Announcement:
+            playback_devices: list[dict[str, str | None]] = [
+                {
+                    "deviceSerialNumber": serial,
+                    "deviceTypeId": device.device_cluster_members[serial],
+                }
+                for serial in device.device_cluster_members
+            ]
+
+            payload = {
+                **base_payload,
+                "expireAfter": "PT5S",
+                "content": [
+                    {
+                        "locale": self._session_state_data.language,
+                        "display": {
+                            "title": "Home Assistant",
+                            "body": message_body,
+                        },
+                        "speak": {
+                            "type": "text",
+                            "value": message_body,
+                        },
+                    }
+                ],
+                "target": {
+                    "customerId": self._session_state_data.account_customer_id,
+                    "devices": playback_devices,
+                },
+                "skillId": "amzn1.ask.1p.routines.messaging",
+            }
+        elif message_type == AmazonSequenceType.Sound:
+            payload = {
+                **base_payload,
+                "soundStringId": message_body,
+                "skillId": "amzn1.ask.1p.sound",
+            }
+        elif message_type == AmazonSequenceType.Music:
+            payload = {
+                **base_payload,
+                "searchPhrase": message_body,
+                "sanitizedSearchPhrase": message_body,
+                "musicProviderId": message_source,
+            }
+        elif message_type == AmazonSequenceType.TextCommand:
+            payload = {
+                **base_payload,
+                "skillId": "amzn1.ask.1p.tellalexa",
+                "text": message_body,
+            }
+        elif message_type == AmazonSequenceType.LaunchSkill:
+            payload = {
+                **base_payload,
+                "targetDevice": {
+                    "deviceType": device.device_type,
+                    "deviceSerialNumber": device.serial_number,
+                },
+                "connectionRequest": {
+                    "uri": "connection://AMAZON.Launch/" + message_body,
+                },
+            }
+        elif message_type in ALEXA_INFO_SKILLS:
+            payload = {
+                **base_payload,
+            }
+        else:
+            raise ValueError(f"Message type <{message_type}> is not recognised")
+
+        sequence = {
+            "@type": "com.amazon.alexa.behaviors.model.Sequence",
+            "startNode": {
+                "@type": "com.amazon.alexa.behaviors.model.SerialNode",
+                "nodesToExecute": [
+                    {
+                        "@type": "com.amazon.alexa.behaviors.model.OpaquePayloadOperationNode",  # noqa: E501
+                        "type": message_type,
+                        "operationPayload": payload,
+                    },
+                ],
+            },
+        }
+
+        node_data = {
+            "behaviorId": "PREVIEW",
+            "sequenceJson": orjson.dumps(sequence).decode("utf-8"),
+            "status": "ENABLED",
+        }
+
+        _LOGGER.debug("Preview data payload: %s", node_data)
+        await self._http_wrapper.session_request(
+            method=HTTPMethod.POST,
+            url=f"https://alexa.amazon.{self._session_state_data.domain}/api/behaviors/preview",
+            input_data=node_data,
+            json_data=True,
+        )