Skip to main content

Python client for Toyota Connected Services.

Project description

GitHub Workflow Status GitHub Release GitHub Activity

Toyota Connected Services Python module

[!] This is still in beta

Description

Python 3 package to communicate with Toyota Connected Services. This is an unofficial package and Toyota can change their API at any point without warning.

Installation

This package can be installed through pip.

pip install mytoyota

Usage

import json
import asyncio
from mytoyota.client import MyT

username = "jane@doe.com"
password = "MyPassword"
locale = "da-dk"

# Get supported regions.
print(MyT.get_supported_regions())

client = MyT(username=username, password=password, locale=locale, region="europe")


async def get_information():
    print("Logging in...")
    await client.login()

    print("Retrieving cars...")
    # Returns cars registered to your account + information about each car.
    cars = await client.get_vehicles()

    for car in cars:

        # Returns live data from car/last time you used it as an object.
        vehicle = await client.get_vehicle_status(car)


        # You can either get them all async (Recommended) or sync (Look further down).
        data = await asyncio.gather(
            *[
                client.get_driving_statistics(vehicle.vin, interval="day"),
                client.get_driving_statistics(vehicle.vin, interval="isoweek"),
                client.get_driving_statistics(vehicle.vin),
                client.get_driving_statistics(vehicle.vin, interval="year"),
            ]
        )

        # You can deposit each result into premade object holder for statistics. This will make it easier to use in your code.

        vehicle.statistics.daily = data[0]
        vehicle.statistics.weekly = data[1]
        vehicle.statistics.monthly = data[2]
        vehicle.statistics.yearly = data[3]


        # You can access odometer data like this:
        mileage = vehicle.odometer.mileage
        # Or retrieve the energy level (electric or gasoline)
        fuel = vehicle.energy.level
        # Or Parking information:
        latitude = vehicle.parking.latitude


        # Pretty print the object. This will provide you with all available information.
        print(json.dumps(vehicle.as_dict(), indent=3))


        # -------------------------------
        # All data is return in an object.
        # -------------------------------

        # Returns live data from car/last time you used it.
        vehicle = await client.get_vehicle_status(car)
        print(vehicle.as_dict())

        # Stats returned in a dict
        daily_stats = await client.get_driving_statistics(vehicle.vin, interval="day")
        print(daily_stats.as_list())

        # Stats returned in json.
        weekly_stats = await client.get_driving_statistics(vehicle.vin, interval="isoweek")
        print(weekly_stats.as_list())

        # ISO 8601 week stats
        iso_weekly_stats = await client.get_driving_statistics(vehicle.vin, interval="isoweek")
        print(iso_weekly_stats.as_list)

        # Monthly stats is returned by default
        monthly_stats = await client.get_driving_statistics(vehicle.vin)
        print(monthly_stats.as_list())

        #Get year to date stats.
        yearly_stats = await client.get_driving_statistics(vehicle.vin, interval="year")
        print(yearly_stats.as_list())


loop = asyncio.get_event_loop()
loop.run_until_complete(get_information())
loop.close()

Known issues

  • Statistical endpoint will return None if no trip have been performed in the requested timeframe. This problem will often happen at the start of each week, month or year. Also daily stats will of course also be unavailable if no trip have been performed.

Docs

Coming soon...

Contributing

This python module uses poetry and pre-commit.

To start contributing, fork this repository and run poetry install. Then create a new branch. Before making a PR, please run pre-commit poetry run pre-commit run --all-files and make sure that all tests passes locally first.

Note

As I @DurgNomis-drol am not a professional programmer. I will try to maintain it as best as I can. If someone is interested in helping with this, they are more the welcome to message me to be a collaborator on this project.

Credits

A huge thanks go to @calmjm for making tojota.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mytoyota, version 0.7.2
Filename, size File type Python version Upload date Hashes
Filename, size mytoyota-0.7.2-py3-none-any.whl (22.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size mytoyota-0.7.2.tar.gz (19.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page