Cordova Plugin

Cordova plugin for the MetaWear API. This is currently a work in progress. The API is very fluid and breaking changes are likely until things are a bit more feature complete.

##Supported Sensors *Accelerometer *GPIO Pins *RSSI *Gyroscope

##Getting Started:

Create your Cordova project

cordova create <your project>

Add in the plugin

cordova plugin add http://www.github.com/mbientlab-projects/cordova-plugin-metawear.html

Add in your platform

cordova platform add android
cordova platform add ios

Load Device.js in your javascript.

Head over to https://github.com/mbientlab-projects/metawear_cordova_example for a simple example project.

##Using The Plugin

Currently the project supports the following functions:

• Connecting and Disconnecting to the board
• Reading the RSSI for the device.
• Streaming accelerometer data.

This module currently support IOS and Android. If you would like to see support for other platforms please open an issue.

Methods are called from the metawear.mwdevice object. Callbacks take the form of

var mycallback = function(result){
   // your code here
}

##Supported Methods

###Connect

Connects to the specified board. The success callback is also used for disconnect.

mbientlab.mwdevice.connect(macAddressOfBoard, succesCallback, failureCallback);

###Disconnect

Disconnects from the board. Sends a disconnect message to the success callback of connect.

mbientlab.mwdevice.disconnect();

###supportedModules

Returns a object with the various modules with a true or false value indicating if they are supported on the board you are connected to in the success callback.

mbientlab.mwdevice.supportedModules(successCallback, failureCallback);

successCallback.gpio //value will be true if supported,  false if not.
successCallback.accelerometer
successCallback.gyroscope
successCallback.stepCounter

###readRssi

Reads the RSSI value you are currently getting from the board. The RSSI is returned as a string in the success callback.

mbientlab.mwdevice.readRssi(successCallback, failureCallback);

###readBatteryLevel

Reads the Battery Level value you are currently getting from the board. The Battery Level is returned as a int in the success callback.

mbientlab.mwdevice.readBatteryLevel(successCallback, failureCallback);

###playLED

Plays a pattern on the LED on a per channel basis. For example, the following command produces a blue (breathing) type of flash on the board.

metawear.mwdevice.playLED({channel:"BLUE",
                           riseTime: 750, pulseDuration: 2000,
                           repeatCount: -1, highTime: 500,
                           fallTime: 750, lowIntensity: 0,
                           highIntensity: 31})

###stopLED

Turns off any LED functions that were started withe the playLED method.

mbientlab.mwdevice.stopLED();

###readTemperature

Performs a one time read from a thermistor. It takes three arguments. A success callback, a failure callback and a hash object. Currently the only supported parameter is called 'sensor'.

If you have a MetaWear C or R-Pro your sensor options are:

• PRO_BMP_280 - thermistor on the BMP 280 sensor.
• PRO_NRF_DIE - the nordic chip on die sensor.
• PRO_ON_BOARD_THERMISTOR - A separate on board sensor.

If you have the MetaWear R your options are:

• R_NRF_DIE - the nordic chip on die sensor.

var temperatureSuccess = function(result){
    console.log(result);
    $("#temperature").text(
        'temperature: ' + result.temperature 
    );
};

var failure = function(result){
    var message = "";
    if(result.status !== undefined){
      message = result.status;
    }else{
      message = result;
    }
    console.log(result);
    alert("ERROR : " + message);
}

metawear.mwdevice.readTemperature(temperatureSuccess, failure, {sensor: 'R_NRF_DIE'})

###startAccelerometer

Starts the accelerometer on the board and streams the data to the callback until it is stopped. The callback result is an object with x,y and z values from the accelerometer.

var failure = function(result){
}

var success = function(result){
   console.log("x: " + result.x + " y: " + result.y + " z: " + result.z);
}

mbientlab.mwdevice.startAccelerometer(success, failure);

###stopAccelerometer

Stops the accelerometer and stops streaming data.

mbientlab.mwdevice.stopAccelerometer();

###startStepCounter

Note: BMI160 devices only

Starts the step counter on the board and streams the data to the callback until it is stopped. The callback result is an object with text that says 'TOOK_A_STEP' when a step is detected.

var failure = function(result){
}

var totalSteps = 0;
var success = function(result){
   totalSteps = totalSteps + 1;
   console.log(result);
   console.log(totalSteps + " total steps");
}

mbientlab.mwdevice.startStepCounter(success, failure);

###stopStepCounter

Stops the step counter and stops streaming data.

mbientlab.mwdevice.stopStepCounter();

###startGyroscope

NOTE: BMI160 devices only.

Starts the gyroscope on the board and streams the data to the callback until it is stopped. The callback result is an object with x,y and z values from the gyroscope.

var failure = function(result){
}

var success = function(result){
   console.log("x: " + result.x + " y: " + result.y + " z: " + result.z);
}

mbientlab.mwdevice.startGyroscope(success, failure);

Note: The failure callback will come back with a result.status of "MODULE_NOT_SUPPORTED" if the board you are connected to does not support this module.

###stopGyroscope

Stops the gyroscope and stops streaming data.

mbientlab.mwdevice.stopGyroscope();

##Roadmap

Right now the following components are on the roadmap for this plugin. The plan is to add these in this order, but if there is specific functionality that you need please file an issue and we can see about moving it up on the list.

*LED *BMI 160 Accelerometer -- advanced functions *BMI 160 Gyro -- advanced functions *BMP 280 Barometer-Pressure Sensor *Haptic *I2C *MMA 8452Q Accelerometer - Axis Sampling *MultiChannel Temperature *NeoPixel *Logging *Data Processor - **accumulator **RMS **threshold **counter