Compass

Utilizzo di @capgo/capacitor-compass

Capacitor Plugin Compass per l'interfaccia di lettura della direzione del dispositivo compasso.

Installa

bun add @capgo/capacitor-compass
bunx cap sync

Cosa Questo Plugin Espone

• getCurrentHeading - Ottieni la direzione attuale del compasso in gradi. Su iOS, la direzione viene aggiornata in background e il valore più recente viene restituito. Su Android, la direzione viene calcolata quando viene chiamato il metodo utilizzando i sensori accelerometro e magnetometro. Non implementato su Web.
• startListening - Avvia l'ascolto delle modifiche della direzione del compasso tramite eventi. Ciò avvia i sensori del compasso e emette eventi di tipo 'headingChange'.
• stopListening - Fermati di ascoltare le modifiche della direzione del compasso. Ciò ferma i sensori del compasso e ferma l'emissione di eventi.
• checkPermissions - Verifica lo stato di autorizzazione corrente per l'accesso ai dati del compasso. Su iOS, questo controlla lo stato di autorizzazione per la posizione. Su Android, questo restituisce sempre 'concesso' poiché non sono richieste autorizzazioni.

Esempio di utilizzo

getCurrentHeading

Ottenere l'attuale orientamento del compasso in gradi. Su iOS, l'orientamento viene aggiornato in background e il valore più recente viene restituito. Su Android, l'orientamento viene calcolato quando viene chiamato il metodo utilizzando i sensori accelerometro e magnetometro. Non implementato su Web.

import { CapgoCompass } from '@capgo/capacitor-compass';

const { value } = await CapgoCompass.getCurrentHeading();
console.log('Compass heading:', value, 'degrees');

startListening

Inizia a ricevere notifiche di cambiamento dell'orientamento del compasso tramite eventi. Questo avvia i sensori del compasso e emette eventi di tipo 'headingChange'.

import { CapgoCompass } from '@capgo/capacitor-compass';

// With default throttling (100ms interval, 2° minimum change)
await CapgoCompass.startListening();

// With custom throttling for high-frequency updates
await CapgoCompass.startListening({
  minInterval: 50,      // 50ms between events
  minHeadingChange: 1.0 // 1° minimum change
});

CapgoCompass.addListener('headingChange', (event) => {
  console.log('Heading:', event.value);
});

stopListening

Interrompi la ricezione di notifiche di cambiamento dell'orientamento del compasso. Questo ferma i sensori del compasso e interrompe l'emissione di eventi.

import { CapgoCompass } from '@capgo/capacitor-compass';

await CapgoCompass.stopListening();

checkPermissions

Verifica lo stato di autorizzazione corrente per l'accesso ai dati del compasso. Su iOS, questo controlla lo stato di autorizzazione per la posizione. Su Android, questo restituisce sempre 'concesso' poiché non sono richieste autorizzazioni.

import { CapgoCompass } from '@capgo/capacitor-compass';

const status = await CapgoCompass.checkPermissions();
console.log('Compass permission:', status.compass);

Riferimento completo

• GitHub: https://github.com/Cap-go/capacitor-compass/
• Doc: /docs/plugins/compass/