Getting Started

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrem AI-Tool hinzu, indem Sie den folgenden Befehl ausführen:

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

Dann verwenden Sie den folgenden Prompt:

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 darunterstehenden plattform-spezifischen Anweisungen befolgen.

bun add @capgo/capacitor-uwb
bunx cap sync

Importieren

import { CapacitorUwb } from '@capgo/capacitor-uwb';

Verfügbarkeit überprüfen

const availability = await CapacitorUwb.isAvailable();

if (!availability.supported) {
  console.log('This device does not support UWB.');
}

iOS-Peer-Sitzung

1. Anrufen getDiscoveryToken() auf beiden Geräten.
2. Austauschen Sie die zurückgegebenen Base64-Tokens außerhalb des Systems.
3. Mit dem Peer-Token beginnen, den Bereich zu messen.

const { discoveryToken } = await CapacitorUwb.getDiscoveryToken();

await CapacitorUwb.startPeerSession({
  peerDiscoveryToken: '<peer-token-base64>',
});

Siehe iOS-Einrichtung für die Anforderungen an Fähigkeiten und Berechtigungen.

Android-Controller / Controlee-Sitzung

1. Der Controller ruft an startControllerSession() und teilt die zurückgegebenen rangingParameters und localAddress.
2. Der Controlee baut seinen eigenen rangingParametersmit Hilfe des Controllers localAddress als peerAddress.
3. Der Controlee ruft an startControleeSession({ rangingParameters }).
4. Optional kann man peerAddress zum Controller, sobald die Adresse des Kontrollierten 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

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

await CapacitorUwb.addListener('sessionStateChanged', (event) => {
  console.log(event.state, event.reason);
});

Sitzung beenden

await CapacitorUwb.stopSession();

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert src/definitions.tsAktualisieren Sie die TypeScript-Definitionen und führen Sie bun run docgen in der Plugin-Repository aktualisieren, um die generierten API Dokumente neu zu laden.