Getting Started

Installieren

Sie können unser AI-gestütztes Setup verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrem AI-Tool hinzu, indem Sie folgenden Befehl verwenden:

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

Benutzen Sie dann die folgende Anweisung:

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die untenstehenden 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 vom native Layer aufgezeichnet wurde.

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

await CapacitorAccelerometer.getMeasurement();

isAvailable

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

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

await CapacitorAccelerometer.isAvailable();

startMeasurementUpdates

Beginnen Sie mit dem Streamen von Accelerometer-Updates in die JavaScript-Schicht.

Rufen Sie mit dem measurement ereignis auf, um die Updates zu erhalten.

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

await CapacitorAccelerometer.startMeasurementUpdates();

stopMeasurementUpdates

Stop Streaming Beschleunigungsaufnahmen, die über . gestartet wurden

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

await CapacitorAccelerometer.stopMeasurementUpdates();

checkPermissions

Gibt den aktuellen Zustand der Berechtigung zurück, Zugriff auf Bewegungsdaten zu erhalten

Bei Plattformen ohne explizite Berechtigungen lautet die Antwort granted.

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

await CapacitorAccelerometer.checkPermissions();

requestPermissions

Berechtigung zum Zugriff auf Bewegungsdaten anfordern, wenn dies durch die Plattform unterstützt wird

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

await CapacitorAccelerometer.requestPermissions();

Typenreferenz

GetMeasurementResult

Alias für die jüngste Messung.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Ergibt zurück .

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

Beitragsempfangsereignis, wenn aktiv ist.

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

Einheit für die Zustandsbeschreibung der Zugriffsrechte, einschließlich limited für Plattformen, die die Zugriffsrechte auf Bewegungszugriffe drosseln können.

export type AccelerometerPermissionState = PermissionState | 'limited';

PermissionState

Zustände der Plattformzugriffsrechte, 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.ts. Re-run die Synchronisierung, wenn die öffentliche API sich im Hintergrund ändert.

Weiter zum Getting Started

Wenn Sie " Getting Started um das Dashboard und die API-Operationen zu planen, verbinden Sie es mit Verwenden Sie @capgo/capacitor-Accelerometer für die native Fähigkeit in Verwenden Sie @capgo/capacitor-Accelerometer, API-Übersicht für die Implementierungsdetails in API-Übersicht, Einführung für die Implementierungsdetails in Einführung, API Schlüssel für die Implementierungsdetails in API Schlüssel, und Geräte für die Implementierungsdetails in Geräte.