Erste Schritte

Installieren

Du kannst unser KI-gestütztes Setup nutzen, um das Plugin zu installieren. Füge die Capgo Skills mit dem folgenden Befehl deinem KI-Tool hinzu:

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

Nutze dann diesen Prompt:

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

Wenn du ein manuelles Setup bevorzugst, installiere das Plugin mit den folgenden Befehlen und befolge die plattformspezifischen Anweisungen unten:

bun add @capgo/capacitor-accelerometer
bunx cap sync

Importieren

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

Quickstart

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

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

Beispiel: Web-Berechtigung

Im Web den Zugriff auf Bewegungsdaten über requestPermissions() anfordern, bevor du Werte ungleich null erwartest.

Häufige Stolperfallen

• Web-Nullwerte: vor dem ersten Bewegungsereignis, getMeasurement() gibt Nullen zurück.
• Streaming stoppen: stopMeasurementUpdates() beim Verlassen des Screens.
• Einheiten: Nutze die dokumentierte Achsenkonvention des Plugins für deine Spielmathematik.

API Übersicht

getMeasurement

Den aktuellsten Beschleunigungssensor-Messwert abrufen, der vom Native Layer aufgezeichnet wurde.

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

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

isAvailable

Prüfen, ob das aktuelle Gerät über einen Beschleunigungssensor verfügt.

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

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

startMeasurementUpdates

Das Streaming von Beschleunigungssensor-Updates an den JavaScript-Layer starten.

Rufe addListener mit dem measurement Event, um die Updates zu empfangen.

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

await CapacitorAccelerometer.startMeasurementUpdates();

stopMeasurementUpdates

Das Streaming von Beschleunigungssensor-Updates stoppen, gestartet über startMeasurementUpdates.

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

await CapacitorAccelerometer.stopMeasurementUpdates();

checkPermissions

Gibt den aktuellen Berechtigungsstatus für den Zugriff auf Bewegungsdaten zurück.

Auf Plattformen ohne explizite Berechtigungen wird dies aufgelöst zu granted.

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

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

requestPermissions

Fordert die Berechtigung für den Zugriff auf Bewegungsdaten an, sofern die Plattform dies unterstützt.

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

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

Typreferenz

GetMeasurementResult

Alias für die aktuellste Messung.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Rückgabewert von isAvailable.

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

PermissionStatus

Zurückgegebene Berechtigungsdaten von checkPermissions und requestPermissions.

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

MeasurementEvent

Event-Payload, das gesendet wird, wenn startMeasurementUpdates aktiv ist.

export type MeasurementEvent = Measurement;

Measurement

Die von den Bewegungssensoren des Geräts gemeldeten Beschleunigungswerte für die x-, y- und z-Achse.

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

Permission-State-Union, die Folgendes enthält: limited für Plattformen, die den Zugriff auf Bewegungsdaten drosseln können.

export type AccelerometerPermissionState = PermissionState | 'limited';

PermissionState

Von Capacitor unterstützte Plattform-Berechtigungsstatus.

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

Source of Truth

Diese Seite wird aus dem Plugin generiert src/definitions.ts. Führe den Sync erneut aus, wenn sich das öffentliche API upstream ändert.

Weiter geht's nach Getting Started

Wenn du es nutzt Erste Schritte um Dashboard- und API-Operationen zu planen, verbinde es mit Mit @capgo/capacitor-accelerometer für die native Funktion in „Verwendung von @capgo/capacitor-accelerometer“, API Übersicht für Details zur Implementierung im API Overview, Einführung für die Implementierungsdetails in der Einleitung, API Schlüssel für das Implementierungsdetail in API Keys und Geräte für das Implementierungsdetail in Devices.