Skip to content

Latest commit

 

History

History
108 lines (75 loc) · 4.99 KB

README.md

File metadata and controls

108 lines (75 loc) · 4.99 KB
Raw

Tesla Model S Rest API

Build Status

A Java implementation of the client side interface to the Tesla Model S API documented at:

Note: This version of the library corresponds to the "owner" API from Tesla which came about in the same timeframe as version 6 of the car software. This version is completely incompatible with the old Tesla API and the old version of this library. If you want to continue to use the older library, please refer to tag 0.5.

This is unofficial documentation of the Tesla Model S REST API used by the iOS and Android apps. It features functionality to monitor and control the Model S remotely. The documents are updated as new information is found.

This software and documentation do not come from Tesla Motors Inc.

Be careful when using this software as it can lock and unlock your car as well as control various functions relating to the charging system, sun roof, lights, horn, and other subsystems of the car.

Be careful not to send your login and password to anyone other than Tesla or you are giving away the authentication details required to control your car.

Disclaimer

Use these programs at your own risk. The authors do not guaranteed the proper functioning of these applications. This code attempts to use the same interfaces used by the official Tesla phone apps. However, it is possible that use of this code may cause unexpected damage for which nobody but you are responsible. Use of these functions can change the settings on your car and may have negative consequences such as (but not limited to) unlocking the doors, opening the sun roof, or reducing the available charge in the battery.

Contributors

Joe Pasqua

Greyson Fischer

James Burke

Preparing your build environment (gradle)

The following command will resolve and download all dependencies, set up the classpath, and create the JAR file. This allows the Tesla project to be included in other gradle builds in the usual way (using settings.gradle)

    > gradle assemble

Preparing your build environment (Ant/NetBeans)

This project assumes a directory structure that looks like this:

Tesla					-- Overall container that may include other Tesla related projects
	TeslaClient			-- This project
		build
		src
ThirdParty				-- A repository for third party library dependencies
	apache
		commons-codec-1.11
		commons-lang3-3.8.1
		commons-logging-1.2
	geocoder
	google-gson-2.8.5
	resty

The Tesla/TeslaClient directory corrsponds to this github project (TeslaClient.git).

The following commands will create and populate the hierarchy. It assumes that:

  • $ROOTis where the Tesla and ThirdParty directories will reside

Be sure to either set these variables or adapt the commands below:

cd $ROOT
mkdir $ROOT/Tesla
mkdir $ROOT/ThirdParty
mkdir $ROOT/ThirdParty/apache
mkdir $ROOT/ThirdParty/geocoder-java
mkdir $ROOT/ThirdParty/resty

# Download the TeslaClient repo
cd $ROOT/Tesla
git clone https://github.com/jbct/TeslaClient.git

# Download the apache libraries
cd $ROOT/ThirdParty/apache
curl -s -O http://mirrors.gigenet.com/apache/commons/codec/binaries/commons-codec-1.11-bin.zip
unzip commons-codec-1.11-bin.zip
rm commons-codec-1.11-bin.zip

curl -s -O http://mirrors.ibiblio.org/apache/commons/lang/binaries/commons-lang3-3.8.1-bin.zip
unzip commons-lang3-3.8.1-bin.zip
rm commons-lang3-3.8.1-bin.zip

curl -s -O http://mirror.reverse.net/pub/apache//commons/logging/binaries/commons-logging-1.2-bin.zip
unzip commons-logging-1.2-bin.zip
rm commons-logging-1.2-bin.zip

# Download the geocoder library
cd $ROOT/ThirdParty/geocoder-java
curl -s -O http://central.maven.org/maven2/com/google/code/geocoder-java/geocoder-java/0.16/geocoder-java-0.16.jar

# Download the gson library
cd $ROOT/ThirdParty
curl -s -O https://github.com/google/gson/archive/gson-parent-2.8.5.zip
unzip gson-parent-2.8.5.zip
rm gson-parent-2.8.5.zip

# Download the resty library
cd $ROOT/ThirdParty
cd resty
curl -s -O http://repo2.maven.org/maven2/us/monoid/web/resty/0.3.2/resty-0.3.2.jar

Tests and Samples

There are two test programs included in the project: BasicTest and Interactive. The former simply runs through a sequence of functions in the client library to demonstrate that it is connecting and working. The second presents an interactive shell that allows the user to issue the various commands that are available through the client library.

To use either of these programs you must have active credentials for a Tesla vehicle that has remote access enabled. If you have more than one vehicle, you may select which vehicle to use in the Interactive program. BasicTest will always use the first vehicle returned by the Tesla portal.