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-accelerometer` 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-accelerometer
bunx cap sync

Importer

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

Démarrage rapide

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

await CapacitorAccelerometer.startMeasurementUpdates();
await CapacitorAccelerometer.addListener('measurement', ({ x, y, z }) => {
  detectShake(x, y, z);
});

Exemple : permission web

On web, request motion access through requestPermissions() avant d’attendre des échantillons non nuls.

Erreurs courantes

• Web zéro : avant le premier événement de mouvement, getMeasurement() renvoie des zéros.
• Arrêter le streaming: stopMeasurementUpdates() lorsque vous quittez l'écran.
• Unités : utilisez la convention d'axes documentée par le plugin pour vos calculs de jeu.

Aperçu de API

getMeasurement

Récupérer l'échantillon d'accéléromètre le plus récent enregistré par la couche native.

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

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

isAvailable

Vérifier si l'appareil actuel dispose d'un capteur d'accéléromètre.

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

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

startMeasurementUpdates

Commencez à streamer les mises à jour de l'accéléromètre vers la couche JavaScript.

Appelez addListener avec le measurement événement pour recevoir les mises à jour.

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

await CapacitorAccelerometer.startMeasurementUpdates();

stopMeasurementUpdates

Arrêter le flux de mises à jour de l'accéléromètre lancé via startMeasurementUpdates.

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

await CapacitorAccelerometer.stopMeasurementUpdates();

checkPermissions

Renvoie l'état actuel de la permission d'accès aux données de mouvement.

Sur les plateformes sans permissions explicites, cela renvoie granted.

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

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

requestPermissions

Demander la permission d'accéder aux données de mouvement si la plateforme le permet.

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

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

Référence de type

GetMeasurementResult

Alias pour la mesure la plus récente.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Résultat renvoyé par isAvailable.

export interface IsAvailableResult {
  /**
   * Whether an accelerometer sensor is available on the device.
   *
   * @since 1.0.0
   */
  isAvailable: boolean;
}

PermissionStatus

Informations sur la permission renvoyées par checkPermissions et requestPermissions.

export interface PermissionStatus {
  /**
   * The permission state for accessing motion data on the current platform.
   *
   * @since 1.0.0
   */
  accelerometer: AccelerometerPermissionState;
}

MeasurementEvent

Payload de l’événement émis lorsque startMeasurementUpdates est actif.

export type MeasurementEvent = Measurement;

Measurement

Les valeurs d'accélération des axes x, y et z rapportées par les capteurs de mouvement de l'appareil.

export interface Measurement {
  /**
   * The acceleration on the x-axis in G's.
   *
   * @since 1.0.0
   */
  x: number;

  /**
   * The acceleration on the y-axis in G's.
   *
   * @since 1.0.0
   */
  y: number;

  /**
   * The acceleration on the z-axis in G's.
   *
   * @since 1.0.0
   */
  z: number;
}

AccelerometerPermissionState

Union des états de permission incluant limited pour les plateformes pouvant limiter l'accès aux mouvements.

export type AccelerometerPermissionState = PermissionState | 'limited';

PermissionState

États de permission des plateformes supportés par Capacitor.

export type PermissionState = 'prompt' | 'prompt-with-rationale' | 'granted' | 'denied';

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-accelerometer pour la fonctionnalité native dans Utiliser @capgo/capacitor-accelerometer, 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.