Getting Started

Copy sebuah prompt pengaturan dengan langkah instalasi dan panduan markdown lengkap untuk plugin ini.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-accelerometer`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/accelerometer/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Instal

bun add @capgo/capacitor-accelerometer
bunx cap sync

Impor

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

Ringkasan API

`getMeasurement`

Ambil contoh sampel accelerometer terbaru yang direkam oleh layer native.

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

await CapacitorAccelerometer.getMeasurement();

`isAvailable`

Periksa apakah perangkat saat ini memiliki sensor accelerometer.

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

await CapacitorAccelerometer.isAvailable();

`startMeasurementUpdates`

Mulai streaming update accelerometer ke layer JavaScript.

Panggil dengan event untuk menerima update. measurement Salin ke clipboard

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

await CapacitorAccelerometer.startMeasurementUpdates();

`stopMeasurementUpdates`

Hentikan streaming update accelerometer yang dimulai melalui .

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

await CapacitorAccelerometer.stopMeasurementUpdates();

`checkPermissions`

Kembalikan status izin saat ini untuk mengakses data gerakan.

Pada platform tanpa izin eksplisit ini akan menyelesaikan granted.

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

await CapacitorAccelerometer.checkPermissions();

`requestPermissions`

Minta izin untuk mengakses data gerakan jika didukung oleh platform.

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

await CapacitorAccelerometer.requestPermissions();

Referensi Tipe

`GetMeasurementResult`

Alias untuk pengukuran terakhir.

export type GetMeasurementResult = Measurement;

`IsAvailableResult`

Hasil yang dikembalikan oleh .

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

`PermissionStatus`

Informasi izin yang dikembalikan oleh dan .

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

`MeasurementEvent`

Payload acara yang dikeluarkan ketika aktif.

export type MeasurementEvent = Measurement;

`Measurement`

Nilai percepatan x, y, dan z yang dilaporkan oleh sensor gerakan perangkat.

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`

Status izin termasuk limited untuk platform yang dapat mengurangi akses gerakan.

export type AccelerometerPermissionState = PermissionState | 'limited';

`PermissionState`

Status izin platform yang didukung oleh Capacitor.

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

Sumber Kebenaran

Halaman ini dihasilkan dari plugin’s src/definitions.ts. Re-run sync ketika public API berubah di upstream.

Lanjutkan dari Getting Started

Jika Anda menggunakan Getting Started untuk merencanakan dashboard dan API operasional, hubungkannya dengan Menggunakan @capgo/capacitor-accelerometer untuk kemampuan asli di Menggunakan @capgo/capacitor-accelerometer, API Overview untuk detail implementasi di API Overview, Pendahuluan untuk detail implementasi di Pendahuluan, Kunci API untuk detail implementasi di Kunci API dan Perangkat untuk detail implementasi di Perangkat.