Getting Started

安装

您可以使用我们的 AI 助手设置来安装插件。将 Capgo 技能添加到您的 AI 工具中，使用以下命令：

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

然后使用以下提示：

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

如果您更喜欢手动设置，请运行以下命令安装插件，并按照以下平台特定的说明进行操作：

bun add @capgo/capacitor-accelerometer
bunx cap sync

导入

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

API 概述

getMeasurement

获取本地层最近记录的加速度计样本。

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

await CapacitorAccelerometer.getMeasurement();

isAvailable

检测当前设备是否包含加速计传感器。

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

await CapacitorAccelerometer.isAvailable();

startMeasurementUpdates

开始将加速计数据流式传输到 JavaScript 层。

使用 事件接收更新。 measurement 复制到剪贴板

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

await CapacitorAccelerometer.startMeasurementUpdates();

stopMeasurementUpdates

复制到剪贴板

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

await CapacitorAccelerometer.stopMeasurementUpdates();

checkPermissions

返回当前运动数据访问权限的状态

在没有明确权限的平台上，这个值会 granted.

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

await CapacitorAccelerometer.checkPermissions();

requestPermissions

如果平台支持，请求访问运动数据的权限

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

await CapacitorAccelerometer.requestPermissions();

类型参考

GetMeasurementResult

运动数据最近一次测量的别名

export type GetMeasurementResult = Measurement;

IsAvailableResult

由 . 返回的结果

export interface IsAvailableResult {
  /**
   * Whether an accelerometer sensor is available on the device.
   *
   * @since 1.0.0
   */
  isAvailable: boolean;
}

PermissionStatus

由 和 . 返回的权限信息

export interface PermissionStatus {
  /**
   * The permission state for accessing motion data on the current platform.
   *
   * @since 1.0.0
   */
  accelerometer: AccelerometerPermissionState;
}

MeasurementEvent

当 是激活状态时，发出的事件载荷

export type MeasurementEvent = Measurement;

Measurement

设备运动传感器报告的 x、y 和 z 轴加速度值

export interface Measurement {
  /**
   * The acceleration on the x-axis in G's.
   *
   * @since 1.0.0
   */
  x: number;

  /**
   * The acceleration on the y-axis in G's.
   *
   * @since 1.0.0
   */
  y: number;

  /**
   * The acceleration on the z-axis in G's.
   *
   * @since 1.0.0
   */
  z: number;
}

AccelerometerPermissionState

__CAPGO_KEEP_0__包含的权限状态联合体，适用于可以限制运动访问的平台。 limited for platforms that can throttle motion access.

export type AccelerometerPermissionState = PermissionState | 'limited';

PermissionState

Capacitor支持的平台权限状态包括

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

真实来源

本页面是由插件生成的。 src/definitions.ts当公共API上游更改时，请重新运行同步。

从开始就继续

如果您正在使用 入门 为了计划仪表板和API操作，连接它 使用@capgo/capacitor-加速计 在使用@capgo/capacitor-加速计中 API概述 在API概述中 介绍 在介绍中 API密钥 在API密钥中 设备 设备详细信息的实现细节。