tesla-fleet-api 0.0.1__py3-none-any.whl

tesla_fleet_api/TeslaFleetOAuth.py

@@ -0,0 +1,21 @@
+import aiohttp
+from .TeslaFleetApi import TeslaFleetApi
+
+
+class TeslaFleetOAuth(TeslaFleetApi):
+    """Tesla Fleet OAuth API."""
+
+    def __init__(
+        self,
+        session: aiohttp.ClientSession,
+        refresh_token: str,
+        client_id: str,
+        server: str | None = None,
+        raise_for_status: bool = True,
+    ):
+        super().__init__(
+            session,
+            refresh_token,
+            server,
+            raise_for_status,
+        )

tesla_fleet_api/Teslemetry.py

@@ -0,0 +1,23 @@
+import aiohttp
+from .TeslaFleetApi import TeslaFleetApi
+
+
+class Teslemetry(TeslaFleetApi):
+    def __init__(
+        self,
+        session: aiohttp.ClientSession,
+        access_token: str,
+        raise_for_status: bool = False,
+    ):
+        """Initialize the Teslemetry API."""
+        super().__init__(
+            session,
+            access_token,
+            use_command_protocol=False,
+            server="https://teslemetry.com",
+            raise_for_status=raise_for_status,
+        )
+
+    async def find_server(self):
+        """Find the server URL for the Tesla Fleet API."""
+        raise NotImplementedError("Do not use this function for Teslemetry.")

tesla_fleet_api/__init__.py

@@ -0,0 +1,4 @@
+from .TeslaFleetApi import TeslaFleetApi
+from .TeslaFleetOAuth import TeslaFleetOAuth
+from .Teslemetry import Teslemetry
+from .exceptions import TeslaFleetError

tesla_fleet_api/const.py

@@ -0,0 +1,22 @@
+"""Tesla Fleet API constants."""
+from enum import StrEnum
+
+
+class Errors(StrEnum):
+    """Tesla Fleet API error codes."""
+
+    INVALID_COMMAND = "invalid_command"
+    INVALID_FIELD = "invalid_field"
+    INVALID_REQUEST = "invalid_request"
+    INVALID_AUTH_CODE = "invalid_auth_code"
+    INVALID_REDIRECT_URL = "invalid_redirect_url"
+    UNAUTHORIZED_CLIENT = "unauthorized_client"
+    MOBILE_ACCESS_DISABLED = "mobile_access_disabled"
+    NO_RESPONSE_BODY = "no response body"
+
+
+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",
+}

tesla_fleet_api/exceptions.py

@@ -0,0 +1,218 @@
+import aiohttp
+import json
+from .const import Errors
+
+
+class TeslaFleetError:
+    """Base class for all Tesla exceptions."""
+
+    class Base(BaseException):
+        message: str
+        status: int
+        error: str | None
+        error_description: str | None
+
+        def __init__(self, status: int, data: dict[str, str] | None = None):
+            self.status = status
+            self.error = data.get("error") or data.get("message")
+            self.error_description = data.get("error_description")
+
+    class InvalidCommand(Base):
+        """The data request or command is unknown."""
+
+        message = "The data request or command is unknown."
+
+    class InvalidField(Base):
+        """A field in the input is not valid."""
+
+        message = "A field in the input is not valid."
+
+    class InvalidRequest(Base):
+        """The request body is not valid, a description giving a more specific error message may be returned."""
+
+        message = "The request body is not valid"
+
+    class InvalidAuthCode(Base):
+        """The "code" in request body is invalid, generate a new one and try again."""
+
+        message = (
+            "The 'code' in request body is invalid, generate a new one and try again."
+        )
+
+    class InvalidRedirectUrl(Base):
+        """Invalid redirect URI/URL. The authorize redirect URI and token redirect URI must match."""
+
+        message = "Invalid redirect URI/URL. The authorize redirect URI and token redirect URI must match."
+
+    class UnauthorizedClient(Base):
+        """We don't recognize this client_id and client_secret combination. Use the client_id and client_secret that has been granted for the application."""
+
+        message = "We don't recognize this client_id and client_secret combination. Use the client_id and client_secret that has been granted for the application."
+
+    class MobileAccessDisabled(Base):
+        """The vehicle has turned off remote access."""
+
+        message = "The vehicle has turned off remote access."
+
+    class NoResponseBody(Base):
+        """The OAuth token has expired."""
+
+        message = "The OAuth token has expired."
+
+    class PaymentRequired(Base):
+        """Payment is required in order to use the API (non-free account only)."""
+
+        message = "Payment is required in order to use the API (non-free account only)."
+
+    class Forbidden(Base):
+        """Access to this resource is not authorized, developers should check required scopes."""
+
+        message = "Access to this resource is not authorized, developers should check required scopes."
+
+    class NotFound(Base):
+        """The requested resource does not exist."""
+
+        message = "The requested resource does not exist."
+
+    class NotAllowed(Base):
+        """The operation is not allowed."""
+
+        message = "The operation is not allowed."
+
+    class NotAcceptable(Base):
+        """The HTTP request does not have a Content-Type header set to application/json."""
+
+        message = "The HTTP request does not have a Content-Type header set to application/json."
+
+    class VehicleOffline(Base):
+        """The vehicle is not "online."""
+
+        message = "The vehicle is not 'online'."
+
+    class PreconditionFailed(Base):
+        """A condition has not been met to process the request."""
+
+        message = "A condition has not been met to process the request."
+
+    class InvalidRegion(Base):
+        """This user is not present in the current region."""
+
+        message = "This user is not present in the current region."
+
+    class InvalidResource(Base):
+        """There is a semantic problem with the data, e.g. missing or invalid data."""
+
+        message = (
+            "There is a semantic problem with the data, e.g. missing or invalid data."
+        )
+
+    class Locked(Base):
+        """Account is locked, and must be unlocked by Tesla."""
+
+        message = "Account is locked, and must be unlocked by Tesla."
+
+    class RateLimited(Base):
+        """Account or server is rate limited."""
+
+        message = "Account or server is rate limited."
+
+    class ResourceUnavailableForLegalReasons(Base):
+        """Querying for a user/vehicle without proper privacy settings."""
+
+        message = "Querying for a user/vehicle without proper privacy settings."
+
+    class ClientClosedRequest(Base):
+        """Client has closed the request before the server could send a response."""
+
+        message = (
+            "Client has closed the request before the server could send a response."
+        )
+
+    class InternalServerError(Base):
+        """An error occurred while processing the request."""
+
+        message = "An error occurred while processing the request."
+
+    class ServiceUnavailable(Base):
+        """Either an internal service or a vehicle did not respond (timeout)."""
+
+        message = "Either an internal service or a vehicle did not respond (timeout)."
+
+    class GatewayTimeout(Base):
+        """Server did not receive a response."""
+
+        message = "Server did not receive a response."
+
+    class DeviceUnexpectedResponse(Base):
+        """Vehicle responded with an error - might need a reboot, OTA update, or service."""
+
+        message = "Vehicle responded with an error - might need a reboot, OTA update, or service."
+
+
+async def raise_for_status(resp: aiohttp.ClientResponse) -> None:
+    """Raise an exception if the response status code is >=400."""
+    # https://developer.tesla.com/docs/fleet-api#response-codes
+
+    try:
+        data = await resp.json()
+    except json.decoder.JSONDecodeError as error:
+        raise TeslaFleetError.NotFound() from error
+    try:
+        resp.raise_for_status()
+    except aiohttp.ClientResponseError as e:
+        if e.status == 400:
+            if data.error == Errors.INVALID_COMMAND:
+                raise TeslaFleetError.InvalidCommand(e.status, data) from e
+            elif data.error == Errors.INVALID_FIELD:
+                raise TeslaFleetError.InvalidField(e.status, data) from e
+            elif data.error == Errors.INVALID_REQUEST:
+                raise TeslaFleetError.InvalidRequest(e.status, data) from e
+            elif data.error == Errors.INVALID_AUTH_CODE:
+                raise TeslaFleetError.InvalidAuthCode(e.status, data) from e
+            elif data.error == Errors.INVALID_REDIRECT_URL:
+                raise TeslaFleetError.InvalidRedirectUrl(e.status, data) from e
+            elif data.error == Errors.UNAUTHORIZED_CLIENT:
+                raise TeslaFleetError.UnauthorizedClient(e.status, data) from e
+        elif e.status == 401:
+            if data.error == Errors.MOBILE_ACCESS_DISABLED:
+                raise TeslaFleetError.MobileAccessDisabled(e.status, data) from e
+            elif data.error == Errors.NO_RESPONSE_BODY:
+                raise TeslaFleetError.NoResponseBody(e.status, data) from e
+        elif e.status == 402:
+            raise TeslaFleetError.PaymentRequired(e.status, data) from e
+        elif e.status == 403:
+            raise TeslaFleetError.Forbidden(e.status, data) from e
+        elif e.status == 404:
+            raise TeslaFleetError.NotFound(e.status, data) from e
+        elif e.status == 405:
+            raise TeslaFleetError.NotAllowed(e.status, data) from e
+        elif e.status == 406:
+            raise TeslaFleetError.NotAcceptable(e.status, data) from e
+        elif e.status == 408:
+            raise TeslaFleetError.VehicleOffline(e.status, data) from e
+        elif e.status == 412:
+            raise TeslaFleetError.PreconditionFailed(e.status, data) from e
+        elif e.status == 421:
+            raise TeslaFleetError.InvalidRegion(e.status, data) from e
+        elif e.status == 422:
+            raise TeslaFleetError.InvalidResource(e.status, data) from e
+        elif e.status == 423:
+            raise TeslaFleetError.Locked(e.status, data) from e
+        elif e.status == 429:
+            raise TeslaFleetError.RateLimited(e.status, data) from e
+        elif e.status == 451:
+            raise TeslaFleetError.ResourceUnavailableForLegalReasons(
+                e.status, data
+            ) from e
+        elif e.status == 499:
+            raise TeslaFleetError.ClientClosedRequest(e.status, data) from e
+        elif e.status == 500:
+            raise TeslaFleetError.InternalServerError(e.status, data) from e
+        elif e.status == 503:
+            raise TeslaFleetError.ServiceUnavailable(e.status, data) from e
+        elif e.status == 504:
+            raise TeslaFleetError.GatewayTimeout(e.status, data) from e
+        elif e.status == 540:
+            raise TeslaFleetError.DeviceUnexpectedResponse(e.status, data) from e
+        else:
+            raise e

tesla_fleet_api-0.0.1.dist-info/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

tesla_fleet_api-0.0.1.dist-info/METADATA

@@ -0,0 +1,47 @@
+Metadata-Version: 2.1
+Name: tesla_fleet_api
+Version: 0.0.1
+Summary: Tesla Fleet API library for Python
+Home-page: https://github.com/Teslemetry/tesla_fleet_api
+Author: Brett Adams
+Author-email: hello@teslemetry.com
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp
+
+# tesla_fleet_api
+Python library for Tesla Fleet API and Teslemetry
+
+Currently does not support the End to End encrypted Telemetry or Command API.
+
+Based on [Tesla Developer documentation](https://developer.tesla.com/docs/fleet-api).
+
+```
+import asyncio
+import aiohttp
+
+from tesla_fleet_api import TeslaFleetApi, TeslaFleetError
+
+
+async def main():
+    async with aiohttp.ClientSession() as session:
+        api = TeslaFleetApi(
+            access_token="<access_token>",
+            session=session,
+            region="na",
+            raise_for_status=True,
+        )
+
+        try:
+            data = await api.vehicle.list()
+            print(data)
+        except TeslaFleetError.Base as e:
+            print(e.message, e.error)
+
+asyncio.run(main())
+```

tesla_fleet_api-0.0.1.dist-info/RECORD

@@ -0,0 +1,11 @@
+tesla_fleet_api/TeslaFleetApi.py,sha256=gzS7XdhUs2GJtWp0BwH-r-wdiovnPnXsu3PH6FYseIQ,45391
+tesla_fleet_api/TeslaFleetOAuth.py,sha256=AHzuKlrywD9Hf_nj4_1WcQCIaoxiI4JuD7XAv8dV6tU,469
+tesla_fleet_api/Teslemetry.py,sha256=66IorPsqvpZ8Uk1bgj_vkoWNLi9kb5HHnNag_iNoBD8,668
+tesla_fleet_api/__init__.py,sha256=HFzNi2gaIAOSUwE2vO5TgZZAqol47zyhuNOoPXidbVQ,161
+tesla_fleet_api/const.py,sha256=FohVnzQhy_onvN1qkEVvHsx1ox9BvBsedRxDjaO9WRs,663
+tesla_fleet_api/exceptions.py,sha256=y-uWOCgZx-BqZHtMGUV5560xNmu9YTNTmXgqK45egcM,8623
+tesla_fleet_api-0.0.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+tesla_fleet_api-0.0.1.dist-info/METADATA,sha256=zM87ZTGmciNaEg72yqF8XLyY52iSuLOdQDS_CKCUfsY,1284
+tesla_fleet_api-0.0.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+tesla_fleet_api-0.0.1.dist-info/top_level.txt,sha256=jeNbog_1saXBFrGpom9WyPWmilxsyP3szL_G7JLWQfM,16
+tesla_fleet_api-0.0.1.dist-info/RECORD,,

tesla_fleet_api-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.42.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

tesla_fleet_api-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+tesla_fleet_api