指南针

使用@capgo/capacitor-compass

Capacitor Compass插件接口，用于读取设备罗盘方向。

安装

bun add @capgo/capacitor-compass
bunx cap sync

此插件暴露的内容

• getCurrentHeading - 获取当前罗盘方向（以度为单位）。在iOS上，方向会在后台更新，返回最新值。在Android上，方法被调用时使用加速计和磁力计传感器计算方向。Web端未实现。
• startListening - 开始监听罗盘方向变化的事件。这会启动罗盘传感器并发送'headingChange'事件。
• stopListening - 停止监听罗盘方向变化的事件。这会停止罗盘传感器并停止发送事件。
• checkPermissions - 检查访问罗盘数据的当前权限状态。在iOS上，检查位置权限状态。在Android上，始终返回'granted'，因为不需要权限。

示例使用

getCurrentHeading

获取当前罗盘方向（以度为单位）。在iOS上，方向会在后台更新，返回最新值。在Android上，方法被调用时使用加速计和磁力计传感器计算方向。Web端未实现。

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

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

startListening

通过事件开始监听compass方向变化。这会启动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

停止监听compass方向变化。这会停止compass传感器并停止发送事件。

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

await CapgoCompass.stopListening();

checkPermissions

检查当前访问compass数据的权限状态。在iOS中，这会检查位置权限状态。在Android中，这始终返回'granted'，因为没有权限要求。

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

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

全局参考

• GitHub: https://github.com/Cap-go/capacitor-compass/
• 文档：/docs/plugins/compass/

继续使用@capgo/capacitor-compass

如果您正在使用 使用@capgo/capacitor-compass 来规划仪表板和API操作，连接它与 @capgo/capacitor-compass 为 @capgo/capacitor Compass 的实现细节 开始使用 为 Getting Started 的实现细节 API 简介 为 API Overview 的实现细节 介绍 为 Introduction 的实现细节, 和 API 密钥 为 API Keys 的实现细节