tesla-fleet-api 1.0.2__tar.gz → 1.0.4__tar.gz

{tesla_fleet_api-1.0.2/tesla_fleet_api.egg-info → tesla_fleet_api-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: tesla_fleet_api
-Version: 1.0.2
+Version: 1.0.4
 Summary: Tesla Fleet API library for Python
 Home-page: https://github.com/Teslemetry/python-tesla-fleet-api
 Author: Brett Adams
@@ -18,6 +18,7 @@ Requires-Dist: aiolimiter
 Requires-Dist: cryptography
 Requires-Dist: protobuf
 Requires-Dist: bleak
+Requires-Dist: bleak-retry-connector
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -29,10 +30,11 @@ Dynamic: requires-python
 Dynamic: summary
 
 # Tesla Fleet Api
-Python library for Tesla Fleet API and Teslemetry.
+Python library for Tesla Fleet API and Tesla Command Protocol, including signed commands and encrypted local Bluetooth (BLE). Also provides interfaces for Teslemetry and Tessie.
 
-Based on [Tesla Developer documentation](https://developer.tesla.com/docs/fleet-api).
+Based on [Tesla Developer documentation](https://developer.tesla.com/docs/fleet-api) and [Tesla Command Protocol](https://github.com/teslamotors/vehicle-command/blob/main/pkg/protocol/protocol.md)
 
+**Documentation is currently outdated for V1.0.X**
 
 ## TeslaFleetApi
 This is the base class, however can also be used directly if you have a valid user access_token.

{tesla_fleet_api-1.0.2 → tesla_fleet_api-1.0.4}/README.md

@@ -1,8 +1,9 @@
 # Tesla Fleet Api
-Python library for Tesla Fleet API and Teslemetry.
+Python library for Tesla Fleet API and Tesla Command Protocol, including signed commands and encrypted local Bluetooth (BLE). Also provides interfaces for Teslemetry and Tessie.
 
-Based on [Tesla Developer documentation](https://developer.tesla.com/docs/fleet-api).
+Based on [Tesla Developer documentation](https://developer.tesla.com/docs/fleet-api) and [Tesla Command Protocol](https://github.com/teslamotors/vehicle-command/blob/main/pkg/protocol/protocol.md)
 
+**Documentation is currently outdated for V1.0.X**
 
 ## TeslaFleetApi
 This is the base class, however can also be used directly if you have a valid user access_token.

{tesla_fleet_api-1.0.2 → tesla_fleet_api-1.0.4}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setuptools.setup(
     name="tesla_fleet_api",
-    version="1.0.2",
+    version="1.0.4",
     author="Brett Adams",
     author_email="hello@teslemetry.com",
     description="Tesla Fleet API library for Python",
@@ -20,5 +20,5 @@ setuptools.setup(
         "Operating System :: OS Independent",
     ],
     python_requires=">=3.10",
-    install_requires=["aiohttp", "aiofiles", "aiolimiter", "cryptography", "protobuf", "bleak"],
+    install_requires=["aiohttp", "aiofiles", "aiolimiter", "cryptography", "protobuf", "bleak", "bleak-retry-connector"],
 )

{tesla_fleet_api-1.0.2 → tesla_fleet_api-1.0.4}/tesla_fleet_api/const.py

@@ -3,7 +3,7 @@
 from enum import Enum
 import logging
 
-VERSION = "1.0.2"
+VERSION = "1.0.4"
 LOGGER = logging.getLogger(__package__)
 SERVERS = {
     "na": "https://fleet-api.prd.na.vn.cloud.tesla.com",
@@ -159,3 +159,17 @@ class TeslaEnergyPeriod(StrEnum):
     MONTH = "month"
     YEAR = "year"
     LIFETIME = "lifetime"
+
+class BluetoothVehicleData(StrEnum):
+    CHARGE_STATE = "GetChargeState"
+    CLIMATE_STATE = "GetClimateState"
+    DRIVE_STATE = "GetDriveState"
+    LOCATION_STATE = "GetLocationState"
+    CLOSURES_STATE = "GetClosuresState"
+    CHARGE_SCHEDULE_STATE = "GetChargeScheduleState"
+    PRECONDITIONING_SCHEDULE_STATE = "GetPreconditioningScheduleState"
+    TIRE_PRESSURE_STATE = "GetTirePressureState"
+    MEDIA_STATE = "GetMediaState"
+    MEDIA_DETAIL_STATE = "GetMediaDetailState"
+    SOFTWARE_UPDATE_STATE = "GetSoftwareUpdateState"
+    PARENTAL_CONTROLS_STATE = "GetParentalControlsState"

{tesla_fleet_api-1.0.2 → tesla_fleet_api-1.0.4}/tesla_fleet_api/exceptions.py

@@ -656,6 +656,26 @@ class TeslaFleetMessageFaultResponseSizeExceedsMTU(TeslaFleetMessageFault):
     message = "Client's request was received, but response size exceeded MTU"
     code = 25
 
+class TeslaFleetMessageFaultRepeatedCounter(TeslaFleetMessageFault):
+    """The vehicle has seen this counter value before. Reset the counter and try again"""
+
+    message = "The vehicle has seen this counter value before. Reset the counter and try again"
+    code = 26
+
+
+class TeslaFleetMessageFaultInvalidKeyHandle(TeslaFleetMessageFault):
+    """The key handle is not valid. The key may have been revoked or expired"""
+
+    message = "The key handle is not valid. The key may have been revoked or expired"
+    code = 27
+
+
+class TeslaFleetMessageFaultRequiresResponseEncryption(TeslaFleetMessageFault):
+    """The response requires encryption but encryption was not requested"""
+
+    message = "The response requires encryption but encryption was not requested"
+    code = 28
+
 
 MESSAGE_FAULTS = [
     None,
@@ -684,9 +704,9 @@ MESSAGE_FAULTS = [
     TeslaFleetMessageFaultCommandRequiresAccountCredentials,
     TeslaFleetMessageFaultFieldExceedsMTU,
     TeslaFleetMessageFaultResponseSizeExceedsMTU,
-    None,
-    None,
-    None,
+    TeslaFleetMessageFaultRepeatedCounter,
+    TeslaFleetMessageFaultInvalidKeyHandle,
+    TeslaFleetMessageFaultRequiresResponseEncryption,
 ]
 
 class SignedMessageInformationFault(TeslaFleetError):

{tesla_fleet_api-1.0.2 → tesla_fleet_api-1.0.4}/tesla_fleet_api/tesla/bluetooth.py

@@ -2,6 +2,9 @@
 
 import hashlib
 import re
+from google.protobuf.json_format import MessageToJson, MessageToDict
+from bleak.backends.device import BLEDevice
+from cryptography.hazmat.primitives.asymmetric import ec
 
 from tesla_fleet_api.tesla.tesla import Tesla
 from tesla_fleet_api.tesla.vehicle.bluetooth import VehicleBluetooth
@@ -36,8 +39,16 @@ class Vehicles(dict[str, VehicleBluetooth]):
         """Creates a specific vehicle."""
         return self.createBluetooth(vin)
 
-    def createBluetooth(self, vin: str) -> VehicleBluetooth:
+    def createBluetooth(self, vin: str, key: ec.EllipticCurvePrivateKey | None = None, device: None | str | BLEDevice = None) -> VehicleBluetooth:
         """Creates a specific vehicle."""
-        vehicle = VehicleBluetooth(self._parent, vin)
+        vehicle = VehicleBluetooth(self._parent, vin, key, device)
         self[vin] = vehicle
         return vehicle
+
+def toJson(message) -> str:
+    """Convert a protobuf message to JSON."""
+    return MessageToJson(message, preserving_proto_field_name=True)
+
+def toDict(message) -> dict:
+    """Convert a protobuf message to a dictionary."""
+    return MessageToDict(message, preserving_proto_field_name=True)

{tesla_fleet_api-1.0.2 → tesla_fleet_api-1.0.4}/tesla_fleet_api/tesla/partner.py

@@ -1,5 +1,5 @@
 from typing import Any
-from ..const import Method
+from tesla_fleet_api.const import Method
 
 
 class Partner:

tesla_fleet_api-1.0.4/tesla_fleet_api/tesla/vehicle/bluetooth.py

@@ -0,0 +1,397 @@
+from __future__ import annotations
+
+import hashlib
+import asyncio
+from typing import TYPE_CHECKING
+from google.protobuf.message import DecodeError
+from bleak_retry_connector import establish_connection, MAX_CONNECT_ATTEMPTS
+from bleak import BleakClient, BleakScanner
+from bleak.backends.characteristic import BleakGATTCharacteristic
+from bleak.backends.device import BLEDevice
+from cryptography.hazmat.primitives.asymmetric import ec
+
+from tesla_fleet_api.tesla.vehicle.proto.keys_pb2 import Role
+
+from tesla_fleet_api.tesla.vehicle.commands import Commands
+
+from tesla_fleet_api.const import (
+    LOGGER,
+    BluetoothVehicleData
+)
+from tesla_fleet_api.exceptions import (
+    WHITELIST_OPERATION_STATUS,
+    WhitelistOperationStatus,
+)
+
+# Protocol
+from tesla_fleet_api.tesla.vehicle.proto.car_server_pb2 import (
+    Action,
+    VehicleAction,
+    GetVehicleData,
+    GetChargeState,
+    GetClimateState,
+    GetDriveState,
+    GetLocationState,
+    GetClosuresState,
+    GetChargeScheduleState,
+    GetPreconditioningScheduleState,
+    GetTirePressureState,
+    GetMediaState,
+    GetMediaDetailState,
+    GetSoftwareUpdateState,
+    GetParentalControlsState,
+)
+from tesla_fleet_api.tesla.vehicle.proto.universal_message_pb2 import (
+    Destination,
+    Domain,
+    RoutableMessage,
+)
+from tesla_fleet_api.tesla.vehicle.proto.vcsec_pb2 import (
+    FromVCSECMessage,
+    InformationRequest,
+    InformationRequestType,
+    KeyFormFactor,
+    KeyMetadata,
+    PermissionChange,
+    PublicKey,
+    RKEAction_E,
+    UnsignedMessage,
+    VehicleStatus,
+    WhitelistOperation,
+)
+from tesla_fleet_api.tesla.vehicle.proto.vehicle_pb2 import ChargeScheduleState, ChargeState, ClimateState, ClosuresState, DriveState, LocationState, MediaDetailState, MediaState, ParentalControlsState, PreconditioningScheduleState, SoftwareUpdateState, TirePressureState, VehicleData
+
+SERVICE_UUID = "00000211-b2d1-43f0-9b88-960cebf8b91e"
+WRITE_UUID = "00000212-b2d1-43f0-9b88-960cebf8b91e"
+READ_UUID = "00000213-b2d1-43f0-9b88-960cebf8b91e"
+VERSION_UUID = "00000214-b2d1-43f0-9b88-960cebf8b91e"
+
+if TYPE_CHECKING:
+    from tesla_fleet_api.tesla.tesla import Tesla
+
+def prependLength(message: bytes) -> bytearray:
+    """Prepend a 2-byte length to the payload."""
+    return bytearray([len(message) >> 8, len(message) & 0xFF]) + message
+
+class VehicleBluetooth(Commands):
+    """Class describing the Tesla Fleet API vehicle endpoints and commands for a specific vehicle with command signing."""
+
+    ble_name: str
+    device: BLEDevice
+    client: BleakClient
+    _queues: dict[Domain, asyncio.Queue]
+    _ekey: ec.EllipticCurvePublicKey
+    _recv: bytearray = bytearray()
+    _recv_len: int = 0
+    _auth_method = "aes"
+
+    def __init__(
+        self, parent: Tesla, vin: str, key: ec.EllipticCurvePrivateKey | None = None, device: None | str | BLEDevice = None
+    ):
+        super().__init__(parent, vin, key)
+        self.ble_name = "S" + hashlib.sha1(vin.encode('utf-8')).hexdigest()[:16] + "C"
+        self._queues = {
+            Domain.DOMAIN_VEHICLE_SECURITY: asyncio.Queue(),
+            Domain.DOMAIN_INFOTAINMENT: asyncio.Queue(),
+        }
+        if device is not None:
+            self.client = BleakClient(device, services=[SERVICE_UUID])
+
+    async def find_vehicle(self, name: str | None = None, address: str | None = None, scanner: BleakScanner = BleakScanner()) -> BLEDevice:
+        """Find the Tesla BLE device."""
+        if name is not None:
+            device = await scanner.find_device_by_name(name)
+        elif address is not None:
+            device = await scanner.find_device_by_address(address)
+        else:
+            device = await scanner.find_device_by_name(self.ble_name)
+        if not device:
+            raise ValueError(f"Device {self.ble_name} not found")
+        self.device = device
+        return self.device
+
+    def set_device(self, device: BLEDevice) -> None:
+        self.device = device
+
+    def get_device(self) -> BLEDevice:
+        return self.device
+
+    async def connect(self, device: BLEDevice | None = None, max_attempts: int = MAX_CONNECT_ATTEMPTS) -> None:
+        """Connect to the Tesla BLE device."""
+        self.client = await establish_connection(BleakClient, self.device, self.vin, max_attempts=max_attempts, ble_device_callback=self.get_device)
+        await self.client.start_notify(READ_UUID, self._on_notify)
+
+    async def disconnect(self) -> bool:
+        """Disconnect from the Tesla BLE device."""
+        return await self.client.disconnect()
+
+    async def __aenter__(self) -> VehicleBluetooth:
+        """Enter the async context."""
+        await self.connect()
+        return self
+
+    async def __aexit__(self, exc_type, exc_val, exc_tb) -> None:
+        """Exit the async context."""
+        await self.disconnect()
+
+    async def _on_notify(self,sender: BleakGATTCharacteristic,data : bytearray) -> None:
+        """Receive data from the Tesla BLE device."""
+        if self._recv_len:
+            self._recv += data
+        else:
+            self._recv_len = int.from_bytes(data[:2], 'big')
+            self._recv = data[2:]
+        LOGGER.debug(f"Received {len(self._recv)} of {self._recv_len} bytes")
+        while len(self._recv) > self._recv_len:
+            LOGGER.warn(f"Received more data than expected: {len(self._recv)} > {self._recv_len}")
+            await self._on_message(bytes(self._recv[:self._recv_len]))
+            self._recv_len = int.from_bytes(self._recv[self._recv_len:self._recv_len+2], 'big')
+            self._recv = self._recv[self._recv_len+2:]
+            continue
+        if len(self._recv) == self._recv_len:
+            await self._on_message(bytes(self._recv))
+            self._recv = bytearray()
+            self._recv_len = 0
+
+    async def _on_message(self, data:bytes) -> None:
+        """Receive messages from the Tesla BLE data."""
+        try:
+            msg = RoutableMessage.FromString(data)
+        except DecodeError as e:
+            LOGGER.error(f"Error parsing message: {e}")
+            self._recv = bytearray()
+            self._recv_len = 0
+            return
+
+        if(msg.to_destination.routing_address != self._from_destination):
+            # Ignore ephemeral key broadcasts
+            return
+
+        LOGGER.info(f"Received response: {msg}")
+        await self._queues[msg.from_destination.domain].put(msg)
+
+    async def _send(self, msg: RoutableMessage, requires: str) -> RoutableMessage:
+        """Serialize a message and send to the vehicle and wait for a response."""
+        domain = msg.to_destination.domain
+        async with self._sessions[domain].lock:
+            LOGGER.debug(f"Sending message {msg}")
+
+            payload = prependLength(msg.SerializeToString())
+
+            # Empty the queue before sending the message
+            while not self._queues[domain].empty():
+                await self._queues[domain].get()
+            await self.client.write_gatt_char(WRITE_UUID, payload, True)
+
+            # Process the response
+            async with asyncio.timeout(10):
+                while True:
+                    resp = await self._queues[domain].get()
+                    LOGGER.debug(f"Received message {resp}")
+
+                    self.validate_msg(resp)
+
+                    if resp.HasField(requires):
+                        return resp
+
+    async def pair(self, role: Role = Role.ROLE_OWNER, form: KeyFormFactor = KeyFormFactor.KEY_FORM_FACTOR_CLOUD_KEY):
+        """Pair the key."""
+
+        request = UnsignedMessage(
+            WhitelistOperation=WhitelistOperation(
+                addKeyToWhitelistAndAddPermissions=PermissionChange(
+                    key=PublicKey(PublicKeyRaw=self._public_key),
+                    keyRole=role
+                ),
+                metadataForKey=KeyMetadata(
+                    keyFormFactor=form
+                )
+            )
+        )
+        msg = RoutableMessage(
+            to_destination=Destination(
+                domain=Domain.DOMAIN_VEHICLE_SECURITY
+            ),
+            from_destination=Destination(
+                routing_address=self._from_destination
+            ),
+            protobuf_message_as_bytes=request.SerializeToString(),
+        )
+        resp = await self._send(msg)
+        respMsg = FromVCSECMessage.FromString(resp.protobuf_message_as_bytes)
+        if(respMsg.commandStatus.whitelistOperationStatus.whitelistOperationInformation):
+            if(respMsg.commandStatus.whitelistOperationStatus.whitelistOperationInformation < len(WHITELIST_OPERATION_STATUS)):
+                raise WHITELIST_OPERATION_STATUS[respMsg.commandStatus.whitelistOperationStatus.whitelistOperationInformation]
+            else:
+                raise WhitelistOperationStatus(f"Unknown whitelist operation failure: {respMsg.commandStatus.whitelistOperationStatus.whitelistOperationInformation}")
+        return
+
+    async def wake_up(self):
+        """Wake up the vehicle."""
+        return await self._sendVehicleSecurity(
+            UnsignedMessage(RKEAction=RKEAction_E.RKE_ACTION_WAKE_VEHICLE)
+        )
+
+    async def vehicle_data(self, endpoints: list[BluetoothVehicleData]) -> VehicleData:
+        """Get vehicle data."""
+        return await self._getInfotainment(
+            Action(
+                vehicleAction=VehicleAction(
+                    getVehicleData=GetVehicleData(
+                        getChargeState = GetChargeState() if BluetoothVehicleData.CHARGE_STATE in endpoints else None,
+                        getClimateState = GetClimateState() if BluetoothVehicleData.CLIMATE_STATE in endpoints else None,
+                        getDriveState = GetDriveState() if BluetoothVehicleData.DRIVE_STATE in endpoints else None,
+                        getLocationState = GetLocationState() if BluetoothVehicleData.LOCATION_STATE in endpoints else None,
+                        getClosuresState = GetClosuresState() if BluetoothVehicleData.CLOSURES_STATE in endpoints else None,
+                        getChargeScheduleState = GetChargeScheduleState() if BluetoothVehicleData.CHARGE_SCHEDULE_STATE in endpoints else None,
+                        getPreconditioningScheduleState = GetPreconditioningScheduleState() if BluetoothVehicleData.PRECONDITIONING_SCHEDULE_STATE in endpoints else None,
+                        getTirePressureState = GetTirePressureState() if BluetoothVehicleData.TIRE_PRESSURE_STATE in endpoints else None,
+                        getMediaState = GetMediaState() if BluetoothVehicleData.MEDIA_STATE in endpoints else None,
+                        getMediaDetailState = GetMediaDetailState() if BluetoothVehicleData.MEDIA_DETAIL_STATE in endpoints else None,
+                        getSoftwareUpdateState = GetSoftwareUpdateState() if BluetoothVehicleData.SOFTWARE_UPDATE_STATE in endpoints else None,
+                        getParentalControlsState = GetParentalControlsState() if BluetoothVehicleData.PARENTAL_CONTROLS_STATE in endpoints else None,
+                    )
+                )
+            )
+        )
+
+    async def charge_state(self) -> ChargeState:
+        return (await self._getInfotainment(
+            Action(
+                vehicleAction=VehicleAction(
+                    getVehicleData=GetVehicleData(
+                        getChargeState=GetChargeState()
+                    )
+                )
+            )
+        )).charge_state
+
+    async def climate_state(self) -> ClimateState:
+        return (await self._getInfotainment(
+            Action(
+                vehicleAction=VehicleAction(
+                    getVehicleData=GetVehicleData(
+                        getClimateState=GetClimateState()
+                    )
+                )
+            )
+        )).climate_state
+
+    async def drive_state(self) -> DriveState:
+        return (await self._getInfotainment(
+            Action(
+                vehicleAction=VehicleAction(
+                    getVehicleData=GetVehicleData(
+                        getDriveState=GetDriveState()
+                    )
+                )
+            )
+        )).drive_state
+
+    async def location_state(self) -> LocationState:
+        return (await self._getInfotainment(
+            Action(
+                vehicleAction=VehicleAction(
+                    getVehicleData=GetVehicleData(
+                        getLocationState=GetLocationState()
+                    )
+                )
+            )
+        )).location_state
+
+    async def closures_state(self) -> ClosuresState:
+        return (await self._getInfotainment(
+            Action(
+                vehicleAction=VehicleAction(
+                    getVehicleData=GetVehicleData(
+                        getClosuresState=GetClosuresState()
+                    )
+                )
+            )
+        )).closures_state
+
+    async def charge_schedule_state(self) -> ChargeScheduleState:
+        return (await self._getInfotainment(
+            Action(
+                vehicleAction=VehicleAction(
+                    getVehicleData=GetVehicleData(
+                        getChargeScheduleState=GetChargeScheduleState()
+                    )
+                )
+            )
+        )).charge_schedule_state
+
+    async def preconditioning_schedule_state(self) -> PreconditioningScheduleState:
+        return (await self._getInfotainment(
+            Action(
+                vehicleAction=VehicleAction(
+                    getVehicleData=GetVehicleData(
+                        getPreconditioningScheduleState=GetPreconditioningScheduleState()
+                    )
+                )
+            )
+        )).preconditioning_schedule_state
+
+    async def tire_pressure_state(self) -> TirePressureState:
+        return (await self._getInfotainment(
+            Action(
+                vehicleAction=VehicleAction(
+                    getVehicleData=GetVehicleData(
+                        getTirePressureState=GetTirePressureState()
+                    )
+                )
+            )
+        )).tire_pressure_state
+
+    async def media_state(self) -> MediaState:
+        return (await self._getInfotainment(
+            Action(
+                vehicleAction=VehicleAction(
+                    getVehicleData=GetVehicleData(
+                        getMediaState=GetMediaState()
+                    )
+                )
+            )
+        )).media_state
+
+    async def media_detail_state(self) -> MediaDetailState:
+        return (await self._getInfotainment(
+            Action(
+                vehicleAction=VehicleAction(
+                    getVehicleData=GetVehicleData(
+                        getMediaDetailState=GetMediaDetailState()
+                    )
+                )
+            )
+        )).media_detail_state
+
+    async def software_update_state(self) -> SoftwareUpdateState:
+        return (await self._getInfotainment(
+            Action(
+                vehicleAction=VehicleAction(
+                    getVehicleData=GetVehicleData(
+                        getSoftwareUpdateState=GetSoftwareUpdateState()
+                    )
+                )
+            )
+        )).software_update_state
+
+    async def parental_controls_state(self) -> ParentalControlsState:
+        return (await self._getInfotainment(
+            Action(
+                vehicleAction=VehicleAction(
+                    getVehicleData=GetVehicleData(
+                        getParentalControlsState=GetParentalControlsState()
+                    )
+                )
+            )
+        )).parental_controls_state
+
+    async def vehicle_state(self) -> VehicleStatus:
+        return await self._getVehicleSecurity(
+            UnsignedMessage(
+                InformationRequest=InformationRequest(
+                    informationRequestType=InformationRequestType.INFORMATION_REQUEST_TYPE_GET_STATUS
+                )
+            )
+        )