スタートガイド

インストール

AIアシストによるセットアップでプラグインをインストールできます。以下のコマンドを使用して、お使いのAIツールに Capgo のスキルを追加してください：

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

次に、以下のプロンプトを使用します：

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

手動セットアップを希望する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム別の手順に従ってください：

bun add @capgo/capacitor-barometer
bunx cap sync

インポート

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

クイックスタート

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

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

例：単発の読み取り

呼び出す startMeasurementUpdates() 最初に。 getMeasurement() を返します 0 最初のセンサーイベントが届くまで。

よくある落とし穴

• Web: 利用不可として扱う isAvailable() は false です。
• iOS 相対高度: アップデート実行中のみ有効。
• バッテリー: 呼び出し stopMeasurementUpdates() 時に完了。

API の概要

getMeasurement

ネイティブレイヤーが取得した最新の気圧測定値を取得します。

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

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

isAvailable

デバイスに気圧センサーが搭載されているかを確認します。

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

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

startMeasurementUpdates

JavaScriptレイヤーへの気圧データのストリーミングを開始します。

呼び出す addListener を使用して、 measurement イベントで更新データを受信します。

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

await CapacitorBarometer.startMeasurementUpdates();

stopMeasurementUpdates

〜経由で開始された継続的なアップデートを停止します startMeasurementUpdates.

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

await CapacitorBarometer.stopMeasurementUpdates();

checkPermissions

気圧データへのアクセスに関する現在の権限状態を返します。

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

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

requestPermissions

プラットフォームが必要とする場合、気圧データへのアクセス権限をリクエストします。

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

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

型リファレンス

GetMeasurementResult

最新の気圧サンプルのエイリアス。

export type GetMeasurementResult = Measurement;

IsAvailableResult

から返される結果 isAvailable.

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

PermissionStatus

から返される権限情報 checkPermissions と requestPermissions.

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

MeasurementEvent

が実行されたときに発行されるイベントペイロード startMeasurementUpdates がアクティブな場合。

export type MeasurementEvent = Measurement;

Measurement

デバイスの気圧計から取得した気圧と相対高度の値。

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型 limited センサーアクセスをスロットルできるプラットフォーム向け。

export type BarometerPermissionState = PermissionState | 'limited';

PermissionState

Capacitor がサポートするプラットフォームごとの権限状態。

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

Source of Truth

このページはプラグインの src/definitions.tsから生成されています。upstream で公開 API が変更されたら、再度 sync を実行してください。

Getting Startedの続きを進める

使用している場合 スタートガイド ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-barometer の使用方法 @capgo/capacitor-barometer でネイティブ機能を使用する場合、 API の概要 「API の概要」の実装の詳細については、 はじめに 「はじめに」における実装の詳細については、 API キー および「API Keys」の実装の詳細については、 デバイス 実装の詳細については Devices を参照してください。