tesla_api 1.2.0 → 1.3.0

data/docs/vehicle/commands/doors.md

@@ -0,0 +1,3 @@
+# Doors
+
+

data/docs/vehicle/commands/media.md

@@ -0,0 +1,3 @@
+# Media
+
+

data/docs/vehicle/commands/navigation.md

@@ -0,0 +1,3 @@
+# Navigation
+
+

data/docs/vehicle/commands/remotestart.md

@@ -0,0 +1,3 @@
+# Remote Start
+
+

data/docs/vehicle/commands/softwareupdate.md

@@ -0,0 +1,3 @@
+# Software Updates
+
+

data/docs/vehicle/commands/speedlimit.md

@@ -0,0 +1,3 @@
+# Speed Limit
+
+

data/docs/vehicle/commands/sunroof.md

@@ -0,0 +1,3 @@
+# Sunroof
+
+

data/docs/vehicle/commands/trunk.md

@@ -0,0 +1,3 @@
+# Frunk/Trunk
+
+

data/docs/vehicle/commands/valet.md

@@ -0,0 +1,3 @@
+# Valet Mode
+
+

data/docs/vehicle/commands/wake.md

@@ -0,0 +1,3 @@
+# Wake
+
+

data/docs/vehicle/optioncodes.md

@@ -0,0 +1,253 @@
+
+# Option Codes
+
+The `option_codes` field of a vehicle is a comma-delimited set of codes that
+represent various options the car was built with. This can include trim options,
+battery sizes, color, wheel types, and addon packages.
+
+_This list needs a lot of help! If you know of what any of these mean, please
+edit this page and submit a_
+[_pull request_](https://github.com/timdorr/tesla-api/pulls)_. It is much
+appreciated!_
+
+| Code | Title | Description |
+| :--- | :--- | :--- |
+| MDLS | Model S | This vehicle is a Model S | 
+| MDLX | Model X | This vehicle is a Model X | 
+| MDL3 | Model 3 | This vehicle is a Model 3 | 
+| RENA | Region: North America | | 
+| RENC | Region: Canada | | 
+| REEU | Region: Europe | | 
+| AD02 | NEMA 14-50 | | 
+| AD04 | European 3-Phase | | 
+| AD05 | European 3-Phase, IT | | 
+| AD06 | Schuko (1 phase, 230V 13A) | | 
+| AD07 | Red IEC309 (3 phase, 400V 16A) | | 
+| ADPX2 | Type 2 Public Charging Connector | | 
+| ADX8 | Blue IEC309 (1 phase, 230V 32A) | | 
+| AF00 | No HEPA Filter | | 
+| AF02 | HEPA Filter | | 
+| AH00 | No Accessory Hitch | | 
+| APE1 | Enhanced Autopilot | | 
+| APF0 | Autopilot Firmware 2.0 Base | | 
+| APF1 | Autopilot Firmware 2.0 Enhanced | | 
+| APF2 | Full Self-Driving Capability | | 
+| APH0 | Autopilot 2.0 Hardware | | 
+| APH2 | Autopilot 2.0 Hardware | | 
+| APH3 | Autopilot 2.5 Hardware | | 
+| APPA | Autopilot 1.0 Hardware | | 
+| APPB | Enhanced Autopilot | | 
+| AU00 | No Audio Package | | 
+| AU01 | Ultra High Fidelity Sound | | 
+| BC0R | Tesla Red Brake Calipers | | 
+| BCMB | Black Brake Calipers | | 
+| BP00 | No Ludicrous | | 
+| BP01 | Ludicrous Speed Upgrade | | 
+| BR00 | No Battery Firmware Limit | | 
+| BR03 | Battery Firmware Limit (60kWh) | | 
+| BR05 | Battery Firmware Limit (75kWh) | | 
+| BS00 | General Production Flag | | 
+| BS01 | Special Production Flag | | 
+| BT37 | 75 kWh (Model 3) | | 
+| BT40 | 40 kWh | | 
+| BT60 | 60 kWh | | 
+| BT70 | 70 kWh | | 
+| BT85 | 85 kWh | | 
+| BTX4 | 90 kWh | | 
+| BTX5 | 75 kWh | | 
+| BTX6 | 100 kWh | | 
+| BTX7 | 75 kWh | | 
+| BTX8 | 85 kWh | | 
+| CC04 | Seven Seat Interior | | 
+| CDM0 | No CHAdeMO Charging Adaptor | | 
+| CH00 | Standard Charger (40 Amp) | | 
+| CH01 | Dual Chargers (80 Amp) | | 
+| CH04 | 72 Amp Charger (Model S/X) | | 
+| CH05 | 48 Amp Charger (Model S/X) | | 
+| CH07 | 48 Amp Charger (Model 3) | | 
+| COL0 | Signature | | 
+| COL1 | Solid | | 
+| COL2 | Metallic | | 
+| COL3 | Tesla Multi-Coat | | 
+| COUS | Country: United States | | 
+| CW00 | No Cold Weather Package | | 
+| CW02 | Subzero Weather Package | | 
+| DA00 | No Autopilot | | 
+| DA01 | Active Safety (ACC,LDW,SA) | | 
+| DA02 | Autopilot Convenience Features | | 
+| DCF0 | Autopilot Convenience Features (DCF0) | | 
+| DRLH | Left Hand Drive | | 
+| DRRH | Right Hand Drive | | 
+| DSH5 | PUR Dash Pad | | 
+| DSH7 | Alcantara Dashboard Accents | | 
+| DU00 | Drive Unit - IR | | 
+| DU01 | Drive Unit - Infineon | | 
+| DV2W | Rear-Wheel Drive | | 
+| DV4W | All-Wheel Drive | | 
+| FG00 | No Exterior Lighting Package | | 
+| FG01 | Exterior Lighting Package | | 
+| FG02 | Exterior Lighting Package | | 
+| FMP6 | FMP6 | | 
+| FR01 | Base Front Row | | 
+| FR03 | FR03 | | 
+| FR04 | FR04 | | 
+| HC00 | No Home Charging installation | | 
+| HC01 | Home Charging Installation | | 
+| HP00 | No HPWC Ordered | | 
+| HP01 | HPWC Ordered | | 
+| IDBA | Dark Ash Wood Decor | | 
+| IDBO | Figured Ash Wood Decor | | 
+| IDCF | Carbon Fiber Decor | | 
+| IDOM | Matte Obeche Wood Decor | | 
+| IDOG | Gloss Obeche Wood Decor | | 
+| IDLW | Lacewood Decor | | 
+| IDPB | Piano Black Decor | | 
+| INBBW | White | | 
+| INBFP | Classic Black | | 
+| INBPP | Black | | 
+| INBTB | Multi-Pattern Black | | 
+| INLPC | Cream | | 
+| INLPP | Black / Light Headliner | | 
+| INWPT | Tan Interior | | 
+| IVBPP | All Black Interior | | 
+| IVBSW | Ultra White Interior | | 
+| IVBTB | All Black Interior | | 
+| IVLPC | Vegan Cream | | 
+| IX00 | No Extended Nappa Leather Trim | | 
+| IX01 | Extended Nappa Leather Trim | | 
+| LLP1 | LLP1 | | 
+| LP01 | Premium Interior Lighting | | 
+| LT00 | Vegan interior | | 
+| LT01 | Standard interior | | 
+| LT1B | LT1B | | 
+| LT3W | LT3W | | 
+| LT4B | LT4B | | 
+| LT4C | LT4C | | 
+| LT4W | LT4W | | 
+| LT5C | LT5C | | 
+| LT5P | LT5P | | 
+| ME02 | Memory Seats | | 
+| MI00 | 2015 Production Refresh | | 
+| MI01 | 2016 Production Refresh | | 
+| MI02 | 2017 Production Refresh | | 
+| PA00 | No Paint Armor | | 
+| PBCW | Catalina White | | 
+| PBSB | Sierra Black | | 
+| PBT8 | Performance 85kWh | | 
+| PF00 | No Performance Legacy Package | | 
+| PF01 | Performance Legacy Package | | 
+| PI00 | No Premium Interior | | 
+| PI01 | Premium Upgrades Package | | 
+| PK00 | LEGACY No Parking Sensors | | 
+| PMAB | Anza Brown Metallic | | 
+| PMBL | Obsidian Black Multi-Coat | | 
+| PMMB | Monterey Blue Metallic | | 
+| PMMR | Multi-Coat Red | | 
+| PMNG | Midnight Silver Metallic | | 
+| PMSG | Sequoia Green Metallic | | 
+| PMSS | San Simeon Silver Metallic | | 
+| PMTG | Dolphin Grey Metallic | | 
+| PPMR | Muir Red Multi-Coat | | 
+| PPSB | Deep Blue Metallic | | 
+| PPSR | Signature Red | | 
+| PPSW | Shasta Pearl White Multi-Coat | | 
+| PPTI | Titanium Metallic | | 
+| PS00 | No Parcel Shelf | | 
+| PS01 | Parcel Shelf | | 
+| PX00 | No Performance Plus Package | | 
+| PX01 | Performance Plus | | 
+| PX6D | Zero to 60 in 2.5 sec | | 
+| P85D | P85D | | 
+| QNET | Tan NextGen | | 
+| QPMP | Black seats | | 
+| QTBW | White Premium Seats | | 
+| QTPC | Cream Premium Seats | | 
+| QTPP | Black Premium Seats | | 
+| QTPT | Tan Premium Seats | | 
+| QTTB | Multi-Pattern Black Seats | | 
+| QVBM | Multi-Pattern Black Seats | | 
+| QVPC | Vegan Cream Seats | | 
+| QVPP | Vegan Cream Seats | | 
+| QVSW | White Tesla Seats | | 
+| RCX0 | No Rear Console | | 
+| RF3G | Model 3 Glass Roof | | 
+| RFBK | Black Roof | | 
+| RFBC | Body Color Roof | | 
+| RFFG | Glass Roof | | 
+| RFP0 | All Glass Panoramic Roof | | 
+| RFP2 | Sunroof | | 
+| RFPX | Model X Roof | | 
+| S02P | S02P | | 
+| S31B | S31B | | 
+| S32C | S32C | | 
+| S32P | S32P | | 
+| S32W | S32W | | 
+| SC00 | No Supercharging | | 
+| SC01 | Supercharging Enabled | | 
+| SC04 | Pay Per Use Supercharging | | 
+| SC05 | Free Supercharging | | 
+| SP00 | No Security Package | | 
+| SR01 | Standard 2nd row | | 
+| SR06 | Seven Seat Interior | | 
+| SR07 | Standard 2nd row | | 
+| ST00 | Non-leather Steering Wheel | | 
+| ST01 | Non-heated Leather Steering Wheel | | 
+| SU00 | Standard Suspension | | 
+| SU01 | Smart Air Suspension | | 
+| TIC4 | All-Season Tires | | 
+| TM00 | General Production Trim | | 
+| TM02 | General Production Signature Trim | | 
+| TM0A | ALPHA PRE-PRODUCTION NON-SALEABLE | | 
+| TM0B | BETA PRE-PRODUCTION NON-SALEABLE | | 
+| TM0C | PRE-PRODUCTION SALEABLE | | 
+| TP01 | Tech Package - No Autopilot | | 
+| TP02 | Tech Package with Autopilot | | 
+| TP03 | Tech Package with Enhanced Autopilot | | 
+| TR00 | No Third Row Seat | | 
+| TR01 | Third Row Seating | | 
+| TRA1 | Third Row HVAC | | 
+| TW01 | Towing Package | | 
+| UM01 | Universal Mobile Charger - US Port (Single) | | 
+| UTAB | Black Alcantara Headliner | | 
+| UTAW | Light Headliner | | 
+| UTPB | Dark Headliner | | 
+| UTSB | Dark Headliner | | 
+| WT20 | 20" Silver Slipstream Wheels | | 
+| WTAS | 19" Silver Slipstream Wheels | | 
+| WTDS | 19" Grey Slipstream Wheels | | 
+| WTSG | 21" Turbine Wheels | | 
+| WTSS | 21" Turbine Wheels | | 
+| WTTB | 19" Cyclone Wheels | | 
+| WTW4 | 19" Winter Tire Set | | 
+| WTW5 | 21" Winter Tire Set | | 
+| WTX1 | 19" Michelin Primacy Tire Upgrade | | 
+| WXW4 | No 19" Winter Tire Set | | 
+| WXW5 | No 21" Winter Tire Set | | 
+| X001 | Override: Power Liftgate | | 
+| X003 | Maps & Navigation | | 
+| X004 | Override: No Navigation | | 
+| X007 | Daytime running lights | | 
+| X010 | Base Mirrors | | 
+| X011 | Override: Homelink | | 
+| X012 | Override: No Homelink | | 
+| X013 | Override: Satellite Radio | | 
+| X014 | Override: No Satellite Radio | | 
+| X019 | Carbon Fiber Spoiler | | 
+| X020 | No Performance Exterior | | 
+| X021 | No Spoiler | | 
+| X024 | Performance Package | | 
+| X025 | No Performance Package | | 
+| X027 | Lighted Door Handles | | 
+| X028 | Battery Badge | | 
+| X029 | Remove Battery Badge | | 
+| X030 | Override: No Passive Entry Pkg | | 
+| X031 | Keyless Entry | | 
+| X037 | Powerfolding Mirrors | | 
+| X039 | DAB Radio | | 
+| X040 | No DAB Radio | | 
+| X043 | No Phone Dock Kit | | 
+| X044 | Phone Dock Kit | | 
+| YF00 | No Yacht Floor | | 
+| YF01 | Matching Yacht Floor | | 
+| YFCC | YFCC | | 
+| YFFC | Integrated Center Console | | 

data/docs/vehicle/state/README.md

@@ -0,0 +1,34 @@
+---
+description: These endpoints give the state of the various subsystems of the car.
+---
+
+# State
+
+{% page-ref page="data.md" %}
+
+A cached rollup of all the `data_request` endpoints plus vehicle configuration.
+
+{% page-ref page="chargestate.md" %}
+
+Information on the state of charge in the battery and its various settings.
+
+{% page-ref page="climatestate.md" %}
+
+Information on the current internal temperature and climate control system.
+
+{% page-ref page="drivestate.md" %}
+
+Returns the driving and position state of the vehicle.
+
+{% page-ref page="guisettings.md" %}
+
+Returns various information about the GUI settings of the car, such as unit format and range display.
+
+{% page-ref page="vehiclestate.md" %}
+
+Returns the vehicle's physical state, such as which doors are open.
+
+{% page-ref page="mobileenabled.md" %}
+
+Lets you know if the Mobile Access setting is enabled in the car.
+

data/docs/vehicle/state/chargestate.md

@@ -0,0 +1,56 @@
+# Charge State
+
+## GET `/api/1/vehicles/{id}/data_request/charge_state`
+
+Information on the state of charge in the battery and its various settings.
+
+### Response
+
+```json
+{
+  "response": {
+    "charging_state": "Complete",
+    "fast_charger_type": "<invalid>",
+    "fast_charger_brand": "<invalid>",
+    "charge_limit_soc": 90,
+    "charge_limit_soc_std": 90,
+    "charge_limit_soc_min": 50,
+    "charge_limit_soc_max": 100,
+    "charge_to_max_range": false,
+    "max_range_charge_counter": 0,
+    "fast_charger_present": null,
+    "battery_range": 232.27,
+    "est_battery_range": 215.07,
+    "ideal_battery_range": 290.34,
+    "battery_level": 90,
+    "usable_battery_level": 90,
+    "charge_energy_added": 17.9,
+    "charge_miles_added_rated": 57.5,
+    "charge_miles_added_ideal": 72.0,
+    "charger_voltage": null,
+    "charger_pilot_current": null,
+    "charger_actual_current": null,
+    "charger_power": null,
+    "time_to_full_charge": 0.0,
+    "trip_charging": null,
+    "charge_rate": 0.0,
+    "charge_port_door_open": null,
+    "conn_charge_cable": "<invalid>",
+    "scheduled_charging_start_time": null,
+    "scheduled_charging_pending": false,
+    "user_charge_enable_request": null,
+    "charge_enable_request": true,
+    "charger_phases": null,
+    "charge_port_latch": "<invalid>",
+    "charge_current_request": 40,
+    "charge_current_request_max": 40,
+    "managed_charging_active": false,
+    "managed_charging_user_canceled": false,
+    "managed_charging_start_time": null,
+    "battery_heater_on": false,
+    "not_enough_power_to_heat": null,
+    "timestamp": 1538365158106
+  }
+}
+```
+

data/docs/vehicle/state/climatestate.md

@@ -0,0 +1,43 @@
+# Climate State
+
+## GET `/api/1/vehicles/{id}/data_request/climate_state`
+
+Information on the current internal temperature and climate control system.
+
+### Response
+
+```json
+{
+  "response": {
+    "inside_temp": 30.1,
+    "outside_temp": null,
+    "driver_temp_setting": 22.2,
+    "passenger_temp_setting": 22.2,
+    "left_temp_direction": null,
+    "right_temp_direction": null,
+    "is_front_defroster_on": false,
+    "is_rear_defroster_on": false,
+    "fan_status": 0,
+    "is_climate_on": false,
+    "min_avail_temp": 15.0,
+    "max_avail_temp": 28.0,
+    "seat_heater_left": false,
+    "seat_heater_right": false,
+    "seat_heater_rear_left": false,
+    "seat_heater_rear_right": false,
+    "seat_heater_rear_center": false,
+    "seat_heater_rear_right_back": 0,
+    "seat_heater_rear_left_back": 0,
+    "battery_heater": false,
+    "battery_heater_no_power": null,
+    "steering_wheel_heater": false,
+    "wiper_blade_heater": false,
+    "side_mirror_heaters": false,
+    "is_preconditioning": false,
+    "smart_preconditioning": false,
+    "is_auto_conditioning_on": null,
+    "timestamp": 1538365286085
+  }
+}
+```
+

data/docs/vehicle/state/data.md

@@ -0,0 +1,181 @@
+# Data
+
+## GET `/api/1/vehicles/{id}/data`
+
+A cached rollup of all the `data_request` endpoints plus vehicle configuration.
+
+### Response
+
+```json
+{
+  "response": {
+    "id": 12345678901234567,
+    "user_id": 123,
+    "vehicle_id": 1234567890,
+    "vin": "5YJSA11111111111",
+    "display_name": "Nikola 2.0",
+    "option_codes": "MDLS,RENA,AF02,APF1,APH2,APPB,AU01,BC0R,BP00,BR00,BS00,CDM0,CH05,PBCW,CW00,DCF0,DRLH,DSH7,DV4W,FG02,FR04,HP00,IDBA,IX01,LP01,ME02,MI01,PF01,PI01,PK00,PS01,PX00,PX4D,QTVB,RFP2,SC01,SP00,SR01,SU01,TM00,TP03,TR00,UTAB,WTAS,X001,X003,X007,X011,X013,X021,X024,X027,X028,X031,X037,X040,X044,YFFC,COUS",
+    "color": null,
+    "tokens": ["abcdef1234567890", "1234567890abcdef"],
+    "state": "online",
+    "in_service": false,
+    "id_s": "12345678901234567",
+    "calendar_enabled": true,
+    "backseat_token": null,
+    "backseat_token_updated_at": null,
+    "gui_settings": {
+      "gui_distance_units": "mi/hr",
+      "gui_temperature_units": "F",
+      "gui_charge_rate_units": "mi/hr",
+      "gui_24_hour_time": false,
+      "gui_range_display": "Rated",
+      "timestamp": 1538364665388
+    },
+    "vehicle_config": {
+      "can_actuate_trunks": true,
+      "car_special_type": "base",
+      "car_type": "models2",
+      "charge_port_type": "US",
+      "eu_vehicle": false,
+      "exterior_color": "White",
+      "has_ludicrous_mode": false,
+      "motorized_charge_port": true,
+      "perf_config": "P2",
+      "plg": true,
+      "rear_seat_heaters": 0,
+      "rear_seat_type": 0,
+      "rhd": false,
+      "roof_color": "None",
+      "seat_type": 2,
+      "spoiler_type": "None",
+      "sun_roof_installed": 2,
+      "third_row_seats": "None",
+      "timestamp": 1538364666096,
+      "trim_badging": "p90d",
+      "wheel_type": "AeroTurbine19"
+    },
+    "charge_state": {
+      "charging_state": "Complete",
+      "fast_charger_type": "<invalid>",
+      "fast_charger_brand": "<invalid>",
+      "charge_limit_soc": 90,
+      "charge_limit_soc_std": 90,
+      "charge_limit_soc_min": 50,
+      "charge_limit_soc_max": 100,
+      "charge_to_max_range": false,
+      "max_range_charge_counter": 0,
+      "fast_charger_present": false,
+      "battery_range": 232.27,
+      "est_battery_range": 215.07,
+      "ideal_battery_range": 290.34,
+      "battery_level": 90,
+      "usable_battery_level": 90,
+      "charge_energy_added": 17.9,
+      "charge_miles_added_rated": 57.5,
+      "charge_miles_added_ideal": 72.0,
+      "charger_voltage": 0,
+      "charger_pilot_current": 40,
+      "charger_actual_current": 0,
+      "charger_power": 0,
+      "time_to_full_charge": 0.0,
+      "trip_charging": false,
+      "charge_rate": 0.0,
+      "charge_port_door_open": true,
+      "conn_charge_cable": "SAE",
+      "scheduled_charging_start_time": null,
+      "scheduled_charging_pending": false,
+      "user_charge_enable_request": null,
+      "charge_enable_request": true,
+      "charger_phases": null,
+      "charge_port_latch": "Engaged",
+      "charge_current_request": 40,
+      "charge_current_request_max": 40,
+      "managed_charging_active": false,
+      "managed_charging_user_canceled": false,
+      "managed_charging_start_time": null,
+      "battery_heater_on": false,
+      "not_enough_power_to_heat": false,
+      "timestamp": 1538364666097
+    },
+    "drive_state": {
+      "shift_state": null,
+      "speed": null,
+      "power": 0,
+      "latitude": 33.111111,
+      "longitude": -88.111111,
+      "heading": 5,
+      "gps_as_of": 1538363883,
+      "native_location_supported": 1,
+      "native_latitude": 33.111111,
+      "native_longitude": -88.111111,
+      "native_type": "wgs",
+      "timestamp": 1538364666096
+    },
+    "vehicle_state": {
+      "api_version": 3,
+      "autopark_state_v2": "standby",
+      "autopark_style": "standard",
+      "calendar_supported": true,
+      "car_version": "2018.34.1 3dd3072",
+      "center_display_state": 0,
+      "df": 0,
+      "dr": 0,
+      "ft": 0,
+      "homelink_nearby": true,
+      "last_autopark_error": "no_error",
+      "locked": true,
+      "notifications_supported": true,
+      "odometer": 33561.422505,
+      "parsed_calendar_supported": true,
+      "pf": 0,
+      "pr": 0,
+      "remote_start": false,
+      "remote_start_supported": true,
+      "rt": 0,
+      "speed_limit_mode": {
+        "active": false,
+        "current_limit_mph": 75.0,
+        "max_limit_mph": 90,
+        "min_limit_mph": 50,
+        "pin_code_set": false
+      },
+      "sun_roof_percent_open": 0,
+      "sun_roof_state": "unknown",
+      "timestamp": 1538364666096,
+      "valet_mode": false,
+      "vehicle_name": "Nikola 2.0"
+    },
+    "climate_state": {
+      "inside_temp": 30.1,
+      "outside_temp": 27.0,
+      "driver_temp_setting": 22.2,
+      "passenger_temp_setting": 22.2,
+      "left_temp_direction": null,
+      "right_temp_direction": null,
+      "is_front_defroster_on": false,
+      "is_rear_defroster_on": false,
+      "fan_status": 0,
+      "is_climate_on": false,
+      "min_avail_temp": 15.0,
+      "max_avail_temp": 28.0,
+      "seat_heater_left": false,
+      "seat_heater_right": false,
+      "seat_heater_rear_left": false,
+      "seat_heater_rear_right": false,
+      "seat_heater_rear_center": false,
+      "seat_heater_rear_right_back": 0,
+      "seat_heater_rear_left_back": 0,
+      "battery_heater": false,
+      "battery_heater_no_power": false,
+      "steering_wheel_heater": false,
+      "wiper_blade_heater": false,
+      "side_mirror_heaters": false,
+      "is_preconditioning": false,
+      "smart_preconditioning": false,
+      "is_auto_conditioning_on": null,
+      "timestamp": 1538364666097
+    }
+  }
+}
+```
+