コンパス

@capgo/capacitor-compass を使用する

Capacitor コンパス プラグイン インターフェイス

インストール

bun add @capgo/capacitor-compass
bunx cap sync

このプラグインが公開するもの

• getCurrentHeading - 度で現在のコンパス向きを取得します。iOSでは、向きはバックグラウンドで更新され、最新の値が返されます。Androidでは、メソッドを呼び出すと加速度計と磁気センサを使用して向きが計算されます。Webでは実装されていません。
• startListening - コンパス向きの変更をイベントを介してリスニングすることを開始します。このコンパスセンサを開始し、'headingChange' イベントを発行します。
• stopListening - コンパス向きの変更をリスニングすることを停止します。このコンパスセンサを停止し、イベントの発行を停止します。
• checkPermissions - コンパスデータへのアクセスを許可するための現在の許可状態を確認します。iOSでは、場所の許可状態を確認します。Androidでは、常に 'granted' が返されます。

使用例

getCurrentHeading

- 度で現在のコンパス向きを取得します。iOSでは、向きはバックグラウンドで更新され、最新の値が返されます。Androidでは、メソッドを呼び出すと加速度計と磁気センサを使用して向きが計算されます。Webでは実装されていません。

import { CapgoCompass } from '@capgo/capacitor-compass';

const { value } = await CapgoCompass.getCurrentHeading();
console.log('Compass heading:', value, 'degrees');

startListening

コンパスヘッドの変更をイベントを介して待ち受けることができます。この機能はコンパスセンサを開始し、'headingChange' イベントを発行します。

import { CapgoCompass } from '@capgo/capacitor-compass';

// With default throttling (100ms interval, 2° minimum change)
await CapgoCompass.startListening();

// With custom throttling for high-frequency updates
await CapgoCompass.startListening({
  minInterval: 50,      // 50ms between events
  minHeadingChange: 1.0 // 1° minimum change
});

CapgoCompass.addListener('headingChange', (event) => {
  console.log('Heading:', event.value);
});

stopListening

コンパスヘッドの変更を待ち受ける機能を停止します。この機能はコンパスセンサを停止し、イベントの発行を停止します。

import { CapgoCompass } from '@capgo/capacitor-compass';

await CapgoCompass.stopListening();

checkPermissions

コンパスデータへのアクセスを許可する現在の許可状態を確認します。iOS の場合、位置許可の許可状態を確認します。Android の場合、この機能は常に 'granted' を返します。なぜなら、許可は必要ありませんからです。

import { CapgoCompass } from '@capgo/capacitor-compass';

const status = await CapgoCompass.checkPermissions();
console.log('Compass permission:', status.compass);

フルリファレンス

• GitHub: github.com/Cap-go/capacitor-compass
• ドキュメント: /docs/plugins/compass/

Keep going from Using @capgo/capacitor-compass

Capacitor Compass を使用している場合 Using @capgo/capacitor-compass to plan dashboard and API operations, connect it with @capgo/capacitor-compass Capacitor Compassの実装詳細については@capgo/capacitor-compassを参照してください。 はじめに Capacitor Compassの実装詳細についてはGetting Startedを参照してください。 API Compassの概要 Capacitor Compassの実装詳細についてはAPI Compassの概要を参照してください。 Capacitor Compassの概要 Capacitor Compassの実装詳細についてはCapacitor Compassの概要を参照してください。 API Keys for the implementation detail in API Keys.