はじめに

インストール

AIアシストセットアップを使ってプラグインをインストールできます。以下のコマンドで、お使いのAIツールに Capgo スキルを追加してください：

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';

クイックスタート

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

await CapacitorPedometer.requestPermissions();
await CapacitorPedometer.startMeasurementUpdates();

await CapacitorPedometer.addListener('measurement', (event) => {
  updateStepCount(event.numberOfSteps);
});

例: iOSの履歴クエリ

const sample = await CapacitorPedometer.getMeasurement({
  startDate: start.toISOString(),
  endDate: end.toISOString(),
});

よくある落とし穴

• 権限: iOSでのモーション、 ACTIVITY_RECOGNITION Androidでのモーション。
• Web: 利用不可。WebビルドではステップUIを非表示にします。
• 更新を停止：呼び出す stopMeasurementUpdates() バッテリーを節約するため。

API の概要

getMeasurement

指定した時間範囲の歩数計の測定値を取得します。

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

const result = await CapacitorPedometer.getMeasurement();
console.log(result);

isAvailable

このデバイスで利用可能な歩数計機能を確認します。

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

const result = await CapacitorPedometer.isAvailable();
console.log(result);

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

歩数計データへのアクセス権限を確認します。

オン Androidでは、以下の ACTIVITY_RECOGNITION 権限を確認します。 iOSでは、モーション使用権限を確認します。

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

const result = await CapacitorPedometer.checkPermissions();
console.log(result);

requestPermissions

歩数計データへのアクセス権限をリクエストします。

オン Androidでは、以下の ACTIVITY_RECOGNITION 権限。 有効化 iOS、モーション使用の権限をリクエストします。

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

const result = await CapacitorPedometer.requestPermissions();
console.log(result);

型リファレンス

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 が変更されたら、sync を再実行してください。

Getting Started から続ける

以下を使用している場合： はじめに ダッシュボードと API の操作を計画するには、以下と連携してください @capgo/capacitor-pedometer の使用方法 @capgo/capacitor-pedometer を使用してネイティブ機能を利用する場合、 API の概要 API Overview の実装の詳細については、 はじめに Introduction の実装の詳細については、 API キー API Keys の実装の詳細については、 デバイス Devices の実装の詳細については。