#command-line-tool #data #querying #api #alpha #stage #tesla

bin+lib teslatte

A command line tool and Rust crate for querying the Tesla API

17 releases

0.1.15 Apr 12, 2024
0.1.14 Apr 12, 2024
0.1.13 Jan 23, 2024
0.1.11 Nov 11, 2023
0.0.1 Jul 21, 2022

#522 in Web programming

Download history 2/week @ 2024-09-19 2/week @ 2024-09-26 2/week @ 2024-10-03

968 downloads per month

MIT/Apache

100KB
2.5K SLoC

Teslatte 🚗🔋☀️☕

Crates.io docs.rs GitHub Workflow Status MIT or Apache-2.0

⚠️ Alpha Warning! ⚠️

This Rust crate is still in alpha stage. It is something I quickly put together if anyone needed it. I'm aiming to work on it as I need more features.

0.1.x will have breaking API changes. Don't rely on this project for anything important yet.

Using Rust nightly until async_fn_in_trait is stable.

Teslatte is both a CLI and a Rust crate for interacting with the Tesla API.

It is fairly trivial to add in new endpoints if you feel like creating a PR, but please:

  • Write some unit tests if it relies on new or changed data structures.
  • Let me know if your PR is a massive change before spending a lot of time on it.

APIs implemented

Only the Owner API is partially supported by this crate, with plans to support the Fleet API and the Command Mode SDK.

API.md contains a table of all known Tesla APIs (official and unofficial) and if Teslatte supports it, and where the API details were scraped from.

References

Thanks to https://tesla-api.timdorr.com/ for their excellent reference.

Tesla recently released API documentation for their "Fleet API" which appears to be similar to the Tesla Owner API.

Tesla also recently released a Command Mode SDK which also includes a proxy for the Fleet API.

CLI

There is a CLI that can be used to interact with the API. Example:

$ teslatte --help
Usage: teslatte api [OPTIONS] <COMMAND>

Commands:
  vehicles      List of vehicles
  vehicle       Specific Vehicle
  energy-sites  List of energy sites
  energy-site   Specific energy site
  powerwall     Powerwall queries
  help          Print this message or the help of the given subcommand(s)

Options:
  -a, --access-token <ACCESS_TOKEN>  Access token. If not provided, will try to load from the cli.json file [env: TESLA_ACCESS_TOKEN=]
  -h, --help                         Print help
  
# Prints a URL to start the OAuth flow, then asks for the token URL, then saves the token to `cli.json`.
$ teslatte auth --save 

# Lists your vehicles:
$ teslatte api vehicles
{
  "response": [{
    "vehicle_id": 1234567890,
  }]
}

$ teslatte api vehicle 1234567890
Specific Vehicle

Usage: teslatte api vehicle <ID> <COMMAND>

Commands:
  vehicle-data             Get vehicle data
  charge-port-door-open    Open the charge port door or unlocks the cable
  charge-port-door-close   For vehicles with a motorized charge port, this closes it
  set-charge-limit         Set charge limit
  set-charging-amps        Set charge amps
  charge-standard          Set the charge limit to the standard %
  charge-max-range         Set the charge limit to the maximum %
  charge-start             Start charging
  charge-stop              Stop charging
  set-scheduled-charging   Set scheduled charging
  set-scheduled-departure  Set scheduled departure
  honk-horn                Honk!
  flash-lights             Flash the lights
  help                     Print this message or the help of the given subcommand(s)

Arguments:
  <ID>

Options:
  -h, --help  Print help
  
$ teslatte api vehicle 1234567890 vehicle_data
{ ... }

Crate example

A basic example: examples/basic.rs

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~19–33MB
~594K SLoC