はじめから始める

インストール

CapgoのAI-Assisted Setupを使用してプラグインをインストールできます。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 Setupを使用する場合は、以下のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の指示に従ってください。

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 } 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 } 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

Compassの精度レベル定数

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

Compassへのアクセス許可状態

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

真実の源

公開__CAPGO_KEEP_0__がアップストリームで変更されたときに、再度Syncを実行してください。 src/definitions.ts. Re-run the sync when the public API changes upstream.

Getting Startedから続けてください

Capgoを使用している場合 Getting Started ダッシュボードとAPIの操作を計画するには Capgoの@capgo/capacitor-compassを使用 Capgoの@capgo/capacitor-compassのネイティブ機能について API Overview for the implementation detail in API Overview, Capgoのキーの実装詳細について Capgoのキーの実装詳細について API Keys for the implementation detail in API Keys, and Getting Started __CAPGO_KEEP_0__の実装詳細については、デバイスにあります。