Pasar al contenido principal
@capgo/capacitor-ibeacon Ubicación De código abierto

iBeacon plugin de Capacitor

Plugin de iBeacon para Capacitor - detección de proximidad y monitoreo de regiones de señal

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

How to use iBeacon en Capacitor

Usando @capgo/capacitor-ibeacon

Capacitor Plugin de iBeacon - Deteción de proximidad y monitoreo de regiones de señal.

Instalar

bun add @capgo/capacitor-ibeacon
bunx cap sync

bunx cap sync Copia el plugin nativo de code en tus proyectos nativos. Ejecútalo nuevamente después de cada actualización del plugin.

Importar

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

API en resumen

Método Descripción
startMonitoringForRegion Comience a monitorear una región de beacon. Dispara eventos al entrar/salir de la región.
stopMonitoringForRegion Detener el monitoreo de una región de señal.
startRangingBeaconsInRegion Comience a detectar beacons en una región. Proporciona actualizaciones de distancia continuas.
stopRangingBeaconsInRegion Estopar la detección de beacons en una región.
startAdvertising Iniciar la publicación del dispositivo como un iBeacon (solo iOS).
stopAdvertising Detener la publicación del dispositivo como un iBeacon (solo iOS).
requestWhenInUseAuthorization Solicitar autorización de ubicación "En uso" (requerida para la detección/rastreo).
requestAlwaysAuthorization Solicitar autorización de ubicación "Siempre" (requerida para el monitoreo de fondo).
getAuthorizationStatus Obtener estado de autorización de ubicación actual.
isBluetoothEnabled Comprobar si Bluetooth está habilitado en el dispositivo.
isRangingAvailable Comprobar si la detección está disponible en el dispositivo.
enableARMAFilter Habilitar el filtrado ARMA para cálculos de distancia (solo Android).
enableBackgroundMode Habilitar o deshabilitar el modo de escaneo de fondo de beacons (solo Android). Esto habilita un servicio de primer plano para una detección de fondo confiable de beacons. Debe llamarse después de solicitar autorización de ubicación "Siempre".
setBackgroundScanPeriod Configurar períodos de escaneo de fondo (solo Android). Controla cuántas veces y durante cuánto tiempo el dispositivo escanea beacons cuando está en segundo plano.

Ejemplos

startMonitoringForRegion()

Comience a monitorear una región de beacon. Dispara eventos cuando entra/sale de la región.

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

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

stopMonitoringForRegion()

Detenga la monitoreo de una región de beacon.

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

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

startRangingBeaconsInRegion()

Comience a buscar 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()

Detenga la búsqueda de beacons en una región.

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

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

startAdvertising()

Comience a publicitar el dispositivo como un 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()

Detenga la publicidad del dispositivo como un iBeacon (solo iOS).

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

await CapacitorIbeacon.stopAdvertising();

La tabla anterior enumera los 14 métodos básicos. Los ayudantes de escucha y versión, y la completa contratación de cada método, se documentan en el GitHub repositorio.

Escuche eventos

addListener devuelve un manejador. Llame handle.remove() cuando el pantalla se desmonta, o CapacitorIbeacon.removeAllListeners() para eliminar cada escucha.

Referencia completa

Sigue adelante desde Usando @capgo/capacitor-ibeacon

Si estás utilizando Usando @capgo/capacitor-ibeacon para planificar el trabajo de plugin nativo, conecta con @capgo/capacitor-ibeacon para los detalles de implementación en @capgo/capacitor-ibeacon Inicio rápido para los detalles de implementación en Inicio rápido, Capgo Directorio de Plugins para el flujo de trabajo del producto en Capgo Directorio de Plugins, Capacitor Plugins por Capgo para el detalle de implementación en Capacitor Plugins por Capgo, y Agregar o Actualizar Plugins para el detalle de implementación en Agregar o Actualizar Plugins.

FAQ

Preguntas frecuentes del plugin iBeacon

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

Ejecuta "bun add @capgo/capacitor-ibeacon" (o "npm install @capgo/capacitor-ibeacon"), luego ejecuta "bunx cap sync" para que los proyectos iOS y Android capturen el proyecto nativo code. Importa desde "@capgo/capacitor-ibeacon" en tu aplicación code.

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

Sí. iBeacon es un paquete 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 admite @capgo/capacitor-ibeacon?

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

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

Sí. El código fuente de code está disponible públicamente en GitHub en https://github.com/Cap-go/capacitor-ibeacon/ y el paquete es gratuito para instalar desde npm. Se aceptan informes de errores y solicitudes de extracción.

¿Puedo actualizar code que utiliza iBeacon sin una revisión de la Tienda de Aplicaciones?

Instalar o actualizar el plugin cambia el code nativo, por lo que necesita una nueva compilación de la tienda. Después de eso, los cambios en JavaScript, HTML y CSS que llaman al plugin pueden enviar directamente con Capgo actualizaciones en vivo.

Envía cambios de iBeacon sin esperar la revisión de la aplicación

Una vez que el plugin esté en tu tienda de construcción, Capgo actualizaciones en vivo envían los cambios de JavaScript, HTML y CSS a los usuarios en minutos.

Comienza con Capgo