跳转到正文

快速入门

GitHub

你可以使用我们的 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() 完成后。

获取原生层捕获的最新气压计读数。

import { CapacitorBarometer } from '@capgo/capacitor-barometer';
const result = await CapacitorBarometer.getMeasurement();
console.log(result);

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

import { CapacitorBarometer } from '@capgo/capacitor-barometer';
const result = await CapacitorBarometer.isAvailable();
console.log(result);

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

调用 addListener 配合 measurement 事件以接收更新。

import { CapacitorBarometer } from '@capgo/capacitor-barometer';
await CapacitorBarometer.startMeasurementUpdates();

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

import { CapacitorBarometer } from '@capgo/capacitor-barometer';
await CapacitorBarometer.stopMeasurementUpdates();

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

import { CapacitorBarometer } from '@capgo/capacitor-barometer';
const result = await CapacitorBarometer.checkPermissions();
console.log(result);

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

import { CapacitorBarometer } from '@capgo/capacitor-barometer';
const result = await CapacitorBarometer.requestPermissions();
console.log(result);

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

export type GetMeasurementResult = Measurement;

返回结果: isAvailable.

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

返回的权限信息: checkPermissions 以及 requestPermissions.

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

触发时发出的事件负载 startMeasurementUpdates 处于激活状态。

export type MeasurementEvent = 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;
}

包含以下内容的权限状态联合类型 limited 适用于可限制传感器访问频率的平台。

export type BarometerPermissionState = PermissionState | 'limited';

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 Overview 中的实现细节, 简介 关于 Introduction 中的实现细节, API 密钥 有关 API Keys 的实现细节,以及 设备 有关 Devices 的实现细节。