tesla_api 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe1e175cf04535eb226d4db749103474b9692cc9c6c09a44b511bf15d6cecbf6
-  data.tar.gz: 8d43d6405a1bf5939f57c1527dd61f5eea0033ad1c3baea6eb431db3c4a33533
+  metadata.gz: 4379e187bc321aa06bf2675be264b8f7dba76d33d08ae2088b5491e718aeb387
+  data.tar.gz: d0efa66690fa5ed2edb6b624c77ea1fef140e88c7a4aa177cb6f68c82fe4e88a
 SHA512:
-  metadata.gz: 0fb5ef14ea1c0c71cee3501526a953b38a0f2d6765917eac733f7105803f8444560e3da36aaeb3814981466236e18d7397b2b835e94124063010c2a808f655ca
-  data.tar.gz: 5e31a812bda0b70b9c16f479db8914d0e6af49a2e765c85921e3a5c8bd7236eb9fb31cfa21502954888dcc7b9920a91cb50aa3089de42e980e8d60c401a6b306
+  metadata.gz: d705d155f086cbd9e8476575973d45b346f29dd3b77f7df29295e88bf1dc0563841e745e6f3e79fb33db59fa2d03bec4ce8f3cd6b9e06d849309a6c9709b0575
+  data.tar.gz: ea8910775ee4536f95249ffe0fedb1a8468d9996ebaaab01fab5569955053e515a937c920cff817d76c508d4b3c32b682b5a24b4863a1487f46f01c0cba15339

data/docs/SUMMARY.md

@@ -1,45 +1,46 @@
 # Table of contents
 
-* [Introduction](README.md)
+- [Introduction](README.md)
 
 ## API Basics
 
-* [Authentication](api-basics/authentication.md)
-* [Vehicles](api-basics/vehicles.md)
+- [Authentication](api-basics/authentication.md)
+- [Vehicles](api-basics/vehicles.md)
 
 ## Vehicle
 
-* [State](vehicle/state/README.md)
-  * [Data](vehicle/state/data.md)
-  * [Charge State](vehicle/state/chargestate.md)
-  * [Climate State](vehicle/state/climatestate.md)
-  * [Drive State](vehicle/state/drivestate.md)
-  * [GUI Settings](vehicle/state/guisettings.md)
-  * [Vehicle State](vehicle/state/vehiclestate.md)
-  * [Vehicle Config](vehicle/state/vehicleconfig.md)
-  * [Mobile Enabled](vehicle/state/mobileenabled.md)
-  * [Nearby Charging Sites](vehicle/state/nearbychargingsites.md)
-* [Commands](vehicle/commands/README.md)
-  * [Wake](vehicle/commands/wake.md)
-  * [Alerts](vehicle/commands/alerts.md)
-  * [Remote Start](vehicle/commands/remotestart.md)
-  * [Speed Limit](vehicle/commands/speedlimit.md)
-  * [Valet Mode](vehicle/commands/valet.md)
-  * [Sentry Mode](vehicle/commands/sentrymode.md)
-  * [Doors](vehicle/commands/doors.md)
-  * [Frunk/Trunk](vehicle/commands/trunk.md)
-  * [Sunroof](vehicle/commands/sunroof.md)
-  * [Charging](vehicle/commands/charging.md)
-  * [Climate](vehicle/commands/climate.md)
-  * [Media](vehicle/commands/media.md)
-  * [Navigation](vehicle/commands/navigation.md)
-  * [Software Updates](vehicle/commands/softwareupdate.md)
-  * [Calendar](vehicle/commands/calendar.md)
-* [Streaming](vehicle/streaming.md)
-* [Autopark/Summon](vehicle/autopark.md)
-* [Option Codes](vehicle/optioncodes.md)
+- [State](vehicle/state/README.md)
+  - [Data](vehicle/state/data.md)
+  - [Charge State](vehicle/state/chargestate.md)
+  - [Climate State](vehicle/state/climatestate.md)
+  - [Drive State](vehicle/state/drivestate.md)
+  - [GUI Settings](vehicle/state/guisettings.md)
+  - [Vehicle State](vehicle/state/vehiclestate.md)
+  - [Vehicle Config](vehicle/state/vehicleconfig.md)
+  - [Mobile Enabled](vehicle/state/mobileenabled.md)
+  - [Nearby Charging Sites](vehicle/state/nearbychargingsites.md)
+- [Commands](vehicle/commands/README.md)
+  - [Wake](vehicle/commands/wake.md)
+  - [Alerts](vehicle/commands/alerts.md)
+  - [Remote Start](vehicle/commands/remotestart.md)
+  - [Homelink](vehicle/commands/homelink.md)
+  - [Speed Limit](vehicle/commands/speedlimit.md)
+  - [Valet Mode](vehicle/commands/valet.md)
+  - [Sentry Mode](vehicle/commands/sentrymode.md)
+  - [Doors](vehicle/commands/doors.md)
+  - [Frunk/Trunk](vehicle/commands/trunk.md)
+  - [Windows](vehicle/commands/windows.md)
+  - [Sunroof](vehicle/commands/sunroof.md)
+  - [Charging](vehicle/commands/charging.md)
+  - [Climate](vehicle/commands/climate.md)
+  - [Media](vehicle/commands/media.md)
+  - [Sharing](vehicle/commands/sharing.md)
+  - [Software Updates](vehicle/commands/softwareupdate.md)
+  - [Calendar](vehicle/commands/calendar.md)
+- [Streaming](vehicle/streaming.md)
+- [Autopark/Summon](vehicle/autopark.md)
+- [Option Codes](vehicle/optioncodes.md)
 
 ## Miscellaneous
 
-* [Endpoints File](miscellaneous/endpoints.md)
-
+- [Endpoints File](miscellaneous/endpoints.md)

data/docs/miscellaneous/endpoints.md

@@ -1,9 +1,14 @@
 # Endpoints File
 
-This the latest contents of the ownerapi_endpoints.json file from the 3.9.0 version of the app.
+This the latest contents of the ownerapi_endpoints.json file from the 3.10.0 version of the app.
 
 ```json
 {
+  "STATUS": {
+    "TYPE": "GET",
+    "URI": "status",
+    "AUTH": false
+  },
   "AUTHENTICATE": {
     "TYPE": "POST",
     "URI": "oauth/token",
@@ -84,6 +89,11 @@ This the latest contents of the ownerapi_endpoints.json file from the 3.9.0 vers
     "URI": "api/1/vehicles/{vehicle_id}/command/auto_conditioning_stop",
     "AUTH": true
   },
+  "MAX_DEFROST": {
+    "TYPE": "POST",
+    "URI": "api/1/vehicles/{vehicle_id}/command/set_preconditioning_max",
+    "AUTH": true
+  },
   "CHANGE_CLIMATE_TEMPERATURE_SETTING": {
     "TYPE": "POST",
     "URI": "api/1/vehicles/{vehicle_id}/command/set_temps",
@@ -99,6 +109,11 @@ This the latest contents of the ownerapi_endpoints.json file from the 3.9.0 vers
     "URI": "api/1/vehicles/{vehicle_id}/command/sun_roof_control",
     "AUTH": true
   },
+  "WINDOW_CONTROL": {
+    "TYPE": "POST",
+    "URI": "api/1/vehicles/{vehicle_id}/command/window_control",
+    "AUTH": true
+  },
   "ACTUATE_TRUNK": {
     "TYPE": "POST",
     "URI": "api/1/vehicles/{vehicle_id}/command/actuate_trunk",
@@ -109,6 +124,11 @@ This the latest contents of the ownerapi_endpoints.json file from the 3.9.0 vers
     "URI": "api/1/vehicles/{vehicle_id}/command/remote_start_drive",
     "AUTH": true
   },
+  "TRIGGER_HOMELINK": {
+    "TYPE": "POST",
+    "URI": "api/1/vehicles/{vehicle_id}/command/trigger_homelink",
+    "AUTH": true
+  },
   "CHARGE_PORT_DOOR_OPEN": {
     "TYPE": "POST",
     "URI": "api/1/vehicles/{vehicle_id}/command/charge_port_door_open",
@@ -450,9 +470,9 @@ This the latest contents of the ownerapi_endpoints.json file from the 3.9.0 vers
     "URI": "api/1/notification_confirmations",
     "AUTH": true
   },
-  "NAVIGATION_REQUEST": {
+  "SHARE_TO_VEHICLE": {
     "TYPE": "POST",
-    "URI": "api/1/vehicles/{vehicle_id}/command/navigation_request",
+    "URI": "api/1/vehicles/{vehicle_id}/command/share",
     "AUTH": true
   },
   "REMOTE_SEAT_HEATER_REQUEST": {

data/docs/vehicle/commands/README.md

@@ -18,6 +18,10 @@ Controls for honking the horn and flashing the lights.
 
 Start the car remotely.
 
+{% page-ref page="homelink.md" %}
+
+Open or close the primary garage door via Homelink.
+
 {% page-ref page="speedlimit.md" %}
 
 Limit the maximum speed of the car.
@@ -34,6 +38,10 @@ Lock and unlock the car.
 
 Open and close the trunk and frunk.
 
+{% page-ref page="windows.md" %}
+
+Open and vent the windows.
+
 {% page-ref page="sunroof.md" %}
 
 Open and close the panoramic sunroof.
@@ -50,9 +58,9 @@ Adjust the temperature settings of the car.
 
 Control the media playing in the car.
 
-{% page-ref page="navigation.md" %}
+{% page-ref page="sharing.md" %}
 
-Start the navigation system.
+Share a location to navigate to or video to play in theatre mode.
 
 {% page-ref page="softwareupdate.md" %}
 
@@ -64,4 +72,4 @@ Enable or disable Sentry Mode.
 
 {% page-ref page="calendar.md" %}
 
-Synchronize a calendar with the car. 
+Synchronize a calendar with the car.

data/docs/vehicle/commands/climate.md

@@ -48,6 +48,25 @@ Note: The parameters are always in celsius, regardless of the region the car is
 }
 ```
 
+## POST `/api/1/vehicles/{id}/command/set_preconditioning_max`
+
+Toggles the climate controls between Max Defrost and the previous setting.
+
+### Parameters
+
+| Parameter | Example | Description                         |
+| :-------- | :------ | :---------------------------------- |
+| on        | true    | True to turn on, false to turn off. |
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```
+
 ## POST `/api/1/vehicles/{id}/command/remote_seat_heater_request`
 
 Sets the specified seat's heater level.

data/docs/vehicle/commands/homelink.md

@@ -0,0 +1,21 @@
+# Homelink
+
+## POST `/api/1/vehicles/{id}/command/trigger_homelink`
+
+Opens or closes the primary Homelink device. The provided location must be in proximity of stored location of the Homelink device.
+
+### Parameters
+
+| Parameter | Example            | Description        |
+| :-------- | :----------------- | :----------------- |
+| lat       | 36.98765432109876  | Current lattitude. |
+| lon       | -77.12345678901234 | Current longitude. |
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```

data/docs/vehicle/commands/{navigation.md → sharing.md}

@@ -1,8 +1,8 @@
-# Navigation
+# Sharing
 
-## POST `/api/1/vehicles/{id}/command/navigation_request`
+## POST `/api/1/vehicles/{id}/command/share`
 
-Sends a location for the car to start navigation.
+Sends a location for the car to start navigation or play a video in theatre mode.
 
 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:
 
@@ -17,14 +17,16 @@ These docs take from the Android app, which sends the data in JSON form. However
 }
 ```
 
+Note: This API was previously `navigation_request`, but has been updated to support video links as well.
+
 ### 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. |
+| 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 or video URL to set as the navigation destination. |
 
 ### Response
 

data/docs/vehicle/commands/windows.md

@@ -0,0 +1,22 @@
+# Windows
+
+## POST `/api/1/vehicles/{id}/command/window_control`
+
+Controls the windows. Will vent or close all windows simultaneously.
+
+### Parameters
+
+| Parameter | Example | Description                                                                 |
+| :-------- | :------ | :-------------------------------------------------------------------------- |
+| command   | close   | What action to take with the windows. Allows the values `vent` and `close`. |
+| lat       | 0       | Seems to not care what this is, 0 is the only value sent by the app.        |
+| lon       | 0       | Seems to not care what this is, 0 is the only value sent by the app.        |
+
+### Response
+
+```json
+{
+  "reason": "",
+  "result": true
+}
+```

data/docs/vehicle/optioncodes.md

@@ -174,6 +174,7 @@ appreciated!_
 | LT5C | LT5C | | 
 | LT5P | LT5P | | 
 | LT6P | LT6P | |
+| LT6W | White Base Lower Trim | |
 | LTPB | Lower Trim PUR Black | |
 | ME01 | Memory Seats | |
 | ME02 | Seat Memory | Seat Memory LHD Driver | 
@@ -254,15 +255,18 @@ appreciated!_
 | QVPP | Vegan Cream Seats | | 
 | QVSW | White Tesla Seats | | 
 | RCX0 | No Rear Console | | 
+| RCX1 | Rear Console | |
 | RF3G | Model 3 Glass Roof | | 
 | RFBK | Black Roof | | 
 | RFBC | Body Color Roof | Roof | 
 | RFFG | Glass Roof | | 
 | RFP0 | All Glass Panoramic Roof | | 
 | RFP2 | Sunroof | | 
-| RFPX | Model X Roof | | 
+| RFPX | Model X Roof | |
+| S01B | Black Textile Seats | |
 | S02B | Seat | BLK Leather |
 | S02P | S02P | | 
+| S07W | White Seats | |
 | S31B | S31B | | 
 | S32C | S32C | | 
 | S32P | S32P | | 
@@ -288,7 +292,10 @@ appreciated!_
 | SU3C | Suspension | Coil spring suspension |
 | T3MA | Tires M3 | 18 Michelin All Season, Square |
 | TIC4 | Tires | All-Season Tires | 
+| TIG2 | Summer Tires | |
+| TIM7 | Summer Tires | |
 | TIMP | Tires | Michelin Primacy 19" Tire |
+| TIP0 | All-season Tires | |
 | TM00 | Model Trim | General Production Series Vehicle | 
 | TM02 | General Production Signature Trim | | 
 | TM0A | ALPHA PRE-PRODUCTION NON-SALEABLE | | 
@@ -311,6 +318,7 @@ appreciated!_
 | UTSB | Dark Headliner | | 
 | UTZW | Light Headliner | |
 | USSB | Safety | Safety US Black |
+| USSW | US Safety Kit White | |
 | SLR1 | Carbon Fibre Spoiler | Model 3 |
 | SPT31 | Performance Upgrade | Model 3 |
 | SPTY1 | Performance Upgrade | Model Y |
@@ -377,6 +385,8 @@ appreciated!_
 | X037 | Powerfolding Mirrors | | 
 | X039 | DAB Radio | | 
 | X040 | No DAB Radio | | 
+| X041 | No Auto Presenting Door | |
+| X042 | Auto Presenting Door | |
 | X043 | No Phone Dock Kit | | 
 | X044 | Phone Dock Kit | | 
 | YF00 | No Yacht Floor | | 

data/lib/tesla_api/vehicle.rb

@@ -59,6 +59,10 @@ module TeslaApi
       data_request('vehicle_state')['response']
     end
 
+    def vehicle_config
+      data_request('vehicle_config')['response']
+    end
+
     # Commands
 
     def wake_up
@@ -121,6 +125,10 @@ module TeslaApi
       command('set_temps', body: {driver_temp: driver_temp, passenger_temp: passenger_temp})['response']
     end
 
+    def set_preconditioning_max(on)
+      command('set_preconditioning_max', body: {on: on})['response']
+    end
+
     def auto_conditioning_start
       command('auto_conditioning_start')['response']
     end
@@ -137,6 +145,10 @@ module TeslaApi
       command('sun_roof_control', body: {state: 'move', percent: percent})['response']
     end
 
+    def window_control(command)
+      command('window_control', body: {command: command, lat: 0, lon: 0})['response']
+    end
+
     def remote_start_drive(password)
       command('remote_start_drive', body: {password: password})['response']
     end
@@ -174,6 +186,10 @@ module TeslaApi
       })['response']
     end
 
+    def share(text)
+      navigation_request(text)
+    end
+
     def schedule_software_update(offset_sec = 0)
       command('schedule_software_update', body: {offset_sec: offset_sec})['response']
     end
@@ -194,6 +210,38 @@ module TeslaApi
       command('set_sentry_mode', body: {on: on})['response']
     end
 
+    def trigger_homelink(lat, lon)
+      command('trigger_homelink', body: {lat: lat, lon: lon})['response']
+    end
+
+    def media_toggle_playback
+      command('media_toggle_playback')['response']
+    end
+
+    def media_next_track
+      command('media_next_track')['response']
+    end
+
+    def media_prev_track
+      command('media_prev_track')['response']
+    end
+
+    def media_next_fav
+      command('media_next_fav')['response']
+    end
+
+    def media_prev_fav
+      command('media_prev_fav')['response']
+    end
+
+    def media_volume_up
+      command('media_volume_up')['response']
+    end
+
+    def media_volume_down
+      command('media_volume_down')['response']
+    end
+
     private
 
     def data_request(name)

data/lib/tesla_api/version.rb

@@ -1,3 +1,3 @@
 module TeslaApi
-  VERSION = '3.0.1'
+  VERSION = '3.0.2'
 end