Getting Started

インストール

CapgoのAI-Assistedセットアップを使用してプラグインをインストールできます。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では常に許可が付与されていることを返します。 iOSでは位置情報の許可状況をチェックし、Androidでは常に許可が付与されていることを返します。

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

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

requestPermissions

iOSでは位置情報の許可を要求し、Androidではすぐに許可が付与されていることを返します。 iOSでは位置情報の許可を要求し、Androidではすぐに許可が付与されていることを返します。

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

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

watchAccuracy

Androidでは磁気センサの精度を監視し、精度の変更イベントを発行します。 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');
}

Type Reference

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

__CAPGO_KEEP_2__

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

AccuracyChangeEvent

__CAPGO_KEEP_3__

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

PermissionStatus

__CAPGO_KEEP_5__

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

__CAPGO_KEEP_7__

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から続けて

Capacitorを使用している場合 Getting Started ダッシュボードとAPIの運用計画を立てるには、 @capgo/capacitor-compassを使用 @capgo/capacitor-compassを使用して、 APIの概要 APIの概要の実装詳細について 導入 導入の実装詳細について APIの鍵 APIの鍵の実装詳細について、 デバイス デバイスの実装詳細について。