rivian-python-client 2.3.0__tar.gz → 2.3.1__tar.gz

{rivian_python_client-2.3.0 → rivian_python_client-2.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: rivian-python-client
-Version: 2.3.0
+Version: 2.3.1
 Summary: Rivian API Client (Unofficial)
 Author-email: Brian Retterer <bretterer@gmail.com>, "J.R. Gutierrez" <jrgutier@gmail.com>, Nathan Spencer <natekspencer@gmail.com>, Trevor Mack <drummer8001@gmail.com>
 License-Expression: MIT

{rivian_python_client-2.3.0 → rivian_python_client-2.3.1}/src/rivian/__version__.py

@@ -1,4 +1,4 @@
 # This file is auto-generated by Hatchling. As such, do not:
 #   - modify
 #   - track in version control e.g. be sure to add to .gitignore
-__version__ = VERSION = '2.3.0'
+__version__ = VERSION = '2.3.1'

{rivian_python_client-2.3.0 → rivian_python_client-2.3.1}/src/rivian/parallax/departure.py

@@ -53,11 +53,19 @@ def _decode_schedule(schedule: _Schedules.Schedule) -> dict[str, Any]:
         entry["name"] = v
     entry["isEnabled"] = schedule.is_enabled
 
-    occurrence = schedule.occurrence
-    entry["occurrence"] = {
-        "days": [day for field, day in _WEEKDAYS if getattr(occurrence.days, field)],
-        "startsAtMin": occurrence.starts_at,
-    }
+    if schedule.HasField("single_occurrence"):
+        starts_at = schedule.single_occurrence.starts_at
+        entry["occurrence"] = {
+            "startsAt": from_epoch(starts_at.seconds + starts_at.nanos / 1e9)
+        }
+    else:
+        occurrence = schedule.occurrence
+        entry["occurrence"] = {
+            "days": [
+                day for field, day in _WEEKDAYS if getattr(occurrence.days, field)
+            ],
+            "startsAtMin": occurrence.starts_at,
+        }
 
     settings = schedule.departure_settings
     comfort = settings.comfort_settings
@@ -87,7 +95,9 @@ def decode_departure_schedules(m: departure_pb2.DepartureSchedules) -> dict[str,
         departureSchedules: list[dict] — the gateway's DepartureSchedule shape:
             id: str, name: str, isEnabled: bool
             occurrence: {"days": list[str] ("monday" ... "sunday"; order
-                inferred), "startsAtMin": int (minutes after local midnight)}
+                inferred), "startsAtMin": int (minutes after local midnight)},
+                or {"startsAt": datetime} for the one-off "s-" schedule a
+                departNow adds (departing 10 minutes after the call)
             departureSettings: {"shouldOverrideChargeSchedule": bool,
                 "comfortSettings": {"cabinTempCelsius": float,
                 "frontDefogDefrost": "off" | "defog" | "defrost",

{rivian_python_client-2.3.0 → rivian_python_client-2.3.1}/src/rivian/parallax/navigation.py

@@ -310,7 +310,9 @@ def decode_trip_info(m: navigation_pb2.TripInfo) -> dict[str, Any]:
             and incidents ({firstIndex, lastIndex, type})
         overviewPolyline: str — Google-encoded, whole trip
         nextWaypointDepartureTime: datetime — the next stop's departure if
-            it's a charging stop, else its arrival
+            it's a charging stop, else its arrival. It stops updating once
+            the first stop is reached, keeping that stop's time for the
+            rest of the trip; use waypoints[0] instead
         finalStateOfCharge, finalRangeRemaining: float — the last
             waypoint's (percent, meters)
         socIsBelowLimit: bool
@@ -346,9 +348,11 @@ def decode_trip_progress(m: navigation_pb2.TripProgress) -> dict[str, Any]:
     """navigation.navigation_service.trip_progress — live progress on the active trip.
 
     Fields:
-        nextWaypointArrivalTime: datetime — live ETA
+        nextWaypointArrivalTime: datetime — live ETA, to the minute
         finalDestinationArrivalTime: datetime — live ETA for the last
-            waypoint; missing for one message after the waypoints change
+            waypoint, to the minute; missing while the route is
+            recalculating and on the stale progress the vehicle keeps
+            resending after navigation ends
         nextStopIndex: int
         distanceRemaining, durationRemaining: float — to the next waypoint
             (meters, seconds)

{rivian_python_client-2.3.0 → rivian_python_client-2.3.1}/src/rivian/parallax/proto/departure.proto

@@ -15,9 +15,21 @@ message DepartureSchedules {
     optional string name = 2;
     bool is_enabled = 3;
     Occurrence occurrence = 4;
+    // Set instead of occurrence on the one-off "s-" schedule a departNow
+    // adds; the gateway leaves that schedule out.
+    SingleOccurrence single_occurrence = 5;
     DepartureSettings departure_settings = 6;
   }
 
+  message SingleOccurrence {
+    StartsAt starts_at = 1;
+
+    message StartsAt {
+      int64 seconds = 1; // epoch seconds
+      int32 nanos = 2;
+    }
+  }
+
   message Occurrence {
     Days days = 1;
     optional int32 starts_at = 2; // minutes after local midnight

rivian_python_client-2.3.1/src/rivian/parallax/proto/departure_pb2.py

@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# NO CHECKED-IN PROTOBUF GENCODE
+# source: rivian/parallax/proto/departure.proto
+# Protobuf Python Version: 6.31.1
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import runtime_version as _runtime_version
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+_runtime_version.ValidateProtobufRuntimeVersion(
+    _runtime_version.Domain.PUBLIC,
+    6,
+    31,
+    1,
+    '',
+    'rivian/parallax/proto/departure.proto'
+)
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n%rivian/parallax/proto/departure.proto\x12\x19rivian.parallax.departure\"\xca\r\n\x12\x44\x65partureSchedules\x12H\n\x08schedule\x18\x01 \x03(\x0b\x32\x36.rivian.parallax.departure.DepartureSchedules.Schedule\x12K\n\nupdated_at\x18\x02 \x01(\x0b\x32\x37.rivian.parallax.departure.DepartureSchedules.UpdatedAt\x1a\xd8\x02\n\x08Schedule\x12\x0f\n\x02id\x18\x01 \x01(\tH\x00\x88\x01\x01\x12\x11\n\x04name\x18\x02 \x01(\tH\x01\x88\x01\x01\x12\x12\n\nis_enabled\x18\x03 \x01(\x08\x12L\n\noccurrence\x18\x04 \x01(\x0b\x32\x38.rivian.parallax.departure.DepartureSchedules.Occurrence\x12Y\n\x11single_occurrence\x18\x05 \x01(\x0b\x32>.rivian.parallax.departure.DepartureSchedules.SingleOccurrence\x12[\n\x12\x64\x65parture_settings\x18\x06 \x01(\x0b\x32?.rivian.parallax.departure.DepartureSchedules.DepartureSettingsB\x05\n\x03_idB\x07\n\x05_name\x1a\x9a\x01\n\x10SingleOccurrence\x12Z\n\tstarts_at\x18\x01 \x01(\x0b\x32G.rivian.parallax.departure.DepartureSchedules.SingleOccurrence.StartsAt\x1a*\n\x08StartsAt\x12\x0f\n\x07seconds\x18\x01 \x01(\x03\x12\r\n\x05nanos\x18\x02 \x01(\x05\x1at\n\nOccurrence\x12@\n\x04\x64\x61ys\x18\x01 \x01(\x0b\x32\x32.rivian.parallax.departure.DepartureSchedules.Days\x12\x16\n\tstarts_at\x18\x02 \x01(\x05H\x00\x88\x01\x01\x42\x0c\n\n_starts_at\x1a~\n\x04\x44\x61ys\x12\x0e\n\x06monday\x18\x01 \x01(\x08\x12\x0f\n\x07tuesday\x18\x02 \x01(\x08\x12\x11\n\twednesday\x18\x03 \x01(\x08\x12\x10\n\x08thursday\x18\x04 \x01(\x08\x12\x0e\n\x06\x66riday\x18\x05 \x01(\x08\x12\x10\n\x08saturday\x18\x06 \x01(\x08\x12\x0e\n\x06sunday\x18\x07 \x01(\x08\x1a\x95\x01\n\x11\x44\x65partureSettings\x12W\n\x10\x63omfort_settings\x18\x01 \x01(\x0b\x32=.rivian.parallax.departure.DepartureSchedules.ComfortSettings\x12\'\n\x1fshould_override_charge_schedule\x18\x02 \x01(\x08\x1a\xde\x01\n\x0f\x43omfortSettings\x12\x19\n\x11\x63\x61\x62in_temperature\x18\x01 \x01(\x02\x12I\n\x13\x66ront_defog_defrost\x18\x02 \x01(\x0e\x32,.rivian.parallax.departure.DefogDefrostLevel\x12\x65\n\x18surface_heat_vent_levels\x18\x03 \x01(\x0b\x32\x43.rivian.parallax.departure.DepartureSchedules.SurfaceHeatVentLevels\x1a\x88\x03\n\x15SurfaceHeatVentLevels\x12H\n\x0f\x66ront_left_seat\x18\x01 \x01(\x0e\x32/.rivian.parallax.departure.SurfaceHeatVentLevel\x12I\n\x10\x66ront_right_seat\x18\x02 \x01(\x0e\x32/.rivian.parallax.departure.SurfaceHeatVentLevel\x12G\n\x0erear_left_seat\x18\x03 \x01(\x0e\x32/.rivian.parallax.departure.SurfaceHeatVentLevel\x12H\n\x0frear_right_seat\x18\x04 \x01(\x0e\x32/.rivian.parallax.departure.SurfaceHeatVentLevel\x12G\n\x0esteering_wheel\x18\x05 \x01(\x0e\x32/.rivian.parallax.departure.SurfaceHeatVentLevel\x1a+\n\tUpdatedAt\x12\x0f\n\x07seconds\x18\x01 \x01(\x03\x12\r\n\x05nanos\x18\x02 \x01(\x05*^\n\x11\x44\x65\x66ogDefrostLevel\x12\x15\n\x11\x44\x45\x46OG_DEFROST_OFF\x10\x00\x12\x17\n\x13\x44\x45\x46OG_DEFROST_DEFOG\x10\x01\x12\x19\n\x15\x44\x45\x46OG_DEFROST_DEFROST\x10\x02*\x9f\x01\n\x14SurfaceHeatVentLevel\x12\x0f\n\x0bSURFACE_OFF\x10\x00\x12\x12\n\x0eSURFACE_HEAT_1\x10\x01\x12\x12\n\x0eSURFACE_HEAT_2\x10\x02\x12\x12\n\x0eSURFACE_HEAT_3\x10\x03\x12\x12\n\x0eSURFACE_VENT_1\x10\x04\x12\x12\n\x0eSURFACE_VENT_2\x10\x05\x12\x12\n\x0eSURFACE_VENT_3\x10\x06\x62\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'rivian.parallax.proto.departure_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  DESCRIPTOR._loaded_options = None
+  _globals['_DEFOGDEFROSTLEVEL']._serialized_start=1809
+  _globals['_DEFOGDEFROSTLEVEL']._serialized_end=1903
+  _globals['_SURFACEHEATVENTLEVEL']._serialized_start=1906
+  _globals['_SURFACEHEATVENTLEVEL']._serialized_end=2065
+  _globals['_DEPARTURESCHEDULES']._serialized_start=69
+  _globals['_DEPARTURESCHEDULES']._serialized_end=1807
+  _globals['_DEPARTURESCHEDULES_SCHEDULE']._serialized_start=243
+  _globals['_DEPARTURESCHEDULES_SCHEDULE']._serialized_end=587
+  _globals['_DEPARTURESCHEDULES_SINGLEOCCURRENCE']._serialized_start=590
+  _globals['_DEPARTURESCHEDULES_SINGLEOCCURRENCE']._serialized_end=744
+  _globals['_DEPARTURESCHEDULES_SINGLEOCCURRENCE_STARTSAT']._serialized_start=702
+  _globals['_DEPARTURESCHEDULES_SINGLEOCCURRENCE_STARTSAT']._serialized_end=744
+  _globals['_DEPARTURESCHEDULES_OCCURRENCE']._serialized_start=746
+  _globals['_DEPARTURESCHEDULES_OCCURRENCE']._serialized_end=862
+  _globals['_DEPARTURESCHEDULES_DAYS']._serialized_start=864
+  _globals['_DEPARTURESCHEDULES_DAYS']._serialized_end=990
+  _globals['_DEPARTURESCHEDULES_DEPARTURESETTINGS']._serialized_start=993
+  _globals['_DEPARTURESCHEDULES_DEPARTURESETTINGS']._serialized_end=1142
+  _globals['_DEPARTURESCHEDULES_COMFORTSETTINGS']._serialized_start=1145
+  _globals['_DEPARTURESCHEDULES_COMFORTSETTINGS']._serialized_end=1367
+  _globals['_DEPARTURESCHEDULES_SURFACEHEATVENTLEVELS']._serialized_start=1370
+  _globals['_DEPARTURESCHEDULES_SURFACEHEATVENTLEVELS']._serialized_end=1762
+  _globals['_DEPARTURESCHEDULES_UPDATEDAT']._serialized_start=1764
+  _globals['_DEPARTURESCHEDULES_UPDATEDAT']._serialized_end=1807
+# @@protoc_insertion_point(module_scope)

{rivian_python_client-2.3.0 → rivian_python_client-2.3.1}/src/rivian/parallax/proto/departure_pb2.pyi

@@ -36,18 +36,32 @@ SURFACE_VENT_3: SurfaceHeatVentLevel
 class DepartureSchedules(_message.Message):
     __slots__ = ("schedule", "updated_at")
     class Schedule(_message.Message):
-        __slots__ = ("id", "name", "is_enabled", "occurrence", "departure_settings")
+        __slots__ = ("id", "name", "is_enabled", "occurrence", "single_occurrence", "departure_settings")
         ID_FIELD_NUMBER: _ClassVar[int]
         NAME_FIELD_NUMBER: _ClassVar[int]
         IS_ENABLED_FIELD_NUMBER: _ClassVar[int]
         OCCURRENCE_FIELD_NUMBER: _ClassVar[int]
+        SINGLE_OCCURRENCE_FIELD_NUMBER: _ClassVar[int]
         DEPARTURE_SETTINGS_FIELD_NUMBER: _ClassVar[int]
         id: str
         name: str
         is_enabled: bool
         occurrence: DepartureSchedules.Occurrence
+        single_occurrence: DepartureSchedules.SingleOccurrence
         departure_settings: DepartureSchedules.DepartureSettings
-        def __init__(self, id: _Optional[str] = ..., name: _Optional[str] = ..., is_enabled: bool = ..., occurrence: _Optional[_Union[DepartureSchedules.Occurrence, _Mapping]] = ..., departure_settings: _Optional[_Union[DepartureSchedules.DepartureSettings, _Mapping]] = ...) -> None: ...
+        def __init__(self, id: _Optional[str] = ..., name: _Optional[str] = ..., is_enabled: bool = ..., occurrence: _Optional[_Union[DepartureSchedules.Occurrence, _Mapping]] = ..., single_occurrence: _Optional[_Union[DepartureSchedules.SingleOccurrence, _Mapping]] = ..., departure_settings: _Optional[_Union[DepartureSchedules.DepartureSettings, _Mapping]] = ...) -> None: ...
+    class SingleOccurrence(_message.Message):
+        __slots__ = ("starts_at",)
+        class StartsAt(_message.Message):
+            __slots__ = ("seconds", "nanos")
+            SECONDS_FIELD_NUMBER: _ClassVar[int]
+            NANOS_FIELD_NUMBER: _ClassVar[int]
+            seconds: int
+            nanos: int
+            def __init__(self, seconds: _Optional[int] = ..., nanos: _Optional[int] = ...) -> None: ...
+        STARTS_AT_FIELD_NUMBER: _ClassVar[int]
+        starts_at: DepartureSchedules.SingleOccurrence.StartsAt
+        def __init__(self, starts_at: _Optional[_Union[DepartureSchedules.SingleOccurrence.StartsAt, _Mapping]] = ...) -> None: ...
     class Occurrence(_message.Message):
         __slots__ = ("days", "starts_at")
         DAYS_FIELD_NUMBER: _ClassVar[int]

{rivian_python_client-2.3.0 → rivian_python_client-2.3.1}/src/rivian/rivian.py

@@ -133,6 +133,32 @@ class Rivian:
         self._ws_monitor: WebSocketMonitor | None = None
         self._subscriptions: dict[str, str] = {}
 
+    @property
+    def ws_backoff_remaining(self) -> float:
+        """Seconds until the web socket may reconnect after a failed connection.
+
+        0 when it isn't backing off. While it is, subscribe_for_* fail without
+        connecting.
+        """
+        return self._ws_monitor.backoff_remaining if self._ws_monitor else 0
+
+    @property
+    def ws_rate_limited(self) -> bool:
+        """Whether the web socket is backing off after a rate limit.
+
+        True for the rest of the backoff, including on a new client for the same
+        session; False when backing off for a missing acknowledgement instead.
+        """
+        return self._ws_monitor.rate_limited if self._ws_monitor else False
+
+    @property
+    def ws_unauthenticated(self) -> bool:
+        """Whether the server closed the latest web socket as unauthenticated.
+
+        The session needs a new login; the web socket doesn't reconnect.
+        """
+        return self._ws_monitor.unauthenticated if self._ws_monitor else False
+
     async def create_csrf_token(self) -> None:
         """Create cross-site-request-forgery (csrf) token."""
         url = GRAPHQL_GATEWAY
@@ -812,22 +838,14 @@ class Rivian:
         if not properties:
             properties = VEHICLE_STATES_SUBSCRIPTION_PROPERTIES
 
-        try:
-            await self._ws_connect()
-            assert self._ws_monitor
-            async with asyncio.timeout(self.request_timeout):
-                await self._ws_monitor.connection_ack.wait()
-            payload = {
-                "operationName": "VehicleState",
-                "query": f"subscription VehicleState($vehicleID: String!) {{ vehicleState(id: $vehicleID) {self._build_vehicle_state_fragment(properties)} }}",
-                "variables": {"vehicleID": vehicle_id},
-            }
-            unsubscribe = await self._ws_monitor.start_subscription(payload, callback)
-            _LOGGER.debug("%s subscribed to updates", vehicle_id)
-            return unsubscribe
-        except Exception as ex:  # pylint: disable=broad-except # noqa: BLE001
-            _LOGGER.error(ex)
-            return None
+        payload = {
+            "operationName": "VehicleState",
+            "query": f"subscription VehicleState($vehicleID: String!) {{ vehicleState(id: $vehicleID) {self._build_vehicle_state_fragment(properties)} }}",
+            "variables": {"vehicleID": vehicle_id},
+        }
+        return await self._start_subscription(
+            payload, callback, f"{vehicle_id} vehicle updates"
+        )
 
     async def subscribe_for_departure_schedules(
         self, vehicle_id: str, callback: Callable[[dict[str, Any]], None]
@@ -836,22 +854,14 @@ class Rivian:
 
         The current schedules are sent right after subscribing.
         """
-        try:
-            await self._ws_connect()
-            assert self._ws_monitor
-            async with asyncio.timeout(self.request_timeout):
-                await self._ws_monitor.connection_ack.wait()
-            payload = {
-                "operationName": "VehicleDepartureSchedules",
-                "query": "subscription VehicleDepartureSchedules($vehicleId: String!) { vehicleDepartureSchedules(vehicleId: $vehicleId) { id name isEnabled occurrence { __typename ... on RepeatsWeekly { days startsAtMin skippedOn } } departureSettings { shouldOverrideChargeSchedule comfortSettings { cabinTempCelsius frontDefogDefrost surfaceHeatVentLevels { frontLeftSeat frontRightSeat rearLeftSeat rearRightSeat steeringWheel } } } } }",
-                "variables": {"vehicleId": vehicle_id},
-            }
-            unsubscribe = await self._ws_monitor.start_subscription(payload, callback)
-            _LOGGER.debug("%s subscribed to departure schedules", vehicle_id)
-            return unsubscribe
-        except Exception as ex:  # pylint: disable=broad-except # noqa: BLE001
-            _LOGGER.error(ex)
-            return None
+        payload = {
+            "operationName": "VehicleDepartureSchedules",
+            "query": "subscription VehicleDepartureSchedules($vehicleId: String!) { vehicleDepartureSchedules(vehicleId: $vehicleId) { id name isEnabled occurrence { __typename ... on RepeatsWeekly { days startsAtMin skippedOn } } departureSettings { shouldOverrideChargeSchedule comfortSettings { cabinTempCelsius frontDefogDefrost surfaceHeatVentLevels { frontLeftSeat frontRightSeat rearLeftSeat rearRightSeat steeringWheel } } } } }",
+            "variables": {"vehicleId": vehicle_id},
+        }
+        return await self._start_subscription(
+            payload, callback, f"{vehicle_id} departure schedules"
+        )
 
     async def subscribe_for_parallax_messages(
         self,
@@ -866,32 +876,60 @@ class Rivian:
         no decoder yet (`decode_parallax_message` returns None for those).
         Pass a list, e.g. `PARALLAX_RVMS`, to only receive those topics.
         """
+        variables: dict[str, Any] = {"vehicleId": vehicle_id}
+        if rvms is not None:
+            variables["rvms"] = rvms
+        payload = {
+            "operationName": "ParallaxMessages",
+            "query": "subscription ParallaxMessages($vehicleId: String!, $rvms: [String!]) { parallaxMessages(vehicleId: $vehicleId, rvms: $rvms) { payload timestamp rvm } }",
+            "variables": variables,
+        }
+        topics = "all Parallax RVMs" if rvms is None else f"{len(rvms)} Parallax RVMs"
+        return await self._start_subscription(
+            payload, callback, f"{vehicle_id} {topics}"
+        )
+
+    async def _start_subscription(
+        self,
+        payload: dict[str, Any],
+        callback: Callable[[dict[str, Any]], None],
+        description: str,
+    ) -> Callable[[], Awaitable[None]] | None:
+        """Connect the web socket if needed and start a subscription.
+
+        Returns the unsubscribe function, or None (after logging why) on failure.
+        """
+        reason: str | Exception
         try:
-            await self._ws_connect()
-            assert self._ws_monitor
-            async with asyncio.timeout(self.request_timeout):
-                await self._ws_monitor.connection_ack.wait()
-            variables: dict[str, Any] = {"vehicleId": vehicle_id}
-            if rvms is not None:
-                variables["rvms"] = rvms
-            payload = {
-                "operationName": "ParallaxMessages",
-                "query": "subscription ParallaxMessages($vehicleId: String!, $rvms: [String!]) { parallaxMessages(vehicleId: $vehicleId, rvms: $rvms) { payload timestamp rvm } }",
-                "variables": variables,
-            }
-            unsubscribe = await self._ws_monitor.start_subscription(payload, callback)
-            _LOGGER.debug(
-                "%s subscribed to %s",
-                vehicle_id,
-                "all Parallax RVMs" if rvms is None else f"{len(rvms)} Parallax RVMs",
-            )
-            return unsubscribe
+            ws_monitor = await self._ws_connect()
+            # Ends early if the connection closes, e.g. when rate limited
+            if await ws_monitor.wait_for_ack() and (
+                unsubscribe := await ws_monitor.start_subscription(payload, callback)
+            ):
+                _LOGGER.debug("Subscribed to %s", description)
+                return unsubscribe
+            if backoff_reason := ws_monitor.backoff_reason:
+                reason = f"the web socket connection {backoff_reason}"
+            elif close_message := ws_monitor.close_message:
+                reason = f"the web socket connection closed ({close_message})"
+            else:
+                reason = "the web socket connection closed"
         except Exception as ex:  # pylint: disable=broad-except # noqa: BLE001
-            _LOGGER.error(ex)
-            return None
+            reason = ex
+        # Expected while backing off, so less severe than other failures
+        _LOGGER.log(
+            logging.WARNING if self.ws_backoff_remaining else logging.ERROR,
+            "Unable to subscribe to %s: %s",
+            description,
+            reason,
+        )
+        if self._ws_monitor and not self._ws_monitor.has_subscriptions:
+            # Don't leave a connection open, or reconnecting, with nothing on it
+            await self._ws_monitor.close()
+        return None
 
-    async def _ws_connect(self) -> ClientWebSocketResponse[bool]:
-        """Initiate a websocket connection."""
+    async def _ws_connect(self) -> WebSocketMonitor:
+        """Connect the web socket if needed and return its monitor."""
 
         async def connection_init(websocket: ClientWebSocketResponse[bool]) -> None:
             await websocket.send_json(
@@ -908,17 +946,23 @@ class Rivian:
 
         if not self._ws_monitor:
             self._ws_monitor = WebSocketMonitor(
-                self, GRAPHQL_WEBSOCKET, connection_init
+                self,
+                GRAPHQL_WEBSOCKET,
+                connection_init,
+                backoff_key=self._user_session_token,
             )
         ws_monitor = self._ws_monitor
-        if ws_monitor.backing_off:
-            raise RivianApiException("Web socket is waiting to reconnect")
         if ws_monitor.websocket is None or ws_monitor.websocket.closed:
+            # A backoff only holds off new connections, not an open one
+            if remaining := ws_monitor.backoff_remaining:
+                raise RivianApiException(
+                    "the web socket is waiting to reconnect "
+                    f"({remaining:.0f} seconds left)"
+                )
             await ws_monitor.new_connection(True)
-            assert ws_monitor.websocket
         if ws_monitor.monitor is None or ws_monitor.monitor.done():
             await ws_monitor.start_monitor()
-        return ws_monitor.websocket
+        return ws_monitor
 
     async def __graphql_query(
         self, headers: dict[str, str], url: str, body: dict[str, Any]

{rivian_python_client-2.3.0 → rivian_python_client-2.3.1}/src/rivian/ws_monitor.py

@@ -5,11 +5,13 @@ from __future__ import annotations
 import asyncio
 import inspect
 import logging
-from collections.abc import Awaitable, Callable
+import time
+from collections.abc import Awaitable, Callable, Hashable
+from dataclasses import dataclass
 from datetime import UTC, datetime
 from json import loads
 from random import uniform
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, Any, ClassVar
 from uuid import uuid4
 
 from aiohttp import ClientWebSocketResponse, WSMessage, WSMsgType
@@ -21,14 +23,20 @@ if TYPE_CHECKING:
 _LOGGER = logging.getLogger(__name__)
 
 RATE_LIMITED = "Rate limited"
+UNAUTHENTICATED = "Unauthenticated"
 RATE_LIMIT_BACKOFF_MIN = 30
 RATE_LIMIT_BACKOFF_MAX = 900
 
+# Backoff reasons, completing "the web socket connection ..."
+BACKOFF_RATE_LIMITED = "was rate limited"
+BACKOFF_NOT_ACKNOWLEDGED = "was not acknowledged"
+
 
 async def cancel_task(*tasks: asyncio.Task | None) -> None:
-    """Cancel task(s)."""
+    """Cancel task(s), other than the one running this."""
+    current = asyncio.current_task()
     for task in tasks:
-        if task is not None and not task.done():
+        if task is not None and task is not current and not task.done():
             task.cancel()
             try:
                 await task
@@ -36,24 +44,52 @@ async def cancel_task(*tasks: asyncio.Task | None) -> None:
                 pass
 
 
+@dataclass
+class _Backoff:
+    """Backoff state: consecutive failed connections and when to retry."""
+
+    attempt: int = 0
+    retry_at: float = 0  # time.monotonic()
+    rate_limited: bool = False  # whether the backoff until retry_at is a rate limit
+
+
 class WebSocketMonitor:
     """Web socket monitor for a vehicle."""
 
+    # Backoff state by key, shared so a new monitor for the same session doesn't
+    # connect while another is waiting out a rate limit
+    _shared_backoffs: ClassVar[dict[Hashable, _Backoff]] = {}
+
     def __init__(
         self,
         account: Rivian,
         url: str,
         connection_init: Callable[[ClientWebSocketResponse[bool]], Awaitable[None]],
+        backoff_key: Hashable | None = None,
     ) -> None:
-        """Initialize a web socket monitor."""
+        """Initialize a web socket monitor.
+
+        Monitors with the same `backoff_key` (e.g. the user session) share their
+        backoff state; without one, the state is the monitor's own.
+        """
         self._account = account
         self._url = url
         self._connection_init = connection_init
 
         self._connection_ack: asyncio.Event = asyncio.Event()
+        # Set while there's no open connection
+        self._closed: asyncio.Event = asyncio.Event()
+        self._closed.set()
         self._disconnect = False
+        # Why the current connection is backing off, at most once per connection
         self._backoff_reason: str | None = None
-        self._rate_limit_attempt = 0
+        # The server's reason for closing the current connection, if it gave one
+        self._close_message: str | None = None
+        self._backoff_state = (
+            _Backoff()
+            if backoff_key is None
+            else self._shared_backoffs.setdefault(backoff_key, _Backoff())
+        )
         self._ws: ClientWebSocketResponse[bool] | None = None
         self._monitor_task: asyncio.Task | None = None
         self._receiver_task: asyncio.Task | None = None
@@ -87,12 +123,47 @@ class WebSocketMonitor:
     @property
     def backing_off(self) -> bool:
         """Return `True` while waiting to reconnect after a failed connection."""
-        return self._backoff_reason is not None
+        return self.backoff_remaining > 0
+
+    @property
+    def backoff_reason(self) -> str | None:
+        """Return why the latest connection is backing off, if it is."""
+        return self._backoff_reason
+
+    @property
+    def close_message(self) -> str | None:
+        """Return the server's reason for closing the latest connection, if any."""
+        return self._close_message
+
+    @property
+    def rate_limited(self) -> bool:
+        """Return `True` while backing off after a rate limit.
+
+        Shared like the backoff, so a new monitor for the same session sees it too.
+        """
+        return self._backoff_state.rate_limited and self.backoff_remaining > 0
+
+    @property
+    def unauthenticated(self) -> bool:
+        """Return `True` if the server closed the latest connection as unauthenticated."""
+        return self._close_message == UNAUTHENTICATED
+
+    @property
+    def backoff_remaining(self) -> float:
+        """Return the seconds left before reconnecting is allowed."""
+        return max(self._backoff_state.retry_at - time.monotonic(), 0)
+
+    @property
+    def has_subscriptions(self) -> bool:
+        """Return `True` if there are subscriptions to resume on reconnect."""
+        return bool(self._subscriptions)
 
     async def new_connection(self, start_monitor: bool = False) -> None:
         """Create a new connection and, optionally, start the monitor."""
         await cancel_task(self._receiver_task)
         self._disconnect = False
+        self._backoff_reason = None
+        self._close_message = None
         self._connection_ack.clear()
         # pylint: disable=protected-access
         assert self._account._session
@@ -100,10 +171,36 @@ class WebSocketMonitor:
             url=self._url, headers={"sec-websocket-protocol": "graphql-transport-ws"}
         )
         await self._connection_init(self._ws)
+        self._closed.clear()
         self._receiver_task = asyncio.ensure_future(self._receiver())
         if start_monitor:
             await self.start_monitor()
 
+    async def wait_for_ack(self) -> bool:
+        """Wait for the connection to be acknowledged or to close.
+
+        Returns whether it was acknowledged. A connection that isn't acknowledged
+        within the request timeout is closed and backed off.
+        """
+        if not self._connection_ack.is_set():
+            waits = [
+                asyncio.ensure_future(self._connection_ack.wait()),
+                asyncio.ensure_future(self._closed.wait()),
+            ]
+            try:
+                done, _ = await asyncio.wait(
+                    waits,
+                    timeout=self._account.request_timeout,
+                    return_when=asyncio.FIRST_COMPLETED,
+                )
+            finally:
+                await cancel_task(*waits)
+            if not done:
+                self._start_backoff(BACKOFF_NOT_ACKNOWLEDGED)
+                if self._ws:
+                    await self._ws.close()
+        return self._connection_ack.is_set()
+
     async def start_subscription(
         self, payload: dict[str, Any], callback: Callable[[dict[str, Any]], None]
     ) -> Callable[[], Awaitable[None]] | None:
@@ -121,6 +218,10 @@ class WebSocketMonitor:
                 if self.connected:
                     assert self._ws
                     await self._ws.send_json({"id": _id, "type": "complete"})
+                if not self._subscriptions:
+                    # Don't keep a connection open with nothing on it; the next
+                    # subscription reconnects
+                    await self.close()
 
         return unsubscribe
 
@@ -144,6 +245,17 @@ class WebSocketMonitor:
         """Receive a message from a web socket."""
         if not (websocket := self._ws):
             return
+        try:
+            await self._receive(websocket)
+        finally:
+            # A receiver restarted on an open connection keeps its ack
+            if websocket.closed:
+                self._connection_ack.clear()
+                self._closed.set()
+        self._log_message("web socket stopped")
+
+    async def _receive(self, websocket: ClientWebSocketResponse[bool]) -> None:
+        """Handle messages until the web socket closes."""
         loop = asyncio.get_running_loop()
         ack_deadline = loop.time() + self._account.request_timeout
         while not websocket.closed:
@@ -157,10 +269,11 @@ class WebSocketMonitor:
                 msg = await websocket.receive(timeout=timeout)
                 if msg.type in (WSMsgType.CLOSE, WSMsgType.CLOSING, WSMsgType.CLOSED):
                     self._log_message(msg)
-                    if msg.extra == "Unauthenticated":
+                    self._close_message = msg.extra or None
+                    if msg.extra == UNAUTHENTICATED:
                         self._disconnect = True
                     elif msg.extra == RATE_LIMITED:
-                        self._backoff_reason = "was rate limited"
+                        self._start_backoff(BACKOFF_RATE_LIMITED)
                     break
                 self._last_received = datetime.now(UTC)
                 if msg.type == WSMsgType.TEXT:
@@ -168,13 +281,17 @@ class WebSocketMonitor:
                     if (data_type := data.get("type")) == "connection_ack":
                         self._connection_ack.set()
                     elif data_type == "next":
-                        self._rate_limit_attempt = 0
+                        self._reset_backoff()
                         if (_id := data.get("id")) in self._subscriptions:
                             _fn = self._subscriptions[_id][0]
-                            if inspect.iscoroutinefunction(_fn):
-                                await _fn(data)
-                            else:
-                                _fn(data)
+                            # A failing callback shouldn't take the connection down
+                            try:
+                                if inspect.iscoroutinefunction(_fn):
+                                    await _fn(data)
+                                else:
+                                    _fn(data)
+                            except Exception:  # pylint: disable=broad-except
+                                _LOGGER.exception("Error in a subscription callback")
                     else:
                         self._log_message(msg)
                 elif msg.type == WSMsgType.ERROR:
@@ -182,14 +299,12 @@ class WebSocketMonitor:
                     continue
             except TimeoutError:
                 if not acknowledged:
-                    self._backoff_reason = "was not acknowledged"
+                    self._start_backoff(BACKOFF_NOT_ACKNOWLEDGED)
                     await websocket.close()
                     break
                 # The connection has stayed open, so any rate limit has passed
-                self._rate_limit_attempt = 0
+                self._reset_backoff()
                 await self._resubscribe_all()
-        self._connection_ack.clear()
-        self._log_message("web socket stopped")
 
     async def _monitor(self) -> None:
         """Monitor a web socket connection."""
@@ -200,10 +315,17 @@ class WebSocketMonitor:
                     # Need to restart the receiver
                     self._receiver_task = asyncio.ensure_future(self._receiver())
                 await asyncio.sleep(1)
-            if self._backoff_reason:
-                await self._backoff()
-                if self._disconnect or self.connected:
-                    continue
+            if not self._subscriptions:
+                # Nothing to resume, so stop rather than keep reconnecting; the
+                # next subscription reconnects once any backoff has passed
+                self._log_message("web socket monitor stopped, nothing subscribed")
+                break
+            while delay := self.backoff_remaining:
+                # Re-check after waiting, as another monitor for the same session
+                # may have pushed the retry back
+                await asyncio.sleep(delay)
+            if self._disconnect or self.connected:
+                continue
             if not self._disconnect:
                 try:
                     await self.new_connection()
@@ -217,23 +339,35 @@ class WebSocketMonitor:
                 self._log_message("web socket connection reopened")
                 await self._resubscribe_all()
 
-    async def _backoff(self) -> None:
-        """Wait before reconnecting after a rate limit or a missing connection_ack."""
+    def _start_backoff(self, reason: str) -> None:
+        """Hold off reconnecting after a rate limit or a missing connection_ack.
+
+        The retry time is recorded right away, so closing the monitor can't lose
+        it; a connection backs off at most once.
+        """
+        if self._backoff_reason:
+            return
+        self._backoff_reason = reason
+        state = self._backoff_state
         delay = min(
-            RATE_LIMIT_BACKOFF_MIN * 2**self._rate_limit_attempt
+            RATE_LIMIT_BACKOFF_MIN * 2**state.attempt
             + uniform(0, RATE_LIMIT_BACKOFF_MIN),
             RATE_LIMIT_BACKOFF_MAX,
         )
-        self._rate_limit_attempt += 1
+        state.attempt += 1
+        # Don't cut short a longer backoff another monitor for the session started
+        if (retry_at := time.monotonic() + delay) > state.retry_at:
+            state.retry_at = retry_at
+            state.rate_limited = reason == BACKOFF_RATE_LIMITED
         _LOGGER.warning(
             "Web socket connection %s, reconnecting in %.0f seconds",
-            self._backoff_reason,
-            delay,
+            reason,
+            self.backoff_remaining,
         )
-        try:
-            await asyncio.sleep(delay)
-        finally:
-            self._backoff_reason = None
+
+    def _reset_backoff(self) -> None:
+        """Start the next backoff over, now that the connection is healthy."""
+        self._backoff_state.attempt = 0
 
     async def start_monitor(self) -> None:
         """Start or restart the monitor task."""
@@ -247,7 +381,6 @@ class WebSocketMonitor:
     async def close(self) -> None:
         """Close the web socket."""
         self._disconnect = True
-        self._backoff_reason = None
         if self._ws:
             await self._ws.close()
         await cancel_task(self._monitor_task, self._receiver_task)

rivian_python_client-2.3.0/src/rivian/parallax/proto/departure_pb2.py

@@ -1,54 +0,0 @@
-# -*- coding: utf-8 -*-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# NO CHECKED-IN PROTOBUF GENCODE
-# source: rivian/parallax/proto/departure.proto
-# Protobuf Python Version: 6.31.1
-"""Generated protocol buffer code."""
-from google.protobuf import descriptor as _descriptor
-from google.protobuf import descriptor_pool as _descriptor_pool
-from google.protobuf import runtime_version as _runtime_version
-from google.protobuf import symbol_database as _symbol_database
-from google.protobuf.internal import builder as _builder
-_runtime_version.ValidateProtobufRuntimeVersion(
-    _runtime_version.Domain.PUBLIC,
-    6,
-    31,
-    1,
-    '',
-    'rivian/parallax/proto/departure.proto'
-)
-# @@protoc_insertion_point(imports)
-
-_sym_db = _symbol_database.Default()
-
-
-
-
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n%rivian/parallax/proto/departure.proto\x12\x19rivian.parallax.departure\"\xd2\x0b\n\x12\x44\x65partureSchedules\x12H\n\x08schedule\x18\x01 \x03(\x0b\x32\x36.rivian.parallax.departure.DepartureSchedules.Schedule\x12K\n\nupdated_at\x18\x02 \x01(\x0b\x32\x37.rivian.parallax.departure.DepartureSchedules.UpdatedAt\x1a\xfd\x01\n\x08Schedule\x12\x0f\n\x02id\x18\x01 \x01(\tH\x00\x88\x01\x01\x12\x11\n\x04name\x18\x02 \x01(\tH\x01\x88\x01\x01\x12\x12\n\nis_enabled\x18\x03 \x01(\x08\x12L\n\noccurrence\x18\x04 \x01(\x0b\x32\x38.rivian.parallax.departure.DepartureSchedules.Occurrence\x12[\n\x12\x64\x65parture_settings\x18\x06 \x01(\x0b\x32?.rivian.parallax.departure.DepartureSchedules.DepartureSettingsB\x05\n\x03_idB\x07\n\x05_name\x1at\n\nOccurrence\x12@\n\x04\x64\x61ys\x18\x01 \x01(\x0b\x32\x32.rivian.parallax.departure.DepartureSchedules.Days\x12\x16\n\tstarts_at\x18\x02 \x01(\x05H\x00\x88\x01\x01\x42\x0c\n\n_starts_at\x1a~\n\x04\x44\x61ys\x12\x0e\n\x06monday\x18\x01 \x01(\x08\x12\x0f\n\x07tuesday\x18\x02 \x01(\x08\x12\x11\n\twednesday\x18\x03 \x01(\x08\x12\x10\n\x08thursday\x18\x04 \x01(\x08\x12\x0e\n\x06\x66riday\x18\x05 \x01(\x08\x12\x10\n\x08saturday\x18\x06 \x01(\x08\x12\x0e\n\x06sunday\x18\x07 \x01(\x08\x1a\x95\x01\n\x11\x44\x65partureSettings\x12W\n\x10\x63omfort_settings\x18\x01 \x01(\x0b\x32=.rivian.parallax.departure.DepartureSchedules.ComfortSettings\x12\'\n\x1fshould_override_charge_schedule\x18\x02 \x01(\x08\x1a\xde\x01\n\x0f\x43omfortSettings\x12\x19\n\x11\x63\x61\x62in_temperature\x18\x01 \x01(\x02\x12I\n\x13\x66ront_defog_defrost\x18\x02 \x01(\x0e\x32,.rivian.parallax.departure.DefogDefrostLevel\x12\x65\n\x18surface_heat_vent_levels\x18\x03 \x01(\x0b\x32\x43.rivian.parallax.departure.DepartureSchedules.SurfaceHeatVentLevels\x1a\x88\x03\n\x15SurfaceHeatVentLevels\x12H\n\x0f\x66ront_left_seat\x18\x01 \x01(\x0e\x32/.rivian.parallax.departure.SurfaceHeatVentLevel\x12I\n\x10\x66ront_right_seat\x18\x02 \x01(\x0e\x32/.rivian.parallax.departure.SurfaceHeatVentLevel\x12G\n\x0erear_left_seat\x18\x03 \x01(\x0e\x32/.rivian.parallax.departure.SurfaceHeatVentLevel\x12H\n\x0frear_right_seat\x18\x04 \x01(\x0e\x32/.rivian.parallax.departure.SurfaceHeatVentLevel\x12G\n\x0esteering_wheel\x18\x05 \x01(\x0e\x32/.rivian.parallax.departure.SurfaceHeatVentLevel\x1a+\n\tUpdatedAt\x12\x0f\n\x07seconds\x18\x01 \x01(\x03\x12\r\n\x05nanos\x18\x02 \x01(\x05*^\n\x11\x44\x65\x66ogDefrostLevel\x12\x15\n\x11\x44\x45\x46OG_DEFROST_OFF\x10\x00\x12\x17\n\x13\x44\x45\x46OG_DEFROST_DEFOG\x10\x01\x12\x19\n\x15\x44\x45\x46OG_DEFROST_DEFROST\x10\x02*\x9f\x01\n\x14SurfaceHeatVentLevel\x12\x0f\n\x0bSURFACE_OFF\x10\x00\x12\x12\n\x0eSURFACE_HEAT_1\x10\x01\x12\x12\n\x0eSURFACE_HEAT_2\x10\x02\x12\x12\n\x0eSURFACE_HEAT_3\x10\x03\x12\x12\n\x0eSURFACE_VENT_1\x10\x04\x12\x12\n\x0eSURFACE_VENT_2\x10\x05\x12\x12\n\x0eSURFACE_VENT_3\x10\x06\x62\x06proto3')
-
-_globals = globals()
-_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
-_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'rivian.parallax.proto.departure_pb2', _globals)
-if not _descriptor._USE_C_DESCRIPTORS:
-  DESCRIPTOR._loaded_options = None
-  _globals['_DEFOGDEFROSTLEVEL']._serialized_start=1561
-  _globals['_DEFOGDEFROSTLEVEL']._serialized_end=1655
-  _globals['_SURFACEHEATVENTLEVEL']._serialized_start=1658
-  _globals['_SURFACEHEATVENTLEVEL']._serialized_end=1817
-  _globals['_DEPARTURESCHEDULES']._serialized_start=69
-  _globals['_DEPARTURESCHEDULES']._serialized_end=1559
-  _globals['_DEPARTURESCHEDULES_SCHEDULE']._serialized_start=243
-  _globals['_DEPARTURESCHEDULES_SCHEDULE']._serialized_end=496
-  _globals['_DEPARTURESCHEDULES_OCCURRENCE']._serialized_start=498
-  _globals['_DEPARTURESCHEDULES_OCCURRENCE']._serialized_end=614
-  _globals['_DEPARTURESCHEDULES_DAYS']._serialized_start=616
-  _globals['_DEPARTURESCHEDULES_DAYS']._serialized_end=742
-  _globals['_DEPARTURESCHEDULES_DEPARTURESETTINGS']._serialized_start=745
-  _globals['_DEPARTURESCHEDULES_DEPARTURESETTINGS']._serialized_end=894
-  _globals['_DEPARTURESCHEDULES_COMFORTSETTINGS']._serialized_start=897
-  _globals['_DEPARTURESCHEDULES_COMFORTSETTINGS']._serialized_end=1119
-  _globals['_DEPARTURESCHEDULES_SURFACEHEATVENTLEVELS']._serialized_start=1122
-  _globals['_DEPARTURESCHEDULES_SURFACEHEATVENTLEVELS']._serialized_end=1514
-  _globals['_DEPARTURESCHEDULES_UPDATEDAT']._serialized_start=1516
-  _globals['_DEPARTURESCHEDULES_UPDATEDAT']._serialized_end=1559
-# @@protoc_insertion_point(module_scope)