Démarrage

Installer

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de 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érifiez 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. Démarrer la recherche avec le jeton de pair.

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

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

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

Session du Contrôleur Android / Contrôlé

1. Le contrôleur appelle startControllerSession() et partage le résultat retourné rangingParameters et localAddress.
2. Le contrôlé construit son propre rangingParametersen utilisant le contrôleur localAddress comme peerAddress.
3. Le contrôlé appelle startControleeSession({ rangingParameters }).
4. Optionnellement passer peerAddress à l'adresse du 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 droits.

Ecouter 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êter la Session

await CapacitorUwb.stopSession();

Source de Vérité

Cette page est générée à partir du plugin's src/definitions.ts. Mettre à jour les définitions TypeScript et exécuter bun run docgen dans le référentiel du plugin pour rafraîchir les documents générés API.