@t2tx/react-native-universal-pedometer
TypeScript icon, indicating that this package has built-in type declarations

2.0.3 • Public • Published

react-native-universal-pedometer

React Native pedometer support for iOS version 8.0 and higher and Android. The module is CMPedometer wrapper. More info about CMPedometer can be found in https://developer.apple.com/library/ios/documentation/CoreMotion/Reference/CMPedometer_class/

Example

https://github.com/t2tx/pedometer_example

Note

  • Currently typescript is supported.

Installation

  1. npm install --save @t2tx/react-native-universal-pedometer

or yarn add @t2tx/react-native-universal-pedometer

  1. cd ios && pod install && cd ..
iOS Configuration

add NSMotionUsageDescription on ios/<your-project>/info.plist

// info.plist
<dict>
	...
	<key>NSMotionUsageDescription</key>
	<string></string>
</dict>

General Usage

import Pedometer from '@t2tx/react-native-universal-pedometer';

or

var Pedometer = require('@t2tx/react-native-universal-pedometer');

Methods

Method Name Arguments Notes
isStepCountingAvailable callback: Callback
isDistanceAvailable callback: Callback
isFloorCountingAvailable callback: Callback
isPaceAvailable callback: Callback
isCadenceAvailable callback: Callback
startPedometerUpdatesFromDate date: Date.getTime(), listener: Listener start tracking from current time
queryPedometerDataBetweenDates startDate: Date.getTime(), endDate: Date.getTime(), callback: QueryCallback query pedometer data from selected date to other selected date
stopPedometerUpdates stop pedometer updates

Types

Type Name Interface
PedometerInterface { startDate: nubmer; endDate: number; numberOfSteps: number; distance: number; }
Callback (error: string or null, avaliable: boolean) => any
Listener (data: PedometerInterface) => any
QueryCallback (error: string or null, data: PedometerInterface or null) => any

Package Sidebar

Install

npm i @t2tx/react-native-universal-pedometer

Weekly Downloads

12

Version

2.0.3

License

MIT

Unpacked Size

38.5 kB

Total Files

17

Last publish

Collaborators

  • t2tx