开始教程

安装

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下提示：

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-pedometer` plugin in my project.

如果您更喜欢手动设置，请运行以下命令安装插件并按照以下平台特定的说明进行操作：

bun add @capgo/capacitor-pedometer
bunx cap sync

导入

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

API 概览

getMeasurement

获取指定时间范围内的步数计数器测量值。

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

await CapacitorPedometer.getMeasurement();

isAvailable

检测该设备上的行走计数器功能是否可用

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

await CapacitorPedometer.isAvailable();

startMeasurementUpdates

开始实时接收行走计数器测量数据

开 Android 和 iOS, 在 measurement 调用 startMeasurementUpdates().

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

await CapacitorPedometer.startMeasurementUpdates();

stopMeasurementUpdates

停止实时步行计数测量更新。

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

await CapacitorPedometer.stopMeasurementUpdates();

checkPermissions

检查步行计数数据访问权限。

On Android, 这检查了 ACTIVITY_RECOGNITION 权限。 On iOS, 这检查了运动使用权限。

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

await CapacitorPedometer.checkPermissions();

requestPermissions

请求步数数据权限

On Android，此操作请求 ACTIVITY_RECOGNITION permission。 OniOS

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

await CapacitorPedometer.requestPermissions();

Copy to clipboard

GetMeasurementOptions

export interface GetMeasurementOptions {
  /**
   * The start time for the measurement query (milliseconds since epoch).
   *
   * Required on **iOS**.
   *
   * @since 0.0.1
   */
  start?: number;

  /**
   * The end time for the measurement query (milliseconds since epoch).
   *
   * Required on **iOS**.
   *
   * @since 0.0.1
   */
  end?: number;
}

Measurement

export interface Measurement {
  /**
   * The number of steps taken by the user.
   *
   * @since 0.0.1
   */
  numberOfSteps?: number;

  /**
   * The estimated distance (in meters) traveled by the user.
   *
   * Only available on **iOS**.
   *
   * @since 0.0.1
   */
  distance?: number;

  /**
   * The approximate number of floors ascended.
   *
   * Only available on **iOS**.
   *
   * @since 0.0.1
   */
  floorsAscended?: number;

  /**
   * The approximate number of floors descended.
   *
   * Only available on **iOS**.
   *
   * @since 0.0.1
   */
  floorsDescended?: number;

  /**
   * The current pace (in seconds per meter).
   *
   * Only available on **iOS**.
   *
   * @since 0.0.1
   */
  currentPace?: number;

  /**
   * The current cadence (steps per second).
   *
   * Only available on **iOS**.
   *
   * @since 0.0.1
   */
  currentCadence?: number;

  /**
   * The average active pace (in seconds per meter).
   *
   * Only available on **iOS**.
   *
   * @since 0.0.1
   */
  averageActivePace?: number;

  /**
   * The start time of this measurement (milliseconds since epoch).
   *
   * @since 0.0.1
   */
  startDate?: number;

  /**
   * The end time of this measurement (milliseconds since epoch).
   *
   * @since 0.0.1
   */
  endDate?: number;
}

IsAvailableResult

export interface IsAvailableResult {
  /**
   * Whether step counting is available.
   *
   * @since 0.0.1
   */
  stepCounting: boolean;

  /**
   * Whether distance measurement is available.
   *
   * Only `true` on **iOS** devices that support distance tracking.
   *
   * @since 0.0.1
   */
  distance: boolean;

  /**
   * Whether pace measurement is available.
   *
   * Only `true` on **iOS** devices that support pace tracking.
   *
   * @since 0.0.1
   */
  pace: boolean;

  /**
   * Whether cadence measurement is available.
   *
   * Only `true` on **iOS** devices that support cadence tracking.
   *
   * @since 0.0.1
   */
  cadence: boolean;

  /**
   * Whether floor counting is available.
   *
   * Only `true` on **iOS** devices that support floor tracking.
   *
   * @since 0.0.1
   */
  floorCounting: boolean;
}

PermissionStatus

export interface PermissionStatus {
  /**
   * Permission state for activity recognition.
   *
   * On **Android**, this is the `ACTIVITY_RECOGNITION` permission.
   * On **iOS**, this is the motion usage permission.
   *
   * @since 0.0.1
   */
  activityRecognition: 'prompt' | 'prompt-with-rationale' | 'granted' | 'denied';
}

MeasurementEvent

export type MeasurementEvent = Measurement;

真实来源

本页由插件生成 src/definitions.ts. 当公共 API 上游更改时，请重新运行同步。

继续从 Getting Started

如果您正在使用 Getting Started 来规划仪表板和 API 操作，请将其连接到 使用 @capgo/capacitor-pedometer 用于在 Using @capgo/capacitor-pedometer 中的本机功能 API Overview 用于在 API Overview 中的实现细节 介绍 用于在介绍中实现的细节 API 键 为 API 键的实现细节提供键，和 设备 为设备的实现细节提供键。