Getting Started

Installer

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA en utilisant la commande suivante :

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

Ensuite, utilisez la prompt suivante :

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 la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

bun add @capgo/capacitor-accelerometer
bunx cap sync

Importer

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

Vue d'ensemble des API

getMeasurement

Obtenez l'échantillon d'accéléromètre le plus récent qui a été enregistré par la couche native.

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

await CapacitorAccelerometer.getMeasurement();

isAvailable

Vérifiez si le dispositif actuel comporte un capteur d'accéléromètre.

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

await CapacitorAccelerometer.isAvailable();

startMeasurementUpdates

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

Appelez avec l' measurement événement pour recevoir les mises à jour.

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

await CapacitorAccelerometer.startMeasurementUpdates();

stopMeasurementUpdates

Arrêtez l'envoi de mises à jour d'accéléromètre démarrées via .

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

await CapacitorAccelerometer.stopMeasurementUpdates();

checkPermissions

Retournez l'état actuel des permissions pour accéder aux données de mouvement.

Sur les plateformes sans permissions explicites, cela se résout à granted.

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

await CapacitorAccelerometer.checkPermissions();

requestPermissions

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

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

await CapacitorAccelerometer.requestPermissions();

Référence de type

GetMeasurementResult

Alias pour la mesure la plus récente.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Résultat retourné par .

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

PermissionStatus

Informations sur les permissions retournées par et .

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 lors de l'activation de .

export type MeasurementEvent = Measurement;

Measurement

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

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

État de la permission incluant limited pour les plateformes qui peuvent limiter l'accès au mouvement.

export type AccelerometerPermissionState = PermissionState | 'limited';

PermissionState

États de permission de la plateforme pris en charge par Capacitor.

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

Source de Vérité

Cette page est générée à partir du plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.

Continuez de Getting Started

Si vous utilisez Getting Started pour planifier le tableau de bord et les opérations API, connectez-le avec Utiliser @capgo/capacitor-acceleromètre pour la capacité native dans Utiliser @capgo/capacitor-acceleromètre, API Overview pour les détails d'implémentation dans API Overview, Introduction pour les détails d'implémentation dans Introduction, API Clés pour les détails d'implémentation dans API Clés, et Appareils pour les détails d'implémentation dans Appareils.