rivian-python-client 1.3.1__tar.gz → 1.4.0__tar.gz

{rivian_python_client-1.3.1 → rivian_python_client-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: rivian-python-client
-Version: 1.3.1
+Version: 1.4.0
 Summary: Rivian API Client (Unofficial)
 License: MIT
 Author: Brian Retterer
@@ -17,7 +17,7 @@ Provides-Extra: ble
 Requires-Dist: aiohttp (>=3.0.0)
 Requires-Dist: backports-strenum (>=1.2.4,<2.0.0) ; python_version < "3.11"
 Requires-Dist: bleak (>=0.21,<1.0.0) ; extra == "ble"
-Requires-Dist: cryptography (>=41.0.1,<45.0)
+Requires-Dist: cryptography (>=41.0.1,<46.0)
 Requires-Dist: dbus-fast (>=2.11.0,<3.0.0) ; (sys_platform == "linux") and (extra == "ble")
 Description-Content-Type: text/markdown
 
@@ -35,10 +35,11 @@ curl -sSL https://install.python-poetry.org | python3 -
 
 ## Setup
 
-Install project dependencies into the poetry virtual environment.
+Install project dependencies into the poetry virtual environment and run pre-commit
 
 ```
 poetry install
+pre-commit install
 ```
 
 ## Run Tests

{rivian_python_client-1.3.1 → rivian_python_client-1.4.0}/README.md

@@ -12,10 +12,11 @@ curl -sSL https://install.python-poetry.org | python3 -
 
 ## Setup
 
-Install project dependencies into the poetry virtual environment.
+Install project dependencies into the poetry virtual environment and run pre-commit
 
 ```
 poetry install
+pre-commit install
 ```
 
 ## Run Tests

{rivian_python_client-1.3.1 → rivian_python_client-1.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "rivian-python-client"
-version = "1.3.1"
+version = "1.4.0"
 description = "Rivian API Client (Unofficial)"
 readme = "README.md"
 authors = ["Brian Retterer <bretterer@gmail.com>"]
@@ -12,18 +12,19 @@ packages = [
 [tool.poetry.dependencies]
 python = ">=3.9,<3.14"
 aiohttp = ">=3.0.0"
-cryptography = ">=41.0.1,<45.0"
+cryptography = ">=41.0.1,<46.0"
 backports-strenum = { version = "^1.2.4", python = "<3.11" }
 bleak = { version = ">=0.21,<1.0.0", optional = true }
 dbus-fast = {version = "^2.11.0", optional = true, platform = "linux"}
 
 [tool.poetry.group.dev.dependencies]
 pytest = ">=7.1.2,<9.0.0"
-pytest-asyncio = ">=0.18.3,<0.26.0"
-python-dotenv = ">=0.20,<1.1"
+pytest-asyncio = ">=0.18.3,<0.27.0"
+python-dotenv = ">=0.20,<1.2"
 aresponses = ">=2.1.5,<4.0.0"
 mypy = ">=1.7.0,<2.0.0"
-ruff = ">=0.4,<0.9"
+ruff = ">=0.4,<0.12"
+pre-commit = "^4.1.0"
 
 [tool.poetry.extras]
 ble = ["bleak", "dbus-fast"]

{rivian_python_client-1.3.1 → rivian_python_client-1.4.0}/src/rivian/const.py

@@ -34,15 +34,26 @@ VEHICLE_STATE_PROPERTIES: Final[set[str]] = {
     # VehicleCloudConnection
     "cloudConnection",
     # VehicleLocation
+    "geoLocation",
     "gnssLocation",
-    # TimeStamped(String|Float|Int)
+    "gnssError",
+    # TimeStamped(String|[Nullable]Float|Int)
+    "activeDriverName",
     "alarmSoundStatus",
     "batteryCapacity",
+    "batteryCellType",
     "batteryHvThermalEvent",
     "batteryHvThermalEventPropagation",
     "batteryLevel",
     "batteryLimit",
+    "batteryNeedsLfpCalibration",
     "brakeFluidLow",
+    "btmFfHardwareFailureStatus",
+    "btmIcHardwareFailureStatus",
+    "btmLfdHardwareFailureStatus",
+    "btmOcHardwareFailureStatus",
+    "btmRfdHardwareFailureStatus",
+    "btmRfHardwareFailureStatus",
     "cabinClimateDriverTemperature",
     "cabinClimateInteriorTemperature",
     "cabinPreconditioningStatus",
@@ -51,6 +62,8 @@ VEHICLE_STATE_PROPERTIES: Final[set[str]] = {
     "chargerDerateStatus",
     "chargerState",
     "chargerStatus",
+    "chargePortState",
+    "chargingDisabledAll",
     "closureFrunkClosed",
     "closureFrunkLocked",
     "closureFrunkNextAction",
@@ -88,6 +101,8 @@ VEHICLE_STATE_PROPERTIES: Final[set[str]] = {
     "gnssAltitude",
     "gnssBearing",
     "gnssSpeed",
+    "limitedRegenCold",
+    "limitedAccelCold",
     "otaAvailableVersion",
     "otaAvailableVersionGitHash",
     "otaAvailableVersionNumber",
@@ -110,6 +125,7 @@ VEHICLE_STATE_PROPERTIES: Final[set[str]] = {
     "petModeTemperatureStatus",
     "powerState",
     "rangeThreshold",
+    "rearHitchStatus",
     "remoteChargingAvailable",
     "seatFrontLeftHeat",
     "seatFrontLeftVent",
@@ -145,16 +161,38 @@ VEHICLE_STATE_PROPERTIES: Final[set[str]] = {
     "wiperFluidState",
 }
 
+VEHICLE_STATES_SUBSCRIPTION_ONLY_PROPERTIES: Final[set[str]] = {
+    # TimeStamped(String|[Nullable]Float|Int)
+    "activeDriverName",
+    "chargingDisabledACFaultState",
+    "chargingTimeEstimationValidity",
+    "chargingTripTargetSoc",
+    "chargingTripTargetMinsRemaining",
+    "closureChargePortDoorNextAction",
+    "coldRangeNotification",
+    "tirePressureFrontLeft",
+    "tirePressureFrontRight",
+    "tirePressureRearLeft",
+    "tirePressureRearRight",
+}
+
+VEHICLE_STATES_SUBSCRIPTION_PROPERTIES = (
+    VEHICLE_STATE_PROPERTIES | VEHICLE_STATES_SUBSCRIPTION_ONLY_PROPERTIES
+)
+
 
 class VehicleCommand(StrEnum):
     """Supported vehicle commands."""
 
     WAKE_VEHICLE = "WAKE_VEHICLE"
-    HONK_AND_FLASH_LIGHTS = "HONK_AND_FLASH_LIGHTS"
     UNLOCK_USER_PREFERENCES_AND_DISABLE_ALARM = (
         "UNLOCK_USER_PREFERENCES_AND_DISABLE_ALARM"
     )
 
+    HONK_AND_FLASH_LIGHTS = "HONK_AND_FLASH_LIGHTS"
+    ACTIVATE_EXTERNAL_SOUND = "ACTIVATE_EXTERNAL_SOUND"
+    FLASH_EXTERNAL_LIGHTS = "FLASH_EXTERNAL_LIGHTS"
+
     # Charging
     CHARGING_LIMITS = "CHARGING_LIMITS"
     START_CHARGING = "START_CHARGING"
@@ -172,6 +210,9 @@ class VehicleCommand(StrEnum):
     CABIN_PRECONDITIONING_SET_TEMP = "CABIN_PRECONDITIONING_SET_TEMP"
     VEHICLE_CABIN_PRECONDITION_DISABLE = "VEHICLE_CABIN_PRECONDITION_DISABLE"
     VEHICLE_CABIN_PRECONDITION_ENABLE = "VEHICLE_CABIN_PRECONDITION_ENABLE"
+    # Gen2 HVAC Controls
+    CABIN_HVAC_THIRD_ROW_LEFT_SEAT_HEAT = "CABIN_HVAC_THIRD_ROW_LEFT_SEAT_HEAT"
+    CABIN_HVAC_THIRD_ROW_RIGHT_SEAT_HEAT = "CABIN_HVAC_THIRD_ROW_RIGHT_SEAT_HEAT"
 
     # Closures
     LOCK_ALL_CLOSURES_FEEDBACK = "LOCK_ALL_CLOSURES_FEEDBACK"
@@ -195,6 +236,10 @@ class VehicleCommand(StrEnum):
     # Liftgate/tailgate
     OPEN_LIFTGATE_UNLATCH_TAILGATE = "OPEN_LIFTGATE_UNLATCH_TAILGATE"
 
+    # Chargeport door
+    OPEN_CHARGE_PORT_DOOR = "OPEN_CHARGE_PORT_DOOR"
+    CLOSE_CHARGE_PORT_DOOR = "CLOSE_CHARGE_PORT_DOOR"
+
     # OTA
     OTA_INSTALL_NOW_ACKNOWLEDGE = "OTA_INSTALL_NOW_ACKNOWLEDGE"
 

{rivian_python_client-1.3.1 → rivian_python_client-1.4.0}/src/rivian/rivian.py

@@ -15,7 +15,13 @@ from warnings import warn
 import aiohttp
 from aiohttp import ClientResponse, ClientWebSocketResponse
 
-from .const import LIVE_SESSION_PROPERTIES, VEHICLE_STATE_PROPERTIES, VehicleCommand
+from .const import (
+    LIVE_SESSION_PROPERTIES,
+    VEHICLE_STATE_PROPERTIES,
+    VEHICLE_STATES_SUBSCRIPTION_ONLY_PROPERTIES,
+    VEHICLE_STATES_SUBSCRIPTION_PROPERTIES,
+    VehicleCommand,
+)
 from .exceptions import (
     RivianApiException,
     RivianApiRateLimitError,
@@ -51,12 +57,16 @@ BASE_HEADERS = {
     "Apollographql-Client-Name": APOLLO_CLIENT_NAME,
 }
 
-CLOUD_CONNECTION_TEMPLATE = "{ lastSync }"
-LOCATION_TEMPLATE = "{ latitude longitude timeStamp }"
+CLOUD_CONNECTION_TEMPLATE = "{ lastSync isOnline }"
+LOCATION_TEMPLATE = "{ latitude longitude timeStamp isAuthorized }"
+LOCATION_ERROR_TEMPLATE = (
+    "{ timeStamp positionVertical positionHorizontal speed bearing }"
+)
 VALUE_TEMPLATE = "{ timeStamp value }"
 TEMPLATE_MAP = {
     "cloudConnection": CLOUD_CONNECTION_TEMPLATE,
     "gnssLocation": LOCATION_TEMPLATE,
+    "gnssError": LOCATION_ERROR_TEMPLATE,
 }
 
 LIVE_SESSION_VALUE_RECORD_KEYS = {
@@ -405,6 +415,15 @@ class Rivian:
         """Get vehicle state."""
         if not properties:
             properties = VEHICLE_STATE_PROPERTIES
+        elif (
+            subscription_properties
+            := VEHICLE_STATES_SUBSCRIPTION_ONLY_PROPERTIES.intersection(properties)
+        ):
+            _LOGGER.warning(
+                "Subscription only properties have been identified and removed: %s",
+                ", ".join(subscription_properties),
+            )
+            properties.difference_update(subscription_properties)
 
         url = GRAPHQL_GATEWAY
 
@@ -582,7 +601,7 @@ class Rivian:
     ) -> Callable | None:
         """Open a web socket connection to receive updates."""
         if not properties:
-            properties = VEHICLE_STATE_PROPERTIES
+            properties = VEHICLE_STATES_SUBSCRIPTION_PROPERTIES
 
         try:
             await self._ws_connect()
@@ -714,5 +733,7 @@ class Rivian:
 
     def _build_vehicle_state_fragment(self, properties: set[str]) -> str:
         """Build GraphQL vehicle state fragment from properties."""
-        frag = " ".join(f"{p} {TEMPLATE_MAP.get(p,VALUE_TEMPLATE)}" for p in properties)
+        frag = " ".join(
+            f"{p} {TEMPLATE_MAP.get(p, VALUE_TEMPLATE)}" for p in properties
+        )
         return f"{{ {frag} }}"

{rivian_python_client-1.3.1 → rivian_python_client-1.4.0}/src/rivian/schemas/gateway.graphql

@@ -1,3 +1,5 @@
+directive @subscriptionOnly on FIELD_DEFINITION
+
 type Query {
   currentUser: User
   delivery(orderId: ID!): Delivery
@@ -44,6 +46,7 @@ type Mutation {
   ): MobileLoginResponse
   logout: LogoutResponse
   resendOTPCode(otpToken: String!): ResendOTPCodeResponse
+  sendTripToVehicle(attrs: SendTripToVehicleInput!): OK
   sendVehicleCommand(attrs: VehicleCommandAttributes!): SendVehicleCommandState
   setChargingSchedules(
     vehicleId: String!
@@ -206,6 +209,8 @@ type ChargingLiveData {
   price: Float
   currency: String
   isFreeSession: Boolean
+  vehicleChargerState: String!
+  startTime: Float!
 }
 
 type ChargingSchedule {
@@ -534,6 +539,7 @@ type VehicleLocation implements TimeStamped {
   latitude: Float!
   longitude: Float!
   isAuthorized: Boolean
+  consentStatus: String
 }
 
 type VehicleLocationError implements TimeStamped {
@@ -575,19 +581,24 @@ type VehicleMobileImageOverlay {
 }
 
 type VehicleState {
+  activeDriverName: TimeStampedString @subscriptionOnly
+
   alarmSoundStatus: TimeStampedString
 
   batteryCapacity: TimeStampedFloat
+  batteryCellType: TimeStampedString
   batteryHvThermalEvent: TimeStampedString
   batteryHvThermalEventPropagation: TimeStampedString
   batteryLevel: TimeStampedFloat
   batteryLimit: TimeStampedInt
+  batteryNeedsLfpCalibration: TimeStampedInt
 
   brakeFluidLow: TimeStampedString
 
   btmFfHardwareFailureStatus: TimeStampedString
   btmIcHardwareFailureStatus: TimeStampedString
   btmLfdHardwareFailureStatus: TimeStampedString
+  btmOcHardwareFailureStatus: TimeStampedString
   btmRfdHardwareFailureStatus: TimeStampedString
   btmRfHardwareFailureStatus: TimeStampedString
 
@@ -603,9 +614,14 @@ type VehicleState {
   chargerState: TimeStampedString
   chargerStatus: TimeStampedString
   chargingDisabledAC: TimeStampedInt
+  chargingDisabledACFaultState: TimeStampedInt @subscriptionOnly
   chargingDisabledAll: TimeStampedInt
   chargingTimeEstimationValidity: TimeStampedString
 
+  chargingTripTargetSoc: TimeStampedInt
+  chargingTripTargetMinsRemaining: TimeStampedInt
+
+  closureChargePortDoorNextAction: TimeStampedString @subscriptionOnly
   closureFrunkClosed: TimeStampedString
   closureFrunkLocked: TimeStampedString
   closureFrunkNextAction: TimeStampedString
@@ -627,6 +643,8 @@ type VehicleState {
 
   cloudConnection: VehicleCloudConnection
 
+  coldRangeNotification: TimeStampedString @subscriptionOnly
+
   defrostDefogStatus: TimeStampedString
 
   distanceToEmpty: TimeStampedInt
@@ -648,6 +666,8 @@ type VehicleState {
   gearGuardVideoTermsAccepted: TimeStampedString
   gearStatus: TimeStampedString
 
+  geoLocation: TimeStampedString
+
   gnssAltitude: TimeStampedNullableFloat
   gnssBearing: TimeStampedFloat
   gnssError: VehicleLocationError
@@ -702,10 +722,10 @@ type VehicleState {
 
   timeToEndOfCharge: TimeStampedFloat
 
-  tirePressureFrontLeft: TimeStampedNullableFloat # only available via subscription
-  tirePressureFrontRight: TimeStampedNullableFloat # only available via subscription
-  tirePressureRearLeft: TimeStampedNullableFloat # only available via subscription
-  tirePressureRearRight: TimeStampedNullableFloat # only available via subscription
+  tirePressureFrontLeft: TimeStampedNullableFloat @subscriptionOnly
+  tirePressureFrontRight: TimeStampedNullableFloat @subscriptionOnly
+  tirePressureRearLeft: TimeStampedNullableFloat @subscriptionOnly
+  tirePressureRearRight: TimeStampedNullableFloat @subscriptionOnly
   tirePressureStatusFrontLeft: TimeStampedString
   tirePressureStatusFrontRight: TimeStampedString
   tirePressureStatusRearLeft: TimeStampedString