Panduan Memulai

Instal

Anda bisa menggunakan AI-Assisted Setup untuk menginstal plugin ini. Tambahkan skill Capgo ke tool AI Anda menggunakan perintah berikut:

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

Lalu gunakan prompt berikut:

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

Jika Anda lebih suka Manual Setup, instal plugin dengan menjalankan perintah berikut dan ikuti instruksi khusus platform di bawah ini:

bun add @capgo/capacitor-barometer
bunx cap sync

Impor

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

Mulai cepat

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

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

Contoh: pembacaan tunggal

Panggil startMeasurementUpdates() pertama. getMeasurement() mengembalikan 0 sampai event sensor pertama tiba.

Masalah umum

• Web: anggap tidak tersedia, isAvailable() bernilai false.
• Ketinggian relatif iOS: hanya berlaku saat update berjalan.
• Baterai: panggil stopMeasurementUpdates() saat selesai.

Ikhtisar API

getMeasurement

Dapatkan pembacaan barometer terbaru yang diambil oleh native layer.

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

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

isAvailable

Cek apakah perangkat saat ini memiliki sensor barometer.

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

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

startMeasurementUpdates

Mulai streaming update barometer ke layer JavaScript.

Panggil addListener dengan measurement event untuk menerima update tersebut.

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

await CapacitorBarometer.startMeasurementUpdates();

stopMeasurementUpdates

Hentikan update berkelanjutan yang dimulai via startMeasurementUpdates.

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

await CapacitorBarometer.stopMeasurementUpdates();

checkPermissions

Mengembalikan status izin saat ini untuk mengakses data barometer.

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

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

requestPermissions

Meminta izin untuk mengakses data barometer jika diperlukan oleh platform.

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

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

Referensi Tipe

GetMeasurementResult

Alias untuk sampel tekanan terbaru.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Hasil yang dikembalikan oleh isAvailable.

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

PermissionStatus

Informasi izin yang dikembalikan oleh checkPermissions dan requestPermissions.

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

MeasurementEvent

Payload event yang dikirimkan saat startMeasurementUpdates sedang aktif.

export type MeasurementEvent = Measurement;

Measurement

Nilai tekanan udara dan ketinggian relatif yang diambil dari barometer perangkat.

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

Union state izin yang mencakup limited untuk platform yang dapat membatasi akses sensor.

export type BarometerPermissionState = PermissionState | 'limited';

PermissionState

State izin platform yang didukung oleh Capacitor.

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

Sumber Kebenaran

Halaman ini dibuat dari plugin src/definitions.ts. Jalankan ulang sync saat API publik berubah di upstream.

Lanjutkan dari Getting Started

Jika Anda menggunakan Panduan Memulai untuk merencanakan operasi dashboard dan API, hubungkan dengan Menggunakan @capgo/capacitor-barometer untuk kapabilitas native di Menggunakan @capgo/capacitor-barometer, Ikhtisar API untuk detail implementasi di Ringkasan API, Pendahuluan untuk detail implementasi di Pendahuluan, Kunci API untuk detail implementasi di API Keys, dan Perangkat untuk detail implementasi di Perangkat.