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 Interfaz del plugin de Compass para leer la dirección del compás del dispositivo.

Instalar

bun add @capgo/capacitor-compass
bunx cap sync

What This Plugin Exposa

  • getCurrentHeading - Obten la dirección actual del compás en grados. En iOS, la dirección se actualiza en segundo plano, y el último valor se devuelve. 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 - Inicia la escucha de cambios en la dirección del compás mediante eventos. Esto inicia los sensores del compás y emite eventos de 'headingChange'.
  • stopListening - Detén 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 - Verifica 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.

Ejemplo de Uso

getCurrentHeading

Obten la dirección actual del compás en grados. En iOS, la dirección se actualiza en segundo plano, y el último valor se devuelve. 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

Inicia la escucha de 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

Detén 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

Verifica 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

Sigue adelante desde Usando @capgo/capacitor-compass

Si estás utilizando Usando @capgo/capacitor-compass para planificar la pantalla de control y las operaciones de API, conecta con @capgo/capacitor-compass para obtener detalles de implementación en @capgo/capacitor-compass, Inicio para obtener detalles de implementación en Inicio, Resumen de API para obtener detalles de implementación en Resumen de API, Introducción para los detalles de implementación en Introducción, y API Claves para los detalles de implementación en API Claves.