Per iniziare

Installa

Puoi usare il nostro setup assistito dall'IA per installare il plugin. Aggiungi le skill Capgo al tuo strumento di IA usando il seguente comando:

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

Poi usa il seguente prompt:

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

Se preferisci la configurazione manuale, installa il plugin eseguendo questi comandi e segui le istruzioni specifiche per piattaforma qui sotto:

bun add @capgo/capacitor-ibeacon
bunx cap sync

Importa

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

Avvio rapido

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

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

Esempio: stopMonitoringForRegion

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

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

Esempio: startRangingBeaconsInRegion

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

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

Errori comuni

• Listener: rimuovi gli handle quando gli screen vengono smontati.
• Sync nativo: esegui bunx cap sync dopo gli aggiornamenti dei plugin.
• Fonte di verità: fidati src/definitions.ts nel repo GitHub.

Panoramica API

startMonitoringForRegion

Inizia il monitoraggio di una regione beacon. Attiva eventi quando entri o esci dalla regione.

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

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

stopMonitoringForRegion

Interrompe il monitoraggio di una regione beacon.

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

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

startRangingBeaconsInRegion

Avvia il ranging dei beacon in una regione. Fornisce aggiornamenti continui sulla distanza.

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

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

stopRangingBeaconsInRegion

Ferma il ranging dei beacon in una regione.

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

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

startAdvertising

Avvia l'advertising del dispositivo come 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

Ferma l'advertising del dispositivo come iBeacon (solo iOS).

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

await CapacitorIbeacon.stopAdvertising();

requestWhenInUseAuthorization

Richiedi l'autorizzazione alla posizione “When In Use” (necessaria per ranging/monitoring).

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

const { status } = await CapacitorIbeacon.requestWhenInUseAuthorization();
console.log('Authorization status:', status);

requestAlwaysAuthorization

Richiedi l'autorizzazione alla posizione “Always” (necessaria per il monitoraggio in background).

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

const { status } = await CapacitorIbeacon.requestAlwaysAuthorization();
console.log('Authorization status:', status);

getAuthorizationStatus

Ottieni lo stato attuale dell'autorizzazione alla posizione.

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

const { status } = await CapacitorIbeacon.getAuthorizationStatus();
console.log('Current status:', status);

isBluetoothEnabled

Controlla se il Bluetooth è abilitato sul dispositivo.

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

const { enabled } = await CapacitorIbeacon.isBluetoothEnabled();
if (!enabled) {
  console.log('Please enable Bluetooth');
}

isRangingAvailable

Verifica se il ranging è disponibile sul dispositivo.

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

const { available } = await CapacitorIbeacon.isRangingAvailable();
if (available) {
  console.log('Ranging is supported');
}

enableARMAFilter

Abilita il filtro ARMA per il calcolo della distanza (solo Android).

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

await CapacitorIbeacon.enableARMAFilter({
  enabled: true
});

enableBackgroundMode

Abilita o disabilita la scansione dei beacon in background (solo Android). Attiva un foreground service per un rilevamento affidabile in background. Deve essere chiamato dopo aver richiesto l'autorizzazione alla posizione “Always”.

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

// Enable background mode for beacon scanning
await CapacitorIbeacon.enableBackgroundMode({ enabled: true });

// Disable background mode
await CapacitorIbeacon.enableBackgroundMode({ enabled: false });

setBackgroundScanPeriod

Configura i periodi di scansione in background (solo Android). Controlla la frequenza e la durata della scansione dei beacon in background.

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

// Set background scan to 10 seconds every 30 seconds
await CapacitorIbeacon.setBackgroundScanPeriod({
  scanPeriod: 10000,        // 10 seconds of scanning
  betweenScanPeriod: 30000  // 30 seconds between scans
});

Riferimento ai tipi

BeaconRegion

Definizione della regione Beacon per il monitoraggio e il ranging.

export interface BeaconRegion {
  /**
   * Unique identifier for this region.
   */
  identifier: string;

  /**
   * UUID of the beacon(s) to detect.
   */
  uuid: string;

  /**
   * Major value for filtering (optional).
   */
  major?: number;

  /**
   * Minor value for filtering (optional).
   */
  minor?: number;

  /**
   * Notify when device enters region (iOS only).
   */
  notifyEntryStateOnDisplay?: boolean;

  /**
   * Enable Android background mode for this monitoring/ranging call.
   * When true, the plugin will keep scanning in background using a foreground service.
   */
  enableBackgroundMode?: boolean;
}

BeaconAdvertisingOptions

Opzioni di advertising del Beacon per la trasmissione come iBeacon (solo iOS).

export interface BeaconAdvertisingOptions {
  /**
   * UUID to advertise.
   */
  uuid: string;

  /**
   * Major value (0-65535).
   */
  major: number;

  /**
   * Minor value (0-65535).
   */
  minor: number;

  /**
   * Identifier for the advertising beacon.
   */
  identifier: string;

  /**
   * Measured power (RSSI at 1 meter). Optional, defaults to -59.
   */
  measuredPower?: number;
}

BackgroundScanPeriodOptions

Opzioni di configurazione del periodo di scansione in background (solo Android).

export interface BackgroundScanPeriodOptions {
  /**
   * Duration of each scan period in milliseconds.
   * Default: 10000 (10 seconds)
   */
  scanPeriod?: number;

  /**
   * Duration between scan periods in milliseconds.
   * Default: 15000 (15 seconds)
   */
  betweenScanPeriod?: number;
}

RangingEventData

Dati dell'evento durante il ranging dei beacon.

export interface RangingEventData {
  /**
   * Region that was ranged.
   */
  region: BeaconRegion;

  /**
   * Array of detected beacons.
   */
  beacons: Beacon[];
}

MonitoringEventData

Dati dell'evento all'ingresso o all'uscita da una regione.

export interface MonitoringEventData {
  /**
   * Region that triggered the event.
   */
  region: BeaconRegion;

  /**
   * Event state: 'enter' or 'exit'.
   */
  state: 'enter' | 'exit';
}

Beacon

Informazioni sul beacon rilevato.

export interface Beacon {
  /**
   * Beacon UUID.
   */
  uuid: string;

  /**
   * Major value.
   */
  major: number;

  /**
   * Minor value.
   */
  minor: number;

  /**
   * RSSI (Received Signal Strength Indicator).
   */
  rssi: number;

  /**
   * Proximity: 'immediate', 'near', 'far', or 'unknown'.
   */
  proximity: 'immediate' | 'near' | 'far' | 'unknown';

  /**
   * Estimated distance in meters.
   */
  accuracy: number;
}

Fonte di verità

Questa pagina è generata dal src/definitions.ts. Riesegui la sync quando il API pubblico cambia upstream.

Continua da Getting Started

Se stai usando Per iniziare per pianificare le operazioni della dashboard e di API, collegalo a Utilizzo di @capgo/capacitor-ibeacon per la funzionalità nativa in Utilizzo di @capgo/capacitor-ibeacon, Panoramica API per i dettagli di implementazione in Panoramica di API, Introduzione per i dettagli di implementazione in Introduzione, Chiavi API per i dettagli di implementazione in Chiavi API, e Dispositivi per i dettagli di implementazione in Dispositivi.