始め方

インストール

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

__CAPGO_KEEP_0__を停止します。 この機能はコンパスセンサを停止し、イベントの発行を停止します。

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

「getAccuracy」セクション

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

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

Androidでは、現在の磁気センサの精度を返します。

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 がアップストリームで変更された場合に再度同期してください。

始めから始める

あなたが使用している場合 始めから始める ダッシュボードとAPIの運用計画を立てるには、 Using @capgo/capacitor-compass Using @capgo/capacitor-compass APIの概要 APIの実装詳細 導入 __CAPGO_KEEP_0__の鍵 APIの実装詳細 for the implementation detail in API Keys, and __CAPGO_KEEP_0__の実装詳細 ページを編集