Inizia a utilizzare

Installa

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

Importa

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

API Panoramica

isAvailable

Verifica se il sensore di luce è disponibile sul dispositivo corrente. È sempre necessario verificare la disponibilità del sensore prima di tentare di utilizzarlo.

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

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

start

Avvia l'ascolto delle aggiornamenti del sensore di luce. Ciò farà iniziare le misurazioni del sensore all'intervallo specificato. Usa addListener per ricevere i dati del sensore.

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

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

stop

Smetti di ascoltare le aggiornamenti del sensore di luce. Ciò farà fermare il sensore e risparmiare la batteria.

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

await LightSensor.stop();

checkPermissions

Verifica lo stato di autorizzazione corrente per i sensori di alta frequenza di campionamento. A partire da Android 12+, è richiesta la autorizzazione HIGH_SAMPLING_RATE_SENSORS per intervalli di aggiornamento dei sensori inferiori a 200ms.

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

const status = await LightSensor.checkPermissions();

requestPermissions

Richiedi l'autorizzazione per i sensori di alta frequenza di campionamento. A partire da Android 12+, ciò richiede l'autorizzazione HIGH_SAMPLING_RATE_SENSORS.

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

const status = await LightSensor.requestPermissions();

Riferimento di tipo

IsAvailableResult

Risultato che indica se il sensore è disponibile.

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

Opzioni per l'avvio dell'ascoltatore del sensore di luce.

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

Funzione di callback per aggiornamenti del sensore di luce.

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

PermissionStatus

Risultato di una richiesta o verifica di autorizzazione.

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

Informazioni sulla versione del plugin.

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

LightSensorMeasurement

Una sola misurazione del sensore di luce.

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

Fonte di Verità

Questa pagina è generata dal plugin’s src/definitions.tsRiepiloga la sincronizzazione quando le informazioni pubbliche API cambiano in modo upstream.

Continua da Iniziare

Se stai utilizzando Iniziare per pianificare il dashboard e le API operazioni, connettilo con Utilizza @capgo/capacitor-sensore di luce per la capacità nativa in Utilizzo di @capgo/capacitor-sensore di luce API Panoramica per il dettaglio di implementazione in API Panoramica Introduzione per il dettaglio di implementazione in Introduzione API Chiavi per il dettaglio di implementazione in API Chiavi, e Dispositivi per il dettaglio di implementazione in Dispositivi.