Home-Assistant
/
home-assistant.io
mirror of https://github.com/home-assistant/home-assistant.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_integrations/tesla_fleet.markdown

17 KiB
Raw Permalink Blame History

title description ha_category ha_release ha_iot_class ha_config_flow ha_codeowners ha_domain ha_platforms ha_integration_type
Tesla Fleet Instructions on how to integrate the Tesla Fleet API within Home Assistant.
Binary sensor
Button
Car
Climate
Cover
Device tracker
Lock
Media player
Number
Select
Sensor
Switch
2024.8 Cloud Polling true
@Bre77
tesla_fleet
binary_sensor
button
climate
cover
device_tracker
diagnostics
lock
media_player
number
select
sensor
switch
integration

The Tesla Fleet {% term integration %} lets you control Tesla vehicles and energy sites using the Tesla Fleet API.

Prerequisites

You need to configure developer credentials and host a public key file to allow Home Assistant to communicate with your Tesla account.

{% warning %} The China region is currently not supported by this {% term integration %}. {% endwarning %}

Tesla Developer Application

Create a Tesla Developer Application to connect Home Assistant with the Tesla Fleet API.

  1. Create a developer application:

  2. Enter application details:

    • Application name: A name to identify the application
    • Description: Enter a brief description of your integration
    • Purpose of Usage: Explain how you'll use the API (e.g., "Home Assistant")

  3. Configure client details:

    • OAuth Grant Type: Select Authorization Code and Machine-to-Machine
    • Allowed Origin URL(s): Enter your domain's URL, for example https://yourdomain.com/
    • Allowed Redirect URI: Enter https://my.home-assistant.io/redirect/oauth
    • Allowed Returned URL(s): Leave this field empty (not required)

  4. Select desired API scopes:

    • Vehicle Information (mandatory for vehicles)
    • Vehicle Location (recommended)
    • Vehicle Commands (recommended)
    • Energy Product Information (mandatory for energy products)
    • Energy Product Settings (recommended)

  5. Set up billing (optional):

    • Tesla provides $10 monthly credit for personal use
    • You can add billing details later if needed

  6. Save your credentials:

    • After creating the application, go to View Details > Credentials & APIs
    • Note your Client ID and Client Secret - you'll need these to configure Home Assistant.

{% include integrations/config_flow.md %}

  1. Add application credentials

    • Enter your application Client ID and Client Secret from your Tesla Developer Application
    • This step will be skipped if you already have exactly one Tesla Fleet application credential already configured

  2. Authenticate with Tesla:

    • You'll be redirected to Tesla's login page
    • Enter your Tesla account credentials
    • On the authorization page, select Select All and then Allow to allow all the scopes you previously selected

  3. Redirect to Home Assistant:

    • Confirm you want to Link account to Home Assistant

  4. Enter domain

    • Enter the domain name you intend to host your public key on
    • This domain should be the same or a subdomain of your origin domain, and must use a valid SSL certificate.

  5. Register public key

    • Upload the public key shown to the domain you entered in step 4 at .well-known/appspecific/com.tesla.3p.public-key.pem

  6. Install Virtual Key

    • Use your smartphone to scan the QR code or enter the address to install your public key on your vehicles with the Tesla app.
    • This process needs to be repeated for each vehicle, excluding Model S and Model X vehicles manufactured before 2021.

Hosting with NGINX Add-on (optional)

  1. Create the NGINX configuration:

    echo 'location /.well-known/appspecific/com.tesla.3p.public-key.pem {
root /share/tesla;
}' > /share/nginx_proxy_default_tesla.conf

  2. Copy the public key shown during setup to /share/tesla

  3. Configure the NGINX Add-on:

    • Go to Settings > Add-ons > NGINX Home Assistant SSL proxy > Configuration
    • Change customize.active from false to true
    • Leave config.default at its default value: nginx_proxy_default*.conf

  4. Restart the NGINX Add-on and verify your public key is accessible at: https://yourdomain.com/.well-known/appspecific/com.tesla.3p.public-key.pem

Data updates

The {% term integration %} {% term polling polls %} each vehicle every 10 minutes while it's awake. This is designed to stay within Tesla's $10 monthly credit for most users, which you can monitor usage in the Tesla Developer Dashboard. Energy product APIs are free to use.

If you need different polling intervals, you can define a custom polling interval.

Command signing

Certain vehicles, including all vehicles manufactured since late 2023, require vehicle commands to be signed with a private key. All {% term actions %} on vehicle {% term entities %} will fail with an error if this is required and the key has not been setup correctly.

Your public key must be added to each of these vehicles by visiting https://tesla.com/_ak/YOUR_DOMAIN and following the instructions in the Tesla app. If you're using an iPhone, you may need to use Safari to open the webpage and finish the setup.

For more details see Tesla Fleet API vehicle commands documentation.

Generating your own key pair

The {% term integration %} generates a private key automatically at config/tesla_fleet.key. You can replace it with your own key (such as one from another Home Assistant instance) before configuring the integration. You can generate your own key pair following Tesla's documentation.

Entities

These are the entities available in the Tesla Fleet integration. Not all entities are enabled by default, and not all values are always available.

Vehicles

Domain Name Enabled
Binary sensor Battery heater No
Binary sensor Cabin overheat protection actively cooling No
Binary sensor Charge cable Yes
Binary sensor Charger has multiple phases No
Binary sensor Dashcam No
Binary sensor Front driver door Yes
Binary sensor Front driver window Yes
Binary sensor Front passenger door Yes
Binary sensor Front passenger window Yes
Binary sensor Preconditioning enabled No
Binary sensor Preconditioning No
Binary sensor Rear driver door Yes
Binary sensor Rear driver window Yes
Binary sensor Rear passenger door Yes
Binary sensor Rear passenger window Yes
Binary sensor Scheduled charging pending No
Binary sensor Status Yes
Binary sensor Tire pressure warning front left No
Binary sensor Tire pressure warning front right No
Binary sensor Tire pressure warning rear left No
Binary sensor Tire pressure warning rear right No
Binary sensor Trip charging No
Binary sensor User present Yes
Button Flash lights Yes
Button HomeLink Yes
Button Honk horn Yes
Button Keyless driving Yes
Button Play fart Yes
Button Wake Yes
Climate Cabin overheat protection No
Climate Climate Yes
Cover Charge port door Yes
Cover Frunk Yes
Cover Sunroof No
Cover Trunk Yes
Cover Vent windows Yes
Device tracker Location Yes
Device tracker Route Yes
Lock Charge cable lock Yes
Lock Lock Yes
Media player Media player Yes
Number Charge current Yes
Number Charge limit Yes
Select Seat heater front left Yes
Select Seat heater front right Yes
Select Seat heater rear center No
Select Seat heater rear left No
Select Seat heater rear right No
Select Seat heater third row left No
Select Seat heater third row right No
Select Steering wheel heater Yes
Sensor Battery level Yes
Sensor Battery range Yes
Sensor Charge cable No
Sensor Charge energy added Yes
Sensor Charge rate Yes
Sensor Charger current Yes
Sensor Charger power Yes
Sensor Charger voltage Yes
Sensor Charging Yes
Sensor Distance to arrival Yes
Sensor Driver temperature setting No
Sensor Estimate battery range No
Sensor Fast charger type No
Sensor Ideal battery range No
Sensor Inside temperature Yes
Sensor Odometer No
Sensor Outside temperature Yes
Sensor Passenger temperature setting No
Sensor Power No
Sensor Shift state No
Sensor Speed No
Sensor State of charge at arrival No
Sensor Time to arrival Yes
Sensor Time to full charge Yes
Sensor Tire pressure front left No
Sensor Tire pressure front right No
Sensor Tire pressure rear left No
Sensor Tire pressure rear right No
Sensor Traffic delay No
Sensor Usable battery level No
Switch Auto seat climate left Yes
Switch Auto seat climate right Yes
Switch Auto steering wheel heater Yes
Switch Charge Yes
Switch Defrost Yes
Switch Sentry mode Yes

Energy sites

Domain Name Enabled
Binary sensor Backup capable Yes
Binary sensor Grid services active Yes
Binary sensor Grid services enabled Yes
Binary sensor Storm watch active Yes
Number Backup reserve Yes
Number Off grid reserve Yes
Select Allow export Yes
Select Operation mode Yes
Sensor Battery power Yes
Sensor Consumer imported from battery No
Sensor Consumer imported from generator No
Sensor Consumer imported from grid No
Sensor Consumer imported from solar No
Sensor Energy left Yes
Sensor Generator exported Yes
Sensor Generator power No
Sensor Grid exported Yes
Sensor Grid exported from battery No
Sensor Grid exported from generator No
Sensor Grid exported from solar No
Sensor Grid imported No
Sensor Grid power Yes
Sensor Grid services exported No
Sensor Grid services imported No
Sensor Grid services power Yes
Sensor Home usage Yes
Sensor Island status Yes
Sensor Load power Yes
Sensor Percentage charged Yes
Sensor Solar exported No
Sensor Solar generated Yes
Sensor Solar power Yes
Sensor Total pack energy No
Sensor Version Yes
Sensor VPP backup reserve Yes
Switch Allow charging from grid Yes
Switch Storm watch Yes

Wall connector

Domain Name Enabled
Sensor Fault state No
Sensor Power Yes
Sensor State Yes
Sensor Vehicle Yes

Vehicle sleep

Constant API {% term polling %} will prevent most Model S and Model X vehicles manufactured before 2021 from sleeping. The {% term integration %} automatically stops {% term polling %} these vehicles for 15 minutes after inactivity. You can call the homeassistant.update_entity {% term action %} to force {% term polling %}, which will reset the timer.

Removing the integration

{% include integrations/remove_device_service.md %}

  • Removing the {% term integration %} does not delete your Tesla Developer Application - you can remove it manually from the Tesla Developer Dashboard if no longer needed.

Troubleshooting

  • Setup errors: Verify your public key is accessible at the correct URL and you've completed all registration steps with Tesla
  • Command failures: Ensure tesla_fleet.key exists in your Home Assistant config directory and add your public key to vehicles via https://tesla.com/_ak/YOUR_DOMAIN
  • {% term Integration %} stopped working: Use the reconfigure option in {% my integrations title="Settings > Devices & services" %} > Tesla Fleet
  • Billing errors: Check your Tesla Developer Dashboard for usage limits and add billing information if needed

If you have an error with your credentials, you can delete them in the {% my application_credentials title="Application Credentials" %} user interface.