Per iniziare

Installa

Puoi usare il nostro setup assistito dall'IA per installare il plugin. Aggiungi le skill Capgo al tuo strumento di IA usando il seguente comando:

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

Poi usa il seguente prompt:

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

Se preferisci la configurazione manuale, installa il plugin eseguendo questi comandi e segui le istruzioni specifiche per piattaforma qui sotto:

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

Importa

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

Avvio rapido

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

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

Esempio: avvio

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

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

Esempio: stop

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

await LightSensor.stop();

Errori comuni

• Permessi: chiamata checkPermissions() poi requestPermissions() quando necessario.
• Listener: rimuovi gli handle quando gli schermi vengono smontati.
• Fonte di verità: fidati src/definitions.ts nel repo GitHub.

Panoramica API

isAvailable

Verifica se il sensore di luce è disponibile sul dispositivo corrente. Controlla sempre la disponibilità del sensore prima di provare a usarlo.

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

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

start

Inizia a ricevere gli aggiornamenti del sensore di luce. Questo avvierà 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 ricevere gli aggiornamenti del sensore di luce. Questo disattiverà il sensore per risparmiare batteria.

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

await LightSensor.stop();

checkPermissions

Controlla lo stato dei permessi per i sensori ad alta frequenza di campionamento. Su Android 12+, è richiesto il permesso HIGH_SAMPLING_RATE_SENSORS per intervalli di aggiornamento del sensore inferiori a 200ms.

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

const status = await LightSensor.checkPermissions();

requestPermissions

Richiedi il permesso per i sensori ad alta frequenza di campionamento. Su Android 12+ viene richiesto il permesso HIGH_SAMPLING_RATE_SENSORS.

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

const status = await LightSensor.requestPermissions();

Riferimento ai tipi

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 avviare il listener 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 gli aggiornamenti del sensore di luce.

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

PermissionStatus

Risultato di una richiesta o di un controllo dei permessi.

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 singola 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 src/definitions.ts. Riesegui la sync quando il API pubblico cambia upstream.

Continua da Getting Started

Se stai usando Per iniziare per pianificare le operazioni della dashboard e di API, collegalo a Utilizzo di @capgo/capacitor-light-sensor per la funzionalità nativa in Utilizzo di @capgo/capacitor-light-sensor, Panoramica API per i dettagli di implementazione in Panoramica di API, Introduzione per i dettagli di implementazione in Introduzione, Chiavi API per i dettagli di implementazione in Chiavi API, e Dispositivi per i dettagli di implementazione in Dispositivi.