快速入门

安装

你可以使用我们的 AI 辅助设置来安装插件。使用以下命令将 Capgo skills 添加到你的 AI 工具中：

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下 prompt：

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-barometer` plugin in my project.

如果你更倾向于手动设置，请运行以下命令安装插件，并参考下文针对各平台的具体说明：

bun add @capgo/capacitor-barometer
bunx cap sync

导入

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

快速入门

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

await CapacitorBarometer.startMeasurementUpdates();
await CapacitorBarometer.addListener('measurement', (event) => {
  console.log('hPa', event.pressure);
});

示例：单次读取

调用 startMeasurementUpdates() 首先。 getMeasurement() 返回 0 直到第一个传感器事件到达。

常见坑点

• Web: 视为不可用 isAvailable() 为 false。
• iOS 相对高度: 仅在更新运行时有效。
• 电池：调用 stopMeasurementUpdates() 完成后即可。

API 概览

getMeasurement

获取由 Native 层捕获的最新气压计读数。

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

const result = await CapacitorBarometer.getMeasurement();
console.log(result);

isAvailable

检查当前设备是否包含气压计传感器。

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

const result = await CapacitorBarometer.isAvailable();
console.log(result);

startMeasurementUpdates

开始向 JavaScript 层流式传输气压数据更新。

调用 addListener 并配合 measurement 用于接收更新的事件。

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

await CapacitorBarometer.startMeasurementUpdates();

stopMeasurementUpdates

停止通过以下方式启动的持续更新： startMeasurementUpdates.

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

await CapacitorBarometer.stopMeasurementUpdates();

checkPermissions

返回访问气压计数据的当前权限状态。

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

const result = await CapacitorBarometer.checkPermissions();
console.log(result);

requestPermissions

如果平台需要，请求访问气压计数据的权限。

import { CapacitorBarometer } from '@capgo/capacitor-barometer';

const result = await CapacitorBarometer.requestPermissions();
console.log(result);

类型参考

GetMeasurementResult

最近一次压力采样值的别名。

export type GetMeasurementResult = Measurement;

IsAvailableResult

返回结果： isAvailable.

export interface IsAvailableResult {
  /**
   * Indicates whether the device exposes a barometer sensor.
   *
   * @since 1.0.0
   */
  isAvailable: boolean;
}

PermissionStatus

返回的权限信息： checkPermissions 和 requestPermissions.

export interface PermissionStatus {
  /**
   * The permission state for accessing barometer measurements on the current platform.
   *
   * @since 1.0.0
   */
  barometer: BarometerPermissionState;
}

MeasurementEvent

在以下情况发出的事件负载： startMeasurementUpdates 处于活动状态时。

export type MeasurementEvent = Measurement;

Measurement

从设备气压计中采样的气压和相对高度值。

export interface Measurement {
  /**
   * The static air pressure in hectopascals (hPa).
   *
   * @since 1.0.0
   */
  pressure: number;

  /**
   * The change in altitude relative to the time updates started.
   * Only available on iOS; Android will always return `0`.
   *
   * @since 1.0.0
   */
  relativeAltitude: number;

  /**
   * The timestamp of the measurement in milliseconds since the Unix epoch.
   *
   * @since 1.0.0
   */
  timestamp: number;
}

BarometerPermissionState

权限状态联合类型，包括： limited 适用于可能限制传感器访问的平台。

export type BarometerPermissionState = PermissionState | 'limited';

PermissionState

Capacitor 支持的平台权限状态。

export type PermissionState = 'prompt' | 'prompt-with-rationale' | 'granted' | 'denied';

唯一数据源

本页面由该插件的 src/definitions.ts当上游的公共 API 发生变化时，请重新运行 sync。

继续阅读入门指南

如果你正在使用 快速入门 来规划 dashboard 和 API 操作，请将其连接至 使用 @capgo/capacitor-barometer 关于“使用 @capgo/capacitor-barometer”中的原生能力， API 概览 关于 API 概览中的实现细节， 简介 有关 Introduction 中的实现细节， API 密钥 有关 API Keys 中的实现细节，以及 设备 有关 Devices 中的实现细节。