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 :

npx 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-barometer` 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-barometer
bunx cap sync

Importer

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

Démarrage rapide

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

await CapacitorBarometer.startMeasurementUpdates();
await CapacitorBarometer.addListener('measurement', (event) => {
  console.log('hPa', event.pressure);
});

Exemple : lecture unique

Appelez startMeasurementUpdates() d'abord. getMeasurement() renvoie 0 jusqu'à l'arrivée du premier événement du capteur.

Erreurs courantes

• Le Web: considéré comme indisponible, isAvailable() est faux.
• Altitude relative iOS: n'a de sens que pendant les mises à jour.
• Batterie: appelez stopMeasurementUpdates() une fois terminé.

Aperçu de API

getMeasurement

Récupérer le dernier relevé du baromètre capturé par la couche native.

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

const result = await CapacitorBarometer.getMeasurement();
console.log(result);

isAvailable

- Vérifier si l'appareil actuel dispose d'un capteur barométrique.

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

const result = await CapacitorBarometer.isAvailable();
console.log(result);

startMeasurementUpdates

Commencez à streamer les mises à jour du baromètre vers la couche JavaScript.

Appelez addListener avec le measurement événement pour recevoir les mises à jour.

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

await CapacitorBarometer.startMeasurementUpdates();

stopMeasurementUpdates

- Arrêter les mises à jour continues lancées via startMeasurementUpdates.

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

await CapacitorBarometer.stopMeasurementUpdates();

checkPermissions

Retourne l'état actuel de l'autorisation d'accès aux données du baromètre.

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

const result = await CapacitorBarometer.checkPermissions();
console.log(result);

requestPermissions

Demande la permission d'accéder aux données du baromètre si la plateforme l'exige.

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

const result = await CapacitorBarometer.requestPermissions();
console.log(result);

Référence de type

GetMeasurementResult

Alias de l'échantillon de pression le plus récent.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Résultat renvoyé par isAvailable.

export interface IsAvailableResult {
  /**
   * Indicates whether the device exposes a barometer sensor.
   *
   * @since 1.0.0
   */
  isAvailable: boolean;
}

PermissionStatus

Informations sur la permission renvoyées par checkPermissions et requestPermissions.

export interface PermissionStatus {
  /**
   * The permission state for accessing barometer measurements on the current platform.
   *
   * @since 1.0.0
   */
  barometer: BarometerPermissionState;
}

MeasurementEvent

Payload de l’événement émis lorsque startMeasurementUpdates est actif.

export type MeasurementEvent = Measurement;

Measurement

Valeurs de pression atmosphérique et d'altitude relative échantillonnées depuis le baromètre de l'appareil.

export interface Measurement {
  /**
   * The static air pressure in hectopascals (hPa).
   *
   * @since 1.0.0
   */
  pressure: number;

  /**
   * The change in altitude relative to the time updates started.
   * Only available on iOS; Android will always return `0`.
   *
   * @since 1.0.0
   */
  relativeAltitude: number;

  /**
   * The timestamp of the measurement in milliseconds since the Unix epoch.
   *
   * @since 1.0.0
   */
  timestamp: number;
}

BarometerPermissionState

Union des états de permission incluant limited pour les plateformes qui peuvent limiter l'accès aux capteurs.

export type BarometerPermissionState = PermissionState | 'limited';

PermissionState

États de permission des plateformes supportés par Capacitor.

export type PermissionState = 'prompt' | 'prompt-with-rationale' | 'granted' | 'denied';

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-barometer pour la fonctionnalité native dans « Utiliser @capgo/capacitor-barometer », 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.