TeslaSwift

Swift library to access Tesla API based on Tesla JSON API (Unofficial)

Installation

Manual

Copy Sources folder into your project

CocoaPods

If you don't need any extensions, use this line

pod 'TeslaSwift', '~> 6'

If you need PromiseKit extensions, use this line

pod 'TeslaSwift/PromiseKit', '~> 6'

If you need Combine extensions, use this line

pod 'TeslaSwift/Combine', '~> 6'

If you need Rx extensions, use this line

pod 'TeslaSwift/Rx', '~> 6'

Swift Package Manager

You can use Swift Package Manager and specify a dependency in Package.swift by adding this or adding the dependency to Xcode:

.Package(url: "https://github.com/jonasman/TeslaSwift.git", majorVersion: 6)

There are also extensions for Combine TeslaSwiftCombine, PromiseKit TeslaSwiftPMK and Rx TeslaSwiftRx

Usage

Tesla's server is not fully compatible with ATS so you need to add the following to your app Info.plist

<key>NSAppTransportSecurity</key>
<dict>
    <key>NSAllowsArbitraryLoads</key>
    <true/>
</dict>

Import the module

import TeslaSwift

Add the extension modules as needed (with the previous line)

import TeslaSwiftPMK

import TeslaSwiftCombine

import TeslaSwiftRx

Perform an authentication with your My Tesla credentials:

let api = TeslaSwift()
api.authenticate(email: email, password: password) {
    (result: Result<AuthToken, Error>) in
    switch result {
        case .success(let token):
            // Logged in
        case .failure(let error):
            // Failed

    }
}

Or if you use PromiseKit you can check the success:

api.authenticate(email: email, password: password)
.done { (result) in
    // Logged In!
}.catch { (error) in
    print("Error: \(error as NSError)")
}

Example

class ViewController {
    func showCars() {
        api.getVehicles()
        .done { (response) in
            self.data = response
            self.tableView.reloadData()
        }.catch { (error) in
            //Process error
   }
}

Streaming

class ViewController {

  func showStream() {
    api.openStream(vehicle: myVehicle, dataReceived: {
                    (event: TeslaStreamEvent) in
                    switch event {
                    case .open:
                    case .event(let streamEvent):
                        self.data.append(streamEvent)
                        self.tableView.reloadData()
                    case .error(let error):                    
                        //Process error
                    case .disconnet:
                        break
                    }
                })

    // After some events...
    api.closeStream()
   }
}

Encoder and Decoder

If you need a JSON Encoder and Decoder, the library provides both already configured to be used with Tesla's JSON formats

public let teslaJSONEncoder: JSONEncoder
public let teslaJSONDecoder: JSONDecoder

Options

You can use the mock server by setting: api.useMockServer = true

You can enable debugging by setting: api.debuggingEnabled = true

Other Features

After the authentication is done. The library manages itself the access token. When the token expires the library will perform another authentication with your past credentials.

Roadmap

6.x

Add new API features and summon

Referral

If you want to buy a Tesla or signup for the mailing list using my referral as a "thank you" for this library here it is: http://ts.la/joao290

Apps using this library

Key for Tesla (https://itunes.apple.com/us/app/key-for-tesla/id1202595802?mt=8)
Camper for Tesla (https://itunes.apple.com/us/app/camper-for-tesla/id1227483065?mt=8)
Power for Tesla (https://itunes.apple.com/us/app/power-for-tesla/id1194710823?mt=8)
Plus - for Tesla Model S & X (https://itunes.apple.com/us/app/plus-for-tesla-model-s-x/id1187829197?mt=8)
Nikola for Tesla (https://itunes.apple.com/us/app/nikola-for-tesla/id1244489779?mt=8)
Charged - for Tesla (https://getcharged.app/)

Missing your app? open a PR or issue

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

davidhodge/TeslaSwift