# Device Motion Plugin

{% hint style="danger" %}
Deprecated for Cordova 9.0 or higher.\
Please refer to [here](https://blog.phonegap.com/migrating-from-the-cordova-device-motion-plugin-ddd8176632ed) for the transition from cordova-plugin-device-motion.
{% endhint %}

Tested Version: [1.2.5](https://github.com/apache/cordova-plugin-device-motion/releases/tag/1.2.5)

{% hint style="info" %}
This document is based on the original Cordova docs available at [Cordova Docs](https://github.com/apache/cordova-plugin-device-motion).
{% endhint %}

This plugin provides access to the device's accelerometer. The accelerometer is a motion sensor that detects the change (*delta*) in movement relative to the current device orientation, in three dimensions along the *x*, *y*, and *z* axis.

Access is via a global `navigator.accelerometer` object.

Although the object is attached to the global scoped `navigator`, it is not available until after the `deviceready` event.

```javascript
document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
    console.log(navigator.accelerometer);
}
```

## Plugin ID

```javascript
cordova-plugin-device-motion
```

## Adding the Plugin in Monaca

In order to use this plugin, please [enable](/products_guide/monaca_ide/dependencies/cordova_plugin.md#importing-cordova-plugins) `Device Motion` plugin in Monaca Cloud IDE.

## Supported Platforms

* Android
* iOS

## Methods

* navigator.accelerometer.getCurrentAcceleration
* navigator.accelerometer.watchAcceleration
* navigator.accelerometer.clearWatch

### navigator.accelerometer.getCurrentAcceleration

Get the current acceleration along the *x*, *y*, and *z* axes. These acceleration values are returned to the `accelerometerSuccess` callback function.

```javascript
navigator.accelerometer.getCurrentAcceleration(accelerometerSuccess, accelerometerError);
```

#### Example

```javascript
function onSuccess(acceleration) {
    alert('Acceleration X: ' + acceleration.x + '\n' +
          'Acceleration Y: ' + acceleration.y + '\n' +
          'Acceleration Z: ' + acceleration.z + '\n' +
          'Timestamp: '      + acceleration.timestamp + '\n');
}

function onError() {
    alert('onError!');
}

navigator.accelerometer.getCurrentAcceleration(onSuccess, onError);
```

#### Android Quirks

The accelerometer is called with the `SENSOR_DELAY_UI` flag, which limits the maximum readout frequency to something between 20 and 60 Hz, depending on the device. Values for **period** corresponding to higher frequencies will result in duplicate samples. More details can be found in the [Android API Guide](http://developer.android.com/guide/topics/sensors/sensors_overview.html#sensors-monitor).

#### iOS Quirks

* iOS doesn't recognize the concept of getting the current acceleration at any given point.
* You must watch the acceleration and capture the data at given time intervals.
* Thus, the `getCurrentAcceleration` function yields the last value reported from a `watchAccelerometer` call.

### navigator.accelerometer.watchAcceleration

Retrieves the device's current `Acceleration` at a regular interval, executing the `accelerometerSuccess` callback function each time. Specify the interval in milliseconds via the `acceleratorOptions` object's `frequency` parameter.

The returned watch ID references the accelerometer's watch interval, and can be used with `navigator.accelerometer.clearWatch` to stop watching the accelerometer.

```javascript
var watchID = navigator.accelerometer.watchAcceleration(accelerometerSuccess,
                                                       accelerometerError,
                                                       accelerometerOptions);
```

* **accelerometerOptions**: An object with the following optional keys:
  * **frequency**: requested frequency of calls to accelerometerSuccess with acceleration data in Milliseconds. *(Number)* (Default: 10000)

#### Example

```javascript
function onSuccess(acceleration) {
    alert('Acceleration X: ' + acceleration.x + '\n' +
          'Acceleration Y: ' + acceleration.y + '\n' +
          'Acceleration Z: ' + acceleration.z + '\n' +
          'Timestamp: '      + acceleration.timestamp + '\n');
}

function onError() {
    alert('onError!');
}

var options = { frequency: 3000 };  // Update every 3 seconds

var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);
```

#### iOS Quirks

The API calls the success callback function at the interval requested, but restricts the range of requests to the device between `40ms` and `1000ms`. For example, if you request an interval of 3 seconds, (`3000ms`), the API requests data from the device every 1 second, but only executes the success callback every 3 seconds.

### navigator.accelerometer.clearWatch

Stop watching the `Acceleration` referenced by the `watchID` parameter.

```javascript
navigator.accelerometer.clearWatch(watchID);
```

* **watchID**: The ID returned by

  `navigator.accelerometer.watchAcceleration`.

#### Example

```javascript
var watchID = navigator.accelerometer.watchAcceleration(onSuccess, onError, options);

// ... later on ...

navigator.accelerometer.clearWatch(watchID);
```

## Objects

### Acceleration

Contains `Accelerometer` data captured at a specific point in time. Acceleration values include the effect of gravity (9.81 m/s\\^2), so that when a device lies flat and facing up, *x*, *y*, and *z* values returned should be `0`, `0`, and `9.81`.

#### Properties

* **x**: Amount of acceleration on the x-axis. (in m/s\\^2) *(Number)*
* **y**: Amount of acceleration on the y-axis. (in m/s\\^2) *(Number)*
* **z**: Amount of acceleration on the z-axis. (in m/s\\^2) *(Number)*
* **timestamp**: Creation timestamp in milliseconds. *(DOMTimeStamp)*

See Also:

* [Third-party Cordova Plugins](/reference/third_party_phonegap.md)
* [Core Cordova Plugins](/reference/core-cordova-plugins.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://en.docs.monaca.io/reference/core-cordova-plugins/cordova_9.0/device-motion.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.