Accelerometer

Captures device motion in the x, y, and z direction.

Methods

Arguments

Objects (Read-Only)

Accessing the Feature

As of version 3.0, Cordova implements device-level APIs as plugins. Use the CLI's plugin command, described in The Command-Line Interface, to add or remove this feature for a project:

    $ cordova plugin add org.apache.cordova.device-motion
    $ cordova plugin ls
    [ 'org.apache.cordova.device-motion' ]
    $ cordova plugin rm org.apache.cordova.device-motion

These commands apply to all targeted platforms, but modify the platform-specific configuration settings described below:

  • Amazon Fire OS (in res/xml/config.xml)

      <feature name="Accelerometer">
      <param name="android-package" value="org.apache.cordova.devicemotion.AccelListener" />
  </feature>

  • Android (in res/xml/config.xml)

      <feature name="Accelerometer">
      <param name="android-package" value="org.apache.cordova.devicemotion.AccelListener" />
  </feature>

  • BlackBerry WebWorks

      (in www/plugins.xml)
  <feature name="Accelerometer">
      <param name="blackberry-package" value="org.apache.cordova.accelerometer.Accelerometer" />
  </feature>

  (in www/config.xml)
  <feature id="blackberry.system"  required="true" version="1.0.0.0" />
  <feature id="org.apache.cordova" required="true" version="1.0.0" />

  • iOS (in the named application directory's config.xml)

      <feature name="Accelerometer">
      <param name="ios-package" value="CDVAccelerometer" />
  </feature>

  • Windows Phone (in Properties/WPAppManifest.xml)

      <Capabilities>
      <Capability Name="ID_CAP_SENSORS" />
  </Capabilities>

    Reference: Application Manifest for Windows Phone

Some platforms may support this feature without requiring any special configuration. See Platform Support for an overview.