tesla_api 3.0.2 → 3.0.7

data/docs/vehicle/state/vehicleconfig.md

@@ -14,13 +14,12 @@ Returns the vehicle's configuration information including model, color, badging
     "car_special_type": "base",
     "car_type": "models2",
     "charge_port_type": "US",
+    "ece_restrictions": false,
     "eu_vehicle": false,
     "exterior_color": "White",
     "has_air_suspension": true,
     "has_ludicrous_mode": false,
-    "key_version": 1,
     "motorized_charge_port": true,
-    "perf_config": "P2",
     "plg": true,
     "rear_seat_heaters": 0,
     "rear_seat_type": 0,
@@ -30,8 +29,9 @@ Returns the vehicle's configuration information including model, color, badging
     "spoiler_type": "None",
     "sun_roof_installed": 2,
     "third_row_seats": "None",
-    "timestamp": 1538364666096,
+    "timestamp": 1604977445448,
     "trim_badging": "p90d",
+    "use_range_badging": false,
     "wheel_type": "AeroTurbine19"
   }
 }

data/docs/vehicle/state/vehiclestate.md

@@ -4,27 +4,51 @@
 
 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",
+    "api_version": 10,
+    "autopark_state_v2": "standby",
     "autopark_style": "standard",
     "calendar_supported": true,
-    "car_version": "2018.42.2 19e7e44",
+    "car_version": "2020.36.16 3e9e4e8dd287",
     "center_display_state": 0,
     "df": 0,
     "dr": 0,
     "ft": 0,
+    "homelink_device_count": 2,
     "homelink_nearby": true,
     "is_user_present": false,
     "last_autopark_error": "no_error",
-    "locked": true,
+    "locked": false,
     "media_state": { "remote_control_enabled": true },
     "notifications_supported": true,
-    "odometer": 36051.517239,
+    "odometer": 57509.856033,
     "parsed_calendar_supported": true,
     "pf": 0,
     "pr": 0,
@@ -32,30 +56,30 @@ Returns the vehicle's physical state, such as which doors are open.
     "remote_start_enabled": true,
     "remote_start_supported": true,
     "rt": 0,
-    "sentry_mode": true,
-    "software_update": { "expected_duration_sec": 2700, "status": "" },
+    "sentry_mode": false,
+    "sentry_mode_available": true,
+    "smart_summon_available": true,
+    "software_update": {
+      "download_perc": 0,
+      "expected_duration_sec": 2700,
+      "install_perc": 1,
+      "status": "",
+      "version": ""
+    },
     "speed_limit_mode": {
       "active": false,
       "current_limit_mph": 50.0,
       "max_limit_mph": 90,
       "min_limit_mph": 50,
-      "pin_code_set": false
+      "pin_code_set": true
     },
+    "summon_standby_mode_enabled": false,
     "sun_roof_percent_open": 0,
-    "sun_roof_state": "unknown",
-    "timestamp": 1543187581934,
+    "sun_roof_state": "closed",
+    "timestamp": 1604977470379,
     "valet_mode": false,
     "valet_pin_needed": true,
     "vehicle_name": "Nikola 2.0"
   }
 }
 ```
-
-### 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,

data/lib/tesla_api/stream.rb

@@ -1,57 +1,63 @@
 module TeslaApi
   module Stream
-    def stream(&receiver)
-      EventMachine.run do
-        socket = create_streaming_socket
+    def self.streaming_endpoint_url
+      'wss://streaming.vn.teslamotors.com/streaming/'
+    end
 
-        socket.on(:open) do |event|
-          socket.send(JSON.generate(stream_connect_message))
-        end
+    def self.streaming_endpoint
+      Async::HTTP::Endpoint.parse(streaming_endpoint_url, alpn_protocols: Async::HTTP::Protocol::HTTP11.names)
+    end
 
-        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
-            })
+    def stream(endpoint: Stream.streaming_endpoint, &receiver)
+      Async do |task|
+        Async::WebSocket::Client.connect(endpoint) do |connection|
+          on_timeout = ->(subtask) do
+            subtask.sleep TIMEOUT
+            task.stop
           end
-        end
 
-        socket.on(:close) do |event|
-          EventMachine.stop
+          connection.write(streaming_connect_message)
+          timeout = task.async(&on_timeout)
+
+          while message = connection.read
+            timeout.stop
+            timeout = task.async(&on_timeout)
+
+            case message[:msg_type]
+            when 'data:update'
+              attributes = message[: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
+              })
+            when 'data:error'
+              task.stop
+            end
+          end
         end
       end
     end
 
     private
 
-    def create_streaming_socket
-      Faye::WebSocket::Client.new(streaming_endpoint)
-    end
-
-    def streaming_endpoint
-      'wss://streaming.vn.teslamotors.com/streaming/'
-    end
+    TIMEOUT = 30
 
-    def stream_connect_message
+    def streaming_connect_message
       {
-        msg_type: 'data:subscribe',
-        token: Base64.strict_encode64("#{email}:#{self['tokens'].first}"),
+        msg_type: 'data:subscribe_oauth',
+        token: client.access_token,
         value: 'speed,odometer,soc,elevation,est_heading,est_lat,est_lng,power,shift_state,range,est_range,heading',
         tag: self['vehicle_id'].to_s,
       }

data/lib/tesla_api/vehicle.rb

@@ -27,6 +27,10 @@ module TeslaApi
 
     # State
 
+    def vehicle_data
+      client.get("/vehicles/#{id}/vehicle_data")['response']
+    end
+
     def data
       client.get("/vehicles/#{id}/data")['response']
     end
@@ -94,7 +98,7 @@ module TeslaApi
     end
 
     def set_charge_limit(percent)
-      command('set_charge_limit', body: {percent: percent})['response']
+      command('set_charge_limit', body: {percent: percent.to_i})['response']
     end
 
     def charge_start

data/lib/tesla_api/version.rb

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

data/spec/cassettes/client-login_timeout.yml

@@ -0,0 +1,83 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://owner-api.teslamotors.com/oauth/token
+    body:
+      encoding: UTF-8
+      string: grant_type=password&client_id=<TESLA_CLIENT_ID>&client_secret=<TESLA_CLIENT_SECRET>&email=<TESLA_EMAIL>&password=<TESLA_PASS>
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 408
+      message: Request Timeout
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 15 Dec 2014 03:09:22 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Status:
+      - 408 Request Timeout
+    body:
+      encoding: UTF-8
+      string: '{}'
+    http_version:
+  recorded_at: Mon, 15 Dec 2014 03:09:22 GMT
+- request:
+    method: post
+    uri: https://owner-api.teslamotors.com/oauth/token
+    body:
+      encoding: UTF-8
+      string: grant_type=password&client_id=<TESLA_CLIENT_ID>&client_secret=<TESLA_CLIENT_SECRET>&email=<TESLA_EMAIL>&password=<TESLA_PASS>
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 15 Dec 2014 03:09:22 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      Cache-Control:
+      - no-store
+      Pragma:
+      - no-cache
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      X-Request-Id:
+      - 349d563d345a9694c610770b743d3006
+      X-Runtime:
+      - '0.416152'
+    body:
+      encoding: UTF-8
+      string: '{"access_token":"1cba4845a8653d4b731440e9911d84304a179bd16a9ecbc9b649f2d8e0f6947e","token_type":"bearer","expires_in":7776000,"refresh_token":"fea03b395fa4e72ebc399d9cda6163dcf438c248f744ebdd5bfcda571f5f317f","created_at":1475777133}'
+    http_version:
+  recorded_at: Mon, 15 Dec 2014 03:09:22 GMT
+recorded_with: VCR 2.9.3