cordova-plugin-stepper

Lightweight pedometer Cordova/Phonegap plugin for Android using the hardware step sensor, with notifications.

Plugin using the hardware step-sensor for minimal battery consumption. This app is designed to be kept running all the time without having any impact on your battery life! Therefore the app does not drain any additional battery. Unlike other pedometer apps, this app does not track your movement or your location so it doesn't need to turn on your GPS sensor - no impact on your battery.

The plugin also creates a background service with a neat and nice notification (in Android platform) to continue working even after the application is closed and the device is restarted.

Installation

Latest published version on npm (with Cordova CLI >= 5.0.0)

cordova plugin add cordova-plugin-stepper

Latest version from GitHub

cordova plugin add https://github.com/achubutkin/cordova-plugin-stepper

Usage

startStepperUpdates (offset, successCallback, errorCallback, options)

Run with options and listener data updates. The success handler is called once during the first call and then called from the background thread whenever data is available.

The method also creates a background service with notification (Android only).

The options parameter may contain optional parameters. Below parameters recommended for notification localization (in Android platform):

• pedometerIsCountingText - string - Set title text for notification
• pedometerStepsToGoFormatText - string - Set description format string with text for notification
• pedometerYourProgressFormatText - string - Set progress description format string with text for notification
• pedometerGoalReachedFormatText - string - Set goal description format string with text for notification when the number of steps reaches the target value

Example:

var offset = 0, options = { 
    pedometerIsCountingText: 'Pedometer is counting', 
    pedometerStepsToGoFormatText: '%s steps to go'
  };
  
stepper.startStepperUpdates(offset, success, error, options);

function success (result) {
  var stepsToday = result.steps_today;
}
function error (err) {
  console.error(err);
}

Note: When the application is suspended, the call to handlers is temporarily suspended. When the application is closed, the background service continues to work (in Android platform). The background service continues after the device is restarted.

To stop the background service, call the method stopStepperUpdates. When you open an application and call the launch method again, it joins the current background service.

stopStepperUpdates (successCallback, errorCallback)

The method stops the background calls to the success handler of the startStepperUpdates method and stops the background service (in Android platform) with remove notification.

Example:

stepper.startStepperUpdates(success, error);

function success () {
}
function error (err) {
  console.error(err);
}

Note: Background service can only be stopped by this method.

setGoal (num, successCallback, errorCallback)

Set a goal (number of steps) for a pedometer. This is necessary for the correct calculation of the remaining steps and the display of the indicator in the notification.

Example:

var goal = 1000;

stepper.setGoal(goal, success, error);

function success () {
}
function error () {
  console.error(err);
}

Note: It is recommended to call the method before calling the method startStepperUpdates, but it is allowed to change the target during operation.

getSteps (date, successCallback, errorCallback)

Gets the number of steps for the specified day. date parameter must be start of day and number of milliseconds since the Unix Epoch.

Example:

var interval = 1000 * 60 * 60 * 24, 
  startOfDay = Math.floor(Date.now() / interval) * interval;

stepper.getSteps(startOfDay, success, error);

function success (result) {
  var steps = result.steps;
}
function error () {
  console.error(err);
}

getStepsByPeriod (start, end, successCallback, errorCallback)

Gets the number of steps for the specified period. start and end parameters must be start of day and number of milliseconds since the Unix Epoch.

Example:

// 3 days period 
var interval = 1000 * 60 * 60 * 24, 
  start = Math.floor(Date.now() / interval) * interval - (interval * 3),
  end  = Math.floor(Date.now() / interval) * interval;

stepper.getSteps(start, end, success, error);

function success (result) {
  var steps = result.steps;
}
function error () {
  console.error(err);
}

getLastEntries (num, successCallback, errorCallback)

Gets all recent records in the specified limit.

Example:

var limit = 10;

stepper.getLastEntries(limit, success, error);

function success (result) {
  var entries = result.entries;
  for (var i = 0; i < entries.length; i++) {
    var entry = entries[i], data = entry.data,
      steps = entry.steps;
  }
}
function error () {
  console.error(err);
}

Platform and device support

• Android
• iOS not supported. Highly recommendation, use a plugin https://github.com/leecrossley/cordova-plugin-pedometer to implement a pedometer on iOS and combine these plugins in your application with platforms conditions.

Credits

Icons made by authors from https://www.flaticon.com is licensed by http://creativecommons.org/licenses/by/3.0/

License

Copyright (c) 2019, Alexandr Chubutkin

Project based on source code and includes parts of source code https://github.com/j4velin/Pedometer Copyright (c) 2013 Thomas Hoffmann - All Rights Reserved

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.