@capgo/capacitor-pedometer

Capacitor plugin for accessing pedometer data including steps, distance, pace, cadence, and floors.

Compatibility

Note: The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

Install

npm install @capgo/capacitor-pedometer
npx cap sync

Configuration

iOS

Add the following to your Info.plist:

<key>NSMotionUsageDescription</key>
<string>We need access to your motion data to track steps and activity</string>

Android

The plugin will automatically add the ACTIVITY_RECOGNITION permission to your AndroidManifest.xml.

For Android 10 (API 29) and above, you need to request the ACTIVITY_RECOGNITION permission at runtime.

API

getMeasurement(options?: GetMeasurementOptions | undefined) => Promise<Measurement>

isAvailable() => Promise<IsAvailableResult>

startMeasurementUpdates() => Promise<void>

stopMeasurementUpdates() => Promise<void>

checkPermissions() => Promise<PermissionStatus>

requestPermissions() => Promise<PermissionStatus>

addListener(eventName: 'measurement', listenerFunc: (event: MeasurementEvent) => void) => Promise<PluginListenerHandle>

removeAllListeners() => Promise<void>

getPluginVersion() => Promise<{ version: string; }>

Usage

import { CapacitorPedometer } from '@capgo/capacitor-pedometer';

// Check availability
const availability = await CapacitorPedometer.isAvailable();
console.log('Features available:', availability);

// Check and request permissions
const permission = await CapacitorPedometer.checkPermissions();
if (permission.activityRecognition !== 'granted') {
  await CapacitorPedometer.requestPermissions();
}

// Start real-time updates
await CapacitorPedometer.addListener('measurement', (data) => {
  console.log('Steps:', data.numberOfSteps);
  console.log('Distance:', data.distance);
});

await CapacitorPedometer.startMeasurementUpdates();

// Query historical data (iOS only - requires start and end timestamps)
const now = Date.now();
const yesterday = now - (24 * 60 * 60 * 1000);
const measurement = await CapacitorPedometer.getMeasurement({
  start: yesterday,
  end: now
});

// Stop updates
await CapacitorPedometer.stopMeasurementUpdates();
await CapacitorPedometer.removeAllListeners();

Platform Support

Notes

• On Android, only step counting is available. The plugin uses the TYPE_STEP_COUNTER sensor.
• On iOS, all features are available on supported devices using CMPedometer.
• Historical data queries require explicit start and end timestamps on iOS.
• Android's step counter gives cumulative steps since last device reboot; the plugin tracks the delta.
• Measurements are paused when the app is in the background.

License

MIT