Getting Started

インストール

CapgoのAIアシストセットアップを使用してプラグインをインストールできます。AIツールにCapgoスキルを追加するには、以下のコマンドを使用してください:

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

加速度データのストリーミングを開始します。

イベントを使用してデータを受信します。 measurement クリップボードにコピー

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

await CapacitorAccelerometer.startMeasurementUpdates();

stopMeasurementUpdates

クリップボードにコピー

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

await CapacitorAccelerometer.stopMeasurementUpdates();

checkPermissions

__CAPGO_KEEP_0__の現在の許可状態を取得します。

__CAPGO_KEEP_0__のプラットフォームでは明示的な許可がなければ granted.

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

await CapacitorAccelerometer.checkPermissions();

requestPermissions

プラットフォームが許可をサポートしている場合にのみ、__CAPGO_KEEP_0__の許可を要求します。

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

await CapacitorAccelerometer.requestPermissions();

型の参照

GetMeasurementResult

__CAPGO_KEEP_0__の最新の測定値を表します。

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

許可状態のユニオン、 limited モーションアクセスのスループットを制限できるプラットフォーム向け。

export type AccelerometerPermissionState = PermissionState | 'limited';

PermissionState

Capacitorがサポートするプラットフォームの許可状態

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

真実の源

このページはプラグインの src/definitions.ts上流でAPIが公開されたときに再度syncを実行してください。

Getting Startedから続けて

Capgoを使用している場合 Getting Started APIと連携することで、ダッシュボードとAPIの操作を計画できます。 capgo/capacitor-加速度計を使用する Capacitorを使用することで、capgo/capacitor-加速度計のネイティブ機能を利用できます。 APIの概要 Capacitorを使用することで、APIの実装詳細を確認できます。 導入 Capacitorを使用することで、導入の実装詳細を確認できます。 APIのキー Capacitorを使用することで、APIのキーに関する実装詳細を確認できます。 デバイス __CAPGO_KEEP_0__の実装詳細については、デバイスのページを参照してください。