alex/teslatte
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

docs: readme updates

Browse source
This commit is contained in:
gak 2023-08-30 20:19:50 +10:00
parent 6685072ea4
commit cc01e30c63
No known key found for this signature in database
1 changed files with 20 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -3,9 +3,11 @@
> #### ⚠️ Alpha Warning! ⚠️ > #### ⚠️ 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. > 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.
A Tesla API using the `owner-api.teslamotors.com` endpoint as well as "interactive" OAuth. Teslatte is both a CLI and a Rust crate for interacting with the Tesla API.
Currently, it only supports some the `/api/1/vehicles` endpoint, but might be expanded in the future. A Tesla API using the `owner-api.teslamotors.com` endpoint as well as parts of the OAuth flow.
Currently, it only supports some the API.
It is fairly trivial to add in new endpoints if you feel like creating a PR. Please let me know if your PR is a massive change before spending a lot of time on it. It is fairly trivial to add in new endpoints if you feel like creating a PR. Please let me know if your PR is a massive change before spending a lot of time on it.
@ -48,12 +50,19 @@ Specific Vehicle
Usage: teslatte api vehicle <ID> <COMMAND> Usage: teslatte api vehicle <ID> <COMMAND>
Commands: Commands:
data Get vehicle data vehicle-data Get vehicle data
charge-state Get charge state 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-charge-limit Set charge limit
set-charging-amps Set charge amps 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-start Start charging
charge-stop Stop 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) help Print this message or the help of the given subcommand(s)
Arguments: Arguments:
@ -62,12 +71,12 @@ Arguments:
Options: Options:
-h, --help Print help -h, --help Print help
$ teslatte api vehicle 1234567890 data $ teslatte api vehicle 1234567890 vehicle_data
{ ... } { ... }
``` ```
## Example ## Crate example
A basic example: [examples/basic.rs](examples/basic.rs) A basic example: [examples/basic.rs](examples/basic.rs)