메인 콘텐츠로 바로가기
백으로 플러그인
@capgo/capacitor-compass
튜토리얼
@capgo/capacitor-compass

Compass

장치의 Compass 방위를 읽어 degree 단위로 지속적으로 업데이트하며 권한 처리

가이드

compass에 대한 튜토리얼

장치에서 테스트

Capgo 앱을 다운로드하고 QR code을 스캔하세요.

Compass plugin preview QR code

Using @capgo/capacitor-compass

Capacitor Compass Plugin을 사용하여 기기의 Compass 방향을 읽습니다.

설치

bun add @capgo/capacitor-compass
bunx cap sync

이 플러그인은 노출합니다.

  • getCurrentHeading - 기기의 현재 Compass 방향을 degree 단위로 반환합니다. iOS에서는 Compass 센서가 백그라운드에서 업데이트되며, 최신 값을 반환합니다. Android에서는 Compass 센서를 호출할 때 가속도계 및 자이로 센서를 사용하여 방향을 계산합니다. Web에서는 구현되지 않았습니다.
  • startListening - Compass 방향이 변경될 때 이벤트를 통해 방향을 감지합니다. Compass 센서를 시작하고 'headingChange' 이벤트를 방출합니다.
  • stopListening - Compass 방향이 변경될 때 이벤트를 감지하지 않습니다. Compass 센서를 중지하고 이벤트 방출을 중지합니다.
  • checkPermissions - Compass 데이터에 접근하기 위한 현재 권한 상태를 확인합니다. iOS에서는 위치 권한 상태를 확인합니다. Android에서는 항상 'granted'을 반환하며, 권한이 필요하지 않습니다.

예시 사용법

getCurrentHeading

기기의 현재 Compass 방향을 degree 단위로 반환합니다. iOS에서는 Compass 센서가 백그라운드에서 업데이트되며, 최신 값을 반환합니다. Android에서는 Compass 센서를 호출할 때 가속도계 및 자이로 센서를 사용하여 방향을 계산합니다. Web에서는 구현되지 않았습니다.

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

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

startListening

__CAPGO_KEEP_0__에서 방향을 감지하는 이벤트를 시작합니다. 이 기능은 Compass 센서를 시작하고 '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

__CAPGO_KEEP_0__에서 방향을 감지하는 이벤트를 중지합니다. 이 기능은 Compass 센서를 중지하고 이벤트 방출을 중지합니다.

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

await CapgoCompass.stopListening();

checkPermissions

__CAPGO_KEEP_0__에서 Compass 데이터에 대한 현재 권한 상태를 확인합니다. iOS에서는 위치 권한 상태를 확인하고, Android에서는 항상 'granted'을 반환합니다.

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

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

전체 참조

Keep going from Using @capgo/capacitor-compass

__CAPGO_KEEP_0__를 사용하여 __CAPGO_KEEP_0__를 계획하고 __CAPGO_KEEP_0__를 운영할 경우, Compass를 __CAPGO_KEEP_0__와 연결하세요. Using @capgo/capacitor-compass API를 사용하여 API를 계획하고 API를 운영할 경우, Compass를 API와 연결하세요. @capgo/capacitor-compass implementation detail in @capgo/capacitor-compass 에서 Getting Started implementation detail in Getting Started 에서 API Overview implementation detail in API Overview 에서 소개 implementation detail in __CAPGO_KEEP_0__ Keys 에서 API Keys 150+ API 앱을 위한 프로덕션 준비 완료 플러그인으로 güç을 주세요