Prise en main

Installer

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

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

Utilisez ensuite le prompt suivant :

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 une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :

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

Importer

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

Démarrage rapide

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

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

Exemple : démarrage

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

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

Exemple : arrêter

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

await LightSensor.stop();

Erreurs courantes

• Autorisations: appelez checkPermissions() puis requestPermissions() si nécessaire.
• Écouteurs: supprimez les handles lors du démontage des écrans.
• Source de vérité : fiez-vous src/definitions.ts au repo GitHub.

Aperçu de API

isAvailable

Vérifiez si le capteur de luminosité est disponible sur l’appareil actuel. Vous devez toujours vérifier la disponibilité du capteur avant de tenter de l’utiliser.

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

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

start

Commencez à écouter les mises à jour du capteur de luminosité. Cela lancera 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êtez d'écouter les mises à jour du capteur de luminosité.\nCela stoppera le capteur et économisera la batterie.

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

await LightSensor.stop();

checkPermissions

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

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

const status = await LightSensor.checkPermissions();

requestPermissions

Demander la permission pour les capteurs à taux d'échantillonnage élevé. Sur Android 12+, cela requiert la permission HIGH_SAMPLING_RATE_SENSORS.

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

const status = await LightSensor.requestPermissions();

Référence de type

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 du capteur de luminosité.

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 d’autorisation.

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 mesure unique 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 de src/definitions.ts. Relancez la synchronisation lorsque l’API public change en amont.

Continuer depuis Getting Started

Si vous utilisez Prise en main pour planifier les opérations du dashboard et de API, connectez-l’avec Utiliser @capgo/capacitor-light-sensor pour la fonctionnalité native dans Utilisation de @capgo/capacitor-light-sensor, Aperçu de API pour les détails d'implémentation dans « Vue d'ensemble de API », Introduction pour les détails d'implémentation dans l'introduction, Clés API pour les détails d'implémentation dans « Clés API », et Appareils pour les détails d'implémentation dans Devices.