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

npm install @capgo/capacitor-pedometer
npx cap sync

Add the following to your Info.plist:

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

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.

• getMeasurement(...)
• isAvailable()
• startMeasurementUpdates()
• stopMeasurementUpdates()
• checkPermissions()
• requestPermissions()
• addListener('measurement', ...)
• removeAllListeners()
• getPluginVersion()
• Interfaces
• Type Aliases

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

Get pedometer measurements for a specified time range.

Returns: Promise<Measurement>

Since: 0.0.1

isAvailable() => Promise<IsAvailableResult>

Check which pedometer features are available on this device.

Returns: Promise<IsAvailableResult>

Since: 0.0.1

startMeasurementUpdates() => Promise<void>

Start receiving real-time pedometer measurement updates.

On Android and iOS, the measurement event is only fired after calling startMeasurementUpdates().

Since: 0.0.1

stopMeasurementUpdates() => Promise<void>

Stop receiving real-time pedometer measurement updates.

Since: 0.0.1

checkPermissions() => Promise<PermissionStatus>

Check permission to access pedometer data.

On Android, this checks the ACTIVITY_RECOGNITION permission. On iOS, this checks the motion usage permission.

Returns: Promise<PermissionStatus>

Since: 0.0.1

requestPermissions() => Promise<PermissionStatus>

Request permission to access pedometer data.

On Android, this requests the ACTIVITY_RECOGNITION permission. On iOS, this requests motion usage permission.

Returns: Promise<PermissionStatus>

Since: 0.0.1

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

Called when a new pedometer measurement is received.

Returns: Promise<PluginListenerHandle>

Since: 0.0.1

removeAllListeners() => Promise<void>

Remove all listeners for this plugin.

Since: 0.0.1

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

Get the native Capacitor plugin version.

Returns: Promise<{ version: string; }>

Since: 1.0.0

Measurement

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();

• 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.

MIT