Getting Started

Installieren

Sie können unser AI-gestütztes Setup verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten Ihrem AI-Tool mit folgendem 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 untenstehenden 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 Sensordisponibilität überprüfen, bevor Sie versuchen, ihn zu verwenden.

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

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

start

Starten Sie das Abhören von Lichtsensor-Updates. 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

Beenden Sie das Abhören von Lichtsensor-Updates. Dies beendet 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 HIGH_SAMPLING_RATE_SENSORS erforderlich für Sensor-Update-Intervalle unter 200ms.

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

const status = await LightSensor.checkPermissions();

requestPermissions

Berechtigung für hohe Abtastraten-Sensoren anfordern. Bei Android 12+ wird die Berechtigung HIGH_SAMPLING_RATE_SENSORS angefordert.

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

const status = await LightSensor.requestPermissions();

Typenreferenz

IsAvailableResult

Ergbnis, 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 das Starten 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ückruf-Funktion für Lichtsensor-Updates.

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

PermissionStatus

Ergbnis einer Ermächtigungsanfrage 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

Plugin-Versionsinformationen.

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

LightSensorMeasurement

Ein einzelner Lichtsensor-Messwert.

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;
}

Quelle der Wahrheit

Diese Seite wurde aus dem Plugin generiert. src/definitions.ts. Wenn sich die öffentliche API im Quellcode ändert, führen Sie den Sync erneut durch.

Weiter von Anfang an

Wenn Sie " Anfang an" verwenden, um das Dashboard und die __CAPGO_KEEP_0__-Operationen zu planen, verbinden Sie es mit Mit @API/__CAPGO_KEEP_1__-lichtsensor für die native Fähigkeit in Mit @capgo/capacitor-lichtsensor for the native capability in Using @capgo/capacitor-light-sensor, für die Implementierungsdetails in API-Übersicht for the implementation detail in API Overview, 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.