Einstieg
Kopieren Sie einen Einrichtungsvorschlag mit den Installationsanweisungen und der vollständigen Markdown-Guideline für diesen Plugin.
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
Sektion mit dem Titel „Installieren“Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie den Capgo-Fähigkeiten Ihre AI-Tool mithilfe der folgenden Befehl hinzu:
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 die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und folgen Sie den unten aufgeführten plattform-spezifischen Anweisungen:
bun add @capgo/capacitor-uwbbunx cap syncImportieren
Sektion mit dem Titel „Importieren“import { CapacitorUwb } from '@capgo/capacitor-uwb';Verfügbarkeit überprüfen
Abschnitt: "Verfügbarkeit überprüfen"const availability = await CapacitorUwb.isAvailable();
if (!availability.supported) { console.log('This device does not support UWB.');}iOS-Peer-Sitzung
Abschnitt: "iOS-Peer-Sitzung"- Anrufen
getDiscoveryToken()auf beiden Geräten. - Ersetzen Sie die zurückgegebenen Base64-Tokens außerhalb des Bandes.
- Mit dem Peer-Token beginnen, das Rang zu erstellen.
const { discoveryToken } = await CapacitorUwb.getDiscoveryToken();
await CapacitorUwb.startPeerSession({ peerDiscoveryToken: '<peer-token-base64>',});Weiterlesen iOS-Einrichtung für Fähigkeiten und Berechtigungsanforderungen.
Android Controller / Controlee-Sitzung
Abschnitt mit dem Titel „Android Controller / Controlee-Sitzung“- Der Controller ruft
startControllerSession()und teilt die zurückgegebenerangingParametersundlocalAddress. - Der Controlee baut sein eigenes
rangingParameters, wobei der ControllerlocalAddressalspeerAddress. - Der Controlee ruft
startControleeSession({ rangingParameters }). - Optionell kann
peerAddresszum Controller übergeben werden, sobald die Adresse des Controlees 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 Aktualisierungen lauschen
Abschnitt mit dem Titel “Für Aktualisierungen lauschen”await CapacitorUwb.addListener('rangingUpdate', (event) => { console.log(event.distanceMeters, event.direction);});
await CapacitorUwb.addListener('sessionStateChanged', (event) => { console.log(event.state, event.reason);});Die Sitzung beenden
Abschnitt mit dem Titel “Die Sitzung beenden”await CapacitorUwb.stopSession();Quelle der Wahrheit
Abschnitt mit dem Titel “Quelle der Wahrheit”Diese Seite wurde aus dem Plugin-Modul generiert. src/definitions.ts. Aktualisiere die TypeScript-Definitionen und führe bun run docgen in dem Plugin-Repository aus, um die generierten API Dokumente zu aktualisieren.