capacitor-motion

Capacitor Motion is a plugin that provides access to device motion and orientation data, including accelerometer, gyroscope, and magnetometer readings, for cross-platform mobile apps.

Install

npm install native-capacitor-motion
npx cap sync

API

• addListener('accel', ...)
• addListener('orientation', ...)
• addListener('heading', ...)
• removeAllListeners()
• startMotionUpdates()
• stopMotionUpdates()
• Interfaces
• Type Aliases

addListener('accel', ...)

addListener(eventName: 'accel', listenerFunc: AccelListener) => Promise<PluginListenerHandle>

Add a listener for accelerometer data

| Param | Type | | ------------------ | ------------------------------------------------------- | | eventName | 'accel' | | listenerFunc | AccelListener |

Returns: Promise<PluginListenerHandle>

Since: 1.0.0

addListener('orientation', ...)

addListener(eventName: 'orientation', listenerFunc: OrientationListener) => Promise<PluginListenerHandle>

Add a listener for device orientation change (compass heading, etc.)

| Param | Type | | ------------------ | ------------------------------------------------------------------- | | eventName | 'orientation' | | listenerFunc | OrientationListener |

Returns: Promise<PluginListenerHandle>

Since: 1.0.0

addListener('heading', ...)

addListener(eventName: 'heading', listenerFunc: HeadingListener) => Promise<PluginListenerHandle>

Add a listener for device heading change (compass heading, etc.)

| Param | Type | | ------------------ | ----------------------------------------------------------- | | eventName | 'heading' | | listenerFunc | HeadingListener |

Returns: Promise<PluginListenerHandle>

Since: 1.0.0

removeAllListeners()

removeAllListeners() => Promise<void>

Remove all the listeners that are attached to this plugin.

Since: 1.0.0

startMotionUpdates()

startMotionUpdates() => Promise<void>

Start motion updates

Since: 1.0.0

stopMotionUpdates()

stopMotionUpdates() => Promise<void>

Stop motion updates

Since: 1.0.0

Interfaces

PluginListenerHandle

| Prop | Type | | ------------ | ----------------------------------------- | | remove | () => Promise<void> |

AccelListenerEvent

| Prop | Type | Description | Since | | ---------------------------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | | acceleration | Acceleration | An object giving the acceleration of the device on the three axis X, Y and Z. Acceleration is expressed in m/s² | 1.0.0 | | accelerationIncludingGravity | Acceleration | An object giving the acceleration of the device on the three axis X, Y and Z with the effect of gravity. Acceleration is expressed in m/s² | 1.0.0 | | rotationRate | RotationRate | An object giving the rate of change of the device's orientation on the three orientation axis alpha, beta and gamma. Rotation rate is expressed in degrees per seconds. | 1.0.0 | | interval | number | A number representing the interval of time, in milliseconds, at which data is obtained from the device. | 1.0.0 |

Acceleration

| Prop | Type | Description | Since | | ------- | ------------------- | -------------------------------------------- | ----- | | x | number | The amount of acceleration along the X axis. | 1.0.0 | | y | number | The amount of acceleration along the Y axis. | 1.0.0 | | z | number | The amount of acceleration along the Z axis. | 1.0.0 |

RotationRate

| Prop | Type | Description | Since | | ----------- | ------------------- | ---------------------------------------------------------------- | ----- | | alpha | number | The amount of rotation around the Z axis, in degrees per second. | 1.0.0 | | beta | number | The amount of rotation around the X axis, in degrees per second. | 1.0.0 | | gamma | number | The amount of rotation around the Y axis, in degrees per second. | 1.0.0 |

Heading

| Prop | Type | Description | Since | | ------------- | ------------------- | -------------------------------------- | ----- | | heading | number | The heading of the device, in degrees. | 1.0.0 |

Type Aliases

AccelListener

(event: AccelListenerEvent): void

OrientationListener

(event: RotationRate): void

OrientationListenerEvent

RotationRate

HeadingListener

(event: Heading): void

HeadingListenerEvent

Heading