Getting Started

Installieren

Sie können unser AI-gestütztes Setup verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten Ihrem AI-Tool mit der folgenden Befehl hinzu:

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

Verwenden Sie dann die folgende Anweisung:

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 die darunterstehenden 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-Lesung, die vom native Layer erfasst wurde.

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

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

isAvailable

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

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

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

startMeasurementUpdates

Beginnen Sie das Streaming von Barometer-Updates auf die JavaScript-Schicht.

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

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

await CapacitorBarometer.startMeasurementUpdates();

stopMeasurementUpdates

Stop the continuous updates started via .

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

await CapacitorBarometer.stopMeasurementUpdates();

checkPermissions

Rufen Sie den aktuellen Zustand der Berechtigung ab, um auf Barometer-Daten zuzugreifen.

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

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

requestPermissions

Berechtigung anfordern, um Zugriff auf Barometer-Daten zu erhalten, falls erforderlich durch die Plattform.

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

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

Typenreferenz

GetMeasurementResult

Alias für das neueste Druckproben-Beispiel.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Ergibtung zurückgegeben 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

Aktivitätsereignis, das ausgelöst wird, wenn aktiv ist.

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

Berechtigungsstatusunion einschließlich limited für Plattformen, die den Zugriff auf Sensoren drosseln können.

export type BarometerPermissionState = PermissionState | 'limited';

PermissionState

Berechtigungsstatus der Plattformen, die von Capacitor unterstützt werden.

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

Quelle der Wahrheit

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

Weitermachen von Getting Started

Wenn Sie diese Funktion verwenden Getting Started um das Dashboard und die 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äten.