Lompat ke konten utama
Kembali ke plugin
@capgo/capacitor-compass
Tutorial
oleh github.com/Cap-go

Compass

Baca arah kompas perangkat dalam derajat dengan pembaruan terus-menerus dan pengaturan izin

Petunjuk

Tutorial pada Compass

Menggunakan @capgo/capacitor-compass

Capacitor Compass Plugin interface untuk membaca arah kompas perangkat.

Pasang

bun add @capgo/capacitor-compass
bunx cap sync

Apa yang Dibuka oleh Plugin Ini

  • getCurrentHeading - Dapatkan arah kompas saat ini dalam derajat. Pada iOS, arah kompas diperbarui di latar belakang, dan nilai terbaru dikembalikan. Pada Android, arah kompas dihitung ketika metode dipanggil menggunakan sensor accelerometer dan magnetometer. Belum diimplementasikan pada Web.
  • startListening - Mulai mendengarkan perubahan arah kompas melalui event. Ini memulai sensor kompas dan mengirimkan event 'headingChange'.
  • stopListening - Berhenti mendengarkan perubahan arah kompas. Ini menghentikan sensor kompas dan menghentikan pengiriman event.
  • checkPermissions - Periksa status izin saat ini untuk mengakses data kompas. Pada iOS, ini memeriksa status izin lokasi. Pada Android, ini selalu mengembalikan 'granted' karena tidak ada izin yang diperlukan.

Contoh Penggunaan

getCurrentHeading

Dapatkan arah kompas saat ini dalam derajat. Pada iOS, arah kompas diperbarui di latar belakang, dan nilai terbaru dikembalikan. Pada Android, arah kompas dihitung ketika metode dipanggil menggunakan sensor accelerometer dan magnetometer. Belum diimplementasikan pada Web.

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

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

startListening

Mulai mendengarkan perubahan arah kompas melalui event. Ini memulai sensor kompas dan mengirimkan event '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

Berhenti mendengarkan perubahan arah kompas. Ini menghentikan sensor kompas dan menghentikan pengiriman event.

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

await CapgoCompass.stopListening();

checkPermissions

Periksa status izin saat ini untuk mengakses data kompas. Pada iOS, ini memeriksa status izin lokasi. Pada Android, ini selalu mengembalikan 'granted' karena tidak ada izin yang diperlukan.

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

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

Referensi Lengkap