Merge pull request #53 from SomaticLabs/multiple-device-types

Added support for multiple hardware versions

Author: ajaykarpur

README.md

@@ -46,25 +46,27 @@ $ brew install carthage
 To integrate SwiftyZorb into your Xcode project using Carthage, specify it in your `Cartfile`:
 
 ```ogdl
-github "SomaticLabs/SwiftyZorb" ~> 2.0
+github "SomaticLabs/SwiftyZorb" ~> 3.0
 ```
 
 Run `carthage update` to build the framework and drag the built `SwiftyZorb.framework` into your Xcode project.
 
-You must also drag the built dependencies `Alamofire.framework`, `SwiftyBluetooth.framework`, and `SwiftyJSON.framework` into your project.
+You must also drag the built dependencies `Alamofire.framework`, `SwiftyBluetooth.framework`,  `SwiftyJSON.framework`, and `SwiftProtobuf.framework` into your project.
 
 ## Single Device Usage
 
 There are two ways to use this libary. If you intend to connect and reconnect to one Zorb peripheral device, use the following methods.
 
 ### Connecting
 
-Before being able to communicate with a Zorb peripheral device, you must establish a Bluetooth LE connection with your device.
+Before being able to communicate with a Zorb peripheral device, you must establish a Bluetooth LE connection with your device. 
+
+The `withVersion` parameter is used to specify which version of Zorb hardware you are using. If you are unsure which hardware you have, please [contact us](mailto:developers@somaticlabs.io).
 
 ```swift
 import SwiftyZorb
 
-SwiftyZorb.connect { result in
+SwiftyZorb.connect(withVersion: .V2) { result in
     switch result {
     case .success:
         // Connected succeeded
@@ -193,7 +195,7 @@ If you would like to manage connections with multiple Zorb peripheral devices, y
 
 ```swift
 // Retrieves a list all available devices as an array of `ZorbDevice` objects.
-SwiftyZorb.retrieveAvailableDevices { result in
+SwiftyZorb.retrieveAvailableDevices(withVersion: .V2) { result in
     switch result {
     case .success(let devices):
         // Retrieval succeeded

SwiftyZorb/Info.plist

@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>2.4.0</string>
+	<string>3.0.0</string>
 	<key>CFBundleVersion</key>
 	<string>$(CURRENT_PROJECT_VERSION)</string>
 	<key>NSPrincipalClass</key>

SwiftyZorb/Internal/BluetoothManager.swift

@@ -49,14 +49,19 @@ final internal class BluetoothManager: NSObject {
     /**
      Called to initiate connection with Zorb peripheral, handles reconnection process based on this logical diagram: ![Reconnection flow chart](https://developer.apple.com/library/content/documentation/NetworkingInternetWeb/Conceptual/CoreBluetooth_concepts/Art/ReconnectingToAPeripheral_2x.png "Reconnection workflow")
      */
-    func connect(completion: @escaping ConnectPeripheralCallback) {
+    func connect(withVersion version: ZorbDevice.Version, completion: @escaping ConnectPeripheralCallback) {
         // Identifier and services for device of interest
         var uuid: UUID?
         let services: [CBUUID]
 
         // Check if we have connected to this peripheral before, and get it's UUID and associated services
         uuid = Settings.getZorbPeripheral()
-        services = Identifiers.AdvertisedServices
+        switch version {
+        case .V1:
+            services = Identifiers.V1.AdvertisedServices
+        case .V2:
+            services = Identifiers.V2.AdvertisedServices
+        }
 
         // If we do, try to connect to it
         if let uuid = uuid {
@@ -75,7 +80,7 @@ final internal class BluetoothManager: NSObject {
                         }
 
                         // Update internal `ZorbDevice` and handle in completion
-                        self.device = ZorbDevice(with: peripheral)
+                        self.device = ZorbDevice(with: peripheral, andVersion: version)
                         completion(.success(value))
                     case .failure(let error):
                         // Treat as error and handle in completion
@@ -104,7 +109,7 @@ final internal class BluetoothManager: NSObject {
                             Settings.saveZorbPeripheral(with: peripheral.identifier)
 
                             // Update internal `ZorbDevice` and handle in completion
-                            self.device = ZorbDevice(with: peripheral)
+                            self.device = ZorbDevice(with: peripheral, andVersion: version)
                             completion(.success(value))
                         case .failure(let error):
                             // Treat as error and handle in completion
@@ -150,7 +155,7 @@ final internal class BluetoothManager: NSObject {
                             }
 
                             // Update internal `ZorbDevice` and handle in completion
-                            self.device = ZorbDevice(with: peripheral)
+                            self.device = ZorbDevice(with: peripheral, andVersion: version)
                             completion(.success(value))
                         case .failure(let error):
                             // Treat as error and handle in completion
@@ -173,18 +178,24 @@ final internal class BluetoothManager: NSObject {
     /**
      Scans for and retrieves a collection of available Zorb devices
     */
-    func retrieveAvailableDevices(completion: @escaping (Result<[ZorbDevice]>) -> Void) {
+    func retrieveAvailableDevices(withVersion version: ZorbDevice.Version, completion: @escaping (Result<[ZorbDevice]>) -> Void) {
         // Initialize collection of available peripherals
         var peripherals: [ZorbDevice] = []
 
         // Get associated Zorb device services
-        let services = Identifiers.AdvertisedServices
+        let services: [CBUUID]
+        switch version {
+        case .V1:
+            services = Identifiers.V1.AdvertisedServices
+        case .V2:
+            services = Identifiers.V2.AdvertisedServices
+        }
 
         // First add any already connected peripherals to our collection
         let connectedPeripherals = central.retrieveConnectedPeripherals(withServiceUUIDs: services)
         for peripheral in connectedPeripherals {
             if Constants.deviceNames.contains(peripheral.name ?? "Unknown") {
-                peripherals.append(ZorbDevice(with: peripheral))
+                peripherals.append(ZorbDevice(with: peripheral, andVersion: version))
             }
         }
 
@@ -203,7 +214,7 @@ final internal class BluetoothManager: NSObject {
 
                 // Check if found peripheral is the one we're trying to connect to
                 if Constants.deviceNames.contains(peripheral.name ?? "Unknown") {
-                    peripherals.append(ZorbDevice(with: peripheral))
+                    peripherals.append(ZorbDevice(with: peripheral, andVersion: version))
                 }
             case .scanStopped(let error):
                 // The scan stopped, an error is passed if the scan stopped unexpectedly

SwiftyZorb/Internal/Identifiers.swift

@@ -26,22 +26,7 @@ internal struct Identifiers {
     /// `CBUUID` for identifying the serial number string characteristic
     static let SerialNumberStringCharacteristicUUID = CBUUID(string: "2A25")
 
-    // MARK: - Zorb Specific Bluetooth Service UUIDs
-    
-    /// Array of `CBUUID`s representing all services that Zorb device should advertise
-    static let AdvertisedServices = [CBUUID]() // FIXME: Eventually replace with [HapticTimelineServiceUUID]
-    
-    /// `CBUUID` that advertises the haptic timeline service
-    static let HapticTimelineServiceUUID = CBUUID(string: "A28E9217-E9B5-4C0A-9217-1C64D051D762")
-    
-    /// `CBUUID` that advertises the setttings characteristic
-    static let SettingsCharacteristicUUID = CBUUID(string: "A28EFC07-E9B5-4C0A-9217-1C64D051D762")
-    
-    /// `CBUUID` for identifying the basic actuator control characteristic
-    static let ActuatorCharacteristicUUID = CBUUID(string: "A28EFC05-E9B5-4C0A-9217-1C64D051D762")
-    
-    /// `CBUUID` for identifying the pattern trigger characteristic
-    static let PatternTriggerCharacteristicUUID = CBUUID(string: "A28EFC08-E9B5-4C0A-9217-1C64D051D762")
+    // MARK: - UART Service UUIDs
 
     /// `CBUUID` for identifying the Nordic UART service
     static let NordicUARTServiceUUID = CBUUID(string: "6E400001-B5A3-F393-E0A9-E50E24DCCA9E")
@@ -52,4 +37,42 @@ internal struct Identifiers {
     /// `CBUUID` for identifying the Nordic UART RX characteristic
     static let NordicUARTRXCharacteristicUUID = CBUUID(string: "6E400002-B5A3-F393-E0A9-E50E24DCCA9E")
 
+    // MARK: - Zorb Specific Bluetooth Service UUIDs
+    
+    // Identifiers for hardware V1 devices
+    struct V1 {
+        /// Arrays of `CBUUID`s representing all services that Zorb device should advertise
+        static let AdvertisedServices = [CBUUID]() // FIXME: Eventually replace with [HapticTimelineServiceUUID_V1]
+        
+        /// `CBUUID`s that advertises the haptic timeline service
+        static let HapticTimelineServiceUUID = CBUUID(string: "A28E9217-E9B5-4C0A-9217-1C64D051D762")
+        
+        /// `CBUUID`s that advertises the setttings characteristic
+        static let SettingsCharacteristicUUID = CBUUID(string: "A28EFC07-E9B5-4C0A-9217-1C64D051D762")
+        
+        /// `CBUUID` for identifying the basic actuator control characteristic
+        static let ActuatorCharacteristicUUID = CBUUID(string: "A28EFC05-E9B5-4C0A-9217-1C64D051D762")
+        
+        /// `CBUUID` for identifying the pattern trigger characteristic
+        static let PatternTriggerCharacteristicUUID = CBUUID(string: "A28EFC08-E9B5-4C0A-9217-1C64D051D762")
+    }
+    
+    // Identifiers for hardware V2 devices
+    struct V2 {
+        /// Arrays of `CBUUID`s representing all services that Zorb device should advertise
+        static let AdvertisedServices = [CBUUID]() // FIXME: Eventually replace with [HapticTimelineServiceUUID_V2]
+        
+        /// `CBUUID`s that advertises the haptic timeline service
+        static let HapticTimelineServiceUUID = CBUUID(string: "D6E59217-D763-47FA-A092-C24EE6DF29D3")
+        
+        /// `CBUUID`s that advertises the setttings characteristic
+        static let SettingsCharacteristicUUID = CBUUID(string: "D6E5FC07-D763-47FA-A092-C24EE6DF29D3")
+        
+        /// `CBUUID` for identifying the basic actuator control characteristic
+        static let ActuatorCharacteristicUUID = CBUUID(string: "D6E5FC05-D763-47FA-A092-C24EE6DF29D3")
+        
+        /// `CBUUID` for identifying the pattern trigger characteristic
+        static let PatternTriggerCharacteristicUUID = CBUUID(string: "D6E5FC08-D763-47FA-A092-C24EE6DF29D3")
+    }
+    
 }

SwiftyZorb/Public/SwiftyZorb.swift

@@ -13,13 +13,13 @@ import SwiftyJSON
 // MARK: Bluetooth Management Methods
 
 /**
- Scans for and retrieves a collection of available Zorb devices.
+ Scans for and retrieves a collection of available Zorb devices with a given hardware version (either V1 or V2) as enumerated in `ZorbDevice.Version`.
 
  Usage Example:
 
  ```swift
  // Retrieves a list all available devices as an array of `ZorbDevice` objects.
- SwiftyZorb.retrieveAvailableDevices { result in
+ SwiftyZorb.retrieveAvailableDevices(withVersion: .V2) { result in
     switch result {
     case .success(let devices):
         // Retrieval succeeded
@@ -32,12 +32,58 @@ import SwiftyJSON
  }
  ```
  */
+public func retrieveAvailableDevices(withVersion version: ZorbDevice.Version, completion: @escaping (SwiftyBluetooth.Result<[ZorbDevice]>) -> Void) {
+    bluetoothManager.retrieveAvailableDevices(withVersion: version) { result in completion(result) }
+}
+
+/**
+ Maintaining backwares compatibility, scans for and retrieves a collection of available Zorb devices with V1 hardware.
+ 
+ Usage Example:
+ 
+ ```swift
+ // Retrieves a list all available devices as an array of `ZorbDevice` objects.
+ SwiftyZorb.retrieveAvailableDevices(withVersion: .V2) { result in
+     switch result {
+     case .success(let devices):
+        // Retrieval succeeded
+        for device in devices {
+            // Do something with devices
+        }
+     case .failure(let error):
+        // An error occurred during retrieval
+     }
+ }
+ ```
+ */
+@available(*, deprecated, message: "Please specify hardware version with `withVersion` parameter.")
 public func retrieveAvailableDevices(completion: @escaping (SwiftyBluetooth.Result<[ZorbDevice]>) -> Void) {
-    bluetoothManager.retrieveAvailableDevices { result in completion(result) }
+    bluetoothManager.retrieveAvailableDevices(withVersion: .V1) { result in completion(result) }
+}
+
+/**
+ Initiates a connection to an advertising Zorb device with a given hardware version (either V1 or V2) as enumerated in` ZorbDevice.Version`.
+ 
+ Usage Example:
+ 
+ ```swift
+ // Attempts connection to an advertising device
+ SwiftyZorb.connect(withVersion: .V2) { result in
+    switch result {
+    case .success:
+        // Connect succeeded
+    case .failure(let error):
+        // An error occurred during connection
+    }
+ }
+ ```
+ */
+public func connect(withVersion version: ZorbDevice.Version, completion: @escaping ConnectPeripheralCallback) {
+    bluetoothManager.connect(withVersion: version) { result in completion(result) }
 }
 
 /**
- Initiates a connection to an advertising Zorb device.
+ Maintaining backwares compatibility, initiates a connection to an advertising Zorb device with V1 hardware.
 
  Usage Example:
 
@@ -53,8 +99,9 @@ public func retrieveAvailableDevices(completion: @escaping (SwiftyBluetooth.Resu
  }
  ```
  */
+@available(*, deprecated, message: "Please specify hardware version with `withVersion` parameter.")
 public func connect(completion: @escaping ConnectPeripheralCallback) {
-    bluetoothManager.connect { result in completion(result) }
+    bluetoothManager.connect(withVersion: .V1) { result in completion(result) }
 }
 
 /**

SwiftyZorb/Public/ZorbDevice.swift

@@ -17,6 +17,17 @@ import Alamofire
  */
 final public class ZorbDevice {
 
+    // MARK: - Version Enumeration
+    
+    /// Differentiates between different hardware versions
+    public enum Version: Int {
+        // First hardware iteration
+        case V1 = 1
+        
+        // Second hardware iteration
+        case V2 = 2
+    }
+    
     // MARK: - Class Properties
 
     /// `SwiftyBluetooth` peripheral for device
@@ -25,16 +36,20 @@ final public class ZorbDevice {
     /// `PacketQueue` for storing Javascript packets to be sent
     private var packetQueue: PacketQueue
 
+    /// `Version` of hardware for a given device
+    private let hardwareVersion: Version
+    
     // MARK: - Initialization
 
     /**
-     Public initializer, only requires peripheral associated with given device
+     Internal initializer, only requires peripheral associated with given device
 
      - Parameter peripheral: 
      */
-    internal init(with peripheral: Peripheral) {
+    internal init(with peripheral: Peripheral, andVersion version: Version) {
         self.peripheral = peripheral
         self.packetQueue = PacketQueue()
+        self.hardwareVersion = version
     }
 
     // MARK: - Private Connection Management Methods
@@ -47,8 +62,17 @@ final public class ZorbDevice {
      - Parameter characteristic: The `UUID` of the characteristic being written to
      */
     private func writeBytes(_ bytes: Data, to characteristic: CBUUID, completion: @escaping WriteRequestCallback) {
+        // Get appropriate CBUUID
+        let hapticTimelineServiceUUID: CBUUID
+        switch self.hardwareVersion {
+        case .V1:
+            hapticTimelineServiceUUID = Identifiers.V1.HapticTimelineServiceUUID
+        case .V2:
+            hapticTimelineServiceUUID = Identifiers.V2.HapticTimelineServiceUUID
+        }
+        
         // Write data to settings characteristic
-        peripheral.writeValue(ofCharacWithUUID: characteristic, fromServiceWithUUID: Identifiers.HapticTimelineServiceUUID, value: bytes) { result in
+        peripheral.writeValue(ofCharacWithUUID: characteristic, fromServiceWithUUID: hapticTimelineServiceUUID, value: bytes) { result in
             completion(result)
         }
     }
@@ -319,13 +343,22 @@ final public class ZorbDevice {
      - Parameter bottomRight: Intensity, in a range from 0 to 100, for the bottom right actuator to be set at.
      */
     public func writeActuators(duration: UInt16, topLeft: UInt8, topRight: UInt8, bottomLeft: UInt8, bottomRight: UInt8, completion: @escaping WriteRequestCallback) {
+        // Get appropriate CBUUID
+        let actuatorCharacteristicUUID: CBUUID
+        switch self.hardwareVersion {
+        case .V1:
+            actuatorCharacteristicUUID = Identifiers.V1.ActuatorCharacteristicUUID
+        case .V2:
+            actuatorCharacteristicUUID = Identifiers.V2.ActuatorCharacteristicUUID
+        }
+        
         // Determine data to send
         let duration0: UInt8 = UInt8(duration & 0x00FF)
         let duration1: UInt8 = UInt8(duration >> 8)
         let data = Data(bytes: [duration0, duration1, topLeft, topRight, bottomLeft, bottomRight])
 
         // Write actuator data to Zorb device
-        self.writeBytes(data, to: Identifiers.ActuatorCharacteristicUUID) { result in completion(result) }
+        self.writeBytes(data, to: actuatorCharacteristicUUID) { result in completion(result) }
     }
 
     /**
@@ -521,8 +554,18 @@ final public class ZorbDevice {
      - Parameter pattern: The `Trigger` enumeration option of the given preloaded pattern to trigger
     */
     public func triggerPattern(_ pattern: Trigger, completion: @escaping WriteRequestCallback) {
+        // Get appropriate CBUUID
+        let patternTriggerCharacteristicUUID: CBUUID
+        switch self.hardwareVersion {
+        case .V1:
+            patternTriggerCharacteristicUUID = Identifiers.V1.PatternTriggerCharacteristicUUID
+        case .V2:
+            patternTriggerCharacteristicUUID = Identifiers.V2.PatternTriggerCharacteristicUUID
+        }
+        
+        // Send byte for associated pattern
         let byte = Data(pattern.rawValue.utf8.map{ UInt8($0) })
-        self.writeBytes(byte, to: Identifiers.PatternTriggerCharacteristicUUID) {
+        self.writeBytes(byte, to: patternTriggerCharacteristicUUID) {
             result in completion(result)
         }
     }