Pasar al contenido principal
Volver a plugins
@capgo/capacitor-compass
Tutoriales
@capgo/capacitor-compass

Compass

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

Guía

Tutoría sobre Compass

Probar en dispositivo

Descargue la aplicación Capgo, luego escane el código QR code.

Enlace QR de vista previa del complemento Compass code

Usando @capgo/capacitor-compass

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

Instalar

bun add @capgo/capacitor-compass
bunx cap sync

¿Qué se expone con este complemento?

  • 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.
  • 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 'headingChange'.
  • 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.
  • checkPermissions - Verifique el estado actual de permiso para acceder a datos de 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

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

Comienza 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

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, esto 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-compás

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