Primeros pasos

Instalar

Puedes usar nuestro setup asistido por IA para instalar el plugin. Añade las skills de Capgo a tu herramienta de IA con el siguiente comando:

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

Luego usa el siguiente prompt:

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

Si prefieres la configuración manual, instala el plugin ejecutando estos comandos y sigue las instrucciones de cada plataforma:

bun add @capgo/capacitor-uwb
bunx cap sync

Importar

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

Inicio rápido

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

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

Ejemplo: getDiscoveryToken

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

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

Ejemplo: startPeerSession

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

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

Errores comunes

• Listeners: elimina los handles cuando se desmonten las pantallas.
• Sync nativo: ejecuta bunx cap sync tras actualizar los plugins.
• Fuente de verdad: confianza src/definitions.ts en el repo de GitHub.

Comprobar disponibilidad

const availability = await CapacitorUwb.isAvailable();

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

Sesión peer de iOS

1. Llama a getDiscoveryToken() en ambos dispositivos.
2. Intercambia los tokens base64 devueltos por un canal externo.
3. Empieza el ranging con el peer token.

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

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

Ver iOS setup para requisitos de permisos y capacidades.

Sesión Android Controller / Controlee

1. El controller llama a startControllerSession() y comparte el resultado obtenido rangingParameters y localAddress.
2. El controlee construye su propio rangingParameters, usando el controller localAddress como peerAddress.
3. El dispositivo controlado llama a startControleeSession({ rangingParameters }).
4. Opcionalmente, pasa peerAddress al controlador una vez que se conoce la dirección del dispositivo controlado.

const controller = await CapacitorUwb.startControllerSession();

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

Ver Configuración de Android para requisitos de hardware y permisos.

Escuchar actualizaciones

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

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

Detener la sesión

await CapacitorUwb.stopSession();

Fuente de verdad

Esta página se genera a partir del plugin src/definitions.ts. Actualiza las definiciones de TypeScript y ejecuta bun run docgen en el repositorio del plugin para refrescar la documentación generada de API.