入门
复制一个包含安装步骤和本插件的完整 Markdown 指南的设置提示。
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-uwb`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/uwb/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
您可以使用我们的AI辅助设置来安装插件。使用以下命令将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-uwbbunx cap syncimport { CapacitorUwb } from '@capgo/capacitor-uwb';查看可用性
查看可用性const availability = await CapacitorUwb.isAvailable();
if (!availability.supported) { console.log('This device does not support UWB.');}iOS Peer 会话
iOS Peer 会话- 呼叫
getDiscoveryToken()在两台设备上呼叫。 - 通过其他方式交换返回的 base64 token。
- 使用 peer token 开始范围。
const { discoveryToken } = await CapacitorUwb.getDiscoveryToken();
await CapacitorUwb.startPeerSession({ peerDiscoveryToken: '<peer-token-base64>',});查看 iOS 配置 为了满足能力和权限要求。
Android 控制器 / 控制对象会话
标题:Android 控制器 / 控制对象会话- 控制器调用
startControllerSession()并将返回的rangingParameters并localAddress. - 控制对象使用控制器
rangingParameters作为localAddress控制对象调用peerAddress. - 可选地将
startControleeSession({ rangingParameters }). - 传递给控制器一旦控制对象地址已知。
peerAddress__CAPGO_KEEP_0__
const controller = await CapacitorUwb.startControllerSession();
await CapacitorUwb.startControleeSession({ rangingParameters: { ...controller.rangingParameters, peerAddress: controller.localAddress, },});查看 安卓设置 查看硬件和权限要求。
监听更新
标题:监听更新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 以刷新生成的文档。