tesla_api 3.0.0 → 3.0.5

data/docs/vehicle/state/chargestate.md

@@ -43,6 +43,7 @@ Information on the state of charge in the battery and its various settings.
     "managed_charging_start_time": null,
     "managed_charging_user_canceled": false,
     "max_range_charge_counter": 0,
+    "minutes_to_full_charge": 0,
     "not_enough_power_to_heat": false,
     "scheduled_charging_pending": false,
     "scheduled_charging_start_time": null,

data/docs/vehicle/state/climatestate.md

@@ -12,6 +12,7 @@ Information on the current internal temperature and climate control system.
     "battery_heater": false,
     "battery_heater_no_power": false,
     "climate_keeper_mode": "dog",
+    "defrost_mode": 0,
     "driver_temp_setting": 21.6,
     "fan_status": 0,
     "inside_temp": null,
@@ -35,7 +36,6 @@ Information on the current internal temperature and climate control system.
     "seat_heater_rear_right_back": 0,
     "seat_heater_right": 2,
     "side_mirror_heaters": false,
-    "smart_preconditioning": false,
     "steering_wheel_heater": false,
     "timestamp": 1543187641727,
     "wiper_blade_heater": false

data/docs/vehicle/state/data.md

@@ -4,7 +4,7 @@
 
 A rollup of all the `data_request` endpoints plus vehicle configuration.
 
-*Note:* all `*_range` values are in miles, irrespective of GUI configuration.
+_Note:_ all `*_range` values are in miles, irrespective of GUI configuration.
 
 ### Response
 
@@ -23,7 +23,7 @@ A rollup of all the `data_request` endpoints plus vehicle configuration.
     "in_service": false,
     "id_s": "12345678901234567",
     "calendar_enabled": true,
-    "api_version": 6,
+    "api_version": 7,
     "backseat_token": null,
     "backseat_token_updated_at": null,
     "drive_state": {
@@ -44,6 +44,7 @@ A rollup of all the `data_request` endpoints plus vehicle configuration.
       "battery_heater": false,
       "battery_heater_no_power": false,
       "climate_keeper_mode": "dog",
+      "defrost_mode": 0,
       "driver_temp_setting": 21.6,
       "fan_status": 0,
       "inside_temp": null,
@@ -67,7 +68,6 @@ A rollup of all the `data_request` endpoints plus vehicle configuration.
       "seat_heater_rear_right_back": 0,
       "seat_heater_right": 2,
       "side_mirror_heaters": false,
-      "smart_preconditioning": false,
       "steering_wheel_heater": false,
       "timestamp": 1543186971731,
       "wiper_blade_heater": false
@@ -107,6 +107,7 @@ A rollup of all the `data_request` endpoints plus vehicle configuration.
       "managed_charging_start_time": null,
       "managed_charging_user_canceled": false,
       "max_range_charge_counter": 0,
+      "minutes_to_full_charge": 0,
       "not_enough_power_to_heat": false,
       "scheduled_charging_pending": false,
       "scheduled_charging_start_time": null,
@@ -122,34 +123,51 @@ A rollup of all the `data_request` endpoints plus vehicle configuration.
       "gui_distance_units": "mi/hr",
       "gui_range_display": "Rated",
       "gui_temperature_units": "F",
+      "show_range_units": true,
       "timestamp": 1543186971728
     },
     "vehicle_state": {
-      "api_version": 6,
+      "api_version": 7,
       "autopark_state_v2": "standby",
       "autopark_style": "standard",
       "calendar_supported": true,
-      "car_version": "2018.42.2 19e7e44",
+      "car_version": "2019.40.2.1 38f55d9f9205",
       "center_display_state": 0,
       "df": 0,
       "dr": 0,
+      "fd_window": 0,
+      "fp_window": 0,
       "ft": 0,
+      "homelink_device_count": 0,
       "homelink_nearby": true,
       "is_user_present": false,
       "last_autopark_error": "no_error",
       "locked": true,
-      "media_state": { "remote_control_enabled": true },
+      "media_state": {
+        "remote_control_enabled": true
+      },
       "notifications_supported": true,
       "odometer": 33561.422505,
       "parsed_calendar_supported": true,
       "pf": 0,
       "pr": 0,
+      "rd_window": 0,
       "remote_start": false,
       "remote_start_enabled": true,
       "remote_start_supported": true,
+      "rp_window": 0,
       "rt": 0,
       "sentry_mode": true,
-      "software_update": { "expected_duration_sec": 2700, "status": "" },
+      "sentry_mode_available": true,
+      "smart_summon_available": true,
+      "software_update": {
+        "download_perc": 100,
+        "expected_duration_sec": 2700,
+        "install_perc": 10,
+        "scheduled_time_ms": 1575689678432,
+        "status": "scheduled",
+        "version": "2019.40.2.1"
+      },
       "speed_limit_mode": {
         "active": false,
         "current_limit_mph": 75.0,
@@ -157,6 +175,7 @@ A rollup of all the `data_request` endpoints plus vehicle configuration.
         "min_limit_mph": 50,
         "pin_code_set": false
       },
+      "summon_standby_mode_enabled": true,
       "sun_roof_percent_open": 0,
       "sun_roof_state": "unknown",
       "timestamp": 1538364666096,
@@ -188,6 +207,7 @@ A rollup of all the `data_request` endpoints plus vehicle configuration.
       "third_row_seats": "None",
       "timestamp": 1538364666096,
       "trim_badging": "p90d",
+      "use_range_badging": false,
       "wheel_type": "AeroTurbine19"
     }
   }

data/docs/vehicle/state/guisettings.md

@@ -14,6 +14,7 @@ Returns various information about the GUI settings of the car, such as unit form
     "gui_distance_units": "mi/hr",
     "gui_range_display": "Rated",
     "gui_temperature_units": "F",
+    "show_range_units": true,
     "timestamp": 1543187561462
   }
 }

data/docs/vehicle/state/vehiclestate.md

@@ -4,36 +4,75 @@
 
 Returns the vehicle's physical state, such as which doors are open.
 
+For the trunk (rt) and frunk (ft) fields, you should interpret a zero (0) value as closed and a non-zero value as open (partially or fully).
+
+Here are the currently known values for the `center_display_state` field:
+
+| State | Description     |
+| ----- | --------------- |
+| 0     | Off             |
+| 2     | Normal On       |
+| 3     | Charging Screen |
+| 7     | Sentry Mode     |
+| 8     | Dog Mode        |
+
+Here are the descriptions for the shorthand fields:
+
+| Field | Description     |
+| ----- | --------------- |
+| df    | driver front    |
+| dr    | driver rear     |
+| pf    | passenger front |
+| pr    | passenger rear  |
+| ft    | front trunk     |
+| rt    | rear trunk      |
+
 ### Response
 
 ```json
 {
   "response": {
-    "api_version": 6,
-    "autopark_state_v2": "ready",
-    "autopark_style": "standard",
+    "api_version": 7,
+    "autopark_state_v3": "standby",
+    "autopark_style": "dead_man",
     "calendar_supported": true,
-    "car_version": "2018.42.2 19e7e44",
+    "car_version": "2019.40.2.1 38f55d9f9205",
     "center_display_state": 0,
     "df": 0,
     "dr": 0,
+    "fd_window": 0,
+    "fp_window": 0,
     "ft": 0,
+    "homelink_device_count": 0,
     "homelink_nearby": true,
     "is_user_present": false,
     "last_autopark_error": "no_error",
     "locked": true,
-    "media_state": { "remote_control_enabled": true },
+    "media_state": {
+      "remote_control_enabled": true
+    },
     "notifications_supported": true,
     "odometer": 36051.517239,
     "parsed_calendar_supported": true,
     "pf": 0,
     "pr": 0,
+    "rd_window": 0,
     "remote_start": false,
     "remote_start_enabled": true,
     "remote_start_supported": true,
+    "rp_window": 0,
     "rt": 0,
     "sentry_mode": true,
-    "software_update": { "expected_duration_sec": 2700, "status": "" },
+    "sentry_mode_available": true,
+    "smart_summon_available": true,
+    "software_update": {
+      "download_perc": 100,
+      "expected_duration_sec": 2700,
+      "install_perc": 10,
+      "scheduled_time_ms": 1575689678432,
+      "status": "scheduled",
+      "version": "2019.40.2.1"
+    },
     "speed_limit_mode": {
       "active": false,
       "current_limit_mph": 50.0,
@@ -41,6 +80,7 @@ Returns the vehicle's physical state, such as which doors are open.
       "min_limit_mph": 50,
       "pin_code_set": false
     },
+    "summon_standby_mode_enabled": true,
     "sun_roof_percent_open": 0,
     "sun_roof_state": "unknown",
     "timestamp": 1543187581934,
@@ -50,12 +90,3 @@ Returns the vehicle's physical state, such as which doors are open.
   }
 }
 ```
-
-### Center Display States
-| State | Description     |
-|-------|-----------------|
-| 0     | Off             |
-| 2     | Normal On       |
-| 3     | Charging Screen |
-| 7     | Sentry Mode     |
-| 8     | Dog Mode        |

data/lib/tesla_api.rb

@@ -3,8 +3,10 @@ require 'base64'
 
 require 'faraday'
 require 'faraday_middleware'
-require 'eventmachine'
-require 'faye/websocket'
+
+require 'async'
+require 'async/http/endpoint'
+require 'async/websocket/client'
 
 require 'tesla_api/version'
 require 'tesla_api/client'

data/lib/tesla_api/autopark.rb

@@ -1,60 +1,42 @@
 module TeslaApi
   module Autopark
     def start_autopark(&handler)
-      EventMachine.run do
-        autopark_socket.on(:message) do |event|
-          message = if event.data.is_a?(Array)
-            JSON.parse(event.data.map(&:chr).join)
-          else
-            JSON.parse(event.data)
-          end
-
-          default_handler(message)
-          handler.call(message.delete('msg_type'), message)
-        end
+      Async do |task|
+        Async::WebSocket::Client.connect(autopark_endpoint, headers: headers) do |connection|
+          while message = connection.read
+            case message[:msg_type]
+            when 'control:hello'
+              interval = message[:autopark][:heartbeat_frequency] / 1000.0
+              task.async do |subtask|
+                subtask.sleep interval
+                connection.write({ msg_type: 'autopark:heartbeat_app', timestamp: Time.now.to_i }.to_json)
+              end
+            end
 
-        autopark_socket.on(:close) do |_|
-          @autopark_socket = nil
-          @heartbeat && @heartbeat.cancel
-          EventMachine.stop
+            handler.call(message)
+          end
         end
       end
     end
 
     private
 
-    def default_handler(message)
-      case message['msg_type']
-        when 'control:hello'
-          interval = message['autopark']['heartbeat_frequency'] / 1000.0
-          @heartbeat = EventMachine::Timer.new(interval) do
-            beat = {
-                msg_type: 'autopark:heartbeat_app',
-                timestamp: Time.now.to_i
-            }
-            autopark_socket.send(beat.to_json)
-          end
-      end
+    def autopark_endpoint
+      Async::HTTP::Endpoint.parse(autopark_endpoint_url)
     end
 
-    def autopark_socket
-      @autopark_socket ||= Faye::WebSocket::Client.new(
-          autopark_socket_endpoint,
-          nil,
-          {
-              headers: {
-                  'Authorization' => "Basic #{socket_auth}"
-              }
-          }
-      )
+    def autopark_endpoint_url
+      "wss://streaming.vn.teslamotors.com/connect/#{self['vehicle_id']}"
     end
 
-    def socket_auth
-      Base64.strict_encode64("#{email}:#{self['tokens'].first}")
+    def autopark_headers
+      {
+          'Authorization' => "Basic #{socket_auth}"
+      }
     end
 
-    def autopark_socket_endpoint
-      "wss://streaming.vn.teslamotors.com/connect/#{self['vehicle_id']}"
+    def autopark_socket_auth
+      Base64.strict_encode64("#{email}:#{self['tokens'].first}")
     end
   end
 end

data/lib/tesla_api/client.rb

@@ -2,7 +2,7 @@ module TeslaApi
   class Client
     attr_reader :api, :email, :access_token, :access_token_expires_at, :refresh_token, :client_id, :client_secret
 
-    BASE_URI = 'https://owner-api.teslamotors.com/api/1'
+    BASE_URI = 'https://owner-api.teslamotors.com'
 
     def initialize(
         email: nil,
@@ -10,9 +10,13 @@ module TeslaApi
         access_token_expires_at: nil,
         refresh_token: nil,
         client_id: ENV['TESLA_CLIENT_ID'],
-        client_secret: ENV['TESLA_CLIENT_SECRET']
+        client_secret: ENV['TESLA_CLIENT_SECRET'],
+        retry_options: nil,
+        base_uri: nil,
+        client_options: {}
     )
       @email = email
+      @base_uri = base_uri || BASE_URI
 
       @client_id = client_id
       @client_secret = client_secret
@@ -22,19 +26,22 @@ module TeslaApi
       @refresh_token = refresh_token
 
       @api = Faraday.new(
-        BASE_URI,
-        headers: { 'User-Agent' => "github.com/timdorr/tesla-api v:#{VERSION}" }
+        @base_uri + '/api/1',
+        {
+          headers: { 'User-Agent' => "github.com/timdorr/tesla-api v:#{VERSION}" }
+        }.merge(client_options)
       ) do |conn|
         conn.request :json
         conn.response :json
         conn.response :raise_error
+        conn.request :retry, retry_options if retry_options # Must be registered after :raise_error
         conn.adapter Faraday.default_adapter
       end
     end
 
     def refresh_access_token
       response = api.post(
-        'https://owner-api.teslamotors.com/oauth/token',
+        @base_uri + '/oauth/token',
         {
           grant_type: 'refresh_token',
           client_id: client_id,
@@ -52,7 +59,7 @@ module TeslaApi
 
     def login!(password)
       response = api.post(
-        'https://owner-api.teslamotors.com/oauth/token',
+        @base_uri + '/oauth/token',
         {
           grant_type: 'password',
           client_id: client_id,
@@ -87,7 +94,7 @@ module TeslaApi
     end
 
     def vehicle(id)
-      Vehicle.new(self, email, id, self.class.get("/vehicles/#{id}")['response'])
+      Vehicle.new(self, email, id, self.get("/vehicles/#{id}")['response'])
     end
   end
 end

data/lib/tesla_api/stream.rb

@@ -1,54 +1,60 @@
 module TeslaApi
   module Stream
     def stream(&receiver)
-      EventMachine.run do
-        socket = create_streaming_socket
+      Async do |task|
+        Async::WebSocket::Client.connect(streaming_endpoint) do |connection|
+          on_timeout = ->(subtask) do
+            subtask.sleep TIMEOUT
+            task.stop
+          end
 
-        socket.on(:open) do |event|
-          socket.send(JSON.generate(stream_connect_message))
-        end
+          connection.write(streaming_connect_message)
+          timeout = task.async(&on_timeout)
 
-        socket.on(:message) do |event|
-          data = JSON.parse(event.data.pack('c*'))
-
-          if data['msg_type'] == 'data:update'
-            attributes = data['value'].split(',')
-
-            receiver.call({
-              time: DateTime.strptime((attributes[0].to_i/1000).to_s, '%s'),
-              speed: attributes[1].to_f,
-              odometer: attributes[2].to_f,
-              soc: attributes[3].to_f,
-              elevation: attributes[4].to_f,
-              est_heading: attributes[5].to_f,
-              est_lat: attributes[6].to_f,
-              est_lng: attributes[7].to_f,
-              power: attributes[8].to_f,
-              shift_state: attributes[9].to_s,
-              range: attributes[10].to_f,
-              est_range: attributes[11].to_f,
-              heading: attributes[12].to_f
-            })
-          end
-        end
+          while message = connection.read
+            timeout.stop
+            timeout = task.async(&on_timeout)
+
+            case message[:msg_type]
+            when 'data:update'
+              attributes = message[:value].split(',')
 
-        socket.on(:close) do |event|
-          EventMachine.stop
+              receiver.call({
+                time: DateTime.strptime((attributes[0].to_i/1000).to_s, '%s'),
+                speed: attributes[1].to_f,
+                odometer: attributes[2].to_f,
+                soc: attributes[3].to_f,
+                elevation: attributes[4].to_f,
+                est_heading: attributes[5].to_f,
+                est_lat: attributes[6].to_f,
+                est_lng: attributes[7].to_f,
+                power: attributes[8].to_f,
+                shift_state: attributes[9].to_s,
+                range: attributes[10].to_f,
+                est_range: attributes[11].to_f,
+                heading: attributes[12].to_f
+              })
+            when 'data:error'
+              task.stop
+            end
+          end
         end
       end
     end
 
     private
 
-    def create_streaming_socket
-      Faye::WebSocket::Client.new(streaming_endpoint)
-    end
+    TIMEOUT = 30
 
     def streaming_endpoint
+      Async::HTTP::Endpoint.parse(streaming_endpoint_url)
+    end
+
+    def streaming_endpoint_url
       'wss://streaming.vn.teslamotors.com/streaming/'
     end
 
-    def stream_connect_message
+    def streaming_connect_message
       {
         msg_type: 'data:subscribe',
         token: Base64.strict_encode64("#{email}:#{self['tokens'].first}"),