Guida rapida

Installazione

Puoi usare il nostro Setup assistito dall'AI per installare il plugin. Aggiungi le skill Capgo al tuo tool AI con il comando seguente:

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

Poi usa questo prompt:

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

Se preferisci il Setup manuale, installa il plugin eseguendo i comandi seguenti e segui le istruzioni specifiche per piattaforma qui sotto:

bun add @capgo/capacitor-barometer
bunx cap sync

Importa

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

Avvio rapido

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

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

Esempio: singola lettura

Chiama startMeasurementUpdates() per primo. getMeasurement() restituisce 0 finché non arriva il primo evento del sensore.

Errori comuni

• Web: trattalo come non disponibile, isAvailable() è false.
• Altitudine relativa iOS: rilevante solo durante gli update.
• Batteria: chiama stopMeasurementUpdates() al termine.

API Panoramica

getMeasurement

Ottieni l'ultima lettura del barometro catturata dal layer nativo.

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

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

isAvailable

Verifica se il dispositivo corrente include un sensore barometrico.

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

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

startMeasurementUpdates

Inizia lo streaming degli aggiornamenti del barometro al layer JavaScript.

Chiama addListener con l' measurement event per ricevere gli aggiornamenti.

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

await CapacitorBarometer.startMeasurementUpdates();

stopMeasurementUpdates

Ferma gli aggiornamenti continui avviati tramite startMeasurementUpdates.

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

await CapacitorBarometer.stopMeasurementUpdates();

checkPermissions

Restituisce lo stato attuale dei permessi per accedere ai dati del barometro.

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

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

requestPermissions

Richiedi il permesso per accedere ai dati del barometro, se richiesto dalla piattaforma.

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

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

Riferimento ai tipi

GetMeasurementResult

Alias per l'ultimo campione di pressione rilevato.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Risultato restituito da isAvailable.

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

PermissionStatus

Informazioni sui permessi restituite da checkPermissions e requestPermissions.

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

MeasurementEvent

Payload dell'evento emesso quando startMeasurementUpdates è attivo.

export type MeasurementEvent = Measurement;

Measurement

Valori di pressione atmosferica e altitudine relativa campionati dal barometro del dispositivo.

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

Unione degli stati di permesso, tra cui: limited per le piattaforme che possono limitare l'accesso ai sensori.

export type BarometerPermissionState = PermissionState | 'limited';

PermissionState

Stati dei permessi di piattaforma supportati da Capacitor.

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

Fonte di verità

Questa pagina è generata dal src/definitions.ts. Riesegui la sync quando il API pubblico cambia upstream.

Continua da Getting Started

Se stai usando Guida rapida per pianificare dashboard e operazioni API, collegalo a Utilizzo di @capgo/capacitor-barometer per la funzionalità nativa in Utilizzo di @capgo/capacitor-barometer, API Panoramica per i dettagli di implementazione in Panoramica di API, Introduzione per i dettagli implementativi nell'Introduzione, Chiavi API per i dettagli implementativi in API Keys, e Dispositivi per i dettagli implementativi in Dispositivi.