Allez directement au contenu principal
Retour aux plugins
@capgo/capacitor-compass
Tutoriel
@capgo/capacitor-compass

Compass

Lisez l'orientation du compas de votre appareil en degrés avec des mises à jour continues et une gestion des permissions

Guide

La tutelle sur Compass

Tester sur appareil

Télécharger l'application Capgo, puis scannez le code QR code.

Prévisualisation du lien QR du plugin Compass code

Utilisation de @capgo/capacitor-compass

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

Installation

bun add @capgo/capacitor-compass
bunx cap sync

Ce que ce plugin expose

  • getCurrentHeading - Récupérer l'orientation actuelle du capteur 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 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 d'orientation du capteur via des événements. Cela démarre les capteurs de l'orientation et émet des événements de type 'headingChange'.
  • stopListening - Arrêter la lecture des changements d'orientation du capteur. Cela arrête les capteurs de l'orientation et arrête l'émission d'événements.
  • checkPermissions - Vérifier l'état actuel des autorisations pour accéder aux données de l'orientation. Sur iOS, cela vérifie l'état des autorisations de localisation. Sur Android, cela renvoie toujours 'granted' car aucune autorisation n'est requise.

Exemple d'utilisation

getCurrentHeading

Récupérer l'orientation actuelle du capteur 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 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.

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

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

startListening

Écoutez les changements de direction du compas via les événements. Cela démarre les capteurs de compas et émet des événements de changement de direction.

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 direction du compas. Cela arrête les capteurs de compas et arrête d'émettre des é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 de la permission de localisation. Sur Android, cela retourne toujours « autorisé » 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

Continuez à partir de l'utilisation de @capgo/capacitor-compass

Si vous utilisez L'utilisation de @capgo/capacitor-compass to plan dashboard and API operations, connect it with @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, API : Vue d'ensemble pour les détails d'implémentation dans API : Vue d'ensemble, Introduction pour les détails d'implémentation dans l'Introduction, et API : Clés pour les détails d'implémentation dans API : Clés.