スタートガイド

インストール

AIアシストによるセットアップでプラグインをインストールできます。以下のコマンドを使用して、お使いのAIツールに Capgo のスキルを追加してください：

bunx 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-uwb` plugin in my project.

手動セットアップを希望する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム別の手順に従ってください：

bun add @capgo/capacitor-uwb
bunx cap sync

インポート

import { CapacitorUwb } from '@capgo/capacitor-uwb';

クイックスタート

import { CapacitorUwb } from '@capgo/capacitor-uwb';

const result = await CapacitorUwb.isAvailable();
console.log(result);

例: getDiscoveryToken

import { CapacitorUwb } from '@capgo/capacitor-uwb';

const result = await CapacitorUwb.getDiscoveryToken();
// The result holds sensitive values: use it without logging it.

例: startPeerSession

import { CapacitorUwb } from '@capgo/capacitor-uwb';

await CapacitorUwb.startPeerSession({ peerDiscoveryToken: 'peer-discovery-token-123' });

よくある落とし穴

• リスナー: 画面がアンマウントされたらハンドルを削除します。
• ネイティブ同期: 実行 bunx cap sync プラグインのアップグレード後。
• 信頼できる情報源: 信頼 src/definitions.ts GitHub リポジトリ内。

利用可能性の確認

const availability = await CapacitorUwb.isAvailable();

if (!availability.supported) {
  console.log('This device does not support UWB.');
}

iOS Peer Session

1. 呼び出す getDiscoveryToken() 両方のデバイスで。
2. 返されたbase64トークンを、別の手段（out-of-band）で交換してください。
3. ピアトークンを使用してレンジングを開始します。

const { discoveryToken } = await CapacitorUwb.getDiscoveryToken();

await CapacitorUwb.startPeerSession({
  peerDiscoveryToken: '<peer-token-base64>',
});

詳細は iOSの設定 機能および権限の要件について。

Android Controller / Controlee セッション

1. コントローラーが呼び出し、 startControllerSession() 返されたデータを共有します。 rangingParameters と localAddress.
2. Controlee は独自のデータを構築し、 rangingParametersコントローラーを使用して、 localAddress として peerAddress.
3. Controleeからの呼び出し startControleeSession({ rangingParameters }).
4. オプションで以下を渡します peerAddress Controleeのアドレスが判明次第、controllerに渡します。

const controller = await CapacitorUwb.startControllerSession();

await CapacitorUwb.startControleeSession({
  rangingParameters: {
    ...controller.rangingParameters,
    peerAddress: controller.localAddress,
  },
});

詳細は Androidの設定 ハードウェアおよび権限の要件についてはこちら。

アップデートの待機

await CapacitorUwb.addListener('rangingUpdate', (event) => {
  console.log(event.distanceMeters, event.direction);
});

await CapacitorUwb.addListener('sessionStateChanged', (event) => {
  console.log(event.state, event.reason);
});

セッションの停止

await CapacitorUwb.stopSession();

Source of Truth

このページはプラグインの src/definitions.ts. TypeScriptの定義を更新して実行してください： bun run docgen プラグインのリポジトリ内で実行することで、生成された API ドキュメントが最新の状態になります。