An unofficial NodeJS library that encapsulates the Tesla RESTful API. This library supports all existing Tesla vehicles.
It is important to acknowledge that there are already several very good Javascript libraries available for the Tesla. So why create another one? Rather than contribute to or modify one or more of the existing libraries, this library was created for two main reasons:
- The anticipated need for a few small but important features that existing libraries did not provide
- I was looking for a personal opportunity to learn more about the Tesla REST API, NodeJS, Express and Git/GitHub
With the introduction of the new OAuth-based owner API, one of the features I wanted was the ability to make API calls without having to login each time a new process was invoked. Many existing libraries require a login transaction with each initiation of the library. With the TeslaJS library, once an auth token is retrieved it can be retrieved and used to make other REST API calls. For certain use cases this can be important for moderating load on the Tesla login servers. This is also important if you want to use the library to do server-based data logging. It is generally safer to store an OAuth token on the server instead of logon credentials. If the OAuth token is compromised all existing tokens can be invalidated by changing the password on the account.
Another feature that I wanted was API stateless-ness (achieved via an options parameter to API calls) so that it was possible to use the library to make multiple overlapping async calls for different vehicles for data-logging.
Here are some of the most recent features and fixes:
- With 1.0.32 the testla sample now simulates charging and supercharging!
- With 1.0.34 added homelink support.
- Started working on calendar support beginning with 1.0.36
- Streaming now works as of 1.0.38, see simpleStreaming sample!
- The testla sample is still in active development. Suggestions are welcome but please hold bug reports.
- The homelink API seems to require Autopilot. Can someone with AP test and report back?
- Calendar support not yet functional.
The Tesla REST API encapusulated by this library was documented through the collaboration of many Tesla owners. Please thank and support them for their efforts. The current REST API documentation can be found at:
http://docs.timdorr.apiary.io/
You may use this library with the understanding that doing so is AT YOUR OWN RISK. No warranty, express or implied, is made with regards to the fitness or safety of this code for any purpose. If you use this library to query or change settings of your vehicle you understand that it is possible to make changes that could inadvertently lower the security of your vehicle, or cause damage, through actions including but not limited to:
- Unlocking the vehicle
- Remotely starting the vehicle
- Opening the sunroof
- Opening the frunk or trunk
- Lowering the battery charge level
- Impacting the long-term health of your battery
In order to use the library and/or samples you must first download and install NodeJS.
An installable module for npm is now available. To download and install the library and all of its dependencies to a local project directory use the following:
npm install teslajs
If you are building an npm package that depends upon this library then you will want to use the --save parameter in order to update the package.json file for your package as follows:
npm install teslajs --save
If you prefer to download and install the library globally for all future node projects you may use:
npm install -g teslajs
You may also install directly from the GitHub source. Either download and unzip the source, or clone the repository.
Remember, whether you install via npm, ZIP source or Git clone you must install the dependencies before using TeslaJS.
To install dependencies via npm, from the root level of the library directory type:
npm install
This library and its accomanying samples are under active development. New features, samples and bug fixes are being added regularly. To ensure that you have the very latest version of TeslaJS and it's dependencies be sure to update frequently. To do so, from your project directory type:
npm update
As you can see below, it is very simple to login and acquire an OAuth token.
var tjs = require('TeslaJS');
var username = "<your MyTesla email>";
var password = "<your MyTesla password>";
tjs.login(username, password, function(result) {
if (result.error) {
console.log(JSON.stringify(result.error));
process.exit(1);
}
var token = JSON.stringify(result.authToken);
if (token)
console.log("Login Successfull!");
});Note: Currently the only way to invalidate an issued token is to change your MyTesla account password. Therefore, you must take care to properly secure tokens. Do not share them over an unsecure connection, or store them on a public machine.
With the OAuth token from a successful login() call you can query the vehicles for the account:
var options = { authToken: result.authToken };
tjs.vehicles(options, function (vehicle) {
console.log("Vehicle " + vehicle.vin + " is: " + vehicle.state);
});Adding the vehicle ID from a successful vehicles() call to options you can make other Tesla REST calls:
options.vehicleID = vehicle.id_s;
tjs.chargeState(options, function (chargeState) {
console.log("Current charge level: " + chargeState.battery_level + '%');
});The TeslaJS library exports a number of methods and constants. The library also responds to some environment variables.
Environment Variables
TESLAJS_LOG - if set defines the value of the default logging level
TESLAJS_SERVER - if set defines the URI for the Tesla servers (e.g. set to http://127.0.0.1:3000)
General API calls
setLogLevel() - sets the level of debug logging
getLogLevel() - gets the level of debug logging
setPortalBaseURI() - sets the server for testing, pass null to reset
getPortalBaseURI() - gets the server
login() - authenticate with Tesla servers and retrieve the OAuth token
logout() - delete the current OAuth token
vehicles() - retrieve list of vehicles and option data
API calls for a given vehicle id
chargeState() - retrieve the charge_state data
chargeStandard() - set the charge limit to 90%
chargeMaxRange() - sets the charge limit to 100%
climateState() - retrieve the climate_state data
climateStart() - turn on the HVAC system
climateStop() - turn off the HVAC system
closeChargePort() - close the charge port on appropriately equipped vehicles
doorLock() - locks the doors
doorUnlock() - unlocks the doors
driveState() - retrieve the drive_state data
flashLights() - flashes the headlights
guiSettings() - retrieves the GUI settings
homelink() - Triggers homelink from the vehicle
honkHorn() - honks the horn
mobileEnabled() - returns whether mobile access is enabled
startCharge() - initiates a charging session
stopCharge() - terminates a charging session
openChargePort() - opens the charge port
openTrunk() - open the trunk or frunk
remoteStart() - enables remote starting of the car
resetValetPin() - reset the valet pin
setChargeLimit() - sets the charge limit to a specific amount
setTemps() - set driver/passenger temp set points (in Deg.C)
setValetMode() - set/reset valet mode
startStreaming() - initiate a streaming data session
sunRoofControl() - put the sunroof into a specific state
sunRoofMove() - open the sunroof to a specific percent
vehicleState() - retrieve the vehicle_state data
wakeUp() - attempt to wake a sleeping vehicle
Library exported constants
streamingPortal - the URI for the streaming API portal
portal - the base URI for the OAuth-based API portal
API_CALL_LEVEL - log all API calls
API_RETURN_LEVEL - log all API calls and completions
API_REQUEST_LEVEL - log all API requests
API_RESPONSE_LEVEL - log all API responses
API_BODY_LEVEL - log calls and completions as well as the body of POST commands
API_LOG_ALL - the highest level of logging
CHARGE_STORAGE - charge to 50%
CHARGE_STANDARD - charge to 90%
CHARGE_RANGE - charge to 100%. Tesla recommends against frequent usage!
SUNROOF_OPEN - fully opens the sunroof
SUNROOF_CLOSED - closes the sunroof
SUNROOF_VENT - open the sunroof to the vent position
SUNROOF_COMFORT - open the sunroof to the comfort position
streamingColumns - an array of the available streaming columns
Most of the APIs take both an options parameter and an optional callback function. The options parameter must always contain a member called authToken that contains the OAuth token returned from a successfull login(). For all APIs that act on a specific vehicle the options parameter must also contain a vehicleID member that contains the long vehicle ID value returned from a successful call to vehicles().
By default the vehicles() API returns information on the first vehicle returned. By providing a carIndex member in the options parameter information on a specific vehicle can be queried.
A number of samples are provided in the Examples directory. These demonstrate some basic usage scenarios for the library. To use the samples first:
cd Examples
After running the login sample an auth token will be cached locally. If you prefer to avoid keeping an auth token on your machine, provide login credentials on the command line for each sample. This will perform a login request and keep the token only for the duration of the sample. The difference lies in whether you are more comfortable with the security of a file associated with an account in your file system vs. the visibility of your login credentials in the process table for the lifetime of the sample.
login - Login and acquire an OAuth token. Cached to the local directory
logout - Delete the locally cached OAuth token if present
climate - Display the current state of the HVAC system
climateStart - Turn on the HVAC system
climateStop - Turn off the HVAC system
flashLights - Flash the headlights
geoloc - Display the current GPS location of the vehicle
guiSettings - Display the current unit format settings
homelink - Trigger homelink (note appears to require AP hardware)
honkHorn - Honk the horn
mobileEnabled - Display whether remote access is enabled
odometer - Displays the current odometer value
openChargePort - Opens the charge port
resetValetPin - Resets the valet mode pin
remoteStart - Enables driving without the key fob present
setChargeLimit - Set the battery charge limit to the given value
setTemps - Set the driver and passenger temperatures to the given value
simpleStreaming- Demonstrates basic use of the streaming API
soc - Displays the current battery State of Charge (SOC) for the vehicle
startCharge - Initiate a charging session
stopCharge - Terminate a charging session
sunroof - Control the sunroof. Be careful!
testla - Express app that mimics the Tesla REST API for testing
valet - Enable or disable valet mode
vehicle - Retrieve and display information on the current vehicle state
wakeup - Send a wakeup command to the vehicle
This sample demonstrates the basic login process which returns the OAuth token required for other API calls. The sample writes out a file called .token which stores the OAuth token. Other samples will use this cached token if present to avoid the need to enter the username and password and login via the Tesla servers.
If you prefer not to have your OAuth token stored locally do not run this sample. Instead you may run the samples and provide the username and password each time on the command line.
Usage:
node login.js [options] username password
Options:
-h, --help output usage information
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample deletes the locally cached .token file if present.
Usage:
node logout.js
This sample retrieves and displays the climate_state data on the HVAC system of the vehicle.
Usage:
node climate.js [options]
Options:
-h, --help output usage information
-u, --username [string] username (needed only if token not cached)
-p, --password [string] password (needed only if token not cached)
-i, --index <n> vehicle index (first car by default)
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample demonstrates turning on the HVAC system of the vehicle.
Usage:
node climateStart.js [options]
Options:
-h, --help output usage information
-u, --username [string] username (needed only if token not cached)
-p, --password [string] password (needed only if token not cached)
-i, --index <n> vehicle index (first car by default)
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample demonstrates turning off the HVAC system of the vehicle.
Usage:
node climateStop.js [options]
Options:
-h, --help output usage information
-u, --username [string] username (needed only if token not cached)
-p, --password [string] password (needed only if token not cached)
-i, --index <n> vehicle index (first car by default)
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample demonstrates flashing the headlights of the vehicle.
Usage:
node flashLights.js [options]
Options:
-h, --help output usage information
-u, --username [string] username (needed only if token not cached)
-p, --password [string] password (needed only if token not cached)
-i, --index <n> vehicle index (first car by default)
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample retrieves and displays information on the location and driving state of the car using the drive_state query.
Usage:
node geoloc.js [options]
Options:
-h, --help output usage information
-u, --username [string] username (needed only if token not cached)
-p, --password [string] password (needed only if token not cached)
-g, --geocode geocode (reverse geocode to nearest address)
-i, --index <n> vehicle index (first car by default)
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample retrieves and displays the current display formats for the user interface.
Usage:
node guiSettings.js [options]
Options:
-h, --help output usage information
-u, --username [string] username (needed only if token not cached)
-p, --password [string] password (needed only if token not cached)
-i, --index <n> vehicle index (first car by default)
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample demonstrates triggering homelink via the vehicle.
Note: This feature appears to be tied to the presence of Autopilot hardware and software. Looking for validation on both AP and pre-AP vehicles.
Usage:
node homelink.js [options]
Options:
-h, --help output usage information
-u, --username [string] username (needed only if token not cached)
-p, --password [string] password (needed only if token not cached)
-i, --index <n> vehicle index (first car by default)
-n, --name [string] Either phone Bluetooth name or homelink door name
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample demonstrates honking the horn of the vehicle.
Usage:
node honkHorn.js [options]
Options:
-h, --help output usage information
-u, --username [string] username (needed only if token not cached)
-p, --password [string] password (needed only if token not cached)
-i, --index <n> vehicle index (first car by default)
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample retrieves and displays whether mobile access is enabled.
Usage:
node mobileEnabled.js [options]
Options:
-h, --help output usage information
-u, --username [string] username (needed only if token not cached)
-p, --password [string] password (needed only if token not cached)
-i, --index <n> vehicle index (first car by default)
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample retrieves and displays the current vehicle odometer value.
Usage:
node odometer.js [options]
Options:
-h, --help output usage information
-u, --username [string] username (needed only if token not cached)
-p, --password [string] password (needed only if token not cached)
-i, --index <n> vehicle index (first car by default)
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample sends the command to open the charge port.
Usage:
node openChargePort.js [options]
Options:
-h, --help output usage information
-u, --username [string] username (needed only if token not cached)
-p, --password [string] password (needed only if token not cached)
-i, --index <n> vehicle index (first car by default)
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample enables remotely starting the vehicle without a key fob present. Note that the password parameter is required in this sample.
Usage:
node remoteStart.js [options] password
Options:
-h, --help output usage information
-u, --username [string] username (needed only if token not cached)
-i, --index <n> vehicle index (first car by default)
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample attempts to reset the current valet pin.
Usage:
node resetValetPin.js [options]
Options:
-h, --help output usage information
-u, --username [string] username (needed only if token not cached)
-p, --password [string] password (needed only if token not cached)
-i, --index <n> vehicle index (first car by default)
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample sets the current battery charge limit to the given value.
Usage:
node setChargeLimit.js [options] number|standard|storage|range
Options:
-h, --help output usage information
-u, --username [string] username (needed only if token not cached)
-p, --password [string] password (needed only if token not cached)
-i, --index <n> vehicle index (first car by default)
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample sets the driver and passenger temperature to the given value.
Usage:
node setTemps.js [options] temperature
Options:
-h, --help output usage information
-u, --username [string] username (needed only if token not cached)
-p, --password [string] password (needed only if token not cached)
-i, --index <n> vehicle index (first car by default)
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample demonstrates basic use of the streaming API to retrieve real-time vehicle data.
Usage:
node simpleStreaming.js [options] username
Options:
-h, --help output usage information
-p, --password [string] password (needed only if token not cached)
-i, --index <n> vehicle index (first car by default)
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample retrieves the charge_state information and displays the charge limit, the current vehicle charge level, and the ideal, rated and projected range.
Usage:
node soc.js [options]
Options:
-h, --help output usage information
-u, --username [string] username (needed only if token not cached)
-p, --password [string] password (needed only if token not cached)
-i, --index <n> vehicle index (first car by default)
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample demonstrates how to initiate a charging session.
Usage:
node startCharge.js [options]
Options:
-h, --help output usage information
-u, --username [string] username (needed only if token not cached)
-p, --password [string] password (needed only if token not cached)
-i, --index <n> vehicle index (first car by default)
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample demonstrates how to terminate a charging session.
Usage:
node stopCharge.js [options]
Options:
-h, --help output usage information
-u, --username [string] username (needed only if token not cached)
-p, --password [string] password (needed only if token not cached)
-i, --index <n> vehicle index (first car by default)
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample demonstrates controlling the panoramic sunroof if present.
Usage:
node sunroof.js [options] percentage|open|close|vent|comfort
Options:
-h, --help output usage information
-u, --username [string] username (needed only if token not cached)
-p, --password [string] password (needed only if token not cached)
-i, --index <n> vehicle index (first car by default)
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample is an Express app that mimics the Tesla servers and implements the full REST API surface area. There is now a web interface for this app. Point your web browser to http://127.0.0.1:3000.
Note: the app is still fairly basic and in many cases simply returns success results. It does not validate input parameters including the OAuth token and vehicleID. Streaming is not yet emulated. It does now track vehicle state changes on the server. The web interface does not yet allow for changing vehicle state values.
Note that at this time the sample uses the JADE templating engine. Jade has recently been renamed to PUG. The sample will be updated in a future release. Until then you must explicitly npm install JADE under Express.
Usage:
node testla.js [options]
Options:
-h, --help output usage information
-P, --port port for the server (default: 3000)
This sample retrives and displays several elements of data returned from the vehicle_state REST API.
Usage:
node vehicle.js [options]
Options:
-h, --help output usage information
-u, --username [string] username (needed only if token not cached)
-p, --password [string] password (needed only if token not cached)
-i, --index <n> vehicle index (first car by default)
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample enables or disables valet mode.
Usage:
node valet.js [options] ON|OFF pincode
Options:
-h, --help output usage information
-u, --username [string] username (needed only if token not cached)
-p, --password [string] password (needed only if token not cached)
-i, --index <n> vehicle index (first car by default)
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)
This sample sends a wakeup signal to wake a vehicle in sleep mode.
Usage:
node wakeup.js [options]
Options:
-h, --help output usage information
-u, --username [string] username (needed only if token not cached)
-p, --password [string] password (needed only if token not cached)
-i, --index <n> vehicle index (first car by default)
-U, --uri [string] URI of test server (e.g. http://127.0.0.1:3000)