Skip to main content
Capgo logo
Back to plugins
@capgo/capacitor-ibeacon
Tutorial
by github.com/Cap-go

iBeacon

iBeacon plugin for Capacitor - proximity detection and beacon region monitoring

Downloads/week

4.1k

GitHub Stars

7

Guide

Tutorial on iBeacon

Using @capgo/capacitor-ibeacon

Capacitor iBeacon Plugin - Proximity detection and beacon region monitoring.

Install

bun add @capgo/capacitor-ibeacon
bunx cap sync

What This Plugin Exposes

  • startMonitoringForRegion - Start monitoring for a beacon region. Triggers events when entering/exiting the region.
  • stopMonitoringForRegion - Stop monitoring for a beacon region.
  • startRangingBeaconsInRegion - Start ranging beacons in a region. Provides continuous distance updates.
  • stopRangingBeaconsInRegion - Stop ranging beacons in a region.

Example Usage

startMonitoringForRegion

Start monitoring for a beacon region. Triggers events when entering/exiting the region.

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

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

stopMonitoringForRegion

Stop monitoring for a beacon region.

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

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

startRangingBeaconsInRegion

Start ranging beacons in a region. Provides continuous distance updates.

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

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

stopRangingBeaconsInRegion

Stop ranging beacons in a region.

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

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

Full Reference