Prise en main

Installer

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

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

Utilisez ensuite le prompt suivant :

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

Si vous préférez une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :

bun add @capgo/capacitor-pedometer
bunx cap sync

Importer

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

Démarrage rapide

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

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

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

Exemple : requête de l'historique iOS

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

Erreurs courantes

• Autorisations : mouvement sur iOS, ACTIVITY_RECOGNITION sur Android.
• Le Web : non disponible, masquez l'UI de l'étape sur les builds web.
• Arrêter les mises à jour: appelez stopMeasurementUpdates() pour économiser la batterie.

Aperçu de API

getMeasurement

Récupérez les mesures du podomètre pour un intervalle de temps donné.

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

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

isAvailable

Vérifiez quelles fonctionnalités du podomètre sont disponibles sur cet appareil.

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

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

startMeasurementUpdates

Abonnez-vous aux mesures du podomètre en temps réel.

Activé Android et iOS, les measurement l'événement n'est déclenché qu'après l'appel de startMeasurementUpdates().

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

await CapacitorPedometer.startMeasurementUpdates();

stopMeasurementUpdates

Désabonnez-vous des mesures du podomètre en temps réel.

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

await CapacitorPedometer.stopMeasurementUpdates();

checkPermissions

Vérifiez l'autorisation d'accéder aux données du podomètre.

Activé Android, cela vérifie la ACTIVITY_RECOGNITION permission. Sur iOS, this checks the motion usage permission.

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

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

requestPermissions

Demandez l'autorisation d'accéder aux données du podomètre.

Activé Android, cela demande la ACTIVITY_RECOGNITION permission. Sur iOS, cela demande l'autorisation d'accès au mouvement.

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

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

Référence de type

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;

Source de vérité

Cette page est générée à partir de src/definitions.ts. Relancez la synchronisation lorsque l’API public change en amont.

Continuer depuis Getting Started

Si vous utilisez Prise en main pour planifier les opérations du dashboard et de API, connectez-l’avec Utiliser @capgo/capacitor-pedometer pour la capacité native dans la page Utilisation de @capgo/capacitor-pedometer, Aperçu de API pour les détails d'implémentation dans « Vue d'ensemble de API », Introduction pour les détails d'implémentation dans l'introduction, Clés API pour les détails d'implémentation dans « Clés API », et Appareils pour les détails d'implémentation dans Devices.