Skip to main content
Back to plugins
@capgo/capacitor-accelerometer
Tutorial
@capgo/capacitor-accelerometer

Accelerometer

Read device accelerometer for motion detection and orientation tracking

Guide

Tutorial on Accelerometer

Using @capgo/capacitor-accelerometer

Capacitor plugin contract for working with the device accelerometer.

Install

bun add @capgo/capacitor-accelerometer
bunx cap sync

What This Plugin Exposes

  • getMeasurement - Get the most recent accelerometer sample that was recorded by the native layer.
  • isAvailable - Check if the current device includes an accelerometer sensor.
  • startMeasurementUpdates - Begin streaming accelerometer updates to the JavaScript layer.
  • stopMeasurementUpdates - Stop streaming accelerometer updates started via .

Example Usage

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.

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();

Full Reference

Keep going from Using @capgo/capacitor-accelerometer

If you are using Using @capgo/capacitor-accelerometer to plan dashboard and API operations, connect it with @capgo/capacitor-accelerometer for the implementation detail in @capgo/capacitor-accelerometer, Getting Started for the implementation detail in Getting Started, API Overview for the implementation detail in API Overview, Introduction for the implementation detail in Introduction, and API Keys for the implementation detail in API Keys.