Getting Started

Instalar

Puede utilizar nuestra configuración asistida por IA para instalar el plugin. Agregue las Capgo habilidades a su herramienta de IA utilizando el siguiente comando:

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

Luego utilice el siguiente prompt:

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

Si prefieres la configuración manual, instala el complemento ejecutando los siguientes comandos y sigue las instrucciones específicas de la plataforma a continuación:

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

Importar

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

API Resumen

isAvailable

Verifica 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

Comience a escuchar actualizaciones del sensor de luz. Esto comenzará las mediciones del sensor con el intervalo especificado. Use addListener para recibir los datos del sensor.

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

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

stop

Detenga 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+, el permiso HIGH_SAMPLING_RATE_SENSORS es requerido 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 tipos

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 escuchador 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 de retorno 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 de 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 a partir de la página del plugin. src/definitions.ts. Re-run la sincronización cuando el público API cambia en la fuente.

Sigue adelante desde Inicio

Si estás utilizando Inicio para planificar la consola de dashboard y API operaciones, 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.