Visit the free getting started tutorials on nativescript.org for JavaScript or Angular.
Kindly note that we filter out plugins that:
package.json
$ tns plugin add nativescript-pedometer
From the command prompt go to your app's root folder and execute:
tns plugin add nativescript-pedometer
Want to dive in quickly? Check out the demo app! Otherwise, continue reading.
You can run the demo app from the root of the project by typing npm run demo.ios.device and you'll see this:
npm run demo.ios.device
isStepCountingAvailable
The key feature of this plugin is counting steps. And it's also the only feature that Android supports.
// require the plugin import { Pedometer } from "nativescript-pedometer"; // instantiate the plugin let pedometer = new Pedometer(); pedometer.isStepCountingAvailable().then(avail => { alert(avail ? "Yes" : "No"); });
// require the plugin var Pedometer = require("nativescript-pedometer").Pedometer; // instantiate the plugin var pedometer = new Pedometer(); pedometer.isStepCountingAvailable(function(avail) { alert(avail ? "Yes" : "No"); });
Providing only TypeScript examples from here on out, but usage it largely similar. Also, I'm leaving out the Promises where they don't add clarity to the code sample.
startUpdates
To start receiving step count updates from this moment forward you can invoke startUpdates. If you want historic data on iOS, pass in a custom fromDate.
fromDate
pedometer.startUpdates({ fromDate: new Date(), // iOS only. Optional, default: now onUpdate: result => { // see the table below console.log(`Pedometer update: ${JSON.stringify(result)}`); } }).then(() => { console.log("Pedometer updates started."); }, err => { console.log("Error: " + err); });
The onUpdate callback receives an object containing these properties:
onUpdate
If you want to check beforehand if things like currentPace are available, there's a few functions similar to isStepCountingAvailable that you can invoke:
currentPace
isDistanceAvailable
isFloorCountingAvailable
isPaceAvailable
isCadenceAvailable
stopUpdates
You can wire up a Promise but there's no real need.
pedometer.stopUpdates();
query
Instead of listening to "live" updates you can query historic data:
pedometer.query({ fromDate: new Date(new Date().getTime() - (1000 * 60 * 60)), toDate: new Date() // default }).then(result => { // see the table at 'startUpdates' above console.log(`Pedometer update: ${JSON.stringify(result)}`); });
startEventUpdates
From iOS 10 onwards it's possible to get notified whenever the device detects a switch between a 'paused' and 'resumed' state (so starting/stopping walking).
To check beforehand whether or not this feature is availbe, call isEventTrackingAvailable (which has a similar API to isStepCountingAvailable).
isEventTrackingAvailable
pedometer.startEventUpdates({ onUpdate: result => { // see the table below console.log("Pedometer event update: " + JSON.stringify(result)); } }).then(() => { console.log("Pedometer event updates started."); );
Popularity metric based on:
Quality metric based on:
Maintenance metric based on: