/ha_toyota

Toyota integration for Home Assistant

Primary LanguagePythonMIT LicenseMIT

GitHub Workflow Status GitHub Release hacs GitHub Activity Installs

logo

Toyota EU community integration

This custom integration aims to provide plug-and-play integration for your Toyota vehicle.

About

This is a custom integration the retrieves' data from the Toyota EU MyToyota ctpa-oneapi API and makes them available in Home Assistant as different types of sensors. As there is no official API from Toyota, I will try my best to keep it working, but there are no promises.

Features

Only Europe is supported. See here for North America.

Disclaimer: Features available depends on your car model and year.

Overview

  • VIN (Vehicle Identification Number) sensor
  • Fuel, battery and odometer information
  • Current day, week, month and year statistics.
  • Door and door lock sensors, including hood and trunk sensor.

Binary sensor(s)

Name
 Description
binary_sensor.<you_car_alias>_hood If the hood is open of not.
binary_sensor.<you_car_alias>_*_door Door sensors, one is created for each door and trunk.
binary_sensor.<you_car_alias>_*_lock Lock sensors, one is created for each door and trunk.
binary_sensor.<you_car_alias>_*_window Window sensors, one is created for window.

Device tracker(s)

Name
 Description
device_tracker.<you_car_alias> Shows you last parking information.

Sensor(s)

Name
 Description
sensor.<you_car_alias>_vin Static data about your car.
sensor.<you_car_alias>_odometer Odometer information.
sensor.<you_car_alias>_fuel_level Fuel level information.
sensor.<you_car_alias>_fuel_range Fuel range information.
sensor.<you_car_alias>_battery_level Battery level information.
sensor.<you_car_alias>_battery_range Battery range information.
sensor.<you_car_alias>_battery_range_ac Battery range information when AC is on.
sensor.<you_car_alias>_total_range Information about combined fuel and battery range.
sensor.<you_car_alias>_current_day_stats Statistics for current day.
sensor.<you_car_alias>_current_week_stats Statistics for current week.
sensor.<you_car_alias>_current_month_stats Statistics for current month.
sensor.<you_car_alias>_current_year_stats Statistics for current year.

Statistics sensors

Important

When starting a new week, month or year, it will not show any information before your first trip. Even though a new month starts on the 1, you will need to wait for the 2 of the month before it is able to show you current month stats. This due to a limitation in Toyota API. This limitation also applies to weeks. Due to this, this integration will list sensors as unavailable when no data is available.

Attributes available

Disclaimer: Attributes available depends on your car model and year.

All values will show None if no data is available for the periode.

Attribute Description
Distance Distance driven (Displayed as sensor value).
Average_speed The average speed in the respective period (can be km/h or mph).
Countries The countries travelled through in the respective period.
Duration The total driving time in the respective period.
Total_fuel_consumed The total fuel consumption in the respective period (can be litres or gallons).
Average_fuel_consumed The average fuel consumption in the respective period (can be l/100km or mpg).
EV_distance The driving distiance in EV mode in the respective period .
EV_duration The driving time in EV mode in the respective period .
From_date Start date of the calculation period.
To_date End date of the calculation period.

Getting started

Prerequisites

Use Home Assistant build 2023.12 or above.

If you can confirm that it is working as advertised on older version please open a PR.

Note: It is only tested against latest, but should work on older versions too.

Note: Future updates may change which version are required.

HACS installation (Recommended)

Open HACS and search for Toyota Connected Services under integrations. You can choose to install a specific version or from master (Not recommended).

Manual Installation

  1. Open the directory with your Home Assistant configuration (where you find configuration.yaml, usually ~/.homeassistant/).
  2. If you do not have a custom_components directory there, you need to create it.

Git clone method

This is a preferred method of manual installation, because it allows you to keep the git functionality, allowing you to manually install updates just by running git pull origin master from the created directory.

Now you can clone the repository somewhere else and symlink it to Home Assistant like so:

  1. Clone the repo.

    git clone https://github.com/DurgNomis-drol/ha_toyota.git

  2. Create the symlink to toyota in the configuration directory. If you have non-standard directory for configuration, use it instead.

    ln -s ha_toyota/custom_components/toyota ~/.homeassistant/custom_components/toyota

Copy method

  1. Download ZIP with the code.
  2. Unpack it.
  3. Copy the custom_components/toyota/ from the unpacked archive to custom_components in your Home Assistant configuration directory.

Integration Setup

  • Browse to your Home Assistant instance.
  • In the sidebar click on Configuration.
  • From the configuration menu select: Integrations.
  • In the bottom right, click on the Add Integration button.
  • From the list, search and select “Toyota Connected Services”.
  • Follow the instruction on screen to complete the set-up.
  • After completing, the Toyota Connected Services integration will be immediately available for use.

Contribution

Contributions are more the welcome. This project uses poetry and pre-commit to make sure that we use a unified coding style throughout the code. Poetry can be installed by running poetry install. Please run poetry run pre-commit run --all-files and make sure that all tests passes before opening a PR or committing to the PR. All PR's must pass all checks for them to get approved.

License

By contributing, you agree that your contributions will be licensed under its MIT License.

Credits

Under the hood this integration uses the mytoyota python package.