tesla_api 1.3.0 → 1.4.0

data/docs/vehicle/commands/README.md

@@ -7,16 +7,57 @@ description: These endpoints issue various commands to the car.
 These commands alter the vehicles state and return a boolean `result` to indicate success.
 
 {% page-ref page="wake.md" %}
+
+Wakes up the car from a sleeping state.
+
 {% page-ref page="alerts.md" %}
+
+Controls for honking the horn and flashing the lights.
+
+{% page-ref page="remotestart.md" %}
+
+Start the car remotely.
+
+{% page-ref page="speedlimit.md" %}
+
+Limit the maximum speed of the car.
+
+{% page-ref page="valet.md" %}
+
+Enable Valet Mode and reset the in-car PIN.
+
 {% page-ref page="doors.md" %}
+
+Lock and unlock the car.
+
 {% page-ref page="trunk.md" %}
+
+Open and close the trunk and frunk.
+
 {% page-ref page="sunroof.md" %}
+
+Open and close the panoramic sunroof.
+
 {% page-ref page="charging.md" %}
+
+Control the charging of the car.
+
 {% page-ref page="climate.md" %}
+
+Adjust the temperature settings of the car.
+
 {% page-ref page="media.md" %}
-{% page-ref page="nagivation.md" %}
-{% page-ref page="remotestart.md" %}
+
+Control the media playing in the car.
+
+{% page-ref page="navigation.md" %}
+
+Start the navigation system.
+
 {% page-ref page="softwareupdate.md" %}
-{% page-ref page="speedlimit.md" %}
-{% page-ref page="valet.md" %}
+
+Start an update of the car's software.
+
 {% page-ref page="calendar.md" %}
+
+Synchronize a calendar with the car. 

data/docs/vehicle/commands/alerts.md

@@ -3,3 +3,27 @@
 Controls for honking the horn and flashing the lights.
 
 ## POST `/api/1/vehicles/{id}/command/honk_horn`
+
+Honks the horn twice.
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```
+
+## POST `/api/1/vehicles/{id}/command/flash_lights`
+
+Flashes the headlights once.
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```

data/docs/vehicle/commands/charging.md

@@ -1,3 +1,100 @@
 # Charging
 
+Commands related to the charging of the vehicle.
 
+## POST `/api/1/vehicles/{id}/command/charge_port_door_open`
+
+Opens the charge port.
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```
+
+## POST `/api/1/vehicles/{id}/command/charge_port_door_close`
+
+For vehicles with a motorized charge port, this closes it.
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```
+
+## POST `/api/1/vehicles/{id}/command/charge_start`
+
+If the car is plugged in but not currently charging, this will start it charging.
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```
+
+## POST `/api/1/vehicles/{id}/command/charge_stop`
+
+If the car is currently charging, this will stop it.
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```
+
+## POST `/api/1/vehicles/{id}/command/charge_standard`
+
+Sets the charge limit to "standard" or ~90%.
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```
+
+## POST `/api/1/vehicles/{id}/command/charge_max_range`
+
+Sets the charge limit to "max range" or 100%.
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```
+
+## POST `/api/1/vehicles/{id}/command/set_charge_limit`
+
+Sets the charge limit to a custom value.
+
+### Parameters
+
+| Parameter | Example | Description                                   |
+| :-------- | :------ | :-------------------------------------------- |
+| percent   | 75      | The percentage the battery will charge until. |
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```

data/docs/vehicle/commands/climate.md

@@ -1,3 +1,49 @@
 # Climate
 
+## POST `/api/1/vehicles/{id}/command/auto_conditioning_start`
 
+Start the climate control (HVAC) system. Will cool or heat automatically, depending on set temperature.
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```
+
+## POST `/api/1/vehicles/{id}/command/auto_conditioning_stop`
+
+Stop the climate control (HVAC) system.
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```
+
+## POST `/api/1/vehicles/{id}/command/set_temps`
+
+Sets the target temperature for the climate control (HVAC) system. 
+
+Note: The parameters are always in celcius, regardless of the region the car is in or the display settings of the car.
+
+### Parameters
+
+| Parameter      | Example | Description                                                 |
+| :------------- | :------ | :---------------------------------------------------------- |
+| driver_temp    | 23.4    | The desired temperature on the driver's side in celcius.    |
+| passenger_temp | 23.4    | The desired temperature on the passenger's side in celcius. |
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```

data/docs/vehicle/commands/doors.md

@@ -1,3 +1,27 @@
 # Doors
 
+## POST `/api/1/vehicles/{id}/command/door_unlock`
 
+Unlocks the doors to the car. Extends the handles on the S and X.
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```
+
+## POST `/api/1/vehicles/{id}/command/door_lock`
+
+Locks the doors to the car. Retracts the handles on the S and X, if they are extended.
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```

data/docs/vehicle/commands/media.md

@@ -1,3 +1,95 @@
 # Media
 
+Controls the currently playing media in the car. For these commands to work, the car must be on.
+
+## POST `/api/1/vehicles/{id}/command/media_toggle_playback`
+
+Toggles the media between playing and paused. For the radio, this mutes or unmutes the audio.
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```
+
+## POST `/api/1/vehicles/{id}/command/media_next_track`
+
+Skips to the next track in the current playlist.
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```
+
+## POST `/api/1/vehicles/{id}/command/media_prev_track`
+
+Skips to the previous track in the current playlist. Does nothing for streaming from Stitcher.
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```
+
+## POST `/api/1/vehicles/{id}/command/media_next_fav`
+
+Skips to the next saved favorite in the media system.
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```
+
+## POST `/api/1/vehicles/{id}/command/media_prev_fav`
+
+Skips to the previous saved favorite in the media system.
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```
+
+## POST `/api/1/vehicles/{id}/command/media_volume_up`
+
+Turns up the volume of the media system.
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```
+
+## POST `/api/1/vehicles/{id}/command/media_volume_down`
+
+Turns down the volume of the media system.
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```
 

data/docs/vehicle/commands/navigation.md

@@ -1,3 +1,36 @@
 # Navigation
 
+## POST `/api/1/vehicles/{id}/command/navigation_request`
 
+Sends a location for the car to start navigation.
+
+These docs take from the Android app, which sends the data in JSON form. However, a urlencoded POST body will work as well. The basic format to a request looks like this:
+
+```json
+{
+  "type": "share_ext_content_raw",
+  "value": {
+    "android.intent.extra.TEXT": "123 Main St, City, ST 12345\n\nhttps://goo.gl/maps/X"
+  },
+  "locale": "en-US",
+  "timestamp_ms": "1539465730"
+}
+```
+
+### Parameters
+
+| Parameter                        | Example                     | Description                                       |
+| :------------------------------- | :-------------------------- | :------------------------------------------------ |
+| type                             | share_ext_content_raw       | Must be `share_ext_content_raw`.                  |
+| locale                           | en-US                       | The locale for the navigation request.            |
+| timestamp_ms                     | 1539465730                  | The current UNIX timestamp.                       |
+| value[android.intent.extra.TEXT] | 123 Main St, City, ST 12345 | The address to set as the navigation destination. |
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```

data/docs/vehicle/commands/remotestart.md

@@ -1,3 +1,20 @@
 # Remote Start
 
+## POST `/api/1/vehicles/{id}/command/remote_start_drive`
 
+Enables keyless driving. There is a two minute window after issuing the command to start driving the car.
+
+### Parameters
+
+| Parameter | Example   | Description                                           |
+| :-------- | :-------- | :---------------------------------------------------- |
+| password  | edisonsux | The password for the authenticated tesla.com account. |
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```

data/docs/vehicle/commands/softwareupdate.md

@@ -1,3 +1,33 @@
 # Software Updates
 
+## POST `/api/1/vehicles/{id}/command/schedule_software_update`
 
+Schedules a software update to be installed, if one is available.
+
+### Parameters
+
+| Parameter  | Example | Description                                                                            |
+| :--------- | :------ | :------------------------------------------------------------------------------------- |
+| offset_sec | 7200    | How many seconds in the future to schedule the update. Set to 0 for immediate install. |
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```
+
+## POST `/api/1/vehicles/{id}/command/cancel_software_update`
+
+Cancels a software update, if one is scheduled and has not yet started.
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```