Getting Started

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie den Capgo-Fähigkeiten Ihrer AI-Werkzeugleiste mit folgendem Befehl hinzu:

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

Verwenden Sie dann folgende Anfrage:

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und folgen Sie den unten angegebenen Plattform-spezifischen Anweisungen:

bun add @capgo/capacitor-barometer
bunx cap sync

Importieren

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

API-Übersicht

getMeasurement

Ermitteln Sie die neueste Barometer-Lese, die vom native Layer erfasst wurde.

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

await CapacitorBarometer.getMeasurement();

isAvailable

Überprüfen Sie, ob das aktuelle Gerät einen Barometer-Sensor enthält.

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

await CapacitorBarometer.isAvailable();

startMeasurementUpdates

Beginnen Sie mit dem Streamen von Barometer-Updates an das JavaScript-Layer.

Rufen Sie mit dem measurement ereignis

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

await CapacitorBarometer.startMeasurementUpdates();

stopMeasurementUpdates

Beenden Sie die fortlaufenden Updates, die über . gestartet wurden.

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

await CapacitorBarometer.stopMeasurementUpdates();

checkPermissions

Geben Sie den aktuellen Zustand der Berechtigung zurück, um Zugriff auf Daten des Barometers zu erhalten.

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

await CapacitorBarometer.checkPermissions();

requestPermissions

Bitten Sie um die Berechtigung zum Zugriff auf Daten des Barometers, wenn dies durch die Plattform erforderlich ist.

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

await CapacitorBarometer.requestPermissions();

Typenverweis

GetMeasurementResult

Alias für das jüngste Druckbeispiel.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Ergebnis, das von .

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

PermissionStatus

Zurückgegebene Berechtigungsinformationen von und .

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

MeasurementEvent

Beitragsempfangsereignis, das bei Aktivierung von ausgesendet wird.

export type MeasurementEvent = Measurement;

Measurement

Luftdruck- und relative Höhenwerte, die vom Gerätebarometer abgeleitet werden.

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

Zustand der Genehmigung, einschließlich limited für Plattformen, die den Zugriff auf Sensoren einschränken können.

export type BarometerPermissionState = PermissionState | 'limited';

PermissionState

Genehmigungszustände der Plattformen, die von Capacitor. unterstützt werden.

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

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.ts. Re-run die Synchronisierung, wenn das öffentliche API upstream geändert wird.

Weiter von Getting Started

Wenn Sie " Getting Started um das Dashboard und API-Operationen zu planen, verbinden Sie es mit Mit @capgo/capacitor-barometer für die native Fähigkeit in Mit @capgo/capacitor-barometer, API-Übersicht für die Implementierungsdetails in API-Übersicht, Einführung für die Implementierungsdetails in Einführung, API Schlüssel für die Implementierungsdetails in API Schlüssel, und Geräte für die Implementierungsdetails in Geräte.