Prise en main

Installer

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

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

Utilisez ensuite le prompt suivant :

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 une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :

bun add @capgo/capacitor-uwb
bunx cap sync

Importer

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

Démarrage rapide

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

const result = await CapacitorUwb.isAvailable();
console.log(result);

Exemple : getDiscoveryToken

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

const result = await CapacitorUwb.getDiscoveryToken();
// The result holds sensitive values: use it without logging it.

Exemple : startPeerSession

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

await CapacitorUwb.startPeerSession({ peerDiscoveryToken: 'peer-discovery-token-123' });

Erreurs courantes

• Écouteurs: supprimez les handles lors du démontage des écrans.
• Sync native : exécuter bunx cap sync après les mises à jour du plugin.
• Source de vérité : fiez-vous src/definitions.ts au repo GitHub.

Vérifier la disponibilité

const availability = await CapacitorUwb.isAvailable();

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

Session peer iOS

1. Appelez getDiscoveryToken() sur les deux appareils.
2. Échangez les tokens base64 retournés via un canal externe.
3. Commencez la mesure de distance avec le peer token.

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

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

Consultez Configuration iOS pour les exigences de capacités et de permissions.

Session contrôleur / contrôlé Android

1. Le contrôleur appelle startControllerSession() et partage le résultat retourné rangingParameters et localAddress.
2. Le contrôlé construit son propre rangingParameters, en utilisant le contrôleur localAddress comme peerAddress.
3. L'appareil contrôlé appelle startControleeSession({ rangingParameters }).
4. Passez optionnellement peerAddress au contrôleur une fois l'adresse de l'appareil contrôlé connue.

const controller = await CapacitorUwb.startControllerSession();

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

Consultez Configuration Android pour les exigences matérielles et les 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êter la session

await CapacitorUwb.stopSession();

Source de vérité

Cette page est générée à partir de src/definitions.ts. Mettez à jour les définitions TypeScript et lancez bun run docgen dans le dépôt du plugin pour rafraîchir la documentation API générée.