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 folgender Befehl hinzu:

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

Verwenden Sie dann die folgende Anweisung:

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

Wenn Sie die 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-light-sensor
bunx cap sync

Importieren

import { LightSensor } from '@capgo/capacitor-light-sensor';

API Übersicht

isAvailable

Überprüfen Sie, ob der Lichtsensor auf dem aktuellen Gerät verfügbar ist. Sie sollten immer die Sensorenverfügbarkeit überprüfen, bevor Sie ihn verwenden.

import { LightSensor } from '@capgo/capacitor-light-sensor';

const { available } = await LightSensor.isAvailable();

start

Hören Sie auf das Lichtsensor-Update an. Dies beginnt die Sensormessungen mit der angegebenen Intervall. Verwenden Sie addListener um die Sensor-Daten zu erhalten.

import { LightSensor } from '@capgo/capacitor-light-sensor';

await LightSensor.start({ updateInterval: 500 });

stop

Hören Sie auf das Lichtsensor-Update auf. Dies stoppt den Sensor und spart Batterien.

import { LightSensor } from '@capgo/capacitor-light-sensor';

await LightSensor.stop();

checkPermissions

Überprüfen Sie den aktuellen Berechtigungsstatus für Hochdurchsatzsensoren. Bei Android 12+ ist die Berechtigung für Hochdurchsatzsensoren erforderlich für Sensor-Update-Intervalle unter 200ms.

import { LightSensor } from '@capgo/capacitor-light-sensor';

const status = await LightSensor.checkPermissions();

requestPermissions

Die Berechtigung für hochauflösende Sensoren anfordern. Ab Android 12+ wird die Berechtigung HIGH_SAMPLING_RATE_SENSORS angefordert.

import { LightSensor } from '@capgo/capacitor-light-sensor';

const status = await LightSensor.requestPermissions();

Typenreferenz

IsAvailableResult

Ergebnis, das anzeigt, ob der Sensor verfügbar ist.

export interface IsAvailableResult {
  /**
   * Whether the light sensor is available on this device.
   * Always false on iOS as the light sensor API is not available.
   *
   * @since 0.0.1
   */
  available: boolean;
}

StartOptions

Optionen für den Start des Lichtsensoren-Listeners.

export interface StartOptions {
  /**
   * The desired interval between sensor updates in milliseconds.
   * On Android 12+, there's a minimum interval of 200ms unless the app
   * has the HIGH_SAMPLING_RATE_SENSORS permission.
   *
   * @default 200
   * @since 0.0.1
   */
  updateInterval?: number;
}

LightSensorCallback

Rückruffunktion für Lichtsensoren-Updates.

export type LightSensorCallback = (measurement: LightSensorMeasurement) => void;

PermissionStatus

Erfolg einer Berechtigungsanfrage oder -prüfung.

export interface PermissionStatus {
  /**
   * Whether the high sampling rate sensor permission is granted.
   * On Android 12+, this permission is required for update intervals below 200ms.
   *
   * @since 0.0.1
   */
  highSamplingRate: 'prompt' | 'prompt-with-rationale' | 'granted' | 'denied';
}

VersionResult

Einzelne Lichtmessung

export interface VersionResult {
  /**
   * The current version of the plugin.
   *
   * @since 0.0.1
   */
  version: string;
}

LightSensorMeasurement

Abschnitt mit dem Titel "Zugriffsstatus"

export interface LightSensorMeasurement {
  /**
   * Ambient light level in lux (lx).
   *
   * @since 0.0.1
   */
  illuminance: number;

  /**
   * Timestamp of the measurement in seconds since epoch.
   *
   * @since 0.0.1
   */
  timestamp: number;
}

Abschnitt mit dem Titel "Plugins-Versioneninformationen"

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

Weitergehen von Getting Started

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