Getting Started

Installez

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

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

Ensuite, utilisez la commande suivante :

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

bun add @capgo/capacitor-barometer
bunx cap sync

Importer

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

API : Présentation

getMeasurement

Obtenez la lecture barométrique la plus récente capturée par la couche native.

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

await CapacitorBarometer.getMeasurement();

isAvailable

Vérifiez si le dispositif actuel comporte un capteur de baromètre.

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

await CapacitorBarometer.isAvailable();

startMeasurementUpdates

Commencez à diffuser les mises à jour barométriques vers la couche JavaScript.

Appelez avec l' measurement événement pour recevoir les mises à jour.

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

await CapacitorBarometer.startMeasurementUpdates();

stopMeasurementUpdates

Arrêtez les mises à jour continues démarrées via .

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

await CapacitorBarometer.stopMeasurementUpdates();

checkPermissions

Renvoyez l'état de permission actuel pour accéder aux données du baromètre.

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

await CapacitorBarometer.checkPermissions();

requestPermissions

Demander la permission d'accéder aux données du baromètre si cela est requis par le système d'exploitation.

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

await CapacitorBarometer.requestPermissions();

Référence de type

GetMeasurementResult

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

export type GetMeasurementResult = Measurement;

IsAvailableResult

Résultat retourné par .

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

PermissionStatus

Informations de permission retournées par et .

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

MeasurementEvent

Données de l'événement émises lorsqu'est active.

export type MeasurementEvent = Measurement;

Measurement

Valeurs de pression atmosphérique et d'altitude relative échantillonnées du baromètre du dispositif.

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 d'état de la permission incluant limited pour les plateformes qui peuvent limiter l'accès aux capteurs.

export type BarometerPermissionState = PermissionState | 'limited';

PermissionState

États de la permission de la plateforme pris en charge par Capacitor.

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

Source de Vérité

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

Continuez de l'Accueil

Si vous utilisez Accueil pour planifier le tableau de bord et les opérations API, connectez-le à Utilisation de @capgo/capacitor-baromètre pour la capacité native dans Utilisation de @capgo/capacitor-baromètre, API : Présentation pour le détail d'implémentation dans API : Présentation, Introduction pour le détail d'implémentation dans Introduction, API : Clés pour les détails d'implémentation dans les clés API et Appareils pour les détails d'implémentation dans Appareils.