Zum Hauptinhalt springen
Zurück zu Plugins
@capgo/capacitor-compass
Tutorial
von github.com/Cap-go

Compass

Lese den Kompasswinkel des Geräts in Grad mit kontinuierlichen Updates und Berechtigungsverwaltung

Richtlinie

Tutorial zu Compass

Mit @capgo/capacitor-compass verwenden

Capacitor Compass-Plugin-Schnittstelle zum Lesen der Gerätekompasseinstellung.

Installieren

bun add @capgo/capacitor-compass
bunx cap sync

Was dieses Plugin enthält

  • getCurrentHeading - Aktuelle Kompasseinstellung in Grad erhalten. Auf iOS wird die Einstellung im Hintergrund aktualisiert und der neueste Wert wird zurückgegeben. Auf Android wird die Einstellung, wenn der Methodenaufruf erfolgt, mithilfe von Beschleunigungssensor und Magnetometer-Sensor berechnet. Nicht implementiert auf Web.
  • startListening - Beginnen Sie mit dem Abhören von Änderungen der Kompasseinstellung über Ereignisse. Dies startet die Kompasse-Sensoren und emittiert Ereignisse vom Typ 'headingChange'.
  • stopListening - Abhören von Änderungen der Kompasseinstellung beenden. Dies stoppt die Kompasse-Sensoren und stoppt die Ereignisemission.
  • checkPermissions - Überprüfen Sie den aktuellen Berechtigungsstatus für den Zugriff auf Kompassdaten. Auf iOS wird die Standortberechtigung überprüft. Auf Android wird immer 'erlaubt' zurückgegeben, da keine Berechtigungen erforderlich sind.

Beispielanwendung

getCurrentHeading

Ermitteln Sie den aktuellen Kompasswinkel in Grad. Auf iOS wird der Winkel im Hintergrund aktualisiert und der neueste Wert zurückgegeben. Auf Android wird der Winkel bei Aufruf der Methode mithilfe von Beschleunigungssensor und Magnetometer berechnet. Nicht implementiert auf Web.

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

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

startListening

Starten Sie das Abhören von Kompasswinkelschwankungen über Ereignisse. Dies startet die Kompasssensoren und emittiert Ereignisse vom Typ '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

Beenden Sie das Abhören von Kompasswinkelschwankungen. Dies stoppt die Kompasssensoren und stoppt die Ereignisemission.

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

await CapgoCompass.stopListening();

checkPermissions

Überprüfen Sie den aktuellen Berechtigungsstatus für den Zugriff auf Kompassdaten. Auf iOS wird die Standortberechtigung überprüft. Auf Android wird immer 'erlaubt' zurückgegeben, da keine Berechtigungen erforderlich sind.

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

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

Vollständige Referenz