tesla-fleet-api 0.9.9__tar.gz → 1.0.0__tar.gz

{tesla_fleet_api-0.9.9/tesla_fleet_api.egg-info → tesla_fleet_api-1.0.0}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.2
 Name: tesla_fleet_api
-Version: 0.9.9
+Version: 1.0.0
 Summary: Tesla Fleet API library for Python
 Home-page: https://github.com/Teslemetry/python-tesla-fleet-api
 Author: Brett Adams
 Author-email: hello@teslemetry.com
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
@@ -17,6 +17,7 @@ Requires-Dist: aiofiles
 Requires-Dist: aiolimiter
 Requires-Dist: cryptography
 Requires-Dist: protobuf
+Requires-Dist: bleak
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

tesla_fleet_api-1.0.0/pyproject.toml

@@ -0,0 +1,2 @@
+[tool.ruff]
+exclude = ["tesla_fleet_api/tesla/vehicle/proto/*"]

{tesla_fleet_api-0.9.9 → tesla_fleet_api-1.0.0}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setuptools.setup(
     name="tesla_fleet_api",
-    version="0.9.9",
+    version="1.0.0",
     author="Brett Adams",
     author_email="hello@teslemetry.com",
     description="Tesla Fleet API library for Python",
@@ -14,11 +14,11 @@ setuptools.setup(
     url="https://github.com/Teslemetry/python-tesla-fleet-api",
     packages=setuptools.find_packages(),
     classifiers=[
-        "Development Status :: 4 - Beta",
+        "Development Status :: 5 - Production/Stable",
         "Programming Language :: Python :: 3",
         "License :: OSI Approved :: Apache Software License",
         "Operating System :: OS Independent",
     ],
     python_requires=">=3.10",
-    install_requires=["aiohttp", "aiofiles", "aiolimiter", "cryptography", "protobuf"],
+    install_requires=["aiohttp", "aiofiles", "aiolimiter", "cryptography", "protobuf", "bleak"],
 )

tesla_fleet_api-1.0.0/tesla_fleet_api/__init__.py

@@ -0,0 +1,15 @@
+from .tesla.fleet import TeslaFleetApi
+from .tesla.bluetooth import TeslaBluetooth
+from .tesla.oauth import TeslaFleetOAuth
+from .tesla.opensource import TeslaFleetOpenSource
+from .teslemetry.teslemetry import Teslemetry
+from .tessie.tessie import Tessie
+
+__all__ = [
+    "TeslaFleetApi",
+    "TeslaBluetooth",
+    "TeslaFleetOAuth",
+    "TeslaFleetOpenSource",
+    "Teslemetry",
+    "Tessie",
+]

tesla_fleet_api-1.0.0/tesla_fleet_api/const.py

@@ -0,0 +1,161 @@
+"""Tesla Fleet API constants."""
+
+from enum import Enum
+import logging
+
+VERSION = "1.0.0"
+LOGGER = logging.getLogger(__package__)
+SERVERS = {
+    "na": "https://fleet-api.prd.na.vn.cloud.tesla.com",
+    "eu": "https://fleet-api.prd.eu.vn.cloud.tesla.com",
+    "cn": "https://fleet-api.prd.cn.vn.cloud.tesla.cn",
+}
+
+
+class IntEnum(int, Enum):
+    """Integer Enum."""
+
+    def __str__(self) -> str:
+        return str(self.value)
+
+
+class StrEnum(str, Enum):
+    """String Enum."""
+
+    def __str__(self) -> str:
+        return self.value
+
+
+class Method(StrEnum):
+    """HTTP Methods."""
+
+    GET = "GET"
+    POST = "POST"
+    DELETE = "DELETE"
+
+
+class Trunk(StrEnum):
+    """Trunk options"""
+
+    FRONT = "front"
+    REAR = "rear"
+
+
+class Seat(IntEnum):
+    """Seat positions"""
+
+    FRONT_LEFT = 0
+    FRONT_RIGHT = 1
+    REAR_LEFT = 2
+    REAR_CENTER = 4
+    REAR_RIGHT = 5
+    THIRD_LEFT = 6
+    THIRD_RIGHT = 7
+
+
+class Level(IntEnum):
+    """Level options"""
+
+    OFF = 0
+    LOW = 1
+    MEDIUM = 2
+    HIGH = 3
+
+
+class ClimateKeeperMode(IntEnum):
+    """Climate Keeper Mode options"""
+
+    OFF = 0
+    KEEP_MODE = 1
+    DOG_MODE = 2
+    CAMP_MODE = 3
+
+
+class CabinOverheatProtectionTemp(IntEnum):
+    """COP Temp options"""
+
+    LOW = 0  # 30C 90F
+    MEDIUM = 1  # 35C 95F
+    HIGH = 2  # 40C 100F
+
+
+class VehicleDataEndpoint(StrEnum):
+    """Endpoints options"""
+
+    CHARGE_STATE = "charge_state"
+    CLIMATE_STATE = "climate_state"
+    CLOSURES_STATE = "closures_state"
+    DRIVE_STATE = "drive_state"
+    GUI_SETTINGS = "gui_settings"
+    LOCATION_DATA = "location_data"
+    CHARGE_SCHEDULE_DATA = "charge_schedule_data"
+    PRECONDITIONING_SCHEDULE_DATA = "preconditioning_schedule_data"
+    VEHICLE_CONFIG = "vehicle_config"
+    VEHICLE_STATE = "vehicle_state"
+    VEHICLE_DATA_COMBO = "vehicle_data_combo"
+
+
+
+class SunRoofCommand(StrEnum):
+    """Sunroof options"""
+
+    STOP = "stop"
+    CLOSE = "close"
+    VENT = "vent"
+
+
+class WindowCommand(StrEnum):
+    """Window Control options"""
+
+    VENT = "vent"
+    CLOSE = "close"
+
+
+class DeviceType(StrEnum):
+    """Device Type options"""
+
+    ANDROID = "android"
+    IOS_DEVELOPMENT = "ios-development"
+    IOS_ENTERPRISE = "ios-enterprise"
+    IOS_BETA = "ios-beta"
+    IOS_PRODUCTION = "ios-production"
+
+
+class Scope(StrEnum):
+    """Fleet API Scope"""
+
+    OPENID = "openid"
+    OFFLINE_ACCESS = "offline_access"
+    USER_DATA = "user_data"
+    VEHICLE_DEVICE_DATA = "vehicle_device_data"
+    VEHICLE_LOCATION = "vehicle_location"
+    VEHICLE_CMDS = "vehicle_cmds"
+    VEHICLE_CHARGING_CMDS = "vehicle_charging_cmds"
+    ENERGY_DEVICE_DATA = "energy_device_data"
+    ENERGY_CMDS = "energy_cmds"
+
+
+class EnergyOperationMode(StrEnum):
+    """Energy Operation Mode options"""
+
+    AUTONOMOUS = "autonomous"
+    SELF_CONSUMPTION = "self_consumption"
+    BACKUP = "backup"
+
+
+class EnergyExportMode(StrEnum):
+    """Energy Export Mode options"""
+
+    BATTERY_OK = "battery_ok"
+    PV_ONLY = "pv_only"
+    NEVER = "never"
+
+
+class TeslaEnergyPeriod(StrEnum):
+    """Period for history for energy sites"""
+
+    DAY = "day"
+    WEEK = "week"
+    MONTH = "month"
+    YEAR = "year"
+    LIFETIME = "lifetime"

{tesla_fleet_api-0.9.9 → tesla_fleet_api-1.0.0}/tesla_fleet_api/exceptions.py

@@ -853,6 +853,123 @@ SIGNED_MESSAGE_INFORMATION_FAULTS = [
     SignedMessageInformationFaultCouldNotHashMetadata,
 ]
 
+class WhitelistOperationStatus(TeslaFleetError):
+    message = "Whitelist operation failed"
+
+class WhitelistOperationUndocumentedError(WhitelistOperationStatus):
+    message = "Undocumented whitelist operation error"
+    code = 1
+
+class WhitelistOperationNoPermissionToRemoveOneself(WhitelistOperationStatus):
+    message = "No permission to remove oneself from whitelist"
+    code = 2
+
+class WhitelistOperationKeyfobSlotsFull(WhitelistOperationStatus):
+    message = "Keyfob slots are full"
+    code = 3
+
+class WhitelistOperationWhitelistFull(WhitelistOperationStatus):
+    message = "Whitelist is full"
+    code = 4
+
+class WhitelistOperationNoPermissionToAdd(WhitelistOperationStatus):
+    message = "No permission to add to whitelist"
+    code = 5
+
+class WhitelistOperationInvalidPublicKey(WhitelistOperationStatus):
+    message = "Invalid public key"
+    code = 6
+
+class WhitelistOperationNoPermissionToRemove(WhitelistOperationStatus):
+    message = "No permission to remove from whitelist"
+    code = 7
+
+class WhitelistOperationNoPermissionToChangePermissions(WhitelistOperationStatus):
+    message = "No permission to change permissions"
+    code = 8
+
+class WhitelistOperationAttemptingToElevateOthersAboveOneself(WhitelistOperationStatus):
+    message = "Attempting to elevate others above oneself"
+    code = 9
+
+class WhitelistOperationAttemptingToDemoteSuperiorToOneself(WhitelistOperationStatus):
+    message = "Attempting to demote superior to oneself"
+    code = 10
+
+class WhitelistOperationAttemptingToRemoveOwnPermissions(WhitelistOperationStatus):
+    message = "Attempting to remove own permissions"
+    code = 11
+
+class WhitelistOperationPublicKeyNotOnWhitelist(WhitelistOperationStatus):
+    message = "Public key not on whitelist"
+    code = 12
+
+class WhitelistOperationAttemptingToAddExistingKey(WhitelistOperationStatus):
+    message = "Attempting to add key that is already on the whitelist"
+    code = 13
+
+class WhitelistOperationNotAllowedToAddUnlessOnReader(WhitelistOperationStatus):
+    message = "Not allowed to add unless on reader"
+    code = 14
+
+class WhitelistOperationFMModifyingOutsideOfFMode(WhitelistOperationStatus):
+    message = "FM modifying outside of F mode"
+    code = 15
+
+class WhitelistOperationFMAttemptingToAddPermanentKey(WhitelistOperationStatus):
+    message = "FM attempting to add permanent key"
+    code = 16
+
+class WhitelistOperationFMAttemptingToRemovePermanentKey(WhitelistOperationStatus):
+    message = "FM attempting to remove permanent key"
+    code = 17
+
+class WhitelistOperationKeychainWhileFSFull(WhitelistOperationStatus):
+    message = "Keychain while FS full"
+    code = 18
+
+class WhitelistOperationAttemptingToAddKeyWithoutRole(WhitelistOperationStatus):
+    message = "Attempting to add key without role"
+    code = 19
+
+class WhitelistOperationAttemptingToAddKeyWithServiceRole(WhitelistOperationStatus):
+    message = "Attempting to add key with service role"
+    code = 20
+
+class WhitelistOperationNonServiceKeyAttemptingToAddServiceTech(WhitelistOperationStatus):
+    message = "Non-service key attempting to add service tech"
+    code = 21
+
+class WhitelistOperationServiceKeyAttemptingToAddServiceTechOutsideServiceMode(WhitelistOperationStatus):
+    message = "Service key attempting to add service tech outside service mode"
+    code = 22
+
+WHITELIST_OPERATION_STATUS = [
+    None,
+    WhitelistOperationUndocumentedError,
+    WhitelistOperationNoPermissionToRemoveOneself,
+    WhitelistOperationKeyfobSlotsFull,
+    WhitelistOperationWhitelistFull,
+    WhitelistOperationNoPermissionToAdd,
+    WhitelistOperationInvalidPublicKey,
+    WhitelistOperationNoPermissionToRemove,
+    WhitelistOperationNoPermissionToChangePermissions,
+    WhitelistOperationAttemptingToElevateOthersAboveOneself,
+    WhitelistOperationAttemptingToDemoteSuperiorToOneself,
+    WhitelistOperationAttemptingToRemoveOwnPermissions,
+    WhitelistOperationPublicKeyNotOnWhitelist,
+    WhitelistOperationAttemptingToAddExistingKey,
+    WhitelistOperationNotAllowedToAddUnlessOnReader,
+    WhitelistOperationFMModifyingOutsideOfFMode,
+    WhitelistOperationFMAttemptingToAddPermanentKey,
+    WhitelistOperationFMAttemptingToRemovePermanentKey,
+    WhitelistOperationKeychainWhileFSFull,
+    WhitelistOperationAttemptingToAddKeyWithoutRole,
+    WhitelistOperationAttemptingToAddKeyWithServiceRole,
+    WhitelistOperationNonServiceKeyAttemptingToAddServiceTech,
+    WhitelistOperationServiceKeyAttemptingToAddServiceTechOutsideServiceMode
+]
+
 
 async def raise_for_status(resp: aiohttp.ClientResponse) -> None:
     """Raise an exception if the response status code is >=400."""

tesla_fleet_api-1.0.0/tesla_fleet_api/tesla/__init__.py

@@ -0,0 +1,11 @@
+"""Tesla Fleet API classes."""
+
+from .fleet import TeslaFleetApi
+from .bluetooth import TeslaBluetooth
+from .oauth import TeslaFleetOAuth
+
+__all__ = [
+    "TeslaFleetApi",
+    "TeslaBluetooth",
+    "TeslaFleetOAuth",
+]

tesla_fleet_api-1.0.0/tesla_fleet_api/tesla/bluetooth.py

@@ -0,0 +1,33 @@
+"""Bluetooth only interface."""
+
+import re
+from .tesla import Tesla
+from .vehicle.bluetooth import VehicleBluetooth
+
+class TeslaBluetooth(Tesla):
+    """Class describing a Tesla Bluetooth connection."""
+
+    def __init__(
+        self,
+    ):
+        """Initialize the Tesla Fleet API."""
+
+        self.vehicles = Vehicles(self)
+
+    def valid_name(self, name: str) -> bool:
+        """Check if a BLE device name is a valid Tesla vehicle."""
+        return bool(re.match("^S[a-f0-9]{16}[A-F]$", name))
+
+class Vehicles(dict[str, VehicleBluetooth]):
+    """Class containing and creating vehicles."""
+
+    _parent: TeslaBluetooth
+
+    def __init__(self, parent: TeslaBluetooth):
+        self._parent = parent
+
+    def createBluetooth(self, vin: str) -> VehicleBluetooth:
+        """Creates a specific vehicle."""
+        vehicle = VehicleBluetooth(self._parent, vin)
+        self[vin] = vehicle
+        return vehicle

{tesla_fleet_api-0.9.9/tesla_fleet_api → tesla_fleet_api-1.0.0/tesla_fleet_api/tesla}/charging.py

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

tesla_fleet_api-0.9.9/tesla_fleet_api/energy.py → tesla_fleet_api-1.0.0/tesla_fleet_api/tesla/energysite.py

@@ -1,37 +1,35 @@
 from __future__ import annotations
 from typing import Any, TYPE_CHECKING
-from .const import Method, EnergyOperationMode, EnergyExportMode, TeslaEnergyPeriod
-from .energyspecific import EnergySpecific
+from ..const import Method, EnergyOperationMode, EnergyExportMode, TeslaEnergyPeriod
 
 if TYPE_CHECKING:
-    from .teslafleetapi import TeslaFleetApi
+    from . import TeslaFleetApi
 
-
-class Energy:
+class EnergySite:
     """Class describing the Tesla Fleet API partner endpoints"""
 
-    parent: TeslaFleetApi
+    energy_site_id: int
 
-    def __init__(self, parent):
+    def __init__(
+        self,
+        parent: TeslaFleetApi,
+        energy_site_id: int
+    ):
         self._request = parent._request
-
-    def specific(self, energy_site_id: int) -> EnergySpecific:
-        """Create a specific energy site."""
-        return EnergySpecific(self, energy_site_id)
+        self.energy_site_id = energy_site_id
 
     async def backup(
-        self, energy_site_id: int, backup_reserve_percent: int
+        self, backup_reserve_percent: int
     ) -> dict[str, Any]:
         """Adjust the site's backup reserve."""
         return await self._request(
             Method.POST,
-            f"api/1/energy_sites/{energy_site_id}/backup",
+            f"api/1/energy_sites/{self.energy_site_id}/backup",
             json={"backup_reserve_percent": backup_reserve_percent},
         )
 
     async def backup_history(
         self,
-        energy_site_id: int,
         period: TeslaEnergyPeriod | str | None,
         start_date: str | None = None,
         end_date: str | None = None,
@@ -40,7 +38,7 @@ class Energy:
         """Returns the backup (off-grid) event history of the site in duration of seconds."""
         return await self._request(
             Method.GET,
-            f"api/1/energy_sites/{energy_site_id}/calendar_history",
+            f"api/1/energy_sites/{self.energy_site_id}/calendar_history",
             params={
                 "kind": "backup",
                 "start_date": start_date,
@@ -52,7 +50,6 @@ class Energy:
 
     async def charge_history(
         self,
-        energy_site_id: int,
         start_date: str,
         end_date: str,
         time_zone: str | None = None,
@@ -60,7 +57,7 @@ class Energy:
         """Returns the charging history of a wall connector."""
         return await self._request(
             Method.GET,
-            f"api/1/energy_sites/{energy_site_id}/telemetry_history",
+            f"api/1/energy_sites/{self.energy_site_id}/telemetry_history",
             params={
                 "kind": "charge",
                 "start_date": start_date,
@@ -71,7 +68,6 @@ class Energy:
 
     async def energy_history(
         self,
-        energy_site_id: int,
         period: TeslaEnergyPeriod | str | None,
         start_date: str | None = None,
         end_date: str | None = None,
@@ -80,7 +76,7 @@ class Energy:
         """Returns the energy measurements of the site, aggregated to the requested period."""
         return await self._request(
             Method.GET,
-            f"api/1/energy_sites/{energy_site_id}/calendar_history",
+            f"api/1/energy_sites/{self.energy_site_id}/calendar_history",
             params={
                 "kind": "energy",
                 "start_date": start_date,
@@ -92,70 +88,82 @@ class Energy:
 
     async def grid_import_export(
         self,
-        energy_site_id: int,
         disallow_charge_from_grid_with_solar_installed: bool | None = None,
         customer_preferred_export_rule: EnergyExportMode | str | None = None,
     ) -> dict[str, Any]:
         """Allow/disallow charging from the grid and exporting energy to the grid."""
         return await self._request(
             Method.POST,
-            f"api/1/energy_sites/{energy_site_id}/grid_import_export",
+            f"api/1/energy_sites/{self.energy_site_id}/grid_import_export",
             json={
                 "disallow_charge_from_grid_with_solar_installed": disallow_charge_from_grid_with_solar_installed,
                 "customer_preferred_export_rule": customer_preferred_export_rule,
             },
         )
 
-    async def live_status(self, energy_site_id: int) -> dict[str, Any]:
+    async def live_status(self) -> dict[str, Any]:
         """Returns the live status of the site (power, state of energy, grid status, storm mode)."""
         return await self._request(
             Method.GET,
-            f"api/1/energy_sites/{energy_site_id}/live_status",
+            f"api/1/energy_sites/{self.energy_site_id}/live_status",
         )
 
     async def off_grid_vehicle_charging_reserve(
-        self, energy_site_id: int, off_grid_vehicle_charging_reserve_percent: int
+        self, off_grid_vehicle_charging_reserve_percent: int
     ) -> dict[str, Any]:
         """Adjust the site's off-grid vehicle charging backup reserve."""
         return await self._request(
             Method.POST,
-            f"api/1/energy_sites/{energy_site_id}/off_grid_vehicle_charging_reserve",
+            f"api/1/energy_sites/{self.energy_site_id}/off_grid_vehicle_charging_reserve",
             json={
                 "off_grid_vehicle_charging_reserve_percent": off_grid_vehicle_charging_reserve_percent
             },
         )
 
     async def operation(
-        self, energy_site_id: int, default_real_mode: EnergyOperationMode | str
+        self, default_real_mode: EnergyOperationMode | str
     ) -> dict[str, Any]:
         """Set the site's mode."""
         return await self._request(
             Method.POST,
-            f"api/1/energy_sites/{energy_site_id}/operation",
+            f"api/1/energy_sites/{self.energy_site_id}/operation",
             json={"default_real_mode": default_real_mode},
         )
 
-    async def site_info(self, energy_site_id: int) -> dict[str, Any]:
+    async def site_info(self) -> dict[str, Any]:
         """Returns information about the site. Things like assets (has solar, etc), settings (backup reserve, etc), and features (storm_mode_capable, etc)."""
         return await self._request(
             Method.GET,
-            f"api/1/energy_sites/{energy_site_id}/site_info",
+            f"api/1/energy_sites/{self.energy_site_id}/site_info",
         )
 
-    async def storm_mode(self, energy_site_id: int, enabled: bool) -> dict[str, Any]:
+    async def storm_mode(self, enabled: bool) -> dict[str, Any]:
         """Update storm watch participation."""
         return await self._request(
             Method.POST,
-            f"api/1/energy_sites/{energy_site_id}/storm_mode",
+            f"api/1/energy_sites/{self.energy_site_id}/storm_mode",
             json={"enabled": enabled},
         )
 
     async def time_of_use_settings(
-        self, energy_site_id: int, settings: dict[str, Any]
+        self, settings: dict[str, Any]
     ) -> dict[str, Any]:
         """Update the time of use settings for the energy site."""
         return await self._request(
             Method.POST,
-            f"api/1/energy_sites/{energy_site_id}/time_of_use_settings",
+            f"api/1/energy_sites/{self.energy_site_id}/time_of_use_settings",
             json={"tou_settings": {"tariff_content_v2": settings}},
         )
+
+class EnergySites(dict[int, EnergySite]):
+    """Class describing the Tesla Fleet API partner endpoints"""
+
+    _parent: TeslaFleetApi
+
+    def __init__(self, parent: TeslaFleetApi):
+        self._parent = parent
+
+    def create(self, energy_site_id: int) -> EnergySite:
+        """Create a specific energy site."""
+        self[energy_site_id] = EnergySite(self._parent, energy_site_id)
+        return self[energy_site_id]