Getting Started

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie den Capgo-Fähigkeiten Ihrer AI-Werkzeugleistung mit folgendem Befehl hinzu:

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

Verwenden Sie dann folgende Anfrage:

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

Wenn Sie eine manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die unten angegebenen plattform-spezifischen Anweisungen befolgen:

bun add @capgo/capacitor-accelerometer
bunx cap sync

Importieren

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

API Übersicht

getMeasurement

Ermitteln Sie das neueste Accelerometer-Sample, das von der native Layer aufgezeichnet wurde.

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

await CapacitorAccelerometer.getMeasurement();

isAvailable

Überprüfen Sie, ob das aktuelle Gerät einen Beschleunigungssensor enthält.

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

await CapacitorAccelerometer.isAvailable();

startMeasurementUpdates

Beginnen Sie mit dem Streamen von Beschleunigungsaufzeichnungen auf die JavaScript-Schicht.

Aufrufen Sie mit dem measurement Event, um die Updates zu erhalten.

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

await CapacitorAccelerometer.startMeasurementUpdates();

stopMeasurementUpdates

Beenden Sie das Streamen von Beschleunigungsaufzeichnungen, das über

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

await CapacitorAccelerometer.stopMeasurementUpdates();

checkPermissions

Gibt die aktuelle Berechtigungsstellung für den Zugriff auf Bewegungsdaten zurück.

Auf Plattformen ohne explizite Berechtigungen lautet dies granted.

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

await CapacitorAccelerometer.checkPermissions();

requestPermissions

Berechtigung anfordern, um auf Bewegungsdaten zuzugreifen, wenn dies durch die Plattform unterstützt wird.

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

await CapacitorAccelerometer.requestPermissions();

Typenreferenz

GetMeasurementResult

Alias für die kürzlichste Messung.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Ergibt Ergebnis durch .

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

PermissionStatus

Zurückgegebene Berechtigungsinformationen durch und .

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

MeasurementEvent

Event-Payload, das bei Aktivierung von ausgestoßen wird.

export type MeasurementEvent = Measurement;

Measurement

Die x-, y- und z-Achsenbeschleunigungswerte, die von den Geräebewegungssensoren 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

Zustandsunion einschließlich der Berechtigung limited Für Plattformen, die die Zugriffsbewegung drosseln können.

export type AccelerometerPermissionState = PermissionState | 'limited';

PermissionState

Plattformzustände der Berechtigung, die von Capacitor unterstützt werden.

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

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisation, wenn die öffentliche API upstream geändert wird.

Fortsetzung von Getting Started

Wenn Sie verwenden Einstieg um das Dashboard und API-Operationen zu planen, verbinden Sie es mit für die native Fähigkeit in Using @capgo/capacitor-Accelerometer for the native capability in Using @capgo/capacitor-accelerometer, für die Implementierungsdetails in API-Übersicht for the implementation detail in API Overview, für die Implementierungsdetails in Einführung __CAPGO_KEEP_0__-Schlüssel für die Implementierungsdetails in API-Schlüssel und for the implementation detail in API Keys, and Getting Started für die Implementierungsdetails in Geräten.