Saltar al contenido principal
Capgo logo
Volver a plugins
@capgo/capacitor-compass
Tutoriales
por github.com/Cap-go

Compass

Leer la dirección del compás del dispositivo en grados con actualizaciones continuas y manejo de permisos

Descargas/semana

6.7k

GitHub Estrellas

5

Guía

Tutorial sobre Compass

Usando @capgo/capacitor-compass

Capacitor Plugin de Compass para leer la dirección del compás del dispositivo.

Instalar

bun add @capgo/capacitor-compass
bunx cap sync

¿Qué se expone en 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 último valor. 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 - Verifique el estado de permiso actual para acceder a los datos del compás. En iOS, esto verifica el estado de permiso de ubicación. En Android, siempre devuelve 'concedido' ya que no se requieren permisos.

Uso de ejemplo

getCurrentHeading

Obtenga 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

Inicie 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'.

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 los datos del compás. En iOS, esto verifica el estado de permiso de ubicación. En Android, siempre devuelve 'concedido' 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