Getting Started

Copy a setup prompt with the install steps and the full markdown guide for this plugin.

        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.

Install

bun add @capgo/capacitor-accelerometer
bunx cap sync

Import

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

API Overview

`getMeasurement`

Get the most recent accelerometer sample that was recorded by the native layer.

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

await CapacitorAccelerometer.getMeasurement();

`isAvailable`

Check if the current device includes an accelerometer sensor.

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

await CapacitorAccelerometer.isAvailable();

`startMeasurementUpdates`

Begin streaming accelerometer updates to the JavaScript layer.

Call with the measurement event to receive the updates.

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

await CapacitorAccelerometer.startMeasurementUpdates();

`stopMeasurementUpdates`

Stop streaming accelerometer updates started via .

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

await CapacitorAccelerometer.stopMeasurementUpdates();

`checkPermissions`

Return the current permission state for accessing motion data.

On platforms without explicit permissions this resolves to granted.

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

await CapacitorAccelerometer.checkPermissions();

`requestPermissions`

Request permission to access motion data if supported by the platform.

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

await CapacitorAccelerometer.requestPermissions();

Type Reference

`GetMeasurementResult`

Alias for the most recent measurement.

export type GetMeasurementResult = Measurement;

`IsAvailableResult`

Result returned by .

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

`PermissionStatus`

Permission information returned by and .

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

`MeasurementEvent`

Event payload emitted when is active.

export type MeasurementEvent = Measurement;

`Measurement`

The x, y and z axis acceleration values reported by the device motion sensors.

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`

Permission state union including limited for platforms that can throttle motion access.

export type AccelerometerPermissionState = PermissionState | 'limited';

`PermissionState`

Platform permission states supported by Capacitor.

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

Source Of Truth

This page is generated from the plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.