14 jours d'essai gratuit illimité. Pas de carte de crédit requise

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 commande 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 périphérique actuel. Vous devriez toujours vérifier la disponibilité du capteur avant de l'utiliser.

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

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

start

Démarrez 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êtez d'écouter les mises à jour du capteur de lumière. Cela arrêtera le capteur et économisera de la batterie.

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

await LightSensor.stop();

checkPermissions

Check the current permission status for high sampling rate sensors. On Android 12+, the HIGH_SAMPLING_RATE_SENSORS permission is required for sensor update intervals below 200ms.

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

const status = await LightSensor.checkPermissions();

requestPermissions

Demandez 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();

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 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'un contrôle 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

Information 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.tsRe-run the synchronisation lorsque les données publiques API changent en amont.

Continuez de Getting Started

Si vous utilisez Getting Started pour planifier le tableau de bord et les opérations __CAPGO_KEEP_0__, connectez-l’avec planifier l'écran de tableau et les opérations API, connectez-l’avec Utilisation de @capgo/capacitor-senseur de lumière pour la capacité native dans l'utilisation de @capgo/capacitor-capteur de lumière pour le détail d'implémentation dans API Overview, Pour les détails d'implémentation dans API Vue d'ensemble. Introduction Détails de mise en œuvre dans l'Introduction, API Clés Détails de mise en œuvre dans les API Clés, et Appareils pour les détails d'implémentation dans les appareils.