Prise en main

Installer

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil d'IA en utilisant la commande suivante :

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

Ensuite, utilisez la prompt suivante :

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-uwb` plugin in my project.

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

bun add @capgo/capacitor-uwb
bunx cap sync

Importer

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

Vérifier la disponibilité

const availability = await CapacitorUwb.isAvailable();

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

Session de pair iOS

1. Appeler getDiscoveryToken() sur les deux appareils.
2. Échangez les jetons base64 retournés hors bande.
3. Commencez à émettre des signaux avec le jeton pair.

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

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

Voir Configuration iOS pour les exigences de capacité et de droits.

Session du Contrôleur Android / Contrôlé

1. Le contrôleur appelle startControllerSession() et partage les jetons retournés rangingParameters et localAddress.
2. Le contrôlé construit son propre rangingParameters, en utilisant le contrôleur localAddress comme peerAddress.
3. Le contrôleur appelle startControleeSession({ rangingParameters }).
4. Passer optionnellement peerAddress à la fois au contrôleur une fois que l'adresse du contrôlé est connue.

const controller = await CapacitorUwb.startControllerSession();

await CapacitorUwb.startControleeSession({
  rangingParameters: {
    ...controller.rangingParameters,
    peerAddress: controller.localAddress,
  },
});

Voir Configuration Android pour les exigences de matériel et de permissions.

Écouter les mises à jour

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

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

Arrêtez La Session

await CapacitorUwb.stopSession();

Source De Vérité

Cette page est générée à partir du plugin’s src/definitions.tsMettez à jour les définitions TypeScript et exécutez bun run docgen in le dépôt du plugin pour rafraîchir les documents générés API.