Panduan Memulai

Instal

Anda bisa menggunakan AI-Assisted Setup kami untuk menginstal plugin ini. Tambahkan skill Capgo ke tool AI Anda dengan command berikut:

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

Lalu gunakan prompt berikut:

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

Jika Anda lebih memilih Manual Setup, instal plugin dengan menjalankan perintah berikut dan ikuti petunjuk khusus platform di bawah ini:

bun add @capgo/capacitor-pedometer
bunx cap sync

Impor

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

Mulai cepat

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

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

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

Contoh: query riwayat iOS

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

Kesalahan umum

• Izin: gerakan pada iOS, ACTIVITY_RECOGNITION pada Android.
• Web: tidak tersedia, sembunyikan UI langkah pada build web.
• Hentikan update: panggil stopMeasurementUpdates() untuk menghemat baterai.

Ringkasan API

getMeasurement

Dapatkan pengukuran pedometer untuk rentang waktu tertentu.

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

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

isAvailable

Cek fitur pedometer apa saja yang tersedia di perangkat ini.

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

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

startMeasurementUpdates

Mulai menerima update pengukuran pedometer secara real-time.

Di Android dan iOS, si measurement event hanya dipicu setelah memanggil startMeasurementUpdates().

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

await CapacitorPedometer.startMeasurementUpdates();

stopMeasurementUpdates

Berhenti menerima update pengukuran pedometer secara real-time.

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

await CapacitorPedometer.stopMeasurementUpdates();

checkPermissions

Periksa izin untuk mengakses data pedometer.

Di Android, ini akan mengecek ACTIVITY_RECOGNITION permission. On iOS, ini mengecek izin penggunaan motion.

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

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

requestPermissions

Minta izin untuk mengakses data pedometer.

Di Android, ini akan meminta ACTIVITY_RECOGNITION permission. On iOS, ini meminta izin penggunaan motion.

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

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

Referensi Tipe

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;

Sumber Kebenaran

Halaman ini dibuat dari plugin src/definitions.ts. Jalankan ulang sync saat API publik berubah di upstream.

Lanjutkan dari Getting Started

Jika Anda menggunakan Panduan Memulai untuk merencanakan operasi dashboard dan API, hubungkan dengan Menggunakan @capgo/capacitor-pedometer untuk kapabilitas native di Menggunakan @capgo/capacitor-pedometer, Ringkasan API untuk detail implementasi di API Overview, Pendahuluan untuk detail implementasi di Introduction, Kunci API untuk detail implementasi di API Keys, dan Perangkat untuk detail implementasi di Devices.