mirror of
https://github.com/teslamate-org/teslamate.git
synced 2026-01-24 21:06:08 +08:00
doc: Documentation for new endpoint changes (#3978)
* Update docs * Update for streaming * Update guides and add a reference in the project page * Update for readability * readability * format * update fleet api price * Update direct Tesla API part --------- Co-authored-by: Julien <julien@citio.digital>
This commit is contained in:
jlestel
@@ -0,0 +1,134 @@
|
||||
---
|
||||
title: Using the Official Tesla Fleet API and Telemetry Streaming
|
||||
---
|
||||
|
||||
## Official Tesla APIs
|
||||
|
||||
### Why Tesla Fleet and Telemetry are Needed
|
||||
|
||||
By default, TeslaMate uses the _unofficial_ Owner API and streaming.
|
||||
|
||||
Tesla now provides official APIs: the Fleet API and the Telemetry API, which replace the Owner API and streaming respectively.
|
||||
|
||||
**Migration to the new API depends on your Tesla account type:**
|
||||
|
||||
1. **_[Tesla Business Fleet users](https://www.tesla.com/fleet):_** the Owner API is [being shut down](https://developer.tesla.com/docs/fleet-api#2024-03-26-shutting-down-legacy-vehicle-api-endpoints). Fleet vehicles are upgraded gradually and an error message means that they must now use the official API.
|
||||
|
||||
1. **_Individual users:_** the Owner API is currently still accessible. Even if it seems to incorporate new limitations similar to those present on the official API.
|
||||
|
||||
**Resume: if you are a Tesla Business Fleet user, you should migrate to the official API ASAP!** The official Tesla API will only become mandatory when the Owner API shuts down for all users.
|
||||
|
||||
### Impacts/Limitations of New Endpoints
|
||||
|
||||
#### Tesla Fleet API: no impact
|
||||
|
||||
The [Fleet API](https://developer.tesla.com/docs/fleet-api) is similar to the Owner API but more comprehensive. However, retrieving vehicle information (`vehicle_data`) or sending commands is limited. The limits on the Owner API were historically much higher. It is likely that [these limits](https://developer.tesla.com/docs/fleet-api#membership-levels) will also be applied soon to the API Owner.
|
||||
|
||||
#### Tesla Fleet Telemetry: non compatible by default
|
||||
|
||||
The [Tesla Fleet Telemetry](https://github.com/teslamotors/fleet-telemetry) differs from the "Owner" streaming. By default, metrics are sent to message queues instead of a websocket as streaming did. Historical streaming could send events every second, whereas Fleet Telemetry will only send information every minute at the minimum.
|
||||
|
||||
#### How to Use Tesla APIs
|
||||
|
||||
The setup to use the official Tesla APIs ([described below](#tesla-fleet-api)) is complex.
|
||||
You can use a [third-party providers](#guide-for-third-party-providers) to easily access these APIs.
|
||||
|
||||
## Guide for Third-Party Providers
|
||||
|
||||
Environment variables allow changing the API and streaming endpoints.
|
||||
You must use the `URL` and the `TOKEN` given by the third party API provider.
|
||||
|
||||
### [MyTeslaMate](https://www.myteslamate.com) (free)
|
||||
|
||||
#### MyTeslaMate Fleet API
|
||||
|
||||
1. Log in the [MyTeslaMate](https://app.myteslamate.com) website **with your Tesla account** and go to the [MyTeslaMate Fleet](https://app.myteslamate.com/fleet) page to get your `TOKEN`.
|
||||
1. Add the following environment variables (using your `TOKEN` instead of _`xxxx-xxxx-xxxx-xxxx`_):
|
||||
|
||||
```yml
|
||||
# API Fleet
|
||||
- TOKEN=?token=xxxx-xxxx-xxxx-xxxx
|
||||
- TESLA_API_HOST=https://api.myteslamate.com
|
||||
- TESLA_AUTH_HOST=https://api.myteslamate.com
|
||||
- TESLA_AUTH_PATH=/api/oauth2/v3
|
||||
```
|
||||
|
||||
#### MyTeslaMate Streaming
|
||||
|
||||
MyTeslaMate also provides streaming by [reproducing the old streaming from the data sent by Fleet Telemetry](https://github.com/MyTeslaMate/websocket).
|
||||
|
||||
1. You need to "_Pair your vehicle(s)_" on the [fleet](https://app.myteslamate.com/fleet) page
|
||||
1. Use the following dedicated environment variables:
|
||||
```yml
|
||||
- TESLA_WSS_HOST=wss://streaming.myteslamate.com
|
||||
- TESLA_WSS_TLS_ACCEPT_INVALID_CERTS=true
|
||||
- TESLA_WSS_USE_VIN=true
|
||||
```
|
||||
1. Restart your instance
|
||||
|
||||
### [Teslemetry](https://teslemetry.com/pricing) (paid)
|
||||
|
||||
#### Teslemetry Fleet API
|
||||
|
||||
1. Log in the [Teslemetry website](https://teslemetry.com) and create your `TOKEN`.
|
||||
1. Use this `TOKEN` instead of _`xxxx-xxxx-xxxx-xxxx`_ and add the following environment variables:
|
||||
```yml
|
||||
- TOKEN=?token=xxxx-xxxx-xxxx-xxxx
|
||||
- TESLA_API_HOST=https://api.teslemetry.com
|
||||
- TESLA_AUTH_HOST=https://api.teslemetry.com
|
||||
- TESLA_AUTH_PATH=/api/oauth2/v3
|
||||
```
|
||||
1. Restart your instance
|
||||
|
||||
#### Teslemetry Streaming
|
||||
|
||||
**_Important: no streaming provided by Teslemetry, you MUST disable manually the streaming in Teslamate settings._**
|
||||
|
||||
## Guide to using the official Tesla API directly (free)
|
||||
|
||||
### Requirements
|
||||
|
||||
- Advanced IT skills
|
||||
- A dedicated public hosting
|
||||
- A [free Tesla Fleet API plan](https://developer.tesla.com/docs/fleet-api#membership-levels)
|
||||
|
||||
### Tesla Fleet API
|
||||
|
||||
1. Set up a third-party account at [developer.tesla.com](https://developer.tesla.com) as described on the [Tesla docs](https://developer.tesla.com/docs/fleet-api#setup)
|
||||
1. Add the following environment variable with your own domain :
|
||||
1. Use [the correct region](https://developer.tesla.com/docs/fleet-api#endpoints-and-regional-requirements) in the `TESLA_API_HOST` field:
|
||||
- North America, Asia-Pacific (excluding China): https://fleet-api.prd.na.vn.cloud.tesla.com
|
||||
- Europe, Middle East, Africa: https://fleet-api.prd.eu.vn.cloud.tesla.com
|
||||
- China: https://fleet-api.prd.cn.vn.cloud.tesla.cn
|
||||
1. Update the `TESLA_AUTH_CLIENT_ID` with the client ID of your Tesla application.
|
||||
```yml
|
||||
# API Fleet
|
||||
- TESLA_API_HOST=https://fleet-api.prd.eu.vn.cloud.tesla.com
|
||||
- TESLA_AUTH_HOST=https://auth.tesla.com
|
||||
- TESLA_AUTH_PATH=/oauth2/v3
|
||||
- TESLA_AUTH_CLIENT_ID=xxxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx
|
||||
```
|
||||
1. (Optional) If you want to send commands or use Tesla Telemetry:
|
||||
1. Send drivers a "Pairing request" to be able to use your own [Tesla Vehicle Command Protocol http proxy to send commands](https://github.com/teslamotors/vehicle-command?tab=readme-ov-file#using-the-http-proxy)
|
||||
1. Send test commands or setup Telemetry to [stream it to your Teslamate](#streaming-via-tesla-telemetry)
|
||||
|
||||
|
||||
### Streaming via Tesla Telemetry
|
||||
|
||||
**_Important: if you don't setup your own streaming, you MUST disable manually the streaming in Teslamate settings._**
|
||||
|
||||
To setup your own streaming server, you can follow these steps:
|
||||
|
||||
1. Setup a [Tesla Fleet Telemetry](https://github.com/teslamotors/fleet-telemetry) instance on a public domain (eg: _telemetry.mydomain.com_)
|
||||
1. Add a [Google pubsub dispatcher](https://github.com/teslamotors/fleet-telemetry?tab=readme-ov-file#backendsdispatchers) to your own GCP PubSub.
|
||||
1. Setup a [MyTeslaMate Streaming Server from Fleet Telemetry Events](https://github.com/MyTeslaMate/websocket) on a public domain (eg: _streaming.mydomain.com_)
|
||||
1. Manually create a subscription to the `telemetry_V` created in PubSub by the Tesla Telemetry with:
|
||||
- Delivery type: Push
|
||||
- Endpoint URL: https://streaming.mydomain.com
|
||||
1. Update your environment variables:
|
||||
```yml
|
||||
- TESLA_WSS_HOST=wss://streaming.mydomain.com
|
||||
- TESLA_WSS_TLS_ACCEPT_INVALID_CERTS=true
|
||||
- TESLA_WSS_USE_VIN=true
|
||||
```
|
||||
1. Restart your instance
|
||||
@@ -79,4 +79,14 @@ LINK: [https://github.com/brchri/tesla-geogdo](https://github.com/brchri/tesla-g
|
||||
|
||||
Raspberry Pi project that installs along Tesla's standard USB drive, sends video alerts in real-time & backs up all footage, now comes pre-installed with TeslaMate.
|
||||
|
||||
LINK: [https://www.teslarpi.com)
|
||||
LINK: [https://www.teslarpi.com](https://www.teslarpi.com)
|
||||
|
||||
## [MyTeslaMate](https://www.myteslamate.com)
|
||||
|
||||
For those who do not wish to install their own instance, MyTeslaMate provides a managed instance of TeslaMate ready to use in one minute, with a security overlay (Authelia), 30-day backups, and the possibility of importing a backup to migrate easily.
|
||||
|
||||
For all [TeslaMate](https://www.myteslamate.com) users, MyTeslaMate also provides for free a [Fleet API](https://app.myteslamate.com/fleet) endpoint and a streaming server based on Tesla Telemetry events.
|
||||
|
||||
LINK: [MyTeslaMate Website](https://www.myteslamate.com)
|
||||
|
||||
LINK: [Follow this guide](/docs/guides/api#myteslamate-fleet-api) to use official Tesla APIs on your Teslamate.
|
||||
|
||||
+1
-1
@@ -19,7 +19,7 @@ module.exports = {
|
||||
{
|
||||
type: "category",
|
||||
label: "Guides",
|
||||
items: ["guides/traefik", "guides/apache", "guides/unix_domain_sockets"],
|
||||
items: ["guides/traefik", "guides/apache", "guides/unix_domain_sockets", "guides/api"],
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
|
||||
Reference in New Issue
Block a user