Saltar al contenido principal
Volver a plugins
@capgo/capacitor-compass
Tutorial
@capgo/capacitor-compass

Brújula

Lea la dirección de la brújula del dispositivo en grados con actualizaciones continuas y manejo de permisos

Guía

Tutoriales de Compass

Probar en dispositivo

Descargar la aplicación Capgo, luego escanea el código QR code.

Enlace QR de vista previa del plugin Compass code

Usando @capgo/capacitor-compass

Capacitor Interfaz del plugin Compass para leer la dirección del compás del dispositivo.

Instalar

bun add @capgo/capacitor-compass
bunx cap sync

¿Qué se expone con este plugin?

  • getCurrentHeading - Obtener la dirección actual del compás en grados. En iOS, la dirección se actualiza en segundo plano y se devuelve el valor más reciente. En Android, la dirección se calcula cuando se llama al método utilizando sensores de acelerómetro y magnetómetro. No implementado en Web.
  • startListening - Iniciar la escucha de cambios en la dirección del compás mediante eventos. Esto inicia los sensores del compás y emite eventos de tipo 'headingChange'.
  • stopListening - Detener la escucha de cambios en la dirección del compás. Esto detiene los sensores del compás y detiene la emisión de eventos.
  • checkPermissions - Verificar el estado actual de permiso para acceder a datos del compás. En iOS, esto verifica el estado de permiso de ubicación. En Android, siempre devuelve 'granted' ya que no se requieren permisos.

Ejemplo de uso

getCurrentHeading

Obtener la dirección actual del compás en grados. En iOS, la dirección se actualiza en segundo plano y se devuelve el valor más reciente. En Android, la dirección se calcula cuando se llama al método utilizando sensores de acelerómetro y magnetómetro. No implementado en Web.

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

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

startListening

Comience a escuchar cambios en la dirección del compás mediante eventos. Esto inicia los sensores del compás y emite eventos de '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

Detenga la escucha de cambios en la dirección del compás. Esto detiene los sensores del compás y detiene la emisión de eventos.

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

await CapgoCompass.stopListening();

checkPermissions

Verifique el estado de permiso actual para acceder a datos del compás. En iOS, esto verifica el estado de permiso de ubicación. En Android, siempre devuelve 'granted' ya que no se requieren permisos.

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

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

Referencia Completa

Siga adelante desde Usando @capgo/capacitor-compás

Si está utilizando Usando @capgo/capacitor-compás para planificar la consola y las operaciones de API, conecte con @capgo/capacitor-compás para el detalle de implementación en @capgo/capacitor-compás, Iniciación para el detalle de implementación en Iniciación, API Resumen para el detalle de implementación en API Resumen, Introducción para el detalle de implementación en Introducción, y API Claves para el detalle de implementación en API Claves.