tesla-fleet-api 0.5.5__py3-none-any.whl → 0.5.7__py3-none-any.whl

tesla_fleet_api/__init__.py

@@ -9,3 +9,18 @@ from .partner import Partner
 from .user import User
 from .vehicle import Vehicle
 from .vehiclespecific import VehicleSpecific
+
+
+__all__ = [
+    "TeslaFleetApi",
+    "TeslaFleetOAuth",
+    "Teslemetry",
+    "Tessie",
+    "Charging",
+    "Energy",
+    "EnergySpecific",
+    "Partner",
+    "User",
+    "Vehicle",
+    "VehicleSpecific",
+]

tesla_fleet_api/const.py

@@ -3,7 +3,7 @@
 from enum import Enum
 import logging
 
-VERSION = "0.5.5"
+VERSION = "0.5.7"
 LOGGER = logging.getLogger(__package__)
 SERVERS = {
     "na": "https://fleet-api.prd.na.vn.cloud.tesla.com",

tesla_fleet_api/energy.py

@@ -91,7 +91,7 @@ class Energy:
         self,
         energy_site_id: int,
         disallow_charge_from_grid_with_solar_installed: bool | None = None,
-        customer_preferred_export_rule: EnergyExportMode|str | 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(

tesla_fleet_api/exceptions.py

@@ -114,6 +114,7 @@ class Forbidden(TeslaFleetError):
 
     message = "Access to this resource is not authorized, developers should check required Scope."
     status = 403
+    key = "Unauthorized missing scopes"
 
 
 class UnsupportedVehicle(TeslaFleetError):

tesla_fleet_api/teslafleetapi.py

@@ -15,7 +15,7 @@ from .vehicle import Vehicle
 class TeslaFleetApi:
     """Class describing the Tesla Fleet API."""
 
-    server: str
+    server: str | None = None
     session: aiohttp.ClientSession
     headers: dict[str, str]
     raise_for_status: bool
@@ -23,7 +23,7 @@ class TeslaFleetApi:
     def __init__(
         self,
         session: aiohttp.ClientSession,
-        access_token: str,
+        access_token: str | None = None,
         region: str | None = None,
         server: str | None = None,
         raise_for_status: bool = True,
@@ -38,9 +38,10 @@ class TeslaFleetApi:
         self.session = session
         self.access_token = access_token
 
-        if region and not server and region not in SERVERS:
-            raise ValueError(f"Region must be one of {', '.join(SERVERS.keys())}")
-        self.server = server or SERVERS.get(region)
+        if region is not None:
+            if not server and region not in SERVERS:
+                raise ValueError(f"Region must be one of {', '.join(SERVERS.keys())}")
+            self.server = server or SERVERS.get(region)
         self.raise_for_status = raise_for_status
 
         LOGGER.debug("Using server %s", self.server)
@@ -61,7 +62,8 @@ class TeslaFleetApi:
         for server in SERVERS.values():
             self.server = server
             try:
-                response = await (self.user.region()).get("response")
+                region_response = await self.user.region()
+                response = region_response.get("response")
                 if response:
                     self.server = response["fleet_api_base_url"]
                     LOGGER.debug("Using server %s", self.server)
@@ -74,9 +76,9 @@ class TeslaFleetApi:
         self,
         method: Method,
         path: str,
-        params: dict[str:Any] | None = None,
-        json: dict[str:Any] | None = None,
-    ):
+        params: dict[str, Any] | None = None,
+        json: dict[str, Any] | None = None,
+    ) -> dict[str, Any] | str:
         """Send a request to the Tesla Fleet API."""
 
         if not self.server:
@@ -125,7 +127,7 @@ class TeslaFleetApi:
             LOGGER.debug("Response Text: %s", data)
             return data
 
-    async def status(self):
+    async def status(self) -> str:
         """This endpoint returns the string "ok" if the API is operating normally. No HTTP headers are required."""
         if not self.server:
             raise ValueError("Server was not set at init. Call find_server() first.")

tesla_fleet_api/teslafleetoauth.py

@@ -42,7 +42,9 @@ class TeslaFleetOAuth(TeslaFleetApi):
         """Get the login URL."""
         return f"https://auth.tesla.com/oauth2/v3/authorize?response_type=code&client_id={self.client_id}&redirect_uri={redirect_uri}&scope={' '.join(scopes)}&state={state}"
 
-    async def get_refresh_token(self, client_secret: str, code: str, redirect_uri: str):
+    async def get_refresh_token(
+        self, client_secret: str, code: str, redirect_uri: str
+    ) -> None:
         """Get the refresh token."""
         async with self.session.post(
             "https://auth.tesla.com/oauth2/v3/token",
@@ -63,13 +65,13 @@ class TeslaFleetOAuth(TeslaFleetApi):
                 region = code.split("_")[0].lower()
                 self.server = SERVERS.get(region)
 
-    async def check_access_token(self) -> str | None:
+    async def check_access_token(self) -> dict[str, Any] | None:
         """Get the access token."""
         if self.access_token and self.expires > time.time():
-            return
+            return None
         return await self.refresh_access_token()
 
-    async def refresh_access_token(self) -> str:
+    async def refresh_access_token(self) -> dict[str, Any]:
         """Refresh the access token."""
         if not self.refresh_token:
             raise ValueError("Refresh token is missing")
@@ -93,9 +95,9 @@ class TeslaFleetOAuth(TeslaFleetApi):
         self,
         method: Method,
         path: str,
-        params: dict | None = None,
-        data: dict | None = None,
-    ):
+        params: dict[str, Any] | None = None,
+        data: dict[str, Any] | None = None,
+    ) -> str | dict[str, Any]:
         """Send a request to the Tesla Fleet API."""
         await self.check_access_token()
         return await super()._request(method, path, params, data)

tesla_fleet_api/teslemetry.py

@@ -52,7 +52,8 @@ class Teslemetry(TeslaFleetApi):
             LOGGER.debug("Using server %s", self.server)
         return resp
 
-    async def find_server(self):
+    # TODO: type this properly, it probably should return something
+    async def find_server(self) -> None:
         """Find the server URL for the Tesla Fleet API."""
         await self.metadata(True)
 
@@ -60,9 +61,9 @@ class Teslemetry(TeslaFleetApi):
         self,
         method: Method,
         path: str,
-        params: dict[str:Any] | None = None,
-        json: dict[str:Any] | None = None,
-    ):
+        params: dict[str, Any] | None = None,
+        json: dict[str, Any] | None = None,
+    ) -> str | dict[str, Any]:
         """Send a request to the Teslemetry API."""
         async with rate_limit:
             return await super()._request(method, path, params, json)

tesla_fleet_api/tessie.py

@@ -2,7 +2,6 @@ import aiohttp
 from typing import Any
 from .teslafleetapi import TeslaFleetApi
 from .const import Method
-from .vehiclespecific import VehicleSpecific
 
 
 class Tessie(TeslaFleetApi):
@@ -23,7 +22,7 @@ class Tessie(TeslaFleetApi):
             energy_scope=False,
         )
 
-    async def find_server(self):
+    async def find_server(self) -> str:
         """Find the server URL for the Tesla Fleet API."""
         raise NotImplementedError("Do not use this function for Tessie.")
 

tesla_fleet_api/vehicle.py

@@ -24,6 +24,10 @@ class Vehicle:
     def specific(self, vehicle_tag: str | int) -> VehicleSpecific:
         """Creates a class for each vehicle."""
         return VehicleSpecific(self, vehicle_tag)
+    
+    def pre2021(self, vin: str) -> bool:
+        """Checks if a vehicle is pre-2021."""
+        return vin[9] <= "L"
 
     async def actuate_trunk(
         self, vehicle_tag: str | int, which_trunk: Trunk | str
@@ -426,13 +430,29 @@ class Vehicle:
         )
 
     async def set_scheduled_departure(
-        self, vehicle_tag: str | int, enable: bool, time: int
+        self,
+        vehicle_tag: str | int,
+        enable: bool = True,
+        preconditioning_enabled: bool = False,
+        preconditioning_weekdays_only: bool = False,
+        departure_time: int = 0,
+        off_peak_charging_enabled: bool = False,
+        off_peak_charging_weekdays_only: bool = False,
+        end_off_peak_time: int = 0,
     ) -> dict[str, Any]:
         """Sets a time at which departure should be completed. The time parameter is minutes after midnight (e.g: time=120 schedules departure for 2:00am vehicle local time)."""
         return await self._request(
             Method.POST,
             f"api/1/vehicles/{vehicle_tag}/command/set_scheduled_departure",
-            json={"preconditioning_enabled": enable, "departure_time": time},
+            json={
+                "enable": enable,
+                "preconditioning_enabled": preconditioning_enabled,
+                "preconditioning_weekdays_only": preconditioning_weekdays_only,
+                "departure_time": departure_time,
+                "off_peak_charging_enabled": off_peak_charging_enabled,
+                "off_peak_charging_weekdays_only": off_peak_charging_weekdays_only,
+                "end_off_peak_time": end_off_peak_time,
+            },
         )
 
     async def set_sentry_mode(self, vehicle_tag: str | int, on: bool) -> dict[str, Any]:
@@ -551,7 +571,7 @@ class Vehicle:
         lon: float | None = None,
     ) -> dict[str, Any]:
         """Turns on HomeLink (used to open and close garage doors)."""
-        data = {}
+        data: dict[str, str | float] = {}
         if token:
             data["token"] = token
         if lat and lon:
@@ -726,12 +746,11 @@ class Vehicle:
         endpoints: List[VehicleDataEndpoint] | List[str] | None = None,
     ) -> dict[str, Any]:
         """Makes a live call to the vehicle. This may return cached data if the vehicle is offline. For vehicles running firmware versions 2023.38+, location_data is required to fetch vehicle location. This will result in a location sharing icon to show on the vehicle UI."""
-        if isinstance(endpoints, list):
-            endpoints = ";".join(endpoints)
+        endpoint_payload = ";".join(endpoints) if endpoints else None
         return await self._request(
             Method.GET,
             f"api/1/vehicles/{vehicle_tag}/vehicle_data",
-            {"endpoints": endpoints},
+            {"endpoints": endpoint_payload},
         )
 
     async def vehicle_subscriptions(

tesla_fleet_api/vehiclespecific.py

@@ -13,10 +13,14 @@ from .const import (
 class VehicleSpecific:
     """Class describing the Tesla Fleet API vehicle endpoints and commands for a specific vehicle."""
 
-    def __init__(self, parent, vin: str | None = None):
+    def __init__(self, parent, vin: str | int | None = None):
         self._parent = parent
         self.vin = vin
 
+    def pre2021(self) -> bool:
+        """Checks if a vehicle is pre-2021."""
+        return self._parent.pre2021(self.vin)
+
     async def actuate_trunk(self, which_trunk: Trunk | str) -> dict[str, Any]:
         """Controls the front or rear trunk."""
         return await self._parent.actuate_trunk(self.vin, which_trunk)
@@ -243,9 +247,27 @@ class VehicleSpecific:
         """Sets a time at which charging should be completed. The time parameter is minutes after midnight (e.g: time=120 schedules charging for 2:00am vehicle local time)."""
         return await self._parent.set_scheduled_charging(self.vin, enable, time)
 
-    async def set_scheduled_departure(self, enable: bool, time: int) -> dict[str, Any]:
+    async def set_scheduled_departure(
+        self,
+        enable: bool = True,
+        preconditioning_enabled: bool = False,
+        preconditioning_weekdays_only: bool = False,
+        departure_time: int = 0,
+        off_peak_charging_enabled: bool = False,
+        off_peak_charging_weekdays_only: bool = False,
+        end_off_peak_time: int = 0,
+    ) -> dict[str, Any]:
         """Sets a time at which departure should be completed. The time parameter is minutes after midnight (e.g: time=120 schedules departure for 2:00am vehicle local time)."""
-        return await self._parent.set_scheduled_departure(self.vin, enable, time)
+        return await self._parent.set_scheduled_departure(
+            self.vin,
+            enable,
+            preconditioning_enabled,
+            preconditioning_weekdays_only,
+            departure_time,
+            off_peak_charging_enabled,
+            off_peak_charging_weekdays_only,
+            end_off_peak_time,
+        )
 
     async def set_sentry_mode(self, on: bool) -> dict[str, Any]:
         """Enables and disables Sentry Mode. Sentry Mode allows customers to watch the vehicle cameras live from the mobile app, as well as record sentry events."""

{tesla_fleet_api-0.5.5.dist-info → tesla_fleet_api-0.5.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tesla_fleet_api
-Version: 0.5.5
+Version: 0.5.7
 Summary: Tesla Fleet API library for Python
 Home-page: https://github.com/Teslemetry/tesla_fleet_api
 Author: Brett Adams

tesla_fleet_api-0.5.7.dist-info/RECORD

@@ -0,0 +1,19 @@
+tesla_fleet_api/__init__.py,sha256=0MON9vh3AShIiX16FZ6NU3yZ7kyXFh5GxA0rY8CzVRM,584
+tesla_fleet_api/charging.py,sha256=N_mc8axrXj3iduqLj_jCt4Vx86tHqe3xqQT4R1R7HvU,1689
+tesla_fleet_api/const.py,sha256=cxe_D2pfWT6REocIZEGfC-COOiXZrCcqGGKkYOs6MxM,9277
+tesla_fleet_api/energy.py,sha256=kE-HDupzhgatIsizJoer1MAALP-wH6jjjGliiRQN0Os,5285
+tesla_fleet_api/energyspecific.py,sha256=kICxdeDoWR9JHlgjHvnmjJ1ErLOWJT8bCSESoXo9axU,3732
+tesla_fleet_api/exceptions.py,sha256=Wh9roGPYB9oBGgEEfxMDay5A7RkPy8JFKloKPStGQ2Y,9211
+tesla_fleet_api/partner.py,sha256=1vIBUaxKLIfqcC0X6VXZN0dMAzj_CLNPUMjA6QVqZ1k,1223
+tesla_fleet_api/teslafleetapi.py,sha256=3-gGx-RxOD92Ul0lNCEsCwVBsYunKsO2Sr5rYH0YtIg,5070
+tesla_fleet_api/teslafleetoauth.py,sha256=FfLnuqZMxF2HsZ5miLNtm3pRwKDoQKi2GD-oXgKxZgA,3594
+tesla_fleet_api/teslemetry.py,sha256=XOqm7SaakooJSNXEasJI_tRoCIyiFCD6n_PCx9U_D9g,2107
+tesla_fleet_api/tessie.py,sha256=ZttWuDdQOuTFO4k-BMq7fXKP3Nb4Dsxk3gFJprHHsco,2214
+tesla_fleet_api/user.py,sha256=TZE2oh-n5zrhKXmGRuiNL9voKVODD7rBhGE_IObYVGA,1179
+tesla_fleet_api/vehicle.py,sha256=3MF8KN3BjY2dQxmu6-hrrVxrXxI8iQF-rBS8v89ruUw,32835
+tesla_fleet_api/vehiclespecific.py,sha256=yq1S1rXNUJegG_AIcreoplzznIVDcwviYRvWH2Z5CEI,21492
+tesla_fleet_api-0.5.7.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+tesla_fleet_api-0.5.7.dist-info/METADATA,sha256=YqHUJyTAqgr0WIiXOtOtc3adsNyrBatwTNnjKsyWloc,3961
+tesla_fleet_api-0.5.7.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+tesla_fleet_api-0.5.7.dist-info/top_level.txt,sha256=jeNbog_1saXBFrGpom9WyPWmilxsyP3szL_G7JLWQfM,16
+tesla_fleet_api-0.5.7.dist-info/RECORD,,

tesla_fleet_api-0.5.5.dist-info/RECORD

@@ -1,19 +0,0 @@
-tesla_fleet_api/__init__.py,sha256=RL9KGtDjYwbBa5i6Lagzrya-yjvEE1EVfyge2lV49iI,375
-tesla_fleet_api/charging.py,sha256=N_mc8axrXj3iduqLj_jCt4Vx86tHqe3xqQT4R1R7HvU,1689
-tesla_fleet_api/const.py,sha256=uzb_5f14m5lrcySlHWVL-_JM48HubpWmqL5fXy0kyrw,9277
-tesla_fleet_api/energy.py,sha256=Fgg4pdYc226WNOXHUnzBHbZoZ3jYLfN3GgjprazYLZA,5283
-tesla_fleet_api/energyspecific.py,sha256=kICxdeDoWR9JHlgjHvnmjJ1ErLOWJT8bCSESoXo9axU,3732
-tesla_fleet_api/exceptions.py,sha256=c6i_AegrLzlfrHxht_Z_xLl_kmxcd3DDJaSIcldcUo8,9171
-tesla_fleet_api/partner.py,sha256=1vIBUaxKLIfqcC0X6VXZN0dMAzj_CLNPUMjA6QVqZ1k,1223
-tesla_fleet_api/teslafleetapi.py,sha256=ErPfOz4M4WERrOlo_a_1ssVPcOIGeiBpbxd4vFJH_x4,4929
-tesla_fleet_api/teslafleetoauth.py,sha256=BmRAuwcgFMBo2_3AJzS3QTBm_cP9xt4yoz4vKjwgmsw,3501
-tesla_fleet_api/teslemetry.py,sha256=jB2OlYAjjl98mW4p2-VGTVl5lpG1Qox57mXgsdrF1vg,2005
-tesla_fleet_api/tessie.py,sha256=3ScOi8RaxHdvp6s5ZdSWYXwHZdey6IkX9SF1oohtSWk,2252
-tesla_fleet_api/user.py,sha256=TZE2oh-n5zrhKXmGRuiNL9voKVODD7rBhGE_IObYVGA,1179
-tesla_fleet_api/vehicle.py,sha256=wER3UQIccxN-cUxSkOD1oPQrQ33GoZikmE9yQnEJ7Sk,32010
-tesla_fleet_api/vehiclespecific.py,sha256=C9gCPGZphzcnDPwyX5HR1ZCEC4IWqdv5ATccHqvFryQ,20817
-tesla_fleet_api-0.5.5.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-tesla_fleet_api-0.5.5.dist-info/METADATA,sha256=HMQhlZJBUjSNZUN7LqTggG6b2b_MsN3BBrDxgKAidww,3961
-tesla_fleet_api-0.5.5.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-tesla_fleet_api-0.5.5.dist-info/top_level.txt,sha256=jeNbog_1saXBFrGpom9WyPWmilxsyP3szL_G7JLWQfM,16
-tesla_fleet_api-0.5.5.dist-info/RECORD,,