Getting Started

Install

AI-Assisted セットアップを使用してプラグインをインストールできます。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.

Manual Setupを使用する場合は、以下のコマンドを実行してください。プラットフォーム固有の指示は下記を参照してください。

bun add @capgo/capacitor-pedometer
bunx cap sync

Import

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

リアルタイム歩数計測値の更新を開始します。

オン アンドロイド および アイオス、 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, この動作はモーション使用許可のチェックです。

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

await CapacitorPedometer.checkPermissions();

requestPermissions

歩数データへのアクセス許可を求めます。

オン Android, この動作はモーション使用許可の要求です。 ACTIVITY_RECOGNITION オン iOS, この動作はモーション使用許可の要求です。

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

await CapacitorPedometer.requestPermissions();

型参照

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」を使用してダッシュボードと __CAPGO_KEEP_0__ の作業を計画している場合、 「@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-pedometer」を使用 「@API/__CAPGO_KEEP_1__-pedometer」を使用 Using @capgo/capacitor-pedometer for the native capability in Using @capgo/capacitor-pedometer, 「API」の実装詳細 「API」 導入 導入の実装詳細について API キー API キーの実装詳細について デバイス 編集