@ capgo/ 电容- uwb

测量附近设备之间的距离和方向,在你的Capacitor app中标出Ultra-Wideband,用于精确的发现,解锁和相近体验.

🤖 建筑与AI编码代理? 安装 Capgo 技能 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 @capgo/capacitor-uwb 在您的电容应用程序中: npx skills add Cap-go/capgo-skills。然后问你的经纪人: 添加@capgo/capor-uwb到我的Capacitor应用上,并把它接上 代理设置指南 • 妇女 主机磁共振

主要特点

• 可用性数字 : isAvailable() 检查设备上的 UWB 支持 .
• iOS 对等会议数字 : getDiscoveryToken() 财务报告和审定财务报表 startPeerSession() 与近接互动.
• Android 会话数字 : startControllerSession() 财务报告和审定财务报表 startControleeSession() 与Jetpack UWB。 与Jetpack UWB.
• 搜索事件数字 : rangingUpdate 报告距离和方向, sessionStateChanged 跟踪会话.
• 停下来数字 : stopSession() 结束范围.
• 平台: iOS和Android. 互联网档案馆的存檔,存档日期2013-12-21. 需要 UWB 硬件 。 在网上不可用.

为什么这个插件

此插件将本地的 UWB 范围 API 包裹在 iOS 和 Android 上, 因此 Capacitor app 可以 :

• 检查当前设备是否支持 UWB 范围 .
• 以苹果的"相近互动"框架运行iOS上的对等对等范围.
• 使用 Jetpack 在 Android 上运行控制器/控制器测距 androidx.core.uwb。 。 。 .
• 通过插件听众接收距离、方向和会话生命周期更新.

在 iOS 上, 同行交换 NIDiscoveryToken 值出带,然后调用 startPeerSession()。 。 。 . 在Android上,控制器在控制器开始会话前共享范围参数出带.

平台支持

兼容性

插件主版本遵循Capacitor主版本.

安装

您可以使用我们的 AI 辅助设置安装插件 。 使用以下命令将 Capgo 技能添加到您的 AI 工具 :

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

然后使用下列提示:

Use the `capacitor-plugins` skill from `cap-go/capacitor-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.available) {
  return;
}

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

// iOS: exchange discovery tokens out-of-band, then start ranging
const { discoveryToken } = await CapacitorUwb.getDiscoveryToken();
await CapacitorUwb.startPeerSession({ peerDiscoveryToken: '<peer-token-base64>' });

// Android: controller shares ranging parameters out-of-band
const controller = await CapacitorUwb.startControllerSession();
await CapacitorUwb.startControleeSession({
  rangingParameters: {
    ...controller.rangingParameters,
    peerAddress: controller.localAddress,
  },
});

await CapacitorUwb.stopSession();

页:1

• 测试真实的UWB硬件. 模拟器和大多数桌面浏览器都不曝光UWB收音机.
• iOS: (英语) 在 Xcode 中添加近接交互能力并设定 NSNearbyInteractionUsageDescription 内 Info.plist。 。 。 .
• 机器人: 插件声明 android.permission.UWB_RANGING。在开始会话之前,控制器和控制器之间交换频段参数.
• 网络 : isAvailable() 返回时 supported: false。 。 。 .

完整的设置指南 : capgo.app/docs/插件/uwb

示例应用程序

这个 example-app/ 文件夹中包含一个小 Vite 演示,用于检查可用性、交换会话参数、聆听测距更新和停止会话.

API 密码

• isAvailable()
• getDiscoveryToken()
• startPeerSession(...)
• startControllerSession(...)
• startControleeSession(...)
• stopSession()
• addListener('rangingUpdate', ...)
• addListener('sessionStateChanged', ...)
• removeAllListeners()
• getPluginVersion()
• 接口
• 类型异名

IOS和Android上的超宽波段(UWB)的电容插件.

iOS使用Apple's Nearby Interactive框架进行对等测距. Android使用喷气式包装 androidx.core.uwb 用于控制器/控制器会话.

两个平台都要求交换发现符或测距参数 出带(例如蓝牙LE或后端).

易读 ()

isAvailable() => Promise<UwbAvailabilityResult>

请检查UWB是否支持, 设备上是否目前可用 .

回返情况: Promise<UwbAvailabilityResult>

自: 8.0.0 (单位:千美元)

获取 Discovery Token ()

getDiscoveryToken() => Promise<DiscoveryTokenResult>

在iOS上获取本地的"近相"发现符.

将返回的令牌与对等的带外键共享, 然后调用 startPeerSession() 与对等符号.

回返情况: Promise<DiscoveryTokenResult>

自: 8.0.0 (单位:千美元)

启动PeerSession (...)

startPeerSession(options: StartPeerSessionOptions) => Promise<void>

在 iOS 上启动一个近接互动对等会话 .

自: 8.0.0 (单位:千美元)

启动控制会议(...)

startControllerSession(options?: StartControllerSessionOptions | undefined) => Promise<AndroidControllerSessionResult>

启动Android UWB控制器会话并返回可共享参数.

回返情况: Promise<AndroidControllerSessionResult>

自: 8.0.0 (单位:千美元)

启动控制会议(...)

startControleeSession(options: StartControleeSessionOptions) => Promise<void>

用控制器提供的参数启动一个Android UWB控制器会话.

自: 8.0.0 (单位:千美元)

停止会议( )

stopSession() => Promise<void>

停止活动的 UWB 测距会话 .

自: 8.0.0 (单位:千美元)

添加倾听器( 范围更新date )..

addListener(eventName: 'rangingUpdate', listenerFunc: (event: RangingUpdateEvent) => void) => Promise<PluginListenerHandle>

正在运行的会话中可听到距离和方向的更新 .

回返情况: Promise<PluginListenerHandle>

自: 8.0.0 (单位:千美元)

添加收听器( “session state Changed' ,...)

addListener(eventName: 'sessionStateChanged', listenerFunc: (event: SessionStateChangedEvent) => void) => Promise<PluginListenerHandle>

听听会话周期变化.

回返情况: Promise<PluginListenerHandle>

自: 8.0.0 (单位:千美元)

删除所有收听器( )

removeAllListeners() => Promise<void>

删除此插件的所有注册听众 .

自: 8.0.0 (单位:千美元)

获取 PluginVersion ()

getPluginVersion() => Promise<PluginVersionResult>

获取当前本地插件版本 .

回返情况: Promise<PluginVersionResult>

自: 8.0.0 (单位:千美元)

接口

Uwb 可用性

返回结果 isAvailable()。 。 。 .

发现Token结果

返回结果 getDiscoveryToken() (原始内容存档于2018-03-31). On iOS.

开始会话选项

备选方案 startPeerSession() (原始内容存档于2018-03-31). On iOS.

机器人控制器

在启动 Android 控制器会话时返回参数 .

Android Ranging (英语). 参数

Android测距参数在控制器和控制器之间交换出波段.

Uwb 复合频道

Android UWB 复杂频道与对等端交换出波段.

开始控制会议选项

备选方案 startControllerSession() 安卓号.

启动控制会议选项

备选方案 startControleeSession() 安卓号.

插件听筒

搜索更新事件

有效载荷 rangingUpdate 听着.

用户方向

UWB 测距报告3D方向矢量.

会话状态已改变

有效载荷 sessionStateChanged 听着.

插件变压器

请求插件版本时返回结果 .

类型异名

开会国

插件报告的会话周期状态 .

'initialized' | 'running' | 'suspended' | 'resumed' | 'invalidated' | 'stopped' | 'peerDisconnected'