Imported v3.0.0 beta03

Author: scaryghost

README.md

@@ -21,7 +21,7 @@ Then, add the compile element to the dependencies closure in the module's *build
 
 ```gradle
 dependencies {
-    compile 'com.mbientlab:metawear:3.0.0-beta02'
+    compile 'com.mbientlab:metawear:3.0.0-beta03'
 }
 ```
 

library/build.gradle

@@ -31,8 +31,8 @@ android {
     defaultConfig {
         minSdkVersion 18
         targetSdkVersion 24
-        versionCode 39
-        versionName "3.0.0-beta02"
+        versionCode 41
+        versionName "3.0.0-beta03"
     }
     buildTypes {
         release {

library/src/main/java/com/mbientlab/metawear/AsyncDataProducer.java

@@ -24,31 +24,11 @@
 
 package com.mbientlab.metawear;
 
-import com.mbientlab.metawear.builder.RouteBuilder;
-import com.mbientlab.metawear.builder.filter.Comparison;
-import com.mbientlab.metawear.builder.filter.ComparisonOutput;
-import com.mbientlab.metawear.builder.function.Function2;
-
-import bolts.Task;
-
 /**
  * Interrupt driven data producer
  * @author Eric Tsai
  */
-public interface AsyncDataProducer {
-    /**
-     * Adds a route to direct where the data will go
-     * @param builder   Builder object to construct the route
-     * @return Created route
-     */
-    Task<Route> addRoute(RouteBuilder builder);
-    /**
-     * Unique name identifying the data, used for data processor loops
-     * @return DataToken name
-     * @see com.mbientlab.metawear.builder.RouteElement#filter(Comparison, ComparisonOutput, String...)
-     * @see com.mbientlab.metawear.builder.RouteElement#map(Function2, String...)
-     */
-    String name();
+public interface AsyncDataProducer extends DataProducer {
     /**
      * Starts producing data
      */

library/src/main/java/com/mbientlab/metawear/DataProducer.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2014-2015 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.
+ */
+
+package com.mbientlab.metawear;
+
+import com.mbientlab.metawear.builder.RouteBuilder;
+import com.mbientlab.metawear.builder.RouteElement;
+import com.mbientlab.metawear.builder.filter.Comparison;
+import com.mbientlab.metawear.builder.filter.ComparisonOutput;
+import com.mbientlab.metawear.builder.function.Function2;
+
+import bolts.Task;
+
+/**
+ * A component connected to the board that creates data
+ * @author Eric Tsai
+ */
+public interface DataProducer {
+    /**
+     * Adds a route to direct where the data will go
+     * @param builder   Builder object to construct the route
+     * @return Created route
+     */
+    Task<Route> addRoute(RouteBuilder builder);
+    /**
+     * Unique name identifying the data for feedback loops
+     * @return DataToken name
+     * @see RouteElement#filter(Comparison, ComparisonOutput, String...)
+     * @see RouteElement#map(Function2, String...)
+     */
+    String name();
+}

library/src/main/java/com/mbientlab/metawear/ForcedDataProducer.java

@@ -24,31 +24,11 @@
 
 package com.mbientlab.metawear;
 
-import com.mbientlab.metawear.builder.RouteBuilder;
-import com.mbientlab.metawear.builder.filter.Comparison;
-import com.mbientlab.metawear.builder.filter.ComparisonOutput;
-import com.mbientlab.metawear.builder.function.Function2;
-
-import bolts.Task;
-
 /**
  * Data creator that only produces data when a {@link #read()} command is issued
- * @author Erici Tsai
+ * @author Eric Tsai
  */
-public interface ForcedDataProducer {
-    /**
-     * Adds a route to direct where the data will go
-     * @param builder   Builder object to construct the route
-     * @return Created route
-     */
-    Task<Route> addRoute(RouteBuilder builder);
-    /**
-     * Unique name identifying the data, used for data processor loops
-     * @return DataToken name
-     * @see com.mbientlab.metawear.builder.RouteElement#filter(Comparison, ComparisonOutput, String...)
-     * @see com.mbientlab.metawear.builder.RouteElement#map(Function2, String...)
-     */
-    String name();
+public interface ForcedDataProducer extends DataProducer {
     /**
      * Sends a read command to the producer
      */

library/src/main/java/com/mbientlab/metawear/MetaWearBoard.java

@@ -129,14 +129,16 @@ interface UnexpectedDisconnectHandler {
     /**
      * Retrieves a reference to the requested module if supported.  You must connected to the board before
      * calling this function and the board must not be in MetaBoot mode
-     * @param moduleClass    Module class to lookup
+     * @param moduleClass   Module class to lookup
+     * @param <T>           Runtime type the return value is casted as
      * @return Reference to the requested module, null if the board is not connected, module not supported, or board is in MetaBoot mode
      */
     <T extends Module> T getModule(Class<T> moduleClass);
     /**
      * Retrieves a reference to the requested module if supported, throws a checked exception if the function fails.
      * You must connected to the board before calling this function and the board must not be in MetaBoot mode
-     * @param moduleClass    ModuleId class to lookup
+     * @param moduleClass   ModuleId class to lookup
+     * @param <T>           Runtime type the return value is casted as
      * @return Reference to the requested module
      * @throws UnsupportedModuleException If the requested module is not supported or the board is in MetaBoot mode
      */

library/src/main/java/com/mbientlab/metawear/UnsupportedModuleException.java

@@ -29,6 +29,8 @@
  * @author Eric Tsai
  */
 public class UnsupportedModuleException extends Exception {
+    private static final long serialVersionUID = -2869845467241050695L;
+
     /**
      * Creates an exception with the given message
      * @param msg    Data to accompany the exception

library/src/main/java/com/mbientlab/metawear/android/BtleService.java

@@ -608,18 +608,26 @@ public File findFile(String filename) {
             }
             return mwBoards.get(btDevice);
         }
-
+        /**
+         * Removes the MetaWearBoard object associated with the BluetoothDevice object
+         * @param btDevice    BluetoothDevice object corresponding to the target MetaWear board
+         */
         public void removeMetaWearBoard(final BluetoothDevice btDevice) {
             mwBoards.remove(btDevice);
         }
-
+        /**
+         * Removes the saved serialized state of the MetaWearBoard object associated with the BluetoothDevice object
+         * @param btDevice    BluetoothDevice object corresponding to the target MetaWear board
+         */
         public void clearSerializedState(final BluetoothDevice btDevice) {
             SharedPreferences.Editor editor= BtleService.this.getSharedPreferences(btDevice.getAddress(), MODE_PRIVATE).edit();
             editor.remove(MODULE_INFO);
             editor.remove(BOARD_STATE);
             editor.apply();
         }
-
+        /**
+         * Removes cached firmware files from the Android device
+         */
         public void clearFirmwareCache() {
             File firmwareDir = new File(getFilesDir(), FIRMWARE_DIR_NAME);
             for(File it: firmwareDir.listFiles()) {

library/src/main/java/com/mbientlab/metawear/android/package-info.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2014-2015 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.
+ */
+
+/** Android specific classes implementing the {@link com.mbientlab.metawear.impl.Platform} interface */
+package com.mbientlab.metawear.android;

library/src/main/java/com/mbientlab/metawear/builder/RouteElement.java

@@ -158,7 +158,7 @@ interface Action {
     RouteElement map(Function2 fn, String ... dataNames);
 
     /**
-     * Reduce the amount of data allowed through such that the output data rate matches the period
+     * Reduce the amount of data allowed through such that the output data rate matches the delay
      * @param period    How often to allow data through, in milliseconds (ms)
      * @return Object representing the output of the limiter
      */