Einstieg

Installieren

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

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

Verwenden Sie dann die folgende Anfrage:

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 Verfügbarkeit des Sensors überprüfen, bevor Sie ihn verwenden möchten.

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 Hochauflösungssensoren. 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 hochauflösende Sensoren anfordern. Bei Android 12+ wird die Berechtigung für HIGH_SAMPLING_RATE_SENSORS angefordert.

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

const status = await LightSensor.requestPermissions();

Typenreferenz

IsAvailableResult

Ergibt, 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 Lichtsensoraktualisierungen.

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

Informationen zur Pluginversion.

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

LightSensorMeasurement

Ein einzelnes Lichtmesswert.

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.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 die API-Operationen 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 zur Implementierungsdetail in Einführung, API Schlüssel zur Implementierungsdetail in API Schlüssel, und Geräte zur Implementierungsdetail in Geräte.