Merge branch 'release-2.8.2'

Author: Stephen Schiffli

Docs/gen_api_reference.sh

@@ -1,4 +1,4 @@
-appledoc -p "MetaWear iOS/macOS/tvOS API 2.8.1" --project-version "2.8.1" -c "MBIENTLAB INC" --company-id com.mbientlab --no-create-docset --no-repeat-first-par --ignore .m -o . ../MetaWear/Classes
+appledoc -p "MetaWear iOS/macOS/tvOS API 2.8.2" --project-version "2.8.2" -c "MBIENTLAB INC" --company-id com.mbientlab --no-create-docset --no-repeat-first-par --ignore .m -o . ../MetaWear/Classes
 open html/index.html
 
 make html

Docs/source/conf.py

@@ -55,9 +55,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '2.8.1'
+version = '2.8.2'
 # The full version, including alpha/beta/rc tags.
-release = '2.8.1'
+release = '2.8.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

Docs/source/metawear_manager.rst

@@ -21,7 +21,7 @@ It's simple to start scanning for advertising MetaWear devices using the `MBLMet
 
 ::
 
-    [[MBLMetaWearManager sharedManager] startScanForMetaWearsAllowDuplicates:NO handler:^(NSArray *array) {
+    [[MBLMetaWearManager sharedManager] startScanForMetaWearsAllowDuplicates:NO handler:^(NSArray<MBLMetaWear *> *array) {
         for (MBLMetaWear *device in array) {
             NSLog(@"Found MetaWear: %@", device);
         }
@@ -39,7 +39,7 @@ This feature is handy because the ``discoveryTimeRSSI`` property on the discover
     static const int MAX_ALLOWED_RSSI = -15; // The RSSI calculation sometimes produces erroneous values, we know anything above this value is invalid
     static const int MIN_ALLOWED_RSSI = -45; // Depending on your specific application this value will change!
      
-    [[MBLMetaWearManager sharedManager] startScanForMetaWearsAllowDuplicates:YES handler:^(NSArray *array) {
+    [[MBLMetaWearManager sharedManager] startScanForMetaWearsAllowDuplicates:YES handler:^(NSArray<MBLMetaWear *> *array) {
         for (MBLMetaWear *device in array) {
             // Reject any value above a reasonable range
             if (device.discoveryTimeRSSI.integerValue > MAX_ALLOWED_RSSI) {

MetaWear.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name               = 'MetaWear'
-  s.version            = '2.8.1'
+  s.version            = '2.8.2'
   s.license            = { :type => 'Commercial', :text => 'See https://www.mbientlab.com/terms/', :file => 'LICENSE' }
   s.homepage           = 'https://mbientlab.com'
   s.summary            = 'iOS/macOS/tvOS API and documentation for the MetaWear platform'

MetaWear/Classes/Core/MBLConstants.h

@@ -38,6 +38,7 @@
 @class MBLAccelerometerData;
 @class MBLDeviceInfo;
 @class MBLFirmwareBuild;
+@class MBLMetaWear;
 
 #if TARGET_OS_IOS || TARGET_OS_TV
 #import <UIKit/UIKit.h>
@@ -71,7 +72,8 @@ typedef NS_ENUM(uint8_t, MBLFirmwareVersion) {
     MBLFirmwareVersion1_2_4,
     MBLFirmwareVersion1_2_5,
     MBLFirmwareVersion1_3_0,
-    MBLFirmwareVersion1_3_1
+    MBLFirmwareVersion1_3_1,
+    MBLFirmwareVersion1_3_2
 };
 NSString *MBLFirmwareVersionString(MBLFirmwareVersion version);
 
@@ -85,14 +87,14 @@ typedef NS_ENUM(uint8_t, MBLModel) {
     MBLModelMetaWearRPro,
     MBLModelMetaWearC,
     MBLModelMetaWearCPro,
-    MBLModelMetaWearCEnv,
-    MBLModelMetaWearCDet,
-    MBLModelMetaWearHR,
-    MBLModelMetaWearPPG,
+    MBLModelMetaEnvironment,
+    MBLModelMetaDetector,
+    MBLModelMetaHealth,
     MBLModelMetaTracker,
     MBLModelMetaMotionR,
     MBLModelMetaMotionC
 };
+NSString *MBLModelString(MBLModel model);
 
 /**
  Verbosity of log messages coming from the MetaWear SDK
@@ -122,7 +124,7 @@ typedef void (^MBLVoidHandler)();
 typedef void (^MBLErrorHandler)(NSError *__nullable error);
 typedef void (^MBLDataHandler)(NSData *__nullable data, NSError *__nullable error);
 typedef void (^MBLObjectHandler)(id __nullable obj, NSError *__nullable error);
-typedef void (^MBLArrayHandler)(NSArray *__nonnull array);
+typedef void (^MBLArrayHandler)(NSArray<MBLMetaWear *> *__nonnull array);
 typedef void (^MBLArrayErrorHandler)(NSArray *__nullable array, NSError *__nullable error);
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wdeprecated-declarations"

MetaWear/Classes/Core/MBLConstants.m

@@ -36,7 +36,7 @@
 #import "MBLConstants.h"
 #import "MBLConstants+Private.h"
 
-NSString *const kMBLAPIVersion = @"2.8.1";
+NSString *const kMBLAPIVersion = @"2.8.2";
 
 NSString *MBLFirmwareVersionString(MBLFirmwareVersion version)
 {
@@ -71,6 +71,38 @@
             return @"1.3.0";
         case MBLFirmwareVersion1_3_1:
             return @"1.3.1";
+        case MBLFirmwareVersion1_3_2:
+            return @"1.3.2";
+    }
+}
+
+NSString *MBLModelString(MBLModel model)
+{
+    switch (model) {
+        case MBLModelUnknown:
+            return @"Unknown";
+        case MBLModelMetaWearR:
+            return @"MetaWear R";
+        case MBLModelMetaWearRG:
+            return @"MetaWear RG";
+        case MBLModelMetaWearRPro:
+            return @"MetaWear RPro";
+        case MBLModelMetaWearC:
+            return @"MetaWear C";
+        case MBLModelMetaWearCPro:
+            return @"MetaWear CPro";
+        case MBLModelMetaEnvironment:
+            return @"MetaEnvironment";
+        case MBLModelMetaDetector:
+            return @"MetaDetector";
+        case MBLModelMetaHealth:
+            return @"MetaHealth";
+        case MBLModelMetaTracker:
+            return @"MetaTracker";
+        case MBLModelMetaMotionR:
+            return @"MetaMotion R";
+        case MBLModelMetaMotionC:
+            return @"MetaMotion C";
     }
 }
 

MetaWear/Classes/Core/MBLEvent.m

@@ -42,6 +42,7 @@
 #import "MBLConversion.h"
 #import "MBLConstants+Private.h"
 #import "BFTask+MBLPrivate.h"
+#import "MBLDeviceInfo.h"
 
 
 @interface MBLEvent ()
@@ -503,8 +504,13 @@ - (MBLFilter *)periodicSampleOfEvent:(uint32_t)periodInMsec
 
     deltat_param_t params = {0};
     params.filter_id = 8;
-    params.datalen = self.format.length - 1;
-    params.filter_mode = 0;
+    if (self.module.device.dataProcessor.moduleInfo.moduleRevision == 0) {
+        params.datalen = self.format.length - 1;
+        params.filter_mode = 0;
+    } else {
+        params.datalen = 7; // This is now ignored by passthrough output mode
+        params.filter_mode = 2;
+    }
     uint32_t *tmp = (uint32_t *)params.deltat_ms;
     *tmp = periodInMsec;
 

MetaWear/Classes/Core/MBLMetaWear.h

@@ -262,6 +262,11 @@ typedef NS_ENUM(NSInteger, MBLConnectionState) {
  if you wish to change the advertised name, max 8 characters!
  */
 @property (nonatomic) NSString *name;
+/**
+ The model of this MetaWear.  This is only valid after a successful connection!
+ @see MBLModelString for turning this into a friendly string
+ */
+@property (nonatomic) MBLModel model;
 
 ///----------------------------------
 /// @name Connect/Disconnect
@@ -287,6 +292,13 @@ typedef NS_ENUM(NSInteger, MBLConnectionState) {
  */
 - (BFTask<MBLMetaWear *> *)disconnectAsync;
 
+/**
+ Create a task that will complete once this device disconnects, either expectedly
+ or unexpectedly.  This is useful for observing unexpected disconnects and
+ automatically issing a re-connect request or otherwise updating the UI.
+ */
+- (BFTask<MBLMetaWear *> *)waitForDisconnect;
+
 ///----------------------------------
 /// @name Remember/Forget
 ///----------------------------------
@@ -361,7 +373,7 @@ typedef NS_ENUM(NSInteger, MBLConnectionState) {
 /// @name Debug and Testing Utilities
 ///----------------------------------
 
-/*
+/**
  This causues the device to immediately disconnect with an error.  Useful for testing
  error handling flows.
  */

MetaWear/Classes/Core/MBLMetaWear.m

@@ -218,6 +218,7 @@ - (instancetype)initWithPeripheral:(id<MBLBluetoothPeripheral>)peripheral
         self.identifier = peripheral.identifier;
         self.nameImpl = peripheral.name;
         self.discoveryTimeRSSI = RSSI;
+        self.model = MBLModelUnknown;
 
         self.state = MBLConnectionStateDisconnected;
 
@@ -528,6 +529,7 @@ - (BFTask *)resetModulesAsync
                          self.photometer ? self.photometer : [NSNull null],
                          self.proximity ? self.proximity : [NSNull null],
                          self.sensorFusion ? self.sensorFusion : [NSNull null]];
+        self.model = [self calculateModelType];
 
         // Save this as the reset state of the device
         // Do this on the bleQueue so that we don't process events while the save state is happening
@@ -616,7 +618,7 @@ - (BFTask *)setConfigurationAsync:(id<MBLRestorable>)configuration
         [self removeResetFile];
 
         // When the disconnect occurs we know the device has been cleared and is ready for a fresh programming
-        [[self waitForDisconnection] continueOnMetaWearWithBlock:^id _Nullable(BFTask * _Nonnull t) {
+        [[self waitForDisconnect] continueOnMetaWearWithBlock:^id _Nullable(BFTask * _Nonnull t) {
             // Reconnect if we need to program the beast
             if (configuration) {
                 [[[self connectAsync] success:^(id  _Nonnull result) {
@@ -768,7 +770,7 @@ - (BFTask *)disconnectAsync
         switch (self.state) {
             case MBLConnectionStateConnected:
             {
-                BFTask *task = [self waitForDisconnection];
+                BFTask *task = [self waitForDisconnect];
                 [[self waitForCommandCompletion] continueOnMetaWearWithBlock:^id _Nullable(BFTask * _Nonnull t) {
                     self.state = MBLConnectionStateDisconnecting;
                     [[MBLMetaWearManager sharedManager] disconnectMetaWear:self fromPeripheralSide:YES];
@@ -780,22 +782,63 @@ - (BFTask *)disconnectAsync
             case MBLConnectionStateDiscovery:
             {
                 self.state = MBLConnectionStateDisconnecting;
-                BFTask *task = [self waitForDisconnection];
+                BFTask *task = [self waitForDisconnect];
                 [[self waitForCommandCompletion] continueOnMetaWearWithBlock:^id _Nullable(BFTask * _Nonnull t) {
                     [[MBLMetaWearManager sharedManager] disconnectMetaWear:self fromPeripheralSide:NO];
                     return nil;
                 }];
                 return task;
             }
             case MBLConnectionStateDisconnecting:
-                return [self waitForDisconnection];
+                return [self waitForDisconnect];
             case MBLConnectionStateDisconnected:
                 return nil;
         }
     }];
 }
 
-- (BFTask *)waitForDisconnection
+- (MBLModel)calculateModelType
+{
+    if ([self.deviceInfo.modelNumber isEqualToString:@"0"]) {
+        return MBLModelMetaWearR;
+    } else if ([self.deviceInfo.modelNumber isEqualToString:@"1"]) {
+        if (self.modules) {
+            if (self.barometer) {
+                return MBLModelMetaWearRPro;
+            } else {
+                return MBLModelMetaWearRG;
+            }
+        } else {
+            return MBLModelUnknown;
+        }
+    } else if ([self.deviceInfo.modelNumber isEqualToString:@"2"]) {
+        if (self.modules) {
+            if (self.proximity) {
+                return MBLModelMetaDetector;
+            } else if (self.hygrometer) {
+                return MBLModelMetaEnvironment;
+            } else if (self.magnetometer) {
+                return MBLModelMetaWearCPro;
+            } else {
+                return MBLModelMetaWearC;
+            }
+        } else {
+            return MBLModelUnknown;
+        }
+    } else if ([self.deviceInfo.modelNumber isEqualToString:@"3"]) {
+        return MBLModelMetaHealth;
+    } else if ([self.deviceInfo.modelNumber isEqualToString:@"4"]) {
+        return MBLModelMetaTracker;
+    } else if ([self.deviceInfo.modelNumber isEqualToString:@"5"]) {
+        return MBLModelMetaMotionR;
+    } else if ([self.deviceInfo.modelNumber isEqualToString:@"6"]) {
+        return MBLModelMetaMotionC;
+    } else {
+        return MBLModelUnknown;
+    }
+}
+
+- (BFTask<MBLMetaWear *> *)waitForDisconnect;
 {
     BFTaskCompletionSource *taskSource = [BFTaskCompletionSource taskCompletionSource];
     @synchronized(disconnectionSources) {
@@ -1113,6 +1156,13 @@ - (void)peripheral:(id<MBLBluetoothPeripheral>)peripheral didReadRSSI:(NSNumber
 
 - (BFTask<NSNumber *> *)readBatteryLifeAsync
 {
+    // Use the new age thing if we have it.
+    if (self.settings.batteryRemaining) {
+        return [[self.settings.batteryRemaining readAsync] continueWithSuccessBlock:^id _Nullable(BFTask<MBLNumericData *> * _Nonnull t) {
+            return t.result.value;
+        }];
+    }
+    // Fall back on the battery characteristic
     if (!batteryLifeCharacteristic) {
         return [BFTask taskWithError:[NSError errorWithDomain:kMBLErrorDomain
                                                          code:kMBLErrorNotConnected
@@ -1246,7 +1296,7 @@ - (BFTask *)prepareForFirmwareUpdateToVersionAsync:(MBLFirmwareBuild *)firmware
         }
         // Getting into DFU causes the device to disconnect, so we execute this
         // async to make sure our disconnection handler gets registered first.
-        BFTask *disconnectTask = [self waitForDisconnection];
+        BFTask *disconnectTask = [self waitForDisconnect];
         if (alreadyInDFU) {
             // See to simulate the disconnect that occurs when we jump to bootloader
             [[MBLMetaWearManager sharedManager] disconnectMetaWear:self fromPeripheralSide:NO];
@@ -1492,12 +1542,24 @@ -(void)peripheral:(id<MBLBluetoothPeripheral>)peripheral didUpdateValueForCharac
         if (!characteristic.value.length) {
             return;
         }
-        uint8_t moduleId = *(uint8_t *)characteristic.value.bytes;
-        @synchronized(moduleInfoTaskSources) {
-            BFTaskCompletionSource *source = moduleInfoTaskSources[[NSNumber numberWithInt:moduleId]];
-            if (source) {
+        uint8_t *bytes = (uint8_t *)characteristic.value.bytes;
+        uint8_t moduleId = *bytes; bytes++;
+        uint8_t registerId = *bytes;
+        // The first register is special and should only be read during initialization
+        if (registerId == 0x80) {
+            @synchronized(moduleInfoTaskSources) {
+                BFTaskCompletionSource *source = moduleInfoTaskSources[[NSNumber numberWithInt:moduleId]];
+                if (!source) {
+                    // If another app tries to connect to this MetaWear it could issue these discovery
+                    // commands again, so lets track any unexpected reads of the these registers and use that
+                    // as an indicator someone is trying to use 2 apps simultaneously which is very
+                    // dangerous and unsupported.  Our only option is to disconnect this app.
+                    MBLLog(MBLLogLevelWarning, @"Simultaneous Connection - Disconnecting %@ because another App has initiated a connection", self);
+                    [[MBLMetaWearManager sharedManager] disconnectMetaWear:self fromPeripheralSide:NO];
+                }
                 [moduleInfoTaskSources removeObjectForKey:[NSNumber numberWithInt:moduleId]];
                 if (error) {
+                    // TODO: This can probably never be hit
                     [source trySetError:error];
                 } else if (characteristic.value.length >= 4) {
                     // 4 or more bytes indicates the module is present and active
@@ -1507,22 +1569,27 @@ -(void)peripheral:(id<MBLBluetoothPeripheral>)peripheral didUpdateValueForCharac
                     [source trySetResult:nil];
                 }
                 [self decrementCount];
-            } else if (moduleId < self.modules.count) {
-                id module = self.modules[moduleId];
-                if ([module respondsToSelector:@selector(recievedData:error:)]) {
-                    [module recievedData:characteristic.value error:error];
-                } else {
-                    assert(NO && "No module found");
-                }
-            } else if (moduleId == self.testDebug.moduleInfo.moduleId) {
-                if ([self.testDebug respondsToSelector:@selector(recievedData:error:)]) {
-                    [self.testDebug recievedData:characteristic.value error:error];
-                } else {
-                    assert(NO && "No testDebug module found");
-                }
+            }
+        } else if (moduleId < self.modules.count) {
+            id module = self.modules[moduleId];
+            if ([module respondsToSelector:@selector(recievedData:error:)]) {
+                [module recievedData:characteristic.value error:error];
+            } else {
+                assert(NO && "No module found");
+            }
+        } else if (moduleId == self.testDebug.moduleInfo.moduleId) {
+            if ([self.testDebug respondsToSelector:@selector(recievedData:error:)]) {
+                [self.testDebug recievedData:characteristic.value error:error];
+            } else {
+                assert(NO && "No testDebug module found");
             }
         }
     } else if (characteristic == batteryLifeCharacteristic) {
+        if (!characteristic.value.length) {
+            // Retry if no data received
+            [peripheral readValueForCharacteristic:characteristic];
+            return;
+        }
         @synchronized(batteryLifeSources) {
             for (BFTaskCompletionSource *source in batteryLifeSources) {
                 if (error) {