rivian-python-client 1.1.2__tar.gz → 1.2.0__tar.gz

{rivian_python_client-1.1.2 → rivian_python_client-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rivian-python-client
-Version: 1.1.2
+Version: 1.2.0
 Summary: Rivian API Client (Unofficial)
 License: MIT
 Author: Brian Retterer
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 3.12
 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,<0.22) ; extra == "ble"
+Requires-Dist: bleak (>=0.21,<1.0.0) ; extra == "ble"
 Requires-Dist: cryptography (>=41.0.1,<43.0)
 Requires-Dist: dbus-fast (>=2.11.0,<3.0.0) ; (sys_platform == "linux") and (extra == "ble")
 Description-Content-Type: text/markdown

{rivian_python_client-1.1.2 → rivian_python_client-1.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "rivian-python-client"
-version = "1.1.2"
+version = "1.2.0"
 description = "Rivian API Client (Unofficial)"
 readme = "README.md"
 authors = ["Brian Retterer <bretterer@gmail.com>"]
@@ -10,19 +10,20 @@ packages = [
 ]
 
 [tool.poetry.dependencies]
-python = ">=3.9, <3.13"
+python = ">=3.9,<3.13"
 aiohttp = ">=3.0.0"
-cryptography = ">=41.0.1, <43.0"
+cryptography = ">=41.0.1,<43.0"
 backports-strenum = { version = "^1.2.4", python = "<3.11" }
-bleak = { version = "^0.21", optional = true }
+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"
+pytest = ">=7.1.2,<9.0.0"
 pytest-asyncio = ">=0.18.3,<0.24.0"
 python-dotenv = ">=0.20,<1.1"
-aresponses = "^2.1.5"
-mypy = "^1.7.0"
+aresponses = ">=2.1.5,<4.0.0"
+mypy = ">=1.7.0,<2.0.0"
+ruff = "^0.4"
 
 [tool.poetry.extras]
 ble = ["bleak", "dbus-fast"]
@@ -33,6 +34,10 @@ vcs = "git"
 style = "semver"
 pattern = "default-unprefixed"
 
+[tool.ruff.lint.isort]
+combine-as-imports = true
+split-on-trailing-comma = false
+
 [build-system]
 requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning"]
 build-backend = "poetry_dynamic_versioning.backend"

{rivian_python_client-1.1.2 → rivian_python_client-1.2.0}/src/rivian/ble.py

@@ -1,4 +1,5 @@
 """Rivian BLE handler."""
+
 from __future__ import annotations
 
 import asyncio

{rivian_python_client-1.1.2 → rivian_python_client-1.2.0}/src/rivian/const.py

@@ -1,4 +1,5 @@
 """Rivian constants."""
+
 from __future__ import annotations
 
 import sys

{rivian_python_client-1.1.2 → rivian_python_client-1.2.0}/src/rivian/rivian.py

@@ -1,9 +1,11 @@
 """Asynchronous Python client for the Rivian API."""
+
 from __future__ import annotations
 
 import asyncio
 import logging
 import socket
+import sys
 import time
 import uuid
 from collections.abc import Callable
@@ -11,7 +13,6 @@ from typing import Any, Type
 from warnings import warn
 
 import aiohttp
-import async_timeout
 from aiohttp import ClientResponse, ClientWebSocketResponse
 
 from .const import LIVE_SESSION_PROPERTIES, VEHICLE_STATE_PROPERTIES, VehicleCommand
@@ -29,6 +30,11 @@ from .exceptions import (
 from .utils import generate_vehicle_command_hmac
 from .ws_monitor import WebSocketMonitor
 
+if sys.version_info >= (3, 11):
+    import asyncio as async_timeout
+else:
+    import async_timeout
+
 _LOGGER = logging.getLogger(__name__)
 
 GRAPHQL_BASEPATH = "https://rivian.com/api/gql"
@@ -379,7 +385,7 @@ class Rivian:
             "U-Sess": self._user_session_token,
         }
 
-        graphql_query = "query getVehicleImages( $extension: String $resolution: String $versionForVehicle: String $versionForPreOrder: String ) { getVehicleOrderMobileImages( resolution: $resolution extension: $extension version: $versionForPreOrder ) { ...image } getVehicleMobileImages( resolution: $resolution extension: $extension version: $versionForVehicle ) { ...image } } fragment image on VehicleMobileImage { orderId vehicleId url extension resolution size design placement }"
+        graphql_query = "query getVehicleImages( $extension: String $resolution: String $versionForVehicle: String $versionForPreOrder: String ) { getVehicleOrderMobileImages( resolution: $resolution extension: $extension version: $versionForPreOrder ) { ...image } getVehicleMobileImages( resolution: $resolution extension: $extension version: $versionForVehicle ) { ...image } } fragment image on VehicleMobileImage { orderId vehicleId url extension resolution size design placement overlays { url overlay zIndex } }"
 
         graphql_json = {
             "operationName": "getVehicleImages",

{rivian_python_client-1.1.2 → rivian_python_client-1.2.0}/src/rivian/schemas/gateway.graphql

@@ -28,6 +28,12 @@ type Query {
 
 type Mutation {
   createCsrfToken: CreateCsrfTokenResponse
+  createDepartureSchedule(
+    vehicleId: String!
+    schedule: InputDepartureSchedule!
+  ): Success
+  deleteDepartureSchedule(vehicleId: String!, scheduleId: String!): Success
+  departNow(vehicleId: String!, scheduleId: String!, skipDate: String!): Success
   disenrollPhone(attrs: DisenrollPhoneAttributes!): DisenrollPhoneResponse
   enrollPhone(attrs: EnrollPhoneAttributes!): EnrollPhoneResponse
   login(email: String!, password: String!): LoginResponse
@@ -36,16 +42,61 @@ type Mutation {
     otpToken: String!
     otpCode: String!
   ): MobileLoginResponse
+  logout: LogoutResponse
+  resendOTPCode(otpToken: String!): ResendOTPCodeResponse
   sendVehicleCommand(attrs: VehicleCommandAttributes!): SendVehicleCommandState
   setChargingSchedules(
     vehicleId: String!
     chargingSchedules: [InputChargingSchedule!]!
   ): OK
   setVehicleName(vehicleId: String!, name: String!): OK
+  skipNextScheduledDeparture(
+    vehicleId: String!
+    scheduleId: String!
+    skipDate: String!
+  ): Success
+  updateDepartureSchedule(
+    vehicleId: String!
+    scheduleId: String!
+    schedule: InputDepartureSchedule!
+  ): Success
 }
 
 type Subscription {
-  vehicleState(id: String!): VehicleState
+  chargingSession(vehicleId: String!): ChargingSession!
+  otaInstallSchedules(vehicleId: String!): ParallaxMessageResponse!
+  otaInstallState(vehicleId: String!): ParallaxMessageResponse!
+  vehicleCloudConnection(id: String!): VehicleCloudConnection!
+  vehicleCommandState(id: String!): GetVehicleCommandState!
+  vehicleDepartureSchedules(vehicleId: String!): [DepartureSchedule!]!
+  vehicleGeofences(vehicleId: String!): ParallaxMessageResponse
+  vehicleState(id: String!): VehicleState!
+}
+
+enum DefogDefrostLevel {
+  Off
+  Defog
+  Defrost
+}
+
+enum SurfaceHeatVentLevel {
+  Off
+  Heat1
+  Heat2
+  Heat3
+  Vent1
+  Vent2
+  Vent3
+}
+
+enum WeekDay {
+  Monday
+  Tuesday
+  Wednesday
+  Thursday
+  Friday
+  Saturday
+  Sunday
 }
 
 input CoordinatesInput {
@@ -74,6 +125,38 @@ input InputChargingSchedule {
   enabled: Boolean!
 }
 
+input InputComfortSettings {
+  surfaceHeatVentLevels: InputSurfaceHeatVentLevels!
+  cabinTempCelsius: Float!
+  frontDefogDefrost: DefogDefrostLevel!
+}
+
+input InputDepartureSchedule {
+  name: String!
+  isEnabled: Boolean!
+  repeatsWeekly: InputRepeatsWeekly!
+  departureSettings: InputDepartureSettings!
+}
+
+input InputDepartureSettings {
+  shouldOverrideChargeSchedule: Boolean!
+  comfortSettings: InputComfortSettings!
+}
+
+input InputRepeatsWeekly {
+  days: [WeekDay!]!
+  startsAtMin: Int!
+  skippedOn: [String!]!
+}
+
+input InputSurfaceHeatVentLevels {
+  frontLeftSeat: SurfaceHeatVentLevel!
+  frontRightSeat: SurfaceHeatVentLevel!
+  rearLeftSeat: SurfaceHeatVentLevel!
+  rearRightSeat: SurfaceHeatVentLevel!
+  steeringWheel: SurfaceHeatVentLevel!
+}
+
 input NetworkPreference {
   networkId: String!
   preference: Float
@@ -104,6 +187,27 @@ type CampSpeaker {
   serialNumber: String!
 }
 
+type ChargingChartData {
+  soc: Float!
+  powerKW: Float!
+  startTime: Float!
+  endTime: Float!
+  timeEstimationValidityStatus: String!
+  vehicleChargerState: String!
+}
+
+type ChargingLiveData {
+  powerKW: Float!
+  kilometersChargedPerHour: Float!
+  rangeAddedThisSession: Float!
+  totalChargedEnergy: Float!
+  timeElapsed: Float
+  timeRemaining: Float
+  price: Float
+  currency: String
+  isFreeSession: Boolean
+}
+
 type ChargingSchedule {
   startTime: Int!
   duration: Int!
@@ -113,6 +217,17 @@ type ChargingSchedule {
   weekDays: [String!]!
 }
 
+type ChargingSession {
+  chartData: [ChargingChartData!]!
+  liveData: ChargingLiveData!
+}
+
+type ComfortSettings {
+  surfaceHeatVentLevels: SurfaceHeatVentLevels!
+  cabinTempCelsius: Float!
+  frontDefogDefrost: DefogDefrostLevel!
+}
+
 type CreateCsrfTokenResponse {
   csrfToken: String!
   appSessionToken: String!
@@ -142,6 +257,19 @@ type DeliveryAppointment {
   timeZone: String!
 }
 
+type DepartureSchedule {
+  id: String!
+  name: String!
+  isEnabled: Boolean!
+  occurrence: RepeatsWeekly!
+  departureSettings: DepartureSettings!
+}
+
+type DepartureSettings {
+  shouldOverrideChargeSchedule: Boolean!
+  comfortSettings: ComfortSettings!
+}
+
 type DisenrollPhoneResponse {
   success: Boolean!
 }
@@ -164,6 +292,10 @@ type GetVehicleCommandState {
   statusCode: Int
 }
 
+type LogoutResponse {
+  success: Boolean!
+}
+
 type MobileLoginResponse {
   accessToken: String!
   refreshToken: String!
@@ -189,6 +321,11 @@ type OTAUpdateDetails {
   locale: String!
 }
 
+type ParallaxMessageResponse {
+  payload: String! # base64 encoded??
+  sequenceNumber: Int!
+}
+
 type PlanTripResponse {
   routes: [Route!]!
   tripPlanStatus: String!
@@ -219,6 +356,16 @@ type RegistrationChannel {
   type: String!
 }
 
+type RepeatsWeekly {
+  days: [WeekDay!]!
+  startsAtMin: Int!
+  skippedOn: [String!]!
+}
+
+type ResendOTPCodeResponse {
+  success: Boolean!
+}
+
 type Route {
   routeResponse: String!
   destinationReached: Boolean!
@@ -238,11 +385,23 @@ type SendVehicleCommandState {
   state: Int!
 }
 
+type Success {
+  success: Boolean!
+}
+
 type SupportedFeature {
   name: String!
   status: String!
 }
 
+type SurfaceHeatVentLevels {
+  frontLeftSeat: SurfaceHeatVentLevel!
+  frontRightSeat: SurfaceHeatVentLevel!
+  rearLeftSeat: SurfaceHeatVentLevel!
+  rearRightSeat: SurfaceHeatVentLevel!
+  steeringWheel: SurfaceHeatVentLevel!
+}
+
 type TimeStampedFloat implements TimeStamped {
   timeStamp: String!
   value: Float!
@@ -366,13 +525,23 @@ type Vehicle {
 }
 
 type VehicleCloudConnection {
-  lastSync: String!
+  isOnline: Boolean!
+  lastSync: String
 }
 
 type VehicleLocation implements TimeStamped {
   timeStamp: String!
   latitude: Float!
   longitude: Float!
+  isAuthorized: Boolean
+}
+
+type VehicleLocationError implements TimeStamped {
+  timeStamp: String!
+  bearing: Float!
+  positionHorizontal: Float!
+  positionVertical: Float!
+  speed: Float!
 }
 
 type VehicleMobileConfiguration {
@@ -396,6 +565,13 @@ type VehicleMobileImage {
   resolution: String!
   size: String!
   url: String!
+  overlays: [VehicleMobileImageOverlay!]!
+}
+
+type VehicleMobileImageOverlay {
+  url: String!
+  overlay: String!
+  zIndex: Int!
 }
 
 type VehicleState {
@@ -422,9 +598,13 @@ type VehicleState {
 
   carWashMode: TimeStampedString
 
+  chargePortState: TimeStampedString
   chargerDerateStatus: TimeStampedString
   chargerState: TimeStampedString
   chargerStatus: TimeStampedString
+  chargingDisabledAC: TimeStampedInt
+  chargingDisabledAll: TimeStampedInt
+  chargingTimeEstimationValidity: TimeStampedString
 
   closureFrunkClosed: TimeStampedString
   closureFrunkLocked: TimeStampedString
@@ -470,6 +650,7 @@ type VehicleState {
 
   gnssAltitude: TimeStampedNullableFloat
   gnssBearing: TimeStampedFloat
+  gnssError: VehicleLocationError
   gnssLocation: VehicleLocation
   gnssSpeed: TimeStampedFloat
 
@@ -502,6 +683,8 @@ type VehicleState {
 
   rangeThreshold: TimeStampedString
 
+  rearHitchStatus: TimeStampedString
+
   remoteChargingAvailable: TimeStampedInt
 
   seatFrontLeftHeat: TimeStampedString
@@ -519,6 +702,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
   tirePressureStatusFrontLeft: TimeStampedString
   tirePressureStatusFrontRight: TimeStampedString
   tirePressureStatusRearLeft: TimeStampedString

{rivian_python_client-1.1.2 → rivian_python_client-1.2.0}/src/rivian/utils.py

@@ -1,4 +1,5 @@
 """Utilities."""
+
 from __future__ import annotations
 
 import hashlib

{rivian_python_client-1.1.2 → rivian_python_client-1.2.0}/src/rivian/ws_monitor.py

@@ -1,8 +1,10 @@
 """Websocket monitor."""
+
 from __future__ import annotations
 
 import asyncio
 import logging
+import sys
 from collections.abc import Awaitable, Callable
 from datetime import datetime, timezone
 from json import loads
@@ -10,9 +12,13 @@ from random import uniform
 from typing import TYPE_CHECKING, Any
 from uuid import uuid4
 
-import async_timeout
 from aiohttp import ClientWebSocketResponse, WSMessage, WSMsgType
 
+if sys.version_info >= (3, 11):
+    import asyncio as async_timeout
+else:
+    import async_timeout
+
 if TYPE_CHECKING:
     from .rivian import Rivian