tesla_api 1.2.0 → 1.3.0

data/docs/vehicle/state/drivestate.md

@@ -0,0 +1,27 @@
+# Drive State
+
+## GET `/api/1/vehicles/{id}/data_request/drive_state`
+
+Returns the driving and position state of the vehicle.
+
+### Response
+
+```json
+{
+  "response": {
+    "shift_state": null,
+    "speed": null,
+    "power": 0,
+    "latitude": 33.111111,
+    "longitude": -88.111111,
+    "heading": 5,
+    "gps_as_of": 1538365363,
+    "native_location_supported": 1,
+    "native_latitude": 33.111111,
+    "native_longitude": -88.111111,
+    "native_type": "wgs",
+    "timestamp": 1538365436098
+  }
+}
+```
+

data/docs/vehicle/state/guisettings.md

@@ -0,0 +1,21 @@
+# GUI Settings
+
+## GET `/api/1/vehicles/{id}/data_request/gui_settings`
+
+Returns various information about the GUI settings of the car, such as unit format and range display.
+
+### Response
+
+```json
+{
+  "response": {
+    "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": 1538365490671
+  }
+}
+```
+

data/docs/vehicle/state/mobileenabled.md

@@ -0,0 +1,14 @@
+# Mobile Enabled
+
+## GET `/api/1/vehicles/{id}/mobile_enabled`
+
+Lets you know if the Mobile Access setting is enabled in the car.
+
+### Response
+
+```json
+{
+  "response": true
+}
+```
+

data/docs/vehicle/state/vehiclestate.md

@@ -0,0 +1,47 @@
+# Vehicle State
+
+## GET `/api/1/vehicles/{id}/data_request/vehicle_state`
+
+Returns the vehicle's physical state, such as which doors are open.
+
+### Response
+
+```json
+{
+  "response": {
+    "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": 1538365559247,
+    "valet_mode": false,
+    "vehicle_name": "Nikola 2.0"
+  }
+}
+```
+

data/docs/vehicle/streaming.md

@@ -0,0 +1,4 @@
+# Streaming
+
+
+

data/lib/tesla_api.rb

@@ -1,7 +1,8 @@
-require "httparty"
-require "em-http-request"
+require 'httparty'
+require 'em-http-request'
 
-require "tesla_api/version"
-require "tesla_api/client"
-require "tesla_api/stream"
-require "tesla_api/vehicle"
+require 'tesla_api/version'
+require 'tesla_api/client'
+require 'tesla_api/stream'
+require 'tesla_api/autopark'
+require 'tesla_api/vehicle'

data/lib/tesla_api/autopark.rb

@@ -0,0 +1,62 @@
+require 'faye/websocket'
+
+module TeslaApi
+  module Autopark
+    def start_autopark(&handler)
+      EventMachine.run do
+        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
+
+        socket.on(:close) do |_|
+          @socket = nil
+          @heartbeat && @heartbeat.cancel
+          EventMachine.stop
+        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
+            }
+            socket.send(beat.to_json)
+          end
+      end
+    end
+
+    def socket
+      @socket ||= Faye::WebSocket::Client.new(
+          socket_endpoint,
+          nil,
+          {
+              headers: {
+                  'Authorization' => "Basic #{socket_auth}"
+              }
+          }
+      )
+    end
+
+    def socket_auth
+      Base64.strict_encode64("#{email}:#{self['tokens'].first}")
+    end
+
+    def socket_endpoint
+      "wss://streaming.vn.teslamotors.com/connect/#{self['vehicle_id']}"
+    end
+  end
+end

data/lib/tesla_api/client.rb

@@ -1,12 +1,13 @@
 module TeslaApi
   class Client
     include HTTParty
-    base_uri "https://owner-api.teslamotors.com/api/1"
+    base_uri 'https://owner-api.teslamotors.com/api/1'
+    headers 'User-Agent' => "github.com/timdorr/tesla-api v:#{VERSION}"
     format :json
 
     attr_reader :email, :token, :client_id, :client_secret
 
-    def initialize(email, client_id = ENV["TESLA_CLIENT_ID"], client_secret = ENV["TESLA_CLIENT_SECRET"])
+    def initialize(email, client_id = ENV['TESLA_CLIENT_ID'], client_secret = ENV['TESLA_CLIENT_SECRET'])
       @email = email
       @client_id = client_id
       @client_secret = client_secret
@@ -14,26 +15,46 @@ module TeslaApi
 
     def token=(token)
       @token = token
-      self.class.headers "Authorization" => "Bearer #{token}"
+      self.class.headers 'Authorization' => "Bearer #{token}"
+    end
+
+    def expires_in=(seconds)
+      @expires_in = seconds.to_f
+    end
+
+    def created_at=(timestamp)
+      @created_at = Time.at(timestamp.to_f).to_datetime
+    end
+
+    def expired_at
+      return nil unless defined?(@created_at)
+      (@created_at.to_time + @expires_in.to_f).to_datetime
+    end
+
+    def expired?
+      return true unless defined?(@created_at)
+      expired_at <= DateTime.now
     end
 
     def login!(password)
       response = self.class.post(
-          "https://owner-api.teslamotors.com/oauth/token",
+          'https://owner-api.teslamotors.com/oauth/token',
           body: {
-              "grant_type" => "password",
-              "client_id" => client_id,
-              "client_secret" => client_secret,
-              "email" => email,
-              "password" => password
+              grant_type: 'password',
+              client_id: client_id,
+              client_secret: client_secret,
+              email: email,
+              password: password
           }
       )
 
-      self.token = response["access_token"]
+      self.expires_in = response['expires_in']
+      self.created_at = response['created_at']
+      self.token      = response['access_token']
     end
 
     def vehicles
-      self.class.get("/vehicles")["response"].map { |v| Vehicle.new(self.class, email, v["id"], v) }
+      self.class.get('/vehicles')['response'].map { |v| Vehicle.new(self.class, v['id'], v) }
     end
   end
 end

data/lib/tesla_api/stream.rb

@@ -6,7 +6,7 @@ module TeslaApi
           attributes = chunk.split(",")
 
           reciever.call({
-              time: DateTime.strptime((attributes[0].to_i/1000).to_s, "%s"),
+              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,
@@ -14,7 +14,11 @@ module TeslaApi
               est_heading: attributes[5].to_f,
               est_lat: attributes[6].to_f,
               est_lng: attributes[7].to_f,
-              power: attributes[8].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
 
@@ -27,23 +31,23 @@ module TeslaApi
 
     def request
       @request ||= EventMachine::HttpRequest.new(
-          "#{stream_endpoint}/stream/#{self["vehicle_id"]}/?values=#{stream_params}")
+          "#{stream_endpoint}/stream/#{self['vehicle_id']}/?values=#{stream_params}")
     end
 
     def http
-      @http ||= request.get(
+      request.get(
           head: {
-              "authorization" => [email, self["tokens"].first]
+              'authorization' => [email, self['tokens'].first]
           },
           inactivity_timeout: 15)
     end
 
     def stream_endpoint
-      "https://streaming.vn.teslamotors.com"
+      'https://streaming.vn.teslamotors.com'
     end
 
     def stream_params
-      "speed,odometer,soc,elevation,est_heading,est_lat,est_lng,power"
+      'speed,odometer,soc,elevation,est_heading,est_lat,est_lng,power,shift_state,range,est_range,heading'
     end
   end
 end

data/lib/tesla_api/vehicle.rb

@@ -1,11 +1,11 @@
 module TeslaApi
   class Vehicle
     include Stream
-    attr_reader :api, :email, :id, :vehicle
+    include Autopark
+    attr_reader :api, :id, :vehicle
 
-    def initialize(api, email, id, vehicle)
+    def initialize(api, id, vehicle)
       @api = api
-      @email = email
       @id = id
       @vehicle = vehicle
     end
@@ -26,114 +26,134 @@ module TeslaApi
 
     # State
 
+    def data
+      api.get("/vehicles/#{id}/data")['response']
+    end
+
     def mobile_enabled
-      api.get("/vehicles/#{id}/mobile_enabled")["response"]
+      api.get("/vehicles/#{id}/mobile_enabled")['response']
     end
 
     def gui_settings
-      data_request("gui_settings")["response"]
+      data_request('gui_settings')['response']
     end
 
     def charge_state
-      data_request("charge_state")["response"]
+      data_request('charge_state')['response']
     end
 
     def climate_state
-      data_request("climate_state")["response"]
+      data_request('climate_state')['response']
     end
 
     def drive_state
-      data_request("drive_state")["response"]
+      data_request('drive_state')['response']
     end
 
     def vehicle_state
-      data_request("vehicle_state")["response"]
+      data_request('vehicle_state')['response']
     end
 
     # Commands
 
     def wake_up
-      @vehicle = api.post("/vehicles/#{id}/wake_up")["response"]
+      @vehicle = api.post("/vehicles/#{id}/wake_up")['response']
     end
 
     def set_valet_mode(on, password=nil)
-      command("set_valet_mode", body: {on: on, password: password})["response"]
+      command('set_valet_mode', body: {on: on, password: password})['response']
     end
 
     def reset_valet_pin
-      command("reset_valet_pin")["response"]
+      command('reset_valet_pin')['response']
     end
 
     def charge_port_door_open
-      command("charge_port_door_open")["response"]
+      command('charge_port_door_open')['response']
     end
 
     def charge_standard
-      command("charge_standard")["response"]
+      command('charge_standard')['response']
     end
 
     def charge_max_range
-      command("charge_max_range")["response"]
+      command('charge_max_range')['response']
     end
 
     def set_charge_limit(percent)
-      command("set_charge_limit", body: {percent: percent})["response"]
+      command('set_charge_limit', body: {percent: percent})['response']
     end
 
     def charge_start
-      command("charge_start")["response"]
+      command('charge_start')['response']
     end
 
     def charge_stop
-      command("charge_stop")["response"]
+      command('charge_stop')['response']
     end
 
     def flash_lights
-      command("flash_lights")["response"]
+      command('flash_lights')['response']
     end
 
     def honk_horn
-      command("honk_horn")["response"]
+      command('honk_horn')['response']
     end
 
     def door_unlock
-      command("door_unlock")["response"]
+      command('door_unlock')['response']
     end
 
     def door_lock
-      command("door_lock")["response"]
+      command('door_lock')['response']
     end
 
     def set_temps(driver_temp, passenger_temp)
-      command("set_temps", body: {driver_temp: driver_temp, passenger_temp: passenger_temp})["response"]
+      command('set_temps', body: {driver_temp: driver_temp, passenger_temp: passenger_temp})['response']
     end
 
     def auto_conditioning_start
-      command("auto_conditioning_start")["response"]
+      command('auto_conditioning_start')['response']
     end
 
     def auto_conditioning_stop
-      command("auto_conditioning_stop")["response"]
+      command('auto_conditioning_stop')['response']
     end
 
     def sun_roof_control(state)
-      command("sun_roof_control", body: {state: state})["response"]
+      command('sun_roof_control', body: {state: state})['response']
     end
 
     def sun_roof_move(percent)
-      command("sun_roof_control", body: {state: "move", percent: percent})["response"]
+      command('sun_roof_control', body: {state: 'move', percent: percent})['response']
     end
 
     def remote_start_drive(password)
-      command("remote_start_drive", body: {password: password})["response"]
+      command('remote_start_drive', body: {password: password})['response']
     end
 
     def open_trunk
-      command("trunk_open", body: {which_trunk: "rear"})
+      command('actuate_trunk', body: {which_trunk: 'rear'})['response']
     end
 
     def open_frunk
-      command("trunk_open", body: {which_trunk: "rear"})
+      command('actuate_trunk', body: {which_trunk: 'front'})['response']
+    end
+
+    def activate_speed_limit(pin)
+      command('speed_limit_activate', body: {pin: pin})['response']
+    end
+
+    def deactivate_speed_limit(pin)
+      command('speed_limit_deactivate', body: {pin: pin})['response']
+    end
+
+    def set_speed_limit(limit_mph)
+      command('speed_limit_set_limit', body: {limit_mph: limit_mph})['response']
+    end
+
+    def clear_speed_limit_pin(pin)
+      command('speed_limit_clear_pin', body: {pin: pin})['response']
     end
 
     private