开始使用

安装

您可以使用我们的 AI-Assisted Setup 来安装插件。将 Capgo 技能添加到您的 AI 工具中，使用以下命令:

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

如果您更喜欢手动设置，请按照以下命令安装插件并遵循以下平台特定的说明：

bun add @capgo/capacitor-uwb
bunx cap sync

导入

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

检查可用性

const availability = await CapacitorUwb.isAvailable();

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

iOS Peer 会话

1. 呼叫 getDiscoveryToken() 在两台设备上
2. 交换返回的 base64 令牌
3. 开始与配对令牌进行测距。

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

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

查看 iOS 配置 查看能力和权限要求。

Android 控制器 / 被控会话

1. 控制器调用 startControllerSession() 并共享返回的 rangingParameters 并 localAddress.
2. 控制器 rangingParameters并与控制器共享返回的结果。控制被控端使用控制器 localAddress 作为 peerAddress.
3. 控制者调用 startControleeSession({ rangingParameters }).
4. 可选地将 peerAddress 将其传递给控制器，一旦控制者地址已知。

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();

真实来源

本页面由插件生成 src/definitions.ts更新 TypeScript 定义并运行 bun run docgen 在插件仓库中刷新生成的API文档。