Getting Started

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten Ihrem AI-Tool mit der folgenden Befehlszeile hinzu:

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

Dann verwenden Sie die folgende Anfrage:

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 darunter angegebenen Plattform-spezifischen Anweisungen befolgen.

bun add @capgo/capacitor-accelerometer
bunx cap sync

Importieren

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

API Übersicht

getMeasurement

Holen Sie sich die neueste Beschleunigungsmessung, die vom nativen 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 der Übertragung von Beschleunigungsmessungen zum JavaScript-Layer.

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

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

await CapacitorAccelerometer.startMeasurementUpdates();

stopMeasurementUpdates

Stop streaming accelerometer updates started via .

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

await CapacitorAccelerometer.stopMeasurementUpdates();

checkPermissions

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

Auf Plattformen ohne explizite Berechtigungen lautet dies 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 neueste Messung.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Erfolgsmeldung zurückgegeben durch .

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

PermissionStatus

Zugriffsinformationen zurückgegeben durch und .

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

MeasurementEvent

Bereits aktivem Ereignis Payload.

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

Zustand der Erlaubnis einschließlich limited für Plattformen, die die Zugriffsbewegung einschränken können.

export type AccelerometerPermissionState = PermissionState | 'limited';

PermissionState

Die von Capacitor unterstützten Plattformen zur Erlaubnis des Zugriffs.

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

Quelle der Wahrheit

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

Fortsetzen Sie mit Getting Started

Wenn Sie das Plugin verwenden Getting Started um das Dashboard und API-Operationen zu planen, verbinden Sie es mit Mit @capgo/capacitor-Accelerometer Für die native Fähigkeit in Mit @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äten.