Inicio

Instalar

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

Importar

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

API Resumen

isAvailable

Verificar si el sensor de luz está disponible en el dispositivo actual. Siempre debes verificar la disponibilidad del sensor antes de intentar utilizarlo.

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

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

start

Comenzar a escuchar actualizaciones del sensor de luz. Esto iniciará las mediciones del sensor con el intervalo especificado. Utiliza addListener para recibir los datos del sensor.

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

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

stop

Detener la escucha de actualizaciones del sensor de luz. Esto detendrá el sensor y conservará la batería.

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

await LightSensor.stop();

checkPermissions

Verifique el estado de permiso actual para sensores de alta frecuencia de muestreo. En Android 12+, se requiere la permiso HIGH_SAMPLING_RATE_SENSORS para intervalos de actualización de sensores inferiores a 200ms.

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

const status = await LightSensor.checkPermissions();

requestPermissions

Solicite permiso para sensores de alta frecuencia de muestreo. En Android 12+, esto solicita el permiso HIGH_SAMPLING_RATE_SENSORS.

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

const status = await LightSensor.requestPermissions();

Referencia de tipo

IsAvailableResult

Resultado que indica si el sensor está disponible.

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

Opciones para iniciar el escucha del sensor de luz.

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

Función de llamada para actualizaciones del sensor de luz.

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

PermissionStatus

Resultado de una solicitud o verificación de permiso.

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

Información de versión del plugin.

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

LightSensorMeasurement

Una sola medición del sensor de luz.

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

Fuente de Verdad

Esta página se genera desde el plugin’s src/definitions.tsRe-ejecutar la sincronización cuando los cambios públicos API se actualicen en la fuente.

Sigue adelante desde Getting Started

Si estás utilizando Getting Started para planificar la operación de la consola y API, conecta con Usando @capgo/capacitor-sensor-de-luz para la capacidad nativa en Usando @capgo/capacitor-sensor de luz API Resumen para el detalle de implementación en API Resumen Introducción para el detalle de implementación en Introducción API Claves para el detalle de implementación en API Claves, y Dispositivos para el detalle de implementación en Dispositivos.