コンパス

capgo/capacitor-コンパスを使用する

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/

Using @capgo/capacitor-compass を使用している場合

Using @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-compass Capgo の capgo オペレーションを計画するダッシュボードを使用している場合、@capgo/capacitor-compass を接続してください @API/__CAPGO_KEEP_1__-compass を使用している場合 @capgo/capacitor-compass Capacitor Compass用途の実装詳細については、@capgo/capacitor-compassを参照してください。 Getting Started Capacitor Compass用途の実装詳細については、Getting Startedを参照してください。 API Overview for the implementation detail in API Overview, Capacitor Compassの導入 Capacitor Compass用途の実装詳細については、Capacitor Compassの導入について、 API Keys for the implementation detail in API Keys.