Saltare al contenuto principale
Torna ai plugin
@capgo/capacitor-compass
Istruzioni
@capgo/capacitor-compass

Compass

Leggi l'orientamento del compasso del dispositivo in gradi con aggiornamenti continui e gestione delle autorizzazioni

Guida

Tutoriale su Compass

Testare sul dispositivo

Scarica l'app Capgo, poi scansa il codice QR code.

Collegamento QR di anteprima del plugin Compass code

Utilizza @capgo/capacitor-compass

Interfaccia del plugin Compass di Capacitor per la lettura della direzione del dispositivo compasso.

Installa

bun add @capgo/capacitor-compass
bunx cap sync

Cos'è che 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 si chiama il metodo utilizzando i sensori accelerometro e magnetometro. Non implementato su Web.
  • startListening - Inizia a ricevere cambiamenti della direzione del compasso tramite eventi. Ciò attiva i sensori del compasso e emette eventi di tipo 'headingChange'.
  • stopListening - Fermati di ricevere cambiamenti della direzione del compasso. Ciò ferma i sensori del compasso e ferma l'emissione di eventi.
  • checkPermissions - Controlla lo stato di autorizzazione corrente per accedere ai dati del compasso. Su iOS, ciò controlla lo stato di autorizzazione per la localizzazione. Su Android, questo sempre restituisce 'granted' poiché non sono richieste autorizzazioni.

Esempi di utilizzo

getCurrentHeading

Ottieni 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. Ciò attiva 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

Smetti di ricevere notifiche di cambiamento dell'orientamento del compasso. Ciò ferma i sensori del compasso e ferma l'emissione di eventi.

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

await CapgoCompass.stopListening();

checkPermissions

Controlla lo stato di autorizzazione corrente per l'accesso ai dati del compasso. Su iOS, ciò controlla lo stato di autorizzazione per la localizzazione. Su Android, questo restituisce sempre 'granted' poiché non sono richieste autorizzazioni.

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

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

Riferimento completo

Continua da Utilizzo di @capgo/capacitor-compass

Se stai utilizzando Utilizzo di @capgo/capacitor-compass per pianificare il dashboard e le operazioni API, connettilo con @capgo/capacitor-compass per i dettagli di implementazione in @capgo/capacitor-compass Iniziare per i dettagli di implementazione in Iniziare API Panoramica per i dettagli di implementazione in API Panoramica Introduzione per i dettagli di implementazione in Introduzione, e API Chiavi per i dettagli di implementazione in API Chiavi