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

Compass

Lire l'orientation du compas du dispositif en degrés avec des mises à jour continues et une gestion des permissions

Guide

Tutoriel sur Compass

Tester sur appareil

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

Lien QR de prévisualisation du plugin Compass code

En utilisant @capgo/capacitor-compass

Interface du plugin Compass de Capacitor pour la lecture de l'angle du cap de l'appareil.

Installer

bun add @capgo/capacitor-compass
bunx cap sync

Ce que ce plugin expose

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

Exemple d'utilisation

getCurrentHeading

Récupérer l'angle actuel du cap 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 direction de boussole via des événements.

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 de boussole.

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

await CapgoCompass.stopListening();

checkPermissions

Vérifiez l'état de permission actuel pour accéder aux données de boussole.

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

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

Référence complète

Keep going from Using @capgo/capacitor-compass

L'utilisation de @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-boussole Using @capgo/capacitor-compass to plan dashboard and API operations, connect it with @capgo/capacitor-boussole pour les détails d'implémentation dans @capgo/capacitor-compass, Démarrage pour les détails d'implémentation dans Démarrage, 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 Introduction, et API Clés Pousser vos applications API avec