Accelerometer Capacitor plugin

Using @capgo/capacitor-accelerometer

Capacitor plugin contract for working with the device accelerometer.

Install

bun add @capgo/capacitor-accelerometer
bunx cap sync

bunx cap sync copies the plugin's native code into your native projects. Run it again after every plugin upgrade.

Import

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

API at a glance

Examples

getMeasurement()

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

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

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

isAvailable()

Check if the current device includes an accelerometer sensor.

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

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

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

checkPermissions()

Return the current permission state for accessing motion data.

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

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

requestPermissions()

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

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

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

Listen to events

addListener returns a handle. Call handle.remove() when the screen unmounts, or CapacitorAccelerometer.removeAllListeners() to clear every listener.

Full reference

• GitHub repository
• Documentation
• API 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.