npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

cordova-plugin-pedometer

v0.4.1

Published

Cordova / PhoneGap Plugin for the Core Motion Pedometer to fetch pedestrian-related data, such as step counts and other information about the distance travelled.

Downloads

139

Readme

Core Motion Pedometer Plugin for Cordova npm version

Fetch pedestrian-related pedometer data, such as step counts and other information about the distance travelled.

Install

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

cordova plugin add cordova-plugin-pedometer

Latest version from GitHub

cordova plugin add https://github.com/leecrossley/cordova-plugin-pedometer.git

You do not need to reference any JavaScript, the Cordova plugin architecture will add a pedometer object to your root automatically when you build.

Check feature support (iOS only)

isStepCountingAvailable

pedometer.isStepCountingAvailable(successCallback, failureCallback);
  • => successCallback is called with true if the feature is supported, otherwise false
  • => failureCallback is called if there was an error determining if the feature is supported

isDistanceAvailable

pedometer.isDistanceAvailable(successCallback, failureCallback);

Distance estimation indicates the ability to use step information to supply the approximate distance travelled by the user.

This capability is not supported on all devices, even with iOS 8.

isFloorCountingAvailable

pedometer.isFloorCountingAvailable(successCallback, failureCallback);

Floor counting indicates the ability to count the number of floors the user walks up or down using stairs.

This capability is not supported on all devices, even with iOS 8.

Live pedometer data

startPedometerUpdates

Starts the delivery of recent pedestrian-related data to your Cordova app.

var successHandler = function (pedometerData) {
    // pedometerData.startDate; -> ms since 1970
    // pedometerData.endDate; -> ms since 1970
    // pedometerData.numberOfSteps;
    // pedometerData.distance;
    // pedometerData.floorsAscended;
    // pedometerData.floorsDescended;
};
pedometer.startPedometerUpdates(successHandler, onError);

The success handler is executed when data is available and is called repeatedly from a background thread as new data arrives.

When the app is suspended, the delivery of updates stops temporarily. Upon returning to foreground or background execution, the pedometer object begins updates again.

stopPedometerUpdates

Stops the delivery of recent pedestrian data updates to your Cordova app.

pedometer.stopPedometerUpdates(successCallback, failureCallback);

Historical pedometer data (iOS only)

queryData

Retrieves the data between the specified start and end dates.

The startDate and endDate options are required and can be constructed in any valid JavaScript way (e.g. new Date(2015, 4, 1, 15, 20, 00) is also valid, as is milliseconds).

var successHandler = function (pedometerData) {
    // pedometerData.numberOfSteps;
    // pedometerData.distance;
    // pedometerData.floorsAscended;
    // pedometerData.floorsDescended;
};
var options = {
    "startDate": new Date("Fri May 01 2015 15:20:00"),
    "endDate": new Date("Fri May 01 2015 15:25:00")
};
pedometer.queryData(successHandler, onError, options);

Platform and device support

  • iOS 8+. These capabilities are not supported on all devices, even with iOS 8, so please ensure you use the check feature support functions.
  • Android (when associated hardware is available). Only live pedometer data is supported.

License

MIT License