Saltar al contenido principal
@capgo/capacitor-ibeacon Ubicación Código abierto

iBeacon plugin Capacitor

Plugin iBeacon para Capacitor: detección de proximidad y monitoreo de regiones beacon

Instalar

bun add @capgo/capacitor-ibeacon bunx cap sync
npm, pnpm o yarn
  • npm install @capgo/capacitor-ibeacon
  • pnpm add @capgo/capacitor-ibeacon
  • yarn add @capgo/capacitor-ibeacon

Guía

Cómo usar iBeacon en Capacitor

Uso de @capgo/capacitor-ibeacon

Plugin Capacitor iBeacon: detección de proximidad y monitoreo de regiones de beacons.

Instalar

bun add @capgo/capacitor-ibeacon
bunx cap sync

bunx cap sync copia el code nativo del plugin en tus proyectos nativos. Ejecútalo de nuevo tras cada actualización del plugin.

Importar

import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';

API de un vistazo

Método Descripción
startMonitoringForRegion Empieza a monitorizar una región de beacons. Dispara eventos al entrar o salir de la región.
stopMonitoringForRegion Deja de monitorizar una región de beacons.
startRangingBeaconsInRegion Empieza a detectar beacons en una región. Ofrece actualizaciones de distancia continuas.
stopRangingBeaconsInRegion Deja de detectar beacons en una región.
startAdvertising Empieza a anunciar el dispositivo como iBeacon (solo iOS).
stopAdvertising Deja de anunciar el dispositivo como iBeacon (solo iOS).
requestWhenInUseAuthorization Solicita permiso de ubicación "Al usar la app" (necesario para detección/monitoreo).
requestAlwaysAuthorization Solicitar permiso de ubicación "Siempre" (necesario para el monitoreo en segundo plano).
getAuthorizationStatus Obtener el estado actual del permiso de ubicación.
isBluetoothEnabled Comprueba si Bluetooth está activado en el dispositivo.
isRangingAvailable Comprobar si el dispositivo permite el ranging.
enableARMAFilter Activar el filtrado ARMA para cálculos de distancia (solo Android).
enableBackgroundMode Activar o desactivar el escaneo de beacons en segundo plano (solo Android). Esto habilita un foreground service para una detección fiable. Debe llamarse tras solicitar el permiso de ubicación "Siempre".
setBackgroundScanPeriod Configurar los periodos de escaneo en segundo plano (solo Android). Controla la frecuencia y duración del escaneo de beacons en background.

Ejemplos

startMonitoringForRegion()

Empieza a monitorizar una región de beacons. Dispara eventos al entrar o salir de la región.

import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';

await CapacitorIbeacon.startMonitoringForRegion({
  identifier: 'MyBeaconRegion',
  uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});

stopMonitoringForRegion()

Deja de monitorizar una región de beacons.

import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';

await CapacitorIbeacon.stopMonitoringForRegion({
  identifier: 'MyBeaconRegion',
  uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});

startRangingBeaconsInRegion()

Iniciar el ranging de beacons en una región. Proporciona actualizaciones de distancia continuas.

import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';

await CapacitorIbeacon.startRangingBeaconsInRegion({
  identifier: 'MyBeaconRegion',
  uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});

stopRangingBeaconsInRegion()

Detener el ranging de beacons en una región.

import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';

await CapacitorIbeacon.stopRangingBeaconsInRegion({
  identifier: 'MyBeaconRegion',
  uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});

startAdvertising()

Empieza a anunciar el dispositivo como iBeacon (solo iOS).

import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';

await CapacitorIbeacon.startAdvertising({
  uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D',
  major: 1,
  minor: 2,
  identifier: 'MyBeacon'
});

stopAdvertising()

Deja de anunciar el dispositivo como iBeacon (solo iOS).

import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';

await CapacitorIbeacon.stopAdvertising();

La tabla anterior lista los 14 métodos principales. Los helpers de listener y de versión, y el contrato completo de cada método, están documentados en el repositorio GitHub.

Escuchar eventos

addListener devuelve un handle. Llama handle.remove() cuando la pantalla se desmonte, o CapacitorIbeacon.removeAllListeners() para limpiar todos los listeners.

Referencia completa

Continúa desde Uso de @capgo/capacitor-ibeacon

Si estás usando Uso de @capgo/capacitor-ibeacon para planificar el trabajo con plugins nativos, conéctalo con @capgo/capacitor-ibeacon para el detalle de implementación en @capgo/capacitor-ibeacon, Primeros pasos para los detalles de implementación en Primeros pasos, Directorio de plugins de Capgo para el flujo de trabajo del producto en Capgo Plugin Directory, Plugins de Capacitor por Capgo para los detalles de implementación en Capacitor Plugins de Capgo, y Añadir o actualizar plugins para los detalles de implementación al añadir o actualizar plugins.

FAQ

FAQ del plugin iBeacon

¿Cómo instalo el plugin iBeacon en una app Capacitor?

Ejecuta "bun add @capgo/capacitor-ibeacon" (o "npm install @capgo/capacitor-ibeacon"), luego ejecuta "bunx cap sync" para que los proyectos de iOS y Android reconozcan el code nativo. Impórtalo desde "@capgo/capacitor-ibeacon" en el code de tu app.

¿Es compatible @capgo/capacitor-ibeacon con React, Vue y Angular?

Sí. iBeacon es un paquete de Capacitor, por lo que funciona con cualquier framework web que se ejecute dentro de Capacitor, incluyendo Ionic, React, Vue, Angular, Svelte y JavaScript puro.

¿Qué versión de Capacitor es compatible con @capgo/capacitor-ibeacon?

Los plugins de Capgo siguen la versión mayor de Capacitor: usa la versión mayor del plugin que coincida con la versión mayor de tu Capacitor (por ejemplo, el plugin v8 con Capacitor 8). La tabla de compatibilidad del README de GitHub lista las versiones mantenidas.

¿Es @capgo/capacitor-ibeacon gratuito y de código abierto?

Sí. El código fuente de code es público en GitHub, en https://github.com/Cap-go/capacitor-ibeacon/ y el paquete es gratuito para instalar desde npm. Los reportes de bugs y pull requests son bienvenidos.

¿Puedo actualizar code que usa iBeacon sin pasar por la revisión de la App Store?

Instalar o actualizar el plugin cambia el code nativo, así que requiere un nuevo build para la tienda. Después, los cambios de JavaScript, HTML y CSS que llamen al plugin se pueden publicar al instante con las live updates de Capgo.

Lanza cambios de iBeacon sin esperar la revisión de la app

Una vez que el plugin esté en tu store build, Capgo live updates envía tus cambios de JavaScript, HTML y CSS a los usuarios en minutos.

Empieza con Capgo