Prise En Main

Installer

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de la commande suivante :

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

Utilisez ensuite la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

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

Importer

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

API : Vue d'ensemble

isAvailable

Vérifiez si le capteur de lumière est disponible sur le dispositif actuel. Il est toujours recommandé de vérifier la disponibilité du capteur avant de l'utiliser.

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

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

start

Démarrer l'écoute des mises à jour du capteur de lumière. Cela commencera les mesures du capteur à l'intervalle spécifié. Utilisez addListener pour recevoir les données du capteur.

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

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

stop

Arrêter l'écoute des mises à jour du capteur de lumière. Cela arrêtera le capteur et économisera la batterie.

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

await LightSensor.stop();

checkPermissions

Vérifiez l'état de permission actuel pour les capteurs à haute fréquence d'échantillonnage. Sur Android 12+, la permission HIGH_SAMPLING_RATE_SENSORS est requise pour les intervalles de mise à jour du capteur inférieurs à 200ms.

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

const status = await LightSensor.checkPermissions();

requestPermissions

Demander la permission pour les capteurs à échantillonnage élevé. Sur Android 12+, cela demande la permission HIGH_SAMPLING_RATE_SENSORS.

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

const status = await LightSensor.requestPermissions();

Type de référence

IsAvailableResult

Résultat indiquant si le capteur 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

Options pour démarrer l'écouteur de capteur de lumière.

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

Fonction de rappel pour les mises à jour du capteur de lumière.

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

PermissionStatus

Résultat d'une demande ou d'une vérification de permission.

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

Informations sur la version du plugin.

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

LightSensorMeasurement

Une seule mesure du capteur de lumière.

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

Source de vérité

Cette page est générée à partir du plugin’s src/definitions.ts. Re-run la synchronisation lorsque les informations publiques API changent en amont.

Continuez de la section « Commencer »

Si vous utilisez Commencer pour planifier le tableau de bord et les opérations API, connectez-l’avec Utilisation de @capgo/capacitor-sensibilisant à la lumière pour la capacité native dans Utilisation de @capgo/capacitor-sensibilisant à la lumière, API Vue d'ensemble pour le détail d'implémentation dans API Vue d'ensemble, Introduction pour les détails d'implémentation dans Introduction API Clés pour les détails d'implémentation dans API Clés, et Appareils pour les détails d'implémentation dans Appareils.