Primeros pasos

Instalar

Puedes usar nuestro setup asistido por IA para instalar el plugin. Añade las skills de Capgo a tu herramienta de IA con el siguiente comando:

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

Luego usa el siguiente prompt:

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

Si prefieres la configuración manual, instala el plugin ejecutando los siguientes comandos y sigue las instrucciones específicas para cada plataforma a continuación:

bun add @capgo/capacitor-barometer
bunx cap sync

Importar

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

Inicio rápido

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

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

Ejemplo: lectura única

Llama startMeasurementUpdates() primero. getMeasurement() devuelve 0 hasta que llegue el primer evento del sensor.

Errores comunes

• Web: tratar como no disponible, isAvailable() es falso.
• Altitud relativa en iOS: only meaningful while updates run.
• Batería: llamar a stopMeasurementUpdates() al terminar.

Resumen de API

getMeasurement

Obtén la lectura de barómetro más reciente capturada por la capa nativa.

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

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

isAvailable

Comprueba si el dispositivo actual tiene un sensor de barómetro.

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

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

startMeasurementUpdates

Empieza a enviar actualizaciones del barómetro a la capa de JavaScript.

Llama addListener con el measurement evento para recibir las actualizaciones.

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

await CapacitorBarometer.startMeasurementUpdates();

stopMeasurementUpdates

Detén las actualizaciones continuas iniciadas mediante startMeasurementUpdates.

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

await CapacitorBarometer.stopMeasurementUpdates();

checkPermissions

Devuelve el estado actual de los permisos para acceder a los datos del barómetro.

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

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

requestPermissions

Solicita permiso para acceder a los datos del barómetro si la plataforma lo requiere.

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

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

Referencia de tipos

GetMeasurementResult

Alias para la muestra de presión más reciente.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Resultado devuelto por isAvailable.

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

PermissionStatus

Información de permisos devuelta por checkPermissions y requestPermissions.

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

MeasurementEvent

Payload del evento emitido cuando startMeasurementUpdates está activo.

export type MeasurementEvent = Measurement;

Measurement

Valores de presión atmosférica y altitud relativa obtenidos del barómetro 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

Unión del estado de permisos que incluye limited para plataformas que pueden limitar el acceso al sensor.

export type BarometerPermissionState = PermissionState | 'limited';

PermissionState

Estados de permisos de plataforma compatibles con Capacitor.

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

Fuente de verdad

Esta página se genera a partir del src/definitions.ts. Vuelve a ejecutar el sync cuando el API público cambie en el upstream.

Continúa desde Primeros pasos

Si estás usando Primeros pasos para planificar el dashboard y las operaciones de API, conéctalo con Uso de @capgo/capacitor-barometer para la capacidad nativa en Using @capgo/capacitor-barometer, Resumen de API para el detalle de implementación en Resumen de API Overview, Introducción para el detalle de implementación en Introducción, Claves de API para el detalle de implementación en Claves de API, y Dispositivos para el detalle de implementación en Dispositivos.