コンパス

使用中:@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: https://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 for the implementation detail in @capgo/capacitor-compass, はじめに Capacitor Compassの概要 API Overview for the implementation detail in API Overview, Capacitor Compassのキーについて、 Capacitor Compassのキー API Keys for the implementation detail in API Keys.