Compass

Utilisation de @capgo/capacitor-compass

Capacitor Plugin Compass interface pour la lecture de la direction du cap du dispositif.

Installer

bun add @capgo/capacitor-compass
bunx cap sync

Ce que ce plugin expose

• getCurrentHeading - Récupérer la direction actuelle du cap en degrés. Sur iOS, la direction est mise à jour en arrière-plan, et la dernière valeur est retournée. Sur Android, la direction est calculée lors de l'appel de la méthode à l'aide des capteurs accéléromètre et magnétomètre. Non implémenté sur Web.
• startListening - Démarrer la lecture des changements de direction du cap via des événements. Cela démarre les capteurs du cap et émet des événements 'headingChange'.
• stopListening - Arrêter la lecture des changements de direction du cap. Cela arrête les capteurs du cap et arrête l'émission d'événements.
• checkPermissions - Vérifiez l'état de permission actuel pour accéder aux données du compas. Sur iOS, cela vérifie l'état de la permission de localisation. Sur Android, cela retourne toujours « autorisé » car aucune permission n'est requise.

Exemple d'utilisation

getCurrentHeading

Obtenez l'angle actuel du compas en degrés. Sur iOS, l'angle est mis à jour en arrière-plan, et la valeur la plus récente est retournée. Sur Android, l'angle est calculé lorsque la méthode est appelée à l'aide de capteurs d'accéléromètre et de magnétomètre. Non implémenté sur Web.

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

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

startListening

Commencez à écouter les changements de l'angle du compas via des événements. Cela démarre les capteurs du compas et émet des événements « 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

Arrêtez d'écouter les changements de l'angle du compas. Cela arrête les capteurs du compas et arrête d'émettre des événements.

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

await CapgoCompass.stopListening();

checkPermissions

Vérifiez l'état de permission actuel pour accéder aux données du compas. Sur iOS, cela vérifie l'état de la permission de localisation. Sur Android, cela retourne toujours « autorisé » car aucune permission n'est requise.

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

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

Référence complète

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