Giter VIP home page Giter VIP logo

teslaswift's Introduction

Swift Build Status TeslaSwift

TeslaSwift

Swift library to access the Tesla Model S API based on Unofficial Tesla Model S API

Installation

Manual

Copy Sources folder into your project

CocoaPods

	pod 'TeslaSwift', '~> 4'

Swift Package Manager

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

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

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

Perform an authentication with your My Tesla credentials:

let api = TeslaSwift()
api.authenticate(email: email, password: password)

Use the promise to check the success:

.then { (result) -> Void in
	
	//LogedIn!
	
}.catch { (error) in 
	print("Error: \(error as NSError)")			
}

Example

class ViewController {

  func showCars() {

    api.getVehicles()
		.then { (response) -> Void in
			
			self.data = response
			self.tableView.reloadData()
			
		}.catch { (error) in
			//Process error
   }
}

Streaming

class ViewController {

  func showStream() {

    api.openStream(vehicle: myVehicle, dataReceived: {
					(event: StreamEvent?, error: Error?) in
					
					if event != nil {
						self.data.append(event)
						self.tableView.reloadData()
					} else {
						//Process error
					}
				})
				
	// After some events...
	api.closeStream()
   }
}

Encoder e 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

4.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)

Missing your app? open a PR or issue

Licence

The MIT License (MIT)

Copyright (c) 2016 João Nunes

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.

teslaswift's People

Contributors

creemerica avatar jakeholland avatar jonasman avatar simengjermundsen avatar thedarkcode avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.