Erste Schritte

Installieren

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

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

Nutze anschließend 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 bevorziehst, 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

On web, request motion access through requestPermissions() bevor man mit Werten ungleich Null rechnet.

Häufige Fehlerquellen

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

API Übersicht

getMeasurement

Ruft den aktuellsten Accelerometer-Sample ab, 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 einen Accelerometer-Sensor hat.

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

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

startMeasurementUpdates

Beginne mit dem Streaming von Accelerometer-Updates an den JavaScript-Layer.

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

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

await CapacitorAccelerometer.startMeasurementUpdates();

stopMeasurementUpdates

Streaming der Accelerometer-Updates stoppen, die gestartet wurden über startMeasurementUpdates.

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

await CapacitorAccelerometer.stopMeasurementUpdates();

checkPermissions

Gibt den aktuellen Permission-Status 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

Fordere die Berechtigung an, auf Bewegungsdaten zuzugreifen, sofern die Plattform dies unterstützt.

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

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

Typ-Referenz

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

Berechtigungsinformationen 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 Beschleunigungswerte der x-, y- und z-Achse, die von den Bewegungssensoren des Geräts gemeldet werden.

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 der Berechtigungszustände, einschließlich limited für Plattformen, die den Zugriff auf Bewegungsdaten drosseln können.

export type AccelerometerPermissionState = PermissionState | 'limited';

PermissionState

Von Capacitor unterstützte Plattform-Berechtigungszustände.

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

Source of Truth

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

Weiter mit Getting Started

Wenn Sie ... verwenden Erste Schritte Um Dashboard- und API-Operationen zu planen, verbinde es mit @capgo/capacitor-accelerometer verwenden für die native Funktionalität bei der Nutzung von @capgo/capacitor-accelerometer, API Übersicht für Details zur Implementierung in der Übersicht zu API, Einführung für das Implementierungsdetail in der Einleitung, API Keys für die Implementierungsdetails in den API Keys und Geräte für die Implementierungsdetails bei Devices.