Merge branch 'release-2.10.0'

Author: Stephen Schiffli

Docs/gen_api_reference.sh

@@ -1,4 +1,4 @@
-appledoc -p "MetaWear iOS/macOS/tvOS API 2.9.0" --project-version "2.9.0" -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.10.0" --project-version "2.10.0" -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/advanced_features.rst

@@ -28,7 +28,7 @@ The properties of the configuration objected are automatically persisted to disk
 Updating Firmware
 -----------------
 
-The firmware running on the MetaWear is periodically updated by MbientLab with additional features and bug-fixes.  To update, you first call a MetaWear API which puts the device in a special bootloader mode, then use the Nordic Semiconductor `IOS-DFU-Librarly <https://github.com/NordicSemiconductor/IOS-DFU-Library>`_ to upload the new firmware.  We recommend looking at our `Sample App <https://github.com/mbientlab/Metawear-SampleiOSApp>`_ for an example on how to integrate.
+The firmware running on the MetaWear is periodically updated by MbientLab with additional features and bug-fixes.  To update, you first call a MetaWear API which puts the device in a special bootloader mode, then use the Nordic Semiconductor `IOS-DFU-Librarly <https://github.com/NordicSemiconductor/IOS-DFU-Library>`_ to upload the new firmware.  We recommend looking at our `Sample App <https://github.com/mbientlab/MetaWear-SampleApp-iOS>`_ for an example on how to integrate.
 
 This is one API you can call WITHOUT being connected, there are some cases where you can't connect because the firmware is too old, but you still need to be able to update it!
 

Docs/source/conf.py

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

Docs/source/gen_api_reference.sh

@@ -1,4 +1,4 @@
-appledoc -p "MetaWear iOS/macOS/tvOS API 2.9.0" --project-version "2.9.0" -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.10.0" --project-version "2.10.0" -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/metawearboard.rst

@@ -14,10 +14,15 @@ Bluetooth LE Connection
 -----------------------
 Before using any API features, you must first connect to the board with `connectAsync <https://mbientlab.com/docs/metawear/ios/latest/Classes/MBLMetaWear.html#//api/name/connectAsync>`_.  The returned task will finish when a connection has been established and the ``MBLMetaWear`` state has been initialized.  ::
 
-    device.connectAsync().success { _ in
-        print("Connected")
-    }.failure { error in
-        print("Failed to connect", error)
+    device.connectAsync().continueOnDispatch { t in
+        if t.isCancelled {
+            print("disconnectAsync() called before connection completed")
+        } else if t.isFaulted {
+            print("Connection Error: \(t.error?.localizedDescription ?? "N/A")")
+        } else {
+            print("Connection Success")
+        }
+        return t
     }
 
 There is also a convenient `connectWithTimeoutAsync <https://mbientlab.com/docs/metawear/ios/latest/Classes/MBLMetaWear.html#//api/name/connectWithTimeoutAsync:>`_ which will finish when the connection is complete, or timeout seconds have passed.  If a timeout occurs, the task will get an error of kMBLErrorDomain and kMBLErrorConnectionTimeout code.  ::
@@ -106,7 +111,7 @@ Since we do not support using a single MetaWear device with multiple application
 Identifier
 ----------
 
-Apple generates a unique identifier for each BLE device.  Note, two different Apple devices will generate two different identifiers for the same MetaWear.
+Apple generates a unique identifier for each BLE device.  Note, two different Apple devices will generate two different identifiers for the same MetaWear.  It might be useful to use ``device.mac`` instead.
 
 ::
 
@@ -129,3 +134,13 @@ MetaWear modules, represented by the `MBLModule <https://mbientlab.com/docs/meta
 * Requested module is not supported on the board  
 * Board is in MetaBoot mode  
 * Has not yet connected
+
+Sleep Mode
+----------
+
+Use the ``sleepModeOnReset`` function to put the device in a low-power sleep mode after the next reset.  To wake the device back up you can press the button, connect usb power (latest models only), or remove and reconnect the coin cell battery.
+
+::
+
+    [device sleepModeOnReset];
+    [device resetDevice];

Docs/source/settings.rst

@@ -73,10 +73,11 @@ Event representing a BLE disconnection event.  Note this doesn't make sense to s
 MAC Address
 -----------
 
-Get the MAC address of the MetaWear.
+Get the MAC address of the MetaWear.  As of SDK 2.10.0 this is now automaticaly cached upon connection and avaliable at ``device.mac``.
 
 ::
 
+    print(device.mac)
     device.settings?.macAddress?.readAsync().success { mac in
         print(mac)
     }

MetaWear.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name               = 'MetaWear'
-  s.version            = '2.9.0'
+  s.version            = '2.10.0'
   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/Categories/BFTask+MBLExtensions.h

@@ -88,6 +88,6 @@ typedef __nullable id(^MBLExtensionsContinuationBlock)(BFTask<ResultType> *t);
 @end
 
 
-extern void MBLForceLoadCategory_BFTask_MBLExtensions();
+extern void MBLForceLoadCategory_BFTask_MBLExtensions(void);
 
 NS_ASSUME_NONNULL_END

MetaWear/Classes/Categories/BFTask+MBLExtensions.m

@@ -45,7 +45,7 @@ + (BFExecutor *)dispatchExecutor
     static BFExecutor *singleton;
     static dispatch_once_t onceToken = 0;
     dispatch_once(&onceToken, ^{
-        singleton = [BFExecutor executorWithBlock:^void(void(^block)()) {
+        singleton = [BFExecutor executorWithBlock:^void(void(^block)(void)) {
             [[MBLMetaWearManager dispatchQueue] addOperationWithBlock:block];
         }];
     });

MetaWear/Classes/Core/MBLAnonymousEvent.h

@@ -0,0 +1,50 @@
+/**
+ * MBLAnonymousEvent.h
+ * MetaWear
+ *
+ * Created by Stephen Schiffli on 9/22/17.
+ * Copyright 2017 MbientLab Inc. All rights reserved.
+ *
+ * IMPORTANT: Your use of this Software is limited to those specific rights
+ * granted under the terms of a software license agreement between the user who
+ * downloaded the software, his/her employer (which must be your employer) and
+ * MbientLab Inc, (the "License").  You may not use this Software unless you
+ * agree to abide by the terms of the License which can be found at
+ * www.mbientlab.com/terms.  The License limits your use, and you acknowledge,
+ * that the Software may be modified, copied, and distributed when used in
+ * conjunction with an MbientLab Inc, product.  Other than for the foregoing
+ * purpose, you may not use, reproduce, copy, prepare derivative works of,
+ * modify, distribute, perform, display or sell this Software and/or its
+ * documentation for any purpose.
+ *
+ * YOU FURTHER ACKNOWLEDGE AND AGREE THAT THE SOFTWARE AND DOCUMENTATION ARE
+ * PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, TITLE,
+ * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL
+ * MBIENTLAB OR ITS LICENSORS BE LIABLE OR OBLIGATED UNDER CONTRACT, NEGLIGENCE,
+ * STRICT LIABILITY, CONTRIBUTION, BREACH OF WARRANTY, OR OTHER LEGAL EQUITABLE
+ * THEORY ANY DIRECT OR INDIRECT DAMAGES OR EXPENSES INCLUDING BUT NOT LIMITED
+ * TO ANY INCIDENTAL, SPECIAL, INDIRECT, PUNITIVE OR CONSEQUENTIAL DAMAGES, LOST
+ * PROFITS OR LOST DATA, COST OF PROCUREMENT OF SUBSTITUTE GOODS, TECHNOLOGY,
+ * SERVICES, OR ANY CLAIMS BY THIRD PARTIES (INCLUDING BUT NOT LIMITED TO ANY
+ * DEFENSE THEREOF), OR OTHER SIMILAR COSTS.
+ *
+ * Should you have any questions regarding your right to use this Software,
+ * contact MbientLab via email: hello@mbientlab.com
+ */
+
+#import <MetaWear/MBLEvent.h>
+@class MBLDataSample;
+
+/**
+ Pared down variant of the MBLEvent interface that can only be used to
+ retrieve logged data from a board that was programmed elsewhere.
+ */
+@interface MBLAnonymousEvent : MBLEvent<MBLDataSample *>
+
+/*
+ String identifying the data producer chain
+ */
+@property (nonatomic, readonly, nullable) NSString *identifier;
+
+@end