Anleitung zum Starten
Eine Setup-Vorlage mit den Installationsanweisungen und der vollständigen Markdown-Dokumentation für diesen Plugin kopieren.
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.
Installieren
Abschnitt mit dem Titel „Installieren“Sie können unsere AI-gestützte Einrichtung verwenden, um den Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrem KI-Tool hinzu, indem Sie die folgende Befehl ausführen:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-pluginsDann verwenden Sie die folgende Anfrage:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-uwb` plugin in my project.Wenn Sie eine manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die darunter angegebenen Plattform-spezifischen Anweisungen befolgen:
bun add @capgo/capacitor-uwbbunx cap syncImportieren
Abschnitt mit dem Titel „Importieren“import { CapacitorUwb } from '@capgo/capacitor-uwb';Verfügbarkeit überprüfen
Abschnitt mit dem Titel „Verfügbarkeit überprüfen“const availability = await CapacitorUwb.isAvailable();
if (!availability.supported) { console.log('This device does not support UWB.');}iOS-Peer-Sitzung
Abschnitt mit dem Titel „iOS-Peer-Sitzung“- Aufrufen
getDiscoveryToken()auf beiden Geräten. - Ersetzen Sie die zurückgegebenen Base64-Tokens außerhalb des Bandbreiten.
- Starten Sie das Rangieren mit dem Peer-Token.
const { discoveryToken } = await CapacitorUwb.getDiscoveryToken();
await CapacitorUwb.startPeerSession({ peerDiscoveryToken: '<peer-token-base64>',});Siehe iOS-Einrichtung für Anforderungen an Fähigkeiten und Berechtigungen.
Android Controller / Controlee Sitzung
Abschnitt mit dem Titel „Android Controller / Controlee Sitzung“- Der Controller ruft
startControllerSession()und teilt die zurückgegebenenrangingParametersundlocalAddress. - Der Kontrolleur baut sein eigenes
rangingParameters, indem der Controller verwendet wirdlocalAddressalspeerAddress. - Der Kontrolleur ruft
startControleeSession({ rangingParameters }). - Optionell kann
peerAddressin den Controller einfließen, sobald die Adresse des Kontrolleurs bekannt ist.
const controller = await CapacitorUwb.startControllerSession();
await CapacitorUwb.startControleeSession({ rangingParameters: { ...controller.rangingParameters, peerAddress: controller.localAddress, },});Siehe Android-Einrichtung für Hardware- und Berechtigungsanforderungen.
Für Updates lauschen
Abschnitt mit dem Titel „Für Updates lauschen“await CapacitorUwb.addListener('rangingUpdate', (event) => { console.log(event.distanceMeters, event.direction);});
await CapacitorUwb.addListener('sessionStateChanged', (event) => { console.log(event.state, event.reason);});Sitzung beenden
Abschnitt mit dem Titel „Sitzung beenden“await CapacitorUwb.stopSession();Quellwahrheit
Abschnitt mit dem Titel „Quellwahrheit“Diese Seite wurde aus dem Plugin generiert. src/definitions.tsAktualisieren Sie die TypeScript-Definitionen und führen Sie bun run docgen in dem Plugin-Repository aus, um die generierten API Dokumente zu aktualisieren.