tesla-api 0.0.1

data/lib/tesla-api/tesla_api.rb

@@ -0,0 +1,4 @@
+# Defines a set of objects with Vehcile as the root accessor to
+# both read telemetry and control the state.
+module TeslaAPI
+end

data/lib/tesla-api/vehicle.rb

@@ -0,0 +1,257 @@
+module TeslaAPI
+  # Defines a Model S vehicle returned from the API
+  class Vehicle < Data
+    # An array of Tesla defined option codes
+    attr_reader :option_codes
+
+    ##
+    # :method: color
+    # Should be car color but is always nil
+
+    ##
+    # :method: display_name
+    # Only observed as nil
+
+    ##
+    # :method: id
+    # Vehicle ID used in other API calls
+
+    ##
+    # :method: user_id
+    # Logged in user ID
+
+    ##
+    # :method: vehicle_id
+    # Vehicle ID used in streaming API
+
+    ##
+    # :method: vin
+    # Vehicle Identification Number
+
+    ##
+    # :method: tokens
+    # API tokens (first is used for streaming API)
+
+    ##
+    # :method: online_state
+    # "online" if currently online with API (streaming?)
+
+    ##
+    # :method: option_codes
+    # Array of option codes defining how the vehicle is configured
+
+    def initialize(tesla, data) # :nodoc:
+      @tesla = tesla
+
+      ivar_from_data("color",        "color",        data)
+      ivar_from_data("display_name", "display_name", data)
+      ivar_from_data("id",           "id",           data)
+      ivar_from_data("user_id",      "user_id",      data)
+      ivar_from_data("vehicle_id",   "vehicle_id",   data)
+      ivar_from_data("vin",          "vin",          data)
+      ivar_from_data("tokens",       "tokens",       data)
+      ivar_from_data("online_state", "state",        data)
+
+      @option_codes = data["option_codes"].split(",")
+    end
+
+    # true if the vehicle allows mobile access
+    def mobile_access?
+      tesla.api_mobile_access?(self)
+    end
+
+    # Returns the option codes as human readable string
+    def option_code_descriptions
+      option_codes.map { |code| codes_to_description.fetch(code, code) }.join(", ")
+    end
+
+    # Returns the streaming data interface
+    def stream
+      tesla.stream(self)
+    end
+
+    #################################
+    #
+    # Commands
+    #
+    #################################
+
+    # Wakes up the streaming API
+    def wake_up!
+      tesla.wake_up!(self)
+    end
+
+    # Opens the charging port
+    def open_charge_port!
+      tesla.open_charge_port!(self)
+    end
+
+    # Turns on the temperature conditioning
+    def auto_conditioning_start!
+      tesla.auto_conditioning_start!(self)
+    end
+
+    # Turns off the temperature conditioning
+    def auto_conditioning_stop!
+      tesla.auto_conditioning_stop!(self)
+    end
+
+    # Sets the temperature for both the driver and passenger
+    def set_temperature!(driver_degrees_celcius, passenger_degrees_celcius)
+      tesla.set_temperature!(self, driver_degrees_celcius, passenger_degrees_celcius)
+    end
+
+    # Opens the panoramic roof
+    #
+    # state may be "open", "close", "comfort", or "vent"
+    def open_roof!(state)
+      tesla.open_roof!(self, state)
+    end
+
+    # Locks the vehicle doors
+    def lock_door!
+      tesla.lock_door!(self)
+    end
+
+    # Unlocks the vehicle doors
+    def unlock_door!
+      tesla.unlock_door!(self)
+    end
+
+    # Honks the vehicles horn
+    def honk_horn!
+      tesla.honk_horn!(self)
+    end
+
+    # Flashes the vehicle lights
+    def flash_lights!
+      tesla.flash_lights!(self)
+    end
+
+    # Stops the vehicle charging
+    def charge_stop!
+      tesla.charge_stop!(self)
+    end
+
+    # Starts the vehicle charging
+    def charge_start!
+      tesla.charge_start!(self)
+    end
+
+    # Charge the vehicle for maximum range
+    def charge_max_range!
+      tesla.charge_max_range!(self)
+    end
+
+    # Charge the vehicle to standard range
+    def charge_standard!
+      tesla.charge_standard!(self)
+    end
+
+    #################################
+    #
+    # Queries
+    #
+    #################################
+
+    # Returns the vehicles charge state
+    def charge_state
+      @charge_state ||= tesla.api_charge_state_for_vehicle(self)
+    end
+
+    # Returns the vehicle climate state
+    def climate_state
+      @climate_state || tesla.api_climate_state_for_vehicle(self)
+    end
+
+    # Returns the vehicle drive state
+    def drive_state
+      @drive_state ||= tesla.api_drive_state_for_vehicle(self)
+    end
+
+    # Returns the vehicle gui settings
+    def gui_settings
+      @gui_settings ||= tesla.api_gui_settings_for_vehicle(self)
+    end
+
+    # Returns the vehicle state
+    def state
+      @state ||= tesla.api_get_vehicle_state_for_vehicle(self)
+    end
+
+    private
+
+    def tesla #:nodoc:
+      @tesla
+    end
+
+    def codes_to_description #:nodoc:
+      {
+        "MS01" => "base",
+        "RENA" => "region_us",
+        "RECA" => "region_canada",
+        "TM00" => "standard_trim",
+        "TM02" => "signature_trim",
+        "DRLH" => "left_hand_drive",
+        "DRRH" => "right_hand_drive",
+        "PF00" => "no_performance_model",
+        "PF01" => "performance_model",
+        "BT85" => "battery_85",
+        "BT60" => "battery_60",
+        "BT40" => "battery_40",
+        "PBSB" => "paint_black",
+        "PBSW" => "paint_solid_white",
+        "PMSS" => "paint_silver",
+        "PMTG" => "paint_dolphin_gray_metalic",
+        "PMAB" => "paint_metalic_brown",
+        "PMMB" => "paint_metalic_blue",
+        "PSW"  => "paint_pearl_white",
+        "PSR"  => "paint_signature_red",
+        "RFBC" => "roof_body_color",
+        "RFPO" => "roof_panorama",
+        "WT19" => "wheel_silver_19",
+        "WT21" => "wheel_silver_21",
+        "WTSP" => "wheel_gray_21",
+        "IBSB" => "seats_base_textile",
+        "IZMB" => "seats_black_leather",
+        "IZMG" => "seats_gray_leather",
+        "IPMB" => "seats_performance_black_leather",
+        "IDPB" => "interior_piano_black",
+        "IDLW" => "interior_lacewood",
+        "IDOM" => "interior_obeche_wood_matte",
+        "IDCF" => "interior_carbon_fiber",
+        "IPMG" => "interior_performance_leather",
+        "TR00" => "no_third_row_seating",
+        "TR01" => "third_row_seating",
+        "SU00" => "no_air_suspension",
+        "SU01" => "air_suspension",
+        "SC00" => "no_supercharger",
+        "SC01" => "supercharger",
+        "AU00" => "no_audio_upgrade",
+        "AU01" => "audio_upgrade",
+        "CH00" => "no_second_charger",
+        "CH01" => "second_charger",
+        "HP00" => "no_hpwc_ordered",
+        "HP01" => "hpwc_ordered",
+        "PA00" => "no_paint_armor",
+        "PA01" => "pait_armor",
+        "PS00" => "no_parcel_shelf",
+        "PS01" => "parcel_shelf",
+        "TP00" => "no_tech_package",
+        "TP01" => "tech_package",
+        "AD02" => "power_adapter_nema_14-50",
+        "X001" => "power_lift_gate",
+        "X003" => "navigation",
+        "X007" => "premium_exterior_lighting",
+        "X011" => "homelink",
+        "X013" => "satellite_radio",
+        "X014" => "standard_radio",
+        "X019" => "performance_exterior",
+        "X020" => "no_performance_exterior",
+        "X024" => "performance_powertrain",
+        "X025" => "no_performance_powertrain",
+      }
+    end
+  end
+end
+

data/lib/tesla-api/vehicle_state.rb

@@ -0,0 +1,92 @@
+module TeslaAPI
+  # Defines the current vehicle state
+  class VehicleState < Data
+    ##
+    # :method: firmware_version
+    # Current firmware version
+
+    ##
+    # :method: sun_roof_installed?
+    # true if the vehicle is configured with the panoramic sun roof
+
+    ##
+    # :method: sun_roof_state
+    # Current state of the sun roof
+    # Potential values:
+    #   unknown
+    #   moving
+
+    ##
+    # :method: sun_roof_percent_open
+    # Percentage the sun roof is open
+
+    ##
+    # :method: driver_front_door_open?
+    # true if the driver's side front door is open
+
+    ##
+    # :method: driver_rear_door_open?
+    # true if the driver's side rear door is open
+
+    ##
+    # :method: passenger_front_door_open?
+    # true if the passenger's side front door is open
+
+    ##
+    # :method: passenger_rear_door_open
+    # true if the passenger's side rear door is open
+
+    ##
+    # :method: front_trunk_open?
+    # true if the front trunk (frunk) is open
+
+    ##
+    # :method: rear_trunk_open?
+    # true if the rear trunk is open
+
+    ##
+    # :method: locked?
+    # true if the doors are locked
+
+    ##
+    # :method: dark_rims?
+    # true if configured with dark colored rims
+
+    ##
+    # :method: spoiler?
+    # true if configured with a spoiler
+
+    ##
+    # :method: nineteen_inch_wheels?
+    # true if configured with nineteen inch wheels
+
+    ##
+    # :method: panoramic?
+    # true if configured with a panoramic roof
+
+    ##
+    # :method: perf?
+    # true if a performance configured vehicle
+
+    def initialize(data) # :nodoc:
+      ivar_from_data("firmware_version",          "car_version",           data)
+      ivar_from_data("sun_roof_installed",        "sun_roof_installed",    data)
+      ivar_from_data("sun_roof_state",            "sun_roof_state",        data)
+      ivar_from_data("sun_roof_percent_open",     "sun_roof_percent_open", data)
+      ivar_from_data("driver_front_door_open",    "df",                    data)
+      ivar_from_data("driver_rear_door_open",     "dr",                    data)
+      ivar_from_data("passenger_front_door_open", "pf",                    data)
+      ivar_from_data("passenger_rear_door_open",  "pr",                    data)
+      ivar_from_data("front_trunk_open",          "ft",                    data)
+      ivar_from_data("rear_trunk_open",           "rt",                    data)
+      ivar_from_data("locked",                    "locked",                data)
+      ivar_from_data("dark_rims",                 "dark_rims",             data)
+      ivar_from_data("spoiler",                   "has_spoiler",           data)
+
+      @nineteen_inch_wheels      = data["wheel_type"] == "Base19"
+      @panoramic                 = data["roof_color"] == "None"
+      @perf                      = data["perf_config"] != "Base"
+    end
+  end
+end
+

data/lib/tesla-api/version.rb

@@ -0,0 +1,4 @@
+module TeslaAPI # :nodoc:
+  # Version Number
+  VERSION = "0.0.1"
+end

data/tesla-api.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tesla-api/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "tesla-api"
+  gem.version       = TeslaAPI::VERSION
+  gem.authors       = ["Gavin Stark"]
+  gem.email         = ["gavin@gstark.com"]
+  gem.description   = %q{Implements the Tesla Model S HTTP API}
+  gem.summary       = %q{Implements the Tesla Model S HTTP API}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency 'httpclient', "~> 2.3.2"
+  gem.add_development_dependency 'vcr', "~> 2.4.0"
+  gem.add_development_dependency 'webmock', "~> 1.9.1"
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'vcr'
+require 'tesla-api'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'fixtures/vcr_cassettes'
+  c.hook_into :webmock
+end
+

data/test/test_charge_state.rb

@@ -0,0 +1,72 @@
+require 'helper'
+
+class ChargeStateTest < Test::Unit::TestCase
+  USER        = "user@example.com"
+  PASSWORD    = "password"
+  RECORD_MODE = :new_episodes
+
+  def charge_state
+    @charge_state ||= begin
+      VCR.use_cassette('charge_state', :record => RECORD_MODE) do
+        TeslaAPI::Connection.new(USER, PASSWORD).vehicle.charge_state
+      end
+    end
+  end
+
+  def test_charge_state
+    assert_equal "Disconnected", charge_state.charging_state
+  end
+
+  def test_supercharging
+    assert !charge_state.supercharging?
+  end
+
+  def test_charge_port_open
+    assert !charge_state.charge_port_open
+  end
+
+  def test_charge_rate_miles_per_hour
+    assert_equal -1.0, charge_state.charge_rate_miles_per_hour
+  end
+
+  def test_hours_to_full_charge
+    assert_equal nil, charge_state.hours_to_full_charge
+  end
+
+  def test_charge_power
+    assert_equal 0, charge_state.charger_power
+  end
+
+  def test_charger_actual_amperage
+    assert_equal 0, charge_state.charger_actual_amperage
+  end
+
+  def test_charger_pilot_amperage
+    assert_equal 0, charge_state.charger_pilot_amperage
+  end
+
+  def test_charger_voltage
+    assert_equal 0, charge_state.charger_voltage
+  end
+
+  def test_battery_current_flow
+    assert_equal -0.2, charge_state.battery_current_flow
+  end
+
+  def test_battery_percentage
+    assert_equal 70, charge_state.battery_percentage
+  end
+
+  def test_estimated_battery_range_miles
+    assert_equal 143.96, charge_state.estimated_battry_range_miles
+  end
+
+  def test_battery_range_miles
+    assert_equal 177.38, charge_state.battery_range_miles
+  end
+
+  def test_charging_to_max
+    assert !charge_state.charging_to_max?
+  end
+end
+