Lattis SDK for iOS

Dependencies

• Oval.framework (Lattis networking API)
• KeychainSwift
• CryptoSwift

Installation

Add this line to your Podfile

pod 'LattisSDK'

run

pod install

If you have any errors with previous step please run

pod repo update

If you want to use previous version use tag v1.1.5 or

pod 'LattisSDK', '1.1.5'

Usage

Add LattisSDKToken (String) to you Info.plist

Import

import LattisSDK

Delegates

public protocol EllipseManagerDelegate: class {

    func manager(_ lockManager: EllipseManager, didRestoreConnected locks: [Ellipse])
    // Called when new locks discovered or old ones become not available
    // insert - contains only newly discovered locks
    // delete - contains not reachable locks
    // you can use lockManager.locks to get whole list of available locks
    func manager(_ lockManager: EllipseManager, didUpdateLocks insert: [Ellipse], delete: [Ellipse])

    // Called when state of bluetooth is changing
    func manager(_ lockManager: EllipseManager, didUpdateConnectionState connected: Bool)
}

public protocol EllipseDelegate: class {

    // Called when connection state of lock is changing
    // connection - represents current connection state of the lock
    func ellipse(_ ellipse: Ellipse, didUpdate connection: Ellipse.Connection)

    // Called when lock's security state changing (lock/unlock/etc)
    func ellipse(_ ellipse: Ellipse, didUpdate security: Ellipse.Security)

    // Called when lock's dynamic values changing (magnitude/battery level/RSSI)
    func ellipse(_ ellipse: Ellipse, didUpdate value: Ellipse.Value)
}

Find locks

EllipseManager.shared.scan(with: self)

or you can subscribe to EllipseManager updates if scan() was already called from other class.

EllipseManager.shared.subscribe(handler: self)

• self (or any other object instance) should confirm to EllipseManagerDelegate protocol

Call

EllipseManager.shared.stopScan()

if you don't need to discover new locks anymore.

You don't need to unsubscribe classes from EllipseManager updates. It will be done automatically. There is no strong references to handlers.

Connect to the lock

let ellipse: Ellipse = EllipseManager.shared.locks.first
ellipse?.connect(handler: self)

or you can subscribe to lock updates if it's already connected

ellipse?.subscribe(self)

• self (or any other object instance) should confirm to EllipseDelegate protocol

Call

ellipse?.disconnect()

if you want to disconnect the lock.

Other features

Manage captive touch panel (FW => 2.75)

You can disable or enable captive touch panel

ellipse?.isCapTouchEnabled = false // true by default

• isCapTouchEnabled == nil means you don't have it's state yet. You can receive updates for that value in didUpdate value delegate method

Manage magnet auto lock (FW => 2.75)

You can manage magnetometer based auto lock feature

ellipse?.isMagnetAutoLockEnabled = true // false by default

• isMagnetAutoLockEnabled == nil means you don't have it's state yet. You can receive updates for that value in didUpdate value delegate method.

Shackle position check (FW => 2.75)

You can check if shackle is inserted or not.

ellipse?.isShackleInserted

You can receive updates for that value in didUpdate value delegate method.

Example

You can find Lattis Demo directory in the root of this repository. It contains live demo project, demonstrating SDK API's usage.

React Native support

This library has Rect Native support. You can find example project in following directory ReactNative/RNLattisSDK. Visit wiki page for more information on adding LattisSDK manually (without Cocoapods) to your React Native project.

Background mode

This SDK will work in background automatically if you switch on Uses Bluetooth LE accessories in the app Capabilities settings