Aller directement au contenu principal
Retour aux plugins
@capgo/capacitor-compass
Tutoriel
par github.com/Cap-go

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

Utilisation de @capgo/capacitor-compass

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

Installer

bun add @capgo/capacitor-compass
bunx cap sync

Ce Qu'Exposent Cette Plugin

  • getCurrentHeading - Récupérer l'orientation actuelle 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 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érifier le statut de permission actuel pour accéder aux données d'orientation. Sur iOS, cela vérifie le statut de permission de localisation. Sur Android, cela renvoie toujours 'granted' car aucune permission n'est requise.

Exemple d'Utilisation

getCurrentHeading

Récupérer l'orientation actuelle 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 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érifier le statut de permission actuel pour accéder aux données d'orientation. Sur iOS, cela vérifie le statut de permission de localisation. Sur Android, cela renvoie 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 En utilisant @capgo/capacitor-compass pour planifier le tableau de bord et les opérations API, connectez-le 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 l'Introduction, et API Clés Pour les détails d'implémentation dans API Clés.