rivian-python-client 2.2.0b11__py3-none-any.whl → 2.3.0__py3-none-any.whl

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.2.0b11'
+__version__ = VERSION = '2.3.0'

rivian/const.py

@@ -2,34 +2,9 @@
 
 from __future__ import annotations
 
-import sys
+from enum import StrEnum
 from typing import Final
 
-if sys.version_info >= (3, 11):
-    from enum import StrEnum
-else:
-    from backports.strenum import StrEnum
-
-LIVE_SESSION_PROPERTIES: Final[set[str]] = {
-    "chargerId",
-    "current",
-    "currentCurrency",
-    "currentMiles",
-    "currentPrice",
-    "isFreeSession",
-    "isRivianCharger",
-    "kilometersChargedPerHour",
-    "locationId",
-    "power",
-    "rangeAddedThisSession",
-    "soc",
-    "startTime",
-    "timeElapsed",
-    "timeRemaining",
-    "totalChargedEnergy",
-    "vehicleChargerState",
-}
-
 VEHICLE_STATE_PROPERTIES: Final[set[str]] = {
     # VehicleCloudConnection
     "cloudConnection",
@@ -38,7 +13,6 @@ VEHICLE_STATE_PROPERTIES: Final[set[str]] = {
     "gnssLocation",
     "gnssError",
     # TimeStamped(String|[Nullable]Float|Int)
-    "activeDriverName",
     "alarmSoundStatus",
     "batteryCapacity",
     "batteryCellType",

rivian/parallax/__init__.py

@@ -7,6 +7,9 @@ Public API:
         Same, for a raw `subscribe_for_parallax_messages` message.
     PARALLAX_RVMS: list[str]  — every RVM with a registered decoder
     CHARGING_RVMS: list[str]  — the subset relevant to a charging session
+    encode_vehicle_operation(rvm, payload=b"", ...) -> str
+        Builds a `send_vehicle_operation` request; an empty payload reads
+        the RVM, anything else (e.g. `encode_climate_hold_setting`) writes it.
 
 Layout:
     core.py  - registry, payload parsing and shared helpers
@@ -41,11 +44,17 @@ from . import (  # noqa: F401  (imported to register their decoders)
     vehicle,
     vehicle_access,
 )
+from .comfort import (
+    CLIMATE_HOLD_SETTING_RVM,
+    CLIMATE_HOLD_STATUS_RVM,
+    encode_climate_hold_setting,
+)
 from .core import (
     RVMDecoder,
     decode_parallax_message,
     decode_parallax_subscription_message,
 )
+from .operation import encode_vehicle_operation
 
 PARALLAX_RVMS: list[str] = list(RVMDecoder.decoders)
 
@@ -64,7 +73,11 @@ CHARGING_RVMS: list[str] = [
 
 __all__ = [
     "CHARGING_RVMS",
+    "CLIMATE_HOLD_SETTING_RVM",
+    "CLIMATE_HOLD_STATUS_RVM",
     "PARALLAX_RVMS",
     "decode_parallax_message",
     "decode_parallax_subscription_message",
+    "encode_climate_hold_setting",
+    "encode_vehicle_operation",
 ]

rivian/parallax/body.py

@@ -126,8 +126,8 @@ _WINDOW_MAP: Final[dict[int, str]] = {
 
 # GraphQL's windowXCalibrated values.
 _CALIBRATION_MAP: Final[dict[int, str]] = {
-    body_pb2.CALIBRATION_STATUS_CALIBRATED: "Calibrated",
-    body_pb2.CALIBRATION_STATUS_NOT_CALIBRATED: "Not_Calibrated",
+    body_pb2.CALIBRATION_STATUS_CALIBRATED: "calibrated",
+    body_pb2.CALIBRATION_STATUS_NOT_CALIBRATED: "not_calibrated",
 }
 
 _TRAILER_PRESENCE_MAP: Final[dict[int, str]] = {
@@ -204,7 +204,7 @@ def decode_windows(m: body_pb2.WindowsState) -> dict[str, Any]:
     Fields:
         windowFrontLeftCalibrated, windowFrontRightCalibrated,
         windowRearLeftCalibrated, windowRearRightCalibrated,
-        windowRearCalibrated: str ("Calibrated" | "Not_Calibrated")
+        windowRearCalibrated: str ("calibrated" | "not_calibrated")
     """
     return {
         _WINDOW_MAP[w.instance]: _enum(

rivian/parallax/charging.py

@@ -374,7 +374,7 @@ def decode_energy_state(m: charging_pb2.EnergyState) -> dict[str, Any]:
         energyChargerState, energyConnectionState: str — as
             charging.session.status's chargerState / connectionState, which
             these can lag
-        _field3: int — raw
+        _field3, _field8: int — raw
     """
     result: dict[str, Any] = {}
     if (v := _present(m, "charging_state")) is not None:
@@ -389,6 +389,8 @@ def decode_energy_state(m: charging_pb2.EnergyState) -> dict[str, Any]:
         result["chargerStatus"] = _enum(_CHARGER_STATUS_MAP, v, what="charger status")
     if (v := _present(m, "field_3")) is not None:
         result["_field3"] = v
+    if (v := _present(m, "field_8")) is not None:
+        result["_field8"] = v
     return result
 
 

rivian/parallax/comfort.py

@@ -7,6 +7,9 @@ from typing import Any, Final
 from .core import _LOGGER, RVMDecoder, _enum, _present
 from .proto import comfort_pb2
 
+CLIMATE_HOLD_SETTING_RVM: Final = "comfort.cabin.climate_hold_setting"
+CLIMATE_HOLD_STATUS_RVM: Final = "comfort.cabin.climate_hold_status"
+
 
 @RVMDecoder.register(
     "comfort.cabin.hvac_settings_status", comfort_pb2.HvacSettingsStatus
@@ -63,10 +66,10 @@ _CLIMATE_HOLD_UNAVAILABILITY_REASON_MAP: Final[dict[int, str]] = {
 }
 
 _DEFROST_MAP: Final[dict[int, str]] = {
-    comfort_pb2.DEFROST_DEFOG: "Defog",
-    comfort_pb2.DEFROST_ACTIVE: "Defrost",
-    comfort_pb2.DEFROST_DEFOG_DEFROST: "Defog_Defrost",
-    comfort_pb2.DEFROST_OFF: "Off",
+    comfort_pb2.DEFROST_DEFOG: "defog",
+    comfort_pb2.DEFROST_ACTIVE: "defrost",
+    comfort_pb2.DEFROST_DEFOG_DEFROST: "defog_defrost",
+    comfort_pb2.DEFROST_OFF: "off",
 }
 
 # GraphQL's cabinPreconditioningStatus / cabinPreconditioningType values.
@@ -132,10 +135,10 @@ _CABIN_SURFACE_MAP: Final[dict[int, str]] = {
 }
 
 _CONDITIONING_LEVEL_MAP: Final[dict[int | None, str]] = {
-    None: "Off",
-    comfort_pb2.CONDITIONING_LEVEL_1: "Level_1",
-    comfort_pb2.CONDITIONING_LEVEL_2: "Level_2",
-    comfort_pb2.CONDITIONING_LEVEL_3: "Level_3",
+    None: "off",
+    comfort_pb2.CONDITIONING_LEVEL_1: "level_1",
+    comfort_pb2.CONDITIONING_LEVEL_2: "level_2",
+    comfort_pb2.CONDITIONING_LEVEL_3: "level_3",
 }
 
 _CONDITIONING_TYPE_MAP: Final[dict[int, str]] = {
@@ -200,9 +203,12 @@ def decode_cabin_ventilation(m: comfort_pb2.CabinVentilationSetting) -> dict[str
     return {"cabinVentilationEnabled": m.auto_cabin_ventilation_enabled}
 
 
-@RVMDecoder.register(
-    "comfort.cabin.climate_hold_setting", comfort_pb2.ClimateHoldSetting
-)
+def encode_climate_hold_setting(duration_seconds: int) -> bytes:
+    """Encode a comfort.cabin.climate_hold_setting payload."""
+    return comfort_pb2.ClimateHoldSetting(duration=duration_seconds).SerializeToString()
+
+
+@RVMDecoder.register(CLIMATE_HOLD_SETTING_RVM, comfort_pb2.ClimateHoldSetting)
 def decode_climate_hold_setting(m: comfort_pb2.ClimateHoldSetting) -> dict[str, Any]:
     """comfort.cabin.climate_hold_setting — configured climate-hold duration.
 
@@ -212,7 +218,7 @@ def decode_climate_hold_setting(m: comfort_pb2.ClimateHoldSetting) -> dict[str,
     return {"climateHoldDuration": m.duration}
 
 
-@RVMDecoder.register("comfort.cabin.climate_hold_status", comfort_pb2.ClimateHoldStatus)
+@RVMDecoder.register(CLIMATE_HOLD_STATUS_RVM, comfort_pb2.ClimateHoldStatus)
 def decode_climate_hold_status(m: comfort_pb2.ClimateHoldStatus) -> dict[str, Any]:
     """comfort.cabin.climate_hold_status — current climate-hold status.
 
@@ -248,8 +254,8 @@ def decode_defrost_status(m: comfort_pb2.DefrostDefogStatus) -> dict[str, Any]:
     """comfort.cabin.defrost_defog_status — windshield defrost state.
 
     Fields:
-        defrostDefogStatus: str | None ("Defog" | "Defrost" | "Defog_Defrost"
-            | "Off")
+        defrostDefogStatus: str | None ("defog" | "defrost" | "defog_defrost"
+            | "off")
     """
     return {
         "defrostDefogStatus": _enum(
@@ -293,8 +299,8 @@ def decode_seat_conditioning(m: comfort_pb2.SeatConditioningStatus) -> dict[str,
         seatFrontLeftHeat, seatFrontLeftVent, seatFrontRightHeat,
         seatFrontRightVent, seatRearLeftHeat, seatRearRightHeat,
         seatThirdRowLeftHeat, seatThirdRowRightHeat: str
-            ("Off" | "Level_1" | "Level_2" | "Level_3")
-        steeringWheelHeat: str ("Off" | "Level_1")
+            ("off" | "level_1" | "level_2" | "level_3")
+        steeringWheelHeat: str ("off" | "level_1")
         plus <surface>Heat/Vent for any other surface sent (middle seats,
         rearGlass, frontGlass, sideviewMirrors, wiperArea)
 

rivian/parallax/departure.py

@@ -12,28 +12,28 @@ _Schedules = departure_pb2.DepartureSchedules
 
 # Days field -> gateway WeekDay value.
 _WEEKDAYS = (
-    ("monday", "Monday"),
-    ("tuesday", "Tuesday"),
-    ("wednesday", "Wednesday"),
-    ("thursday", "Thursday"),
-    ("friday", "Friday"),
-    ("saturday", "Saturday"),
-    ("sunday", "Sunday"),
+    ("monday", "monday"),
+    ("tuesday", "tuesday"),
+    ("wednesday", "wednesday"),
+    ("thursday", "thursday"),
+    ("friday", "friday"),
+    ("saturday", "saturday"),
+    ("sunday", "sunday"),
 )
 
 _DEFOG_DEFROST = {
-    departure_pb2.DEFOG_DEFROST_OFF: "Off",
-    departure_pb2.DEFOG_DEFROST_DEFOG: "Defog",
-    departure_pb2.DEFOG_DEFROST_DEFROST: "Defrost",
+    departure_pb2.DEFOG_DEFROST_OFF: "off",
+    departure_pb2.DEFOG_DEFROST_DEFOG: "defog",
+    departure_pb2.DEFOG_DEFROST_DEFROST: "defrost",
 }
 _SURFACE_LEVEL = {
-    departure_pb2.SURFACE_OFF: "Off",
-    departure_pb2.SURFACE_HEAT_1: "Heat1",
-    departure_pb2.SURFACE_HEAT_2: "Heat2",
-    departure_pb2.SURFACE_HEAT_3: "Heat3",
-    departure_pb2.SURFACE_VENT_1: "Vent1",
-    departure_pb2.SURFACE_VENT_2: "Vent2",
-    departure_pb2.SURFACE_VENT_3: "Vent3",
+    departure_pb2.SURFACE_OFF: "off",
+    departure_pb2.SURFACE_HEAT_1: "heat_1",
+    departure_pb2.SURFACE_HEAT_2: "heat_2",
+    departure_pb2.SURFACE_HEAT_3: "heat_3",
+    departure_pb2.SURFACE_VENT_1: "vent_1",
+    departure_pb2.SURFACE_VENT_2: "vent_2",
+    departure_pb2.SURFACE_VENT_3: "vent_3",
 }
 _SURFACES = (
     ("front_left_seat", "frontLeftSeat"),
@@ -86,14 +86,14 @@ def decode_departure_schedules(m: departure_pb2.DepartureSchedules) -> dict[str,
     Fields:
         departureSchedules: list[dict] — the gateway's DepartureSchedule shape:
             id: str, name: str, isEnabled: bool
-            occurrence: {"days": list[str] ("Monday" ... "Sunday"; order
+            occurrence: {"days": list[str] ("monday" ... "sunday"; order
                 inferred), "startsAtMin": int (minutes after local midnight)}
             departureSettings: {"shouldOverrideChargeSchedule": bool,
                 "comfortSettings": {"cabinTempCelsius": float,
-                "frontDefogDefrost": "Off" | "Defog" | "Defrost",
+                "frontDefogDefrost": "off" | "defog" | "defrost",
                 "surfaceHeatVentLevels": {frontLeftSeat, frontRightSeat,
-                rearLeftSeat, rearRightSeat, steeringWheel: "Off" |
-                "Heat1" ... "Vent3"}}}
+                rearLeftSeat, rearRightSeat, steeringWheel: "off" |
+                "heat_1" ... "vent_3"}}}
         departureSchedulesUpdatedAt: datetime
     """
     result: dict[str, Any] = {

rivian/parallax/device_table.py

@@ -5,6 +5,7 @@ from __future__ import annotations
 import uuid
 from typing import Any, Final
 
+from ..utils import from_epoch
 from .core import RVMDecoder, _enum, _present
 from .proto import device_table_pb2
 
@@ -59,9 +60,14 @@ def decode_vas_keyper_devices(m: device_table_pb2.VasKeyperDevices) -> dict[str,
         infoC: int — 1 while active, 2147483647 while inactive, else the
             pairing attempt number
         infoA, infoB: int — unknown
+        keyPermissions: int — raw
+        keyCreatedAt, keyExpiresAt: datetime — when sent and non-zero
+        keyMaterial: str — which key material is set ("owner" | "friend" |
+            "card" | "fob" | "phone" | "fob2")
         deviceId: str — hex; for a key card, the GraphQL `devices[].id`
+        nfcDeviceId: str — hex; fob2's NFC id (deviceId is its BLE id)
         phoneId: str — the phone's UUID; phone keys
-        credentialHex: str — hex; likely key material
+        credentialHex: str — hex; the wrapped shared secret
         deviceOem: str ("unknown" | "rivian" | "apple" | "google" |
             "samsung" | "vw") — the device maker
     """
@@ -100,17 +106,29 @@ def decode_vas_keyper_devices(m: device_table_pb2.VasKeyperDevices) -> dict[str,
                 result[key] = v
         if (v := _present(credentials.info, "status")) is not None:
             result["keyStatus"] = _enum(_KEY_STATUS_MAP, v, what="key status")
-    for field in ("card", "fob", "phone"):
-        if not credentials.HasField(field):
-            continue
+        if (v := _present(credentials.info, "permissions")) is not None:
+            result["keyPermissions"] = v
+        for field, key in (
+            ("created_at", "keyCreatedAt"),
+            ("expires_at", "keyExpiresAt"),
+        ):
+            if v := _present(credentials.info, field):
+                result[key] = from_epoch(v)
+    if (field := credentials.WhichOneof("material")) is not None:
+        result["keyMaterial"] = field
         material = getattr(credentials, field)
-        if (ident := _present(material, "id")) is not None:
+        id_field, cred_field = (
+            ("ble_id", "ble_credential") if field == "fob2" else ("id", "credential")
+        )
+        if (ident := _present(material, id_field)) is not None:
             if field == "phone" and len(ident) == 16:
                 result["phoneId"] = str(uuid.UUID(bytes=ident))
             else:
                 result["deviceId"] = ident.hex()
-        if (cred := _present(material, "credential")) is not None:
+        if (cred := _present(material, cred_field)) is not None:
             result["credentialHex"] = cred.hex()
+        if field == "fob2" and (ident := _present(material, "nfc_id")) is not None:
+            result["nfcDeviceId"] = ident.hex()
     if (v := _present(credentials, "key_type")) is not None:
         result["keyType"] = _enum(_KEY_TYPE_MAP, v, what="key type")
     if (v := _present(credentials, "device_oem")) is not None:

rivian/parallax/dynamics.py

@@ -53,9 +53,8 @@ _TEMPERATURE_IMPACT_MAP: Final[dict[int, str]] = {
     dynamics_pb2.TEMPERATURE_COLD_IMPACT: "cold_impact",
 }
 
-# "OK" is the GraphQL value for normal.
 _TIRE_PRESSURE_STATUS_MAP: Final[dict[int, str]] = {
-    dynamics_pb2.TIRE_PRESSURE_STATUS_NORMAL: "OK",
+    dynamics_pb2.TIRE_PRESSURE_STATUS_NORMAL: "ok",
     dynamics_pb2.TIRE_PRESSURE_STATUS_WARNING_HARD: "warning_hard",
     dynamics_pb2.TIRE_PRESSURE_STATUS_WARNING_SOFT: "warning_soft",
     dynamics_pb2.TIRE_PRESSURE_STATUS_WARNING_PUNCTURE: "warning_puncture",
@@ -195,15 +194,21 @@ def decode_range(m: dynamics_pb2.Range) -> dict[str, Any]:
     }
 
 
+# The app's enum class for tire validity was stripped; only 0 and 1 are known.
+_TIRE_VALID: Final = 0
+_TIRE_VALIDITY_MAP: Final[dict[int, str]] = {_TIRE_VALID: "valid", 1: "invalid"}
+
+
 @RVMDecoder.register("dynamics.tires.state", dynamics_pb2.TiresState)
 def decode_tires(m: dynamics_pb2.TiresState) -> dict[str, Any]:
     """dynamics.tires.state — per-tire pressure, status and validity.
 
     Fields:
         tirePressureFrontLeft, tirePressureFrontRight, etc.: float (bar)
-        tirePressureStatusFrontLeft, etc.: str ("OK" | "warning_hard" |
+        tirePressureStatusFrontLeft, etc.: str ("ok" | "warning_hard" |
             "warning_soft" | "warning_puncture")
-        tirePressureStatusValidFrontLeft, etc.: str ("valid" | "invalid")
+        tirePressureStatusValidFrontLeft, etc.: str ("valid" | "invalid"),
+            or the raw int for an unmapped validity
     """
     result: dict[str, Any] = {}
     for s in m.tire:
@@ -212,10 +217,11 @@ def decode_tires(m: dynamics_pb2.TiresState) -> dict[str, Any]:
             continue
         suffix = _TIRE_POSITION_MAP[s.pos]
 
-        # Pressure and status are stale while invalid.
-        valid = not s.invalid
-        result[f"tirePressureStatusValid{suffix}"] = "valid" if valid else "invalid"
-        if not valid:
+        # Pressure and status are stale unless valid.
+        result[f"tirePressureStatusValid{suffix}"] = _enum(
+            _TIRE_VALIDITY_MAP, s.validity, what="tire validity"
+        )
+        if s.validity != _TIRE_VALID:
             continue
 
         if (pressure := _present(s, "pressure")) is not None:

rivian/parallax/holiday_celebration.py

@@ -14,11 +14,34 @@ from .proto import holiday_celebration_pb2
     holiday_celebration_pb2.HolidayCelebrationEnabled,
 )
 def decode_holiday_celebration_enabled(
-    _m: holiday_celebration_pb2.HolidayCelebrationEnabled,
+    m: holiday_celebration_pb2.HolidayCelebrationEnabled,
 ) -> dict[str, Any]:
-    """holiday_celebration.car_costume.holiday_celebration_enabled — unmapped."""
-    return {}
+    """holiday_celebration.car_costume.holiday_celebration_enabled.
 
+    The names are inferred; the app has no class for this topic.
+
+    Fields:
+        holidayCelebrationAvailable: bool — the (seasonal) feature is offered
+        holidayCelebrationEnabled: bool — the user's on/off switch
+    """
+    return {
+        "holidayCelebrationAvailable": m.available,
+        "holidayCelebrationEnabled": m.enabled,
+    }
+
+
+# Best guess; 2 hasn't been seen.
+_CAR_COSTUME_AVAILABILITY_MAP: Final[dict[int, str]] = {
+    1: "available",
+    3: "unavailable",
+}
+
+
+_COSTUME_THEME_MAP: Final[dict[int, str]] = {
+    holiday_celebration_pb2.CAR_COSTUME_THEME_NONE: "none",
+    holiday_celebration_pb2.CAR_COSTUME_THEME_GHOSTBUSTERS: "ghostbusters",
+    holiday_celebration_pb2.CAR_COSTUME_THEME_GHOSTBUSTERS_DISPLAY: "ghostbusters_display",
+}
 
 _COSTUME_EFFECT_TRIGGER_MAP: Final[dict[int, str]] = {
     holiday_celebration_pb2.COSTUME_EFFECT_TRIGGER_MANUAL: "manual",
@@ -45,7 +68,7 @@ def decode_car_costume_settings(
         costumeInteriorLightShowEnabled: bool
         costumeInteriorOverheadLightsEnabled: bool
         costumeLightsColor: int
-        costumeEffect: int
+        costumeEffect: int (1 none, 3 the display show; inferred)
         costumeEffectTrigger: str ("manual" | "motion"), None when unset
     """
     return {
@@ -80,15 +103,25 @@ def decode_car_costume_state(
     Names come from the app; the int values are unmapped enums.
 
     Fields:
-        carCostumeAvailability: int
-        costumeTheme: int
+        carCostumeAvailability: str | int ("available" | "unavailable"; a
+            best guess), the raw int when unmapped
+        costumeTheme: str | None ("none" | "ghostbusters" |
+            "ghostbusters_display"; inferred), None when unset
         costumeMotionTriggerDetected: bool
-        activeCostumeEffect: int
+        activeCostumeEffect: int (1 none, 3 the display show; inferred)
         costumeStartTime: datetime, only when sent
     """
     result: dict[str, Any] = {
-        "carCostumeAvailability": m.car_costume_availability,
-        "costumeTheme": m.costume_theme,
+        "carCostumeAvailability": _enum(
+            _CAR_COSTUME_AVAILABILITY_MAP,
+            m.car_costume_availability,
+            what="car costume availability",
+        ),
+        "costumeTheme": (
+            _enum(_COSTUME_THEME_MAP, m.costume_theme, what="costume theme")
+            if m.costume_theme
+            else None
+        ),
         "costumeMotionTriggerDetected": m.motion_trigger_detected,
         "activeCostumeEffect": m.active_costume_effect,
     }

rivian/parallax/navigation.py

@@ -85,7 +85,7 @@ def _decode_origin(origin: navigation_pb2.GpsFix) -> dict[str, Any]:
     result = _decode_geocoordinate(
         _present(origin, "location"), "originLatitude", "originLongitude"
     )
-    result["originHeading"] = origin.heading
+    result["originBearing"] = origin.bearing
     if (origin_epoch := _present(origin, "time")) is not None:
         result["originTime"] = from_epoch(origin_epoch)
     return result
@@ -282,7 +282,7 @@ def decode_trip_info(m: navigation_pb2.TripInfo) -> dict[str, Any]:
         tripId: str — changes on every route computation, so it can't
             correlate messages
         originLatitude, originLongitude: float
-        originHeading: float (degrees)
+        originBearing: float (degrees)
         originTime: datetime
         originStateOfCharge: float (percent)
         distance, duration: float — driving totals (meters, seconds),
@@ -354,7 +354,7 @@ def decode_trip_progress(m: navigation_pb2.TripProgress) -> dict[str, Any]:
             (meters, seconds)
         latitude, longitude: float
         speed: float (m/s)
-        heading: float (degrees)
+        bearing: float (degrees)
         locationTime: datetime — time of the position fix
     """
     result: dict[str, Any] = {}
@@ -371,7 +371,7 @@ def decode_trip_progress(m: navigation_pb2.TripProgress) -> dict[str, Any]:
             _decode_geocoordinate(_present(fix, "location"), "latitude", "longitude")
         )
         result["speed"] = fix.speed
-        result["heading"] = fix.heading
+        result["bearing"] = fix.bearing
         if (fix_epoch := _present(fix, "time")) is not None:
             result["locationTime"] = from_epoch(fix_epoch)
     return result

rivian/parallax/operation.py

@@ -0,0 +1,39 @@
+"""Encoder for `sendVehicleOperation` requests."""
+
+from __future__ import annotations
+
+import base64
+import uuid
+
+from .proto import operation_pb2
+
+_Request = operation_pb2.VehicleOperationRequest
+
+
+def encode_vehicle_operation(
+    rvm: str,
+    payload: bytes = b"",
+    phone_id: bytes = bytes(16),
+    request_id: str | None = None,
+) -> str:
+    """Encode a `sendVehicleOperation` request as a base64 string.
+
+    An empty payload asks the vehicle to publish the current value of the RVM,
+    anything else writes it. The vehicle accepts an all-zero phone id.
+    """
+    request = _Request(
+        metadata=_Request.Metadata(
+            phone_info=_Request.Metadata.PhoneInfo(field_1=1, phone_id=phone_id),
+            request_id=request_id or str(uuid.uuid4()),
+        ),
+        operation=_Request.Operation(
+            rvm=rvm,
+            type=(
+                operation_pb2.OPERATION_WRITE
+                if payload
+                else operation_pb2.OPERATION_READ
+            ),
+            payload=payload,
+        ),
+    )
+    return base64.b64encode(request.SerializeToString()).decode("utf-8")

rivian/parallax/ota.py

@@ -27,24 +27,23 @@ _OTA_STATUS_MAP: Final[dict[int, str]] = {
 
 
 _Deployment = ota_pb2.DeploymentState
-# The app's GraphQL-style strings.
 _CURRENT_STATUS_MAP: Final[dict[int, str]] = {
-    _Deployment.CURRENT_STATUS_INSTALL_SUCCESS: "Install_Success",
-    _Deployment.CURRENT_STATUS_INSTALL_FAILED: "Install_Failed",
-    _Deployment.CURRENT_STATUS_INSTALL_UNABLE_TO_START: "Install_Unable_To_Start",
+    _Deployment.CURRENT_STATUS_INSTALL_SUCCESS: "install_success",
+    _Deployment.CURRENT_STATUS_INSTALL_FAILED: "install_failed",
+    _Deployment.CURRENT_STATUS_INSTALL_UNABLE_TO_START: "install_unable_to_start",
 }
 
 _DEPLOYMENT_INTENT_MAP: Final[dict[int, str]] = {
-    _Deployment.DEPLOYMENT_INTENT_PERFORMANCE_UPGRADE: "Performance_Upgrade",
-    _Deployment.DEPLOYMENT_INTENT_BUG_FIX: "Bug_Fix",
-    _Deployment.DEPLOYMENT_INTENT_SECURITY_UPDATE: "Security_Update",
-    _Deployment.DEPLOYMENT_INTENT_FEATURE_ADDITION: "Feature_Addition",
+    _Deployment.DEPLOYMENT_INTENT_PERFORMANCE_UPGRADE: "performance_upgrade",
+    _Deployment.DEPLOYMENT_INTENT_BUG_FIX: "bug_fix",
+    _Deployment.DEPLOYMENT_INTENT_SECURITY_UPDATE: "security_update",
+    _Deployment.DEPLOYMENT_INTENT_FEATURE_ADDITION: "feature_addition",
 }
 
 _SOFTWARE_CATEGORY_MAP: Final[dict[int, str]] = {
-    _Deployment.SOFTWARE_CATEGORY_FIRMWARE: "Firmware",
-    _Deployment.SOFTWARE_CATEGORY_HD_MAPS: "HD_Maps",
-    _Deployment.SOFTWARE_CATEGORY_VEHICLE_CONFIG: "Vehicle_Config",
+    _Deployment.SOFTWARE_CATEGORY_FIRMWARE: "firmware",
+    _Deployment.SOFTWARE_CATEGORY_HD_MAPS: "hd_maps",
+    _Deployment.SOFTWARE_CATEGORY_VEHICLE_CONFIG: "vehicle_config",
 }
 
 
@@ -56,8 +55,8 @@ def _decode_version(
     for field, key in (
         ("version_string", "Version"),
         ("version_year", "VersionYear"),
-        ("version_build", "VersionWeek"),
-        ("build_id", "VersionGitHash"),
+        ("version_week", "VersionWeek"),
+        ("git_hash", "VersionGitHash"),
     ):
         if (v := _present(version, field)) is not None:
             result[f"{prefix}{key}"] = v
@@ -80,7 +79,7 @@ def decode_deployment_state(m: ota_pb2.DeploymentState) -> dict[str, Any]:
         otaCurrentVersionYear, otaCurrentVersionWeek,
             otaCurrentVersionNumber: int
         otaCurrentVersionGitHash: str
-        otaSoftwareCategory: str ("Firmware" | "HD_Maps" | "Vehicle_Config")
+        otaSoftwareCategory: str ("firmware" | "hd_maps" | "vehicle_config")
         otaUpdateInProgress: bool
         otaDeploymentId: str — UUID, only while an update is in flight
         otaAvailableVersion, otaAvailableVersionYear,
@@ -94,13 +93,13 @@ def decode_deployment_state(m: ota_pb2.DeploymentState) -> dict[str, Any]:
         otaDownloadProgress, otaInstallProgress: int (0-100)
         otaTimeRemaining: int (seconds; counts down during
             "install_countdown", a static default otherwise)
-        otaCurrentStatus: str | None ("Install_Success" | "Install_Failed" |
-            "Install_Unable_To_Start") — the last install's result
+        otaCurrentStatus: str | None ("install_success" | "install_failed" |
+            "install_unable_to_start") — the last install's result
         otaInstallReady: str ("ota_available" | "ota_not_available")
         otaInstallDuration: int (minutes)
         otaInstallTimeOfDay: int (minutes after local midnight), when set
-        otaDeploymentIntent: str | None ("Performance_Upgrade" | "Bug_Fix" |
-            "Security_Update" | "Feature_Addition")
+        otaDeploymentIntent: str | None ("performance_upgrade" | "bug_fix" |
+            "security_update" | "feature_addition")
         otaSkipAllowed: bool, otaSkipCount: int
         otaPendingReasons: list[str] — what's blocking an install, e.g.
             "not_parked", "unplugged", "lv_batt"

rivian/parallax/proto/body.proto

@@ -12,16 +12,17 @@ message ClosuresState {
     int32 open_position_percent = 3;
     // Unset on doors and windows; briefly GENERAL while re-reporting.
     ClosureFault fault = 4;
-    optional WindowsNextAction windows_next_action = 5; // on GROUP_WINDOWS
-
-    // One field per closure type. Briefly SNA / not-available while the
+    // One member per closure type. Briefly SNA / not-available while the
     // vehicle re-reports after an app command.
-    optional FrunkNextAction frunk_next_action = 6;
-    optional LiftgateNextAction liftgate_next_action = 7;
-    optional SideBinNextAction side_bin_next_action = 8;
-    optional TailgateNextAction tailgate_next_action = 9;
-    optional ChargePortDoorNextAction charge_port_door_next_action = 10;
-    int32 tonneau_next_action = 11; // enum type unknown
+    oneof next_action {
+      WindowsNextAction windows_next_action = 5; // on GROUP_WINDOWS
+      FrunkNextAction frunk_next_action = 6;
+      LiftgateNextAction liftgate_next_action = 7;
+      SideBinNextAction side_bin_next_action = 8;
+      TailgateNextAction tailgate_next_action = 9;
+      ChargePortDoorNextAction charge_port_door_next_action = 10;
+      int32 tonneau_next_action = 11; // the app's enum (class stripped)
+    }
   }
   repeated Closure closure = 1;
 }