Panduan Memulai

Instal

Anda bisa menggunakan AI-Assisted Setup kami untuk menginstal plugin ini. Tambahkan skill Capgo ke tool AI Anda dengan command berikut:

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

Lalu gunakan prompt berikut:

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

Jika Anda lebih memilih Manual Setup, instal plugin dengan menjalankan perintah berikut dan ikuti petunjuk khusus platform di bawah ini:

bun add @capgo/capacitor-accelerometer
bunx cap sync

Impor

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

Mulai cepat

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

await CapacitorAccelerometer.startMeasurementUpdates();
await CapacitorAccelerometer.addListener('measurement', ({ x, y, z }) => {
  detectShake(x, y, z);
});

Example: web permission

Pada web, minta akses motion melalui requestPermissions() sebelum mengharapkan sampel non-nol.

Kesalahan umum

• Nol di web: sebelum event gerakan pertama, getMeasurement() mengembalikan nol.
• Hentikan streaming: stopMeasurementUpdates() ketika meninggalkan layar.
• Satuan: gunakan konvensi sumbu plugin yang terdokumentasi untuk matematika game Anda.

Ringkasan API

getMeasurement

Dapatkan sampel accelerometer terbaru yang direkam oleh lapisan native.

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

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

isAvailable

Cek apakah perangkat saat ini memiliki sensor accelerometer.

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

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

startMeasurementUpdates

Mulai streaming update accelerometer ke layer JavaScript.

Panggil addListener dengan measurement event untuk menerima update tersebut.

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

await CapacitorAccelerometer.startMeasurementUpdates();

stopMeasurementUpdates

Hentikan streaming pembaruan accelerometer yang dimulai melalui startMeasurementUpdates.

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

await CapacitorAccelerometer.stopMeasurementUpdates();

checkPermissions

Mengembalikan status izin saat ini untuk mengakses data gerakan.

Pada platform tanpa izin eksplisit, ini akan di-resolve menjadi granted.

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

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

requestPermissions

Meminta izin untuk mengakses data gerakan jika didukung oleh platform.

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

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

Referensi Tipe

GetMeasurementResult

Alias untuk pengukuran terbaru.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Hasil yang dikembalikan oleh isAvailable.

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

PermissionStatus

Informasi izin yang dikembalikan oleh checkPermissions dan requestPermissions.

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

MeasurementEvent

Payload event yang dipancarkan saat startMeasurementUpdates sedang aktif.

export type MeasurementEvent = Measurement;

Measurement

Nilai akselerasi sumbu x, y, dan z yang dilaporkan oleh sensor gerak 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

Union status izin yang mencakup limited untuk platform yang dapat membatasi 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 dibuat dari plugin src/definitions.ts. Jalankan ulang sync saat API publik berubah di upstream.

Lanjutkan dari Getting Started

Jika Anda menggunakan Panduan Memulai untuk merencanakan operasi dashboard dan API, hubungkan dengan Menggunakan @capgo/capacitor-accelerometer untuk kapabilitas native saat menggunakan @capgo/capacitor-accelerometer, Ringkasan API untuk detail implementasi di API Overview, Pendahuluan untuk detail implementasi di Introduction, Kunci API untuk detail implementasi di API Keys, dan Perangkat untuk detail implementasi di Devices.