Erste Schritte

Installieren

Du kannst unser KI-gestütztes Setup nutzen, um das Plugin zu installieren. Füge die Capgo Skills mit dem folgenden Befehl deinem KI-Tool hinzu:

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

Nutze dann diesen Prompt:

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

Wenn du ein manuelles Setup bevorzugst, installiere das Plugin mit den folgenden Befehlen und befolge die plattformspezifischen Anweisungen unten:

bun add @capgo/capacitor-barometer
bunx cap sync

Importieren

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

Quickstart

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

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

Beispiel: Einzelmessung

Rufe startMeasurementUpdates() zuerst. getMeasurement() gibt zurück 0 bis das erste Sensorevent eintrifft.

Häufige Stolperfallen

• Web: als nicht verfügbar behandeln, isAvailable() ist false.
• relative Höhe auf iOS: nur während laufender Updates relevant.
• Batterie: aufrufen stopMeasurementUpdates() beim Abschluss.

API Übersicht

getMeasurement

Rufe den aktuellsten Barometerwert aus dem Native Layer ab.

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

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

isAvailable

Prüfe, ob das Gerät über einen Barometersensor verfügt.

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

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

startMeasurementUpdates

Starte das Streamen von Barometer-Updates an den JavaScript-Layer.

Rufe addListener mit dem measurement Event, um die Updates zu empfangen.

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

await CapacitorBarometer.startMeasurementUpdates();

stopMeasurementUpdates

Stopp die kontinuierlichen Updates, die über startMeasurementUpdates.

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

await CapacitorBarometer.stopMeasurementUpdates();

checkPermissions

Gibt den aktuellen Berechtigungsstatus für den Zugriff auf Barometerdaten zurück.

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

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

requestPermissions

Fordert die Berechtigung für den Zugriff auf Barometerdaten an, falls die Plattform dies erfordert.

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

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

Typreferenz

GetMeasurementResult

Alias für den aktuellsten Druckmesswert.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Rückgabewert von isAvailable.

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

PermissionStatus

Zurückgegebene Berechtigungsdaten von checkPermissions und requestPermissions.

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

MeasurementEvent

Event-Payload, das gesendet wird, wenn startMeasurementUpdates aktiv ist.

export type MeasurementEvent = Measurement;

Measurement

Vom Barometer des Geräts erfasste Luftdruck- und relative Höhenwerte.

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

Permission-State-Union mit limited für Plattformen, die den Sensorzugriff drosseln können.

export type BarometerPermissionState = PermissionState | 'limited';

PermissionState

Von Capacitor unterstützte Plattform-Berechtigungsstatus.

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

Source of Truth

Diese Seite wird aus dem Plugin generiert src/definitions.ts. Führe den Sync erneut aus, wenn sich das öffentliche API upstream ändert.

Weiter geht's nach Getting Started

Wenn du es nutzt Erste Schritte um Dashboard- und API-Operationen zu planen, verbinde es mit @capgo/capacitor-barometer verwenden für die native Funktion in „@capgo/capacitor-barometer verwenden“, API Übersicht für Details zur Implementierung im API Overview, Einführung für die Implementierungsdetails in der Einleitung, API Schlüssel für das Implementierungsdetail in API Keys und Geräte für das Implementierungsdetail in Devices.