Aller directement au contenu principal
Capgo logo
Retour aux plugins
@capgo/capacitor-compass
Tutoriel
@capgo/capacitor-compass

Compass

Lisez l'orientation de la boussole du dispositif en degrés avec des mises à jour continues et une gestion des autorisations

Téléchargements/mois

6,7k

GitHub étoiles

6

Guide

Lautorisation de la boussole

En utilisant @capgo/capacitor-boussole

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

Install

bun add @capgo/capacitor-compass
bunx cap sync

Ce que ce plugin expose

  • getCurrentHeading - Récupère l'orientation actuelle en degrés. Sur iOS, l'orientation est mise à jour en arrière-plan, et la valeur la plus récente est retourné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.
  • startListening - Démarrer l'écoute des changements d'orientation via des événements. Cela démarre les capteurs d'orientation et émet des événements de type 'headingChange'.
  • stopListening - Arrêter l'écoute des changements d'orientation. Cela arrête les capteurs d'orientation et arrête l'émission d'événements.
  • checkPermissions - Vérifiez l'état actuel de la permission pour accéder aux données d'orientation. Sur iOS, cela vérifie l'état de la permission de localisation. Sur Android, cela retourne toujours 'granted' car aucune permission n'est requise.

Exemple d'utilisation

getCurrentHeading

Récupère l'orientation actuelle en degrés. Sur iOS, l'orientation est mise à jour en arrière-plan, et la valeur la plus récente est retourné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 via des événements. Cela démarre les capteurs d'orientation 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. Cela arrête les capteurs d'orientation et arrête l'émission d'événements.

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

await CapgoCompass.stopListening();

checkPermissions

Vérifiez l'état actuel de la permission pour accéder aux données d'orientation. Sur iOS, cela vérifie l'état de la permission de localisation. Sur Android, cela retourne toujours 'granted' 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

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

Si vous utilisez L'utilisation de @capgo/capacitor-compass pour planifier le tableau de bord et les opérations API, connectez-le à @capgo/capacitor-compass pour les détails d'implémentation dans @capgo/capacitor-compass, Démarrage pour les détails d'implémentation dans Démarrage, API Overview pour les détails d'implémentation dans API Vue d'ensemble, Introduction pour les détails d'implémentation dans Introduction, et API Clés pour les détails d'implémentation dans API Clés.