Einstieg

Installieren

bun add @capgo/capacitor-light-sensor
bunx cap sync

Importieren

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

API Übersicht

isAvailable

Überprüfe, ob der Lichtsensor auf dem aktuellen Gerät verfügbar ist. Du solltest immer die Verfügbarkeit des Sensors überprüfen, bevor du ihn verwenden möchtest.

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

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

start

Beginne mit dem Abhören von Lichtsensor-Updates. Dies wird die Sensormessungen auf dem angegebenen Intervall beginnen. Verwende addListener um die Sensor-Daten zu erhalten.

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

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

stop

Beende das Abhören von Lichtsensor-Updates. Dies wird den Sensor beenden und die Batterie sparen.

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

await LightSensor.stop();

checkPermissions

Überprüfen Sie den aktuellen Berechtigungsstatus für Hochdurchsatzsensoren.

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

const status = await LightSensor.checkPermissions();

requestPermissions

Abschnitt mit dem Titel „requestPermissions“

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

const status = await LightSensor.requestPermissions();

Zur Zwischenablage kopieren

IsAvailableResult

Abschnitt mit dem Titel „IsAvailableResult“

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

Abschnitt mit dem Titel „StartOptions“

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

Informationen zur Plugin-Version.

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 wird aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisierung, wenn die öffentliche API upstream geändert wird.

Weitermachen von Getting Started

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