はじめ方

インストール

Capgoの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-compass` plugin in my project.

Manualセットアップを使用する場合は、以下のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の指示に従ってください。

bun add @capgo/capacitor-compass
bunx cap sync

インポート

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

API オーバービュー

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では、常に ‘許可されている’ と返されます。なぜなら、許可は必要ありませんからです。

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

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

requestPermissions

コンパスデータへのアクセス許可を要求します。 iOSでは、ヘッディングデータのために位置情報の許可を要求します。 Androidでは、すぐに解決されます。なぜなら、許可は必要ありませんからです。

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

const status = await CapgoCompass.requestPermissions();
if (status.compass === 'granted') {
  // Can now use compass
}

watchAccuracy

コンパス精度を監視する。 Androidでは、磁気センサの精度を監視し、精度の変更イベントを発行します。 開発者は、これらのイベントにリスナーを追加し、カリブレーション用のUIを実装できます。 iOSとWebでは、このメソッドは何も実行しません。なぜなら、コンパス精度の監視は利用できないからです。

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

// Start monitoring accuracy
await CapgoCompass.watchAccuracy();

// Listen for accuracy changes and implement custom UI
CapgoCompass.addListener('accuracyChange', (event) => {
  console.log('Accuracy changed to:', event.accuracy);
  if (event.accuracy < CompassAccuracy.MEDIUM) {
    // Show your custom calibration UI
  }
});

unwatchAccuracy

モニタリングを停止する。 このモニタリングを停止します。

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

await CapgoCompass.unwatchAccuracy();

getAccuracy

現在のコンパス精度を取得する。 Androidでは、現在の磁気センサの精度を返します。 iOSとWebでは、精度モニタリングが利用できないため、常にCompassAccuracy.UNKNOWNを返します。

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

const { accuracy } = await CapgoCompass.getAccuracy();
if (accuracy < CompassAccuracy.MEDIUM) {
  console.log('Compass needs calibration');
}

型参照

CompassHeading

コンパス向きの値を含む結果

export interface CompassHeading {
  /** Compass heading in degrees (0-360) */
  value: number;
}

ListeningOptions

コンパスリスニングの動作を設定するためのオプション

export interface ListeningOptions {
  /**
   * Minimum interval between heading change events in milliseconds.
   * Lower values = more frequent updates but higher CPU/battery usage.
   *
   * @default 100
   * @since 8.1.4
   */
  minInterval?: number;

  /**
   * Minimum heading change in degrees required to trigger an event.
   * Lower values = more sensitive but more events.
   * Handles wraparound (e.g., 359° to 1° = 2° change).
   *
   * @default 2.0
   * @since 8.1.4
   */
  minHeadingChange?: number;
}

HeadingChangeEvent

ヘッディングの変更イベントのデータ

export interface HeadingChangeEvent {
  /** Compass heading in degrees (0-360) */
  value: number;
}

AccuracyChangeEvent

精度の変更イベントのデータ

export interface AccuracyChangeEvent {
  /** Current accuracy level of the compass */
  accuracy: CompassAccuracy;
}

PermissionStatus

コンパス プラグインのパーミッション ステータス

export interface PermissionStatus {
  /**
   * Permission state for accessing compass/location data.
   * On iOS, this requires location permission to access heading.
   * On Android, no special permissions are required for compass sensors.
   *
   * @since 7.0.0
   */
  compass: PermissionState;
}

CompassAccuracy

コンパス精度のレベル定数

export enum CompassAccuracy {
  /** High accuracy - approximates to less than 5 degrees of error */
  HIGH = 3,
  /** Medium accuracy - approximates to less than 10 degrees of error */
  MEDIUM = 2,
  /** Low accuracy - approximates to less than 15 degrees of error */
  LOW = 1,
  /** Unreliable accuracy - approximates to more than 15 degrees of error */
  UNRELIABLE = 0,
  /** Unknown accuracy value */
  UNKNOWN = -1,
}

PermissionState

コンパスのアクセス用の許可状態です。

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

真実の源

このページはプラグインの src/definitions.tsパブリック API がアップストリームで変更されたときに再度同期を実行してください。

Getting Started から続けて

あなたが使用している場合 Getting Started 計画ダッシュボードとAPIの運用を実施するには、 Using @capgo/capacitor-compass Capgoのネイティブ機能を使用するには、Using @capgo/capacitor-compass APIの概要 Capgoの実装詳細については、API Overview 導入 実装詳細については、Introduction APIのキー 実装詳細については、API Keys、 デバイス 実装詳細については、Devices。