iOS Nearby Interaction
Exchange NIDiscoveryToken values and run peer sessions with Apple’s Nearby Interaction framework.
@capgo/capacitor-uwb
Measure precise distance and direction between UWB-capable devices using native iOS and Android ranging APIs.
Overview
Section titled “Overview”Capacitor plugin for Ultra-Wideband (UWB) ranging on iOS and Android.
Android Jetpack UWB
Start controller and controlee sessions with androidx.core.uwb ranging parameters.
Live Ranging Events
Listen for distance, direction, and session lifecycle updates from JavaScript.
Out-of-Band Exchange
Bring your own transport for token and parameter exchange, such as BLE, MultipeerConnectivity, or a backend.
Core Capabilities
Section titled “Core Capabilities”isAvailable- Check whether UWB is supported and currently available.getDiscoveryToken- Get the local Nearby Interaction discovery token on iOS.startPeerSession- Start an iOS peer ranging session.startControllerSession- Start an Android controller session and return shareable parameters.startControleeSession- Start an Android controlee session from controller parameters.stopSession- Stop the active ranging session.
Public API
Section titled “Public API”| Method | Description |
|---|---|
isAvailable | Check whether UWB is supported and currently available on the device. |
getDiscoveryToken | Get the local Nearby Interaction discovery token on iOS. |
startPeerSession | Start a Nearby Interaction peer session on iOS. |
startControllerSession | Start an Android UWB controller session and return shareable parameters. |
startControleeSession | Start an Android UWB controlee session with parameters from the controller. |
stopSession | Stop the active UWB ranging session. |
addListener | Listen for rangingUpdate and sessionStateChanged events. |
getPluginVersion | Get the current native plugin version. |
Source Of Truth
Section titled “Source Of Truth”This reference is synced from src/definitions.ts in capacitor-uwb.