计步器入门

本指南将引导您将 Capacitor 计步器插件集成到您的应用程序中。

安装

使用 npm 安装插件：

npm install @capgo/capacitor-pedometer
npx cap sync

iOS 配置

将动作使用说明添加到您的 Info.plist 中：

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

Android 配置

该插件会自动添加 ACTIVITY_RECOGNITION 权限。对于 Android 10+ (API 29)，您需要在运行时请求此权限。

基本用法

导入插件

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

检查可用性

const checkPedometer = async () => {
  const result = await CapacitorPedometer.isAvailable();
  console.log('Step counting available:', result.stepCounting);
  console.log('Distance available:', result.distance);
  console.log('Floor counting available:', result.floorCounting);
  console.log('Pace available:', result.pace);
  console.log('Cadence available:', result.cadence);
};

请求权限

const requestPermission = async () => {
  const permission = await CapacitorPedometer.requestPermissions();
  console.log('Permission status:', permission.activityRecognition);
};

获取当前测量值

const getMeasurements = async () => {
  const measurements = await CapacitorPedometer.getMeasurement({
    startDate: new Date(Date.now() - 24 * 60 * 60 * 1000), // 24 hours ago
    endDate: new Date()
  });

  console.log('Steps:', measurements.numberOfSteps);
  console.log('Distance:', measurements.distance, 'meters');
  console.log('Floors ascended:', measurements.floorsAscended);
  console.log('Floors descended:', measurements.floorsDescended);
};

开始实时更新

// Add listener for real-time updates
CapacitorPedometer.addListener('measurement', (data) => {
  console.log('Steps:', data.numberOfSteps);
  console.log('Distance:', data.distance);
  console.log('Pace:', data.currentPace);
  console.log('Cadence:', data.currentCadence);
});

// Start receiving updates
await CapacitorPedometer.startMeasurementUpdates();

停止更新

await CapacitorPedometer.stopMeasurementUpdates();
CapacitorPedometer.removeAllListeners();

完整示例

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

class PedometerService {
  private listener: any;

  async initialize() {
    // Check availability
    const available = await CapacitorPedometer.isAvailable();
    if (!available.stepCounting) {
      console.error('Step counting not available');
      return false;
    }

    // Request permissions
    const permission = await CapacitorPedometer.requestPermissions();
    if (permission.activityRecognition !== 'granted') {
      console.error('Permission denied');
      return false;
    }

    return true;
  }

  async startTracking() {
    // Add listener
    this.listener = CapacitorPedometer.addListener('measurement', (data) => {
      this.onMeasurement(data);
    });

    // Start updates
    await CapacitorPedometer.startMeasurementUpdates();
    console.log('Pedometer tracking started');
  }

  async stopTracking() {
    await CapacitorPedometer.stopMeasurementUpdates();
    if (this.listener) {
      this.listener.remove();
    }
    console.log('Pedometer tracking stopped');
  }

  onMeasurement(data: any) {
    console.log('Steps today:', data.numberOfSteps);
    console.log('Distance:', (data.distance / 1000).toFixed(2), 'km');
  }

  async getTodaySteps() {
    const today = new Date();
    today.setHours(0, 0, 0, 0);

    const measurements = await CapacitorPedometer.getMeasurement({
      startDate: today,
      endDate: new Date()
    });

    return measurements.numberOfSteps;
  }
}

// Usage
const pedometer = new PedometerService();
await pedometer.initialize();
await pedometer.startTracking();

最佳实践

1. 检查可用性：使用前务必验证计步器功能
2. 请求权限：优雅地处理权限请求
3. 电池优化：不需要时停止更新
4. 错误处理：将调用包装在 try-catch 块中
5. 后台更新：配置连续跟踪的后台模式

常见问题

权限被拒绝

const handlePermissionDenied = async () => {
  const permission = await CapacitorPedometer.checkPermissions();

  if (permission.activityRecognition === 'denied') {
    alert('Motion tracking permission is required. Please enable it in Settings.');
  }
};

在设备上不可用

const checkSupport = async () => {
  const available = await CapacitorPedometer.isAvailable();

  if (!available.stepCounting) {
    alert('Step counting is not available on this device');
    return false;
  }

  return true;
};

后续步骤

• 浏览 API 参考 以获取完整文档
• 查看示例应用程序
• 有关高级实现，请参阅教程