Compass

Utilisation de @capgo/capacitor-compass

Interface du plugin Compass Capacitor pour la lecture de l'orientation du dispositif.

Installer

bun add @capgo/capacitor-compass
bunx cap sync

Ce que ce plugin expose

• getCurrentHeading - Obtenir l'orientation actuelle du compas en degrés. Sur iOS, l'orientation est mise à jour en arrière-plan, et la dernière valeur est renvoyée. Sur Android, l'orientation est calculée lorsque la méthode est appelée à l'aide des capteurs accéléromètre et magnétomètre. Non implémenté sur Web.
• startListening - Démarrer l'écoute des changements d'orientation du compas via des événements. Cela démarre les capteurs du compas et émet des événements 'headingChange'.
• stopListening - Arrêter l'écoute des changements d'orientation du compas. Cela arrête les capteurs du compas et arrête l'émission d'événements.
• checkPermissions - Vérifier le statut actuel des autorisations pour accéder aux données du compas. Sur iOS, cela vérifie le statut d'autorisation de localisation. Sur Android, cela renvoie toujours 'granted' car aucune autorisation n'est requise.

Exemple d'utilisation

getCurrentHeading

Obtenez l'orientation actuelle du compas en degrés. Sur iOS, l'orientation est mise à jour en arrière-plan, et la valeur la plus récente est renvoyée. Sur Android, l'orientation est calculée 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

Démarrer l'écoute des changements d'orientation du compas via des événements. Cela démarre les capteurs du compas et émet des événements de type '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êter l'écoute des changements d'orientation du compas. Cela arrête les capteurs du compas et arrête l'émission d'événements.

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

await CapgoCompass.stopListening();

checkPermissions

Vérifiez l'état actuel des autorisations pour accéder aux données du compas. Sur iOS, cela vérifie l'état des autorisations de localisation. Sur Android, cela renvoie toujours 'granted' car aucune autorisation 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/

Continuez à utiliser @capgo/capacitor-compass

Si vous utilisez En utilisant @capgo/capacitor-compass planifier le tableau de bord et les API opérations, connectez-l’avec @capgo/capacitor-compass pour les détails d'implémentation dans @capgo/capacitor-compass, Prise en main pour les détails d'implémentation dans Prise en main, Vue d'ensemble de API pour les détails d'implémentation dans Vue d'ensemble de API, Introduction pour les détails d'implémentation dans Introduction, et Clés de API pour les détails d'implémentation dans Clés de API.