Getting Started

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten Ihrem AI-Tool hinzu, indem Sie die folgende Kommandozeilenanweisung verwenden:

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

Dann verwenden Sie die folgende Anfrage:

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

Wenn Sie eine manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die unten angegebenen plattform-spezifischen Anweisungen befolgen:

bun add @capgo/capacitor-barometer
bunx cap sync

Importieren

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

API Übersicht

getMeasurement

Ermitteln Sie die neueste Barometer-Lesezeichen, die vom native Layer erfasst wurden.

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 auf die JavaScript-Schicht.

Aufrufen Sie mit dem measurement Event, um die Updates zu erhalten.

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

await CapacitorBarometer.startMeasurementUpdates();

stopMeasurementUpdates

Beenden Sie die fortlaufenden Updates, die via . gestartet wurden.

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

await CapacitorBarometer.stopMeasurementUpdates();

checkPermissions

Geben Sie den aktuellen Zustand der Berechtigung für den Zugriff auf Barometerdaten zurück.

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

await CapacitorBarometer.checkPermissions();

requestPermissions

Berechtigung zum Zugriff auf Barometerdaten anfordern, wenn dies durch die Plattform erforderlich ist.

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

await CapacitorBarometer.requestPermissions();

Typenreferenz

GetMeasurementResult

Alias für das kürzlichste Druckprobenbeispiel.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Ergebnis, das von . zurückgegeben wird.

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

PermissionStatus

Zurückgegebene Berechtigungsinformationen durch und .

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

MeasurementEvent

Ereignis-Payload, das bei Aktivierung von ausgestoßen wird.

export type MeasurementEvent = Measurement;

Measurement

Luftdruck- und relative Höhenwerte, die aus dem 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

Berechtigungsstatus-Union einschließlich limited für Plattformen, die den Zugriff auf Sensoren einschränken können.

export type BarometerPermissionState = PermissionState | 'limited';

PermissionState

Durch Capacitor unterstützte Zustände der Plattformberechtigungen.

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

Quelle der Wahrheit

Diese Seite wurde aus dem Plugin generiert. src/definitions.tsWenn sich die öffentliche API im Quellcode ändert, führen Sie die Synchronisierung erneut durch.

Weitermachen von Getting Started

Wenn Sie Einstieg um das Dashboard und API-Operationen zu planen, verbinden Sie es mit Mit @capgo/capacitor-Barometer verwenden für die native Fähigkeit in Mit @capgo/capacitor-Barometer verwenden 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.