# accelerometer

Accelerometer模块管理设备加速度传感器，用于获取设备加速度信息，包括x（屏幕水平方向）、y（垂直屏幕水平方向）、z（垂直屏幕平面方向）三个方向的加速度信息。通过plus.accelerometer获取设备加速度传感器管理对象。

## 方法：

- getCurrentAcceleration: 获取当前设备的加速度信息
- watchAcceleration: 监听设备加速度变化信息
- clearWatch: 关闭监听设备加速度信息

## 对象：

- Acceleration: 设备加速度信息对象
- AccelerometerOption: 监听设备加速度感应器参数

## 回调方法：

- AccelerometerSuccessCallback: 获取设备加速度信息成功的回调函数
- AccelerometerErrorCallback: 获取设备加速度信息失败的回调函数

## 权限：

5+功能模块（permissions）

    {
    // ...
    "permissions":{
    	// ...
    	"Accelerometer": {
    		"description": "加速度传感器"
    	}
    }
    }

# Acceleration

设备加速度信息对象

    interface Acceleration {
    	readonly attribute Number xAxis;
    	readonly attribute Number yAxis;
    	readonly attribute Number zAxis;
    }

## 说明：

JSON对象，保存获取设备的加速度信息，包括x、y、z三个方向的加速度信息。

## 属性：

- xAxis: (Number 类型 )x轴方向的加速度

  获取当前设备x轴方向的加速度，浮点型数据，与物理学中的加速度值一致。

- yAxis: (Number 类型 )y轴方向的加速度

  获取当前设备y轴方向的加速度，浮点型数据，与物理学中的加速度值一致。

- zAxis: (Number 类型 )z轴方向的加速度

  获取当前设备z轴方向的加速度，浮点型数据，与物理学中的加速度值一致。

# AccelerometerOption

监听设备加速度感应器参数

    interface Acceleration {
    	readonly attribute DOMString frequency;
    }

## 说明：

JSON对象，用于设置获取设备加速度信息的参数。

## 属性：

- frequency: (Number 类型 )更新加速度信息间隔时间

  监听器获取加速度信息的时间间隔，单位为ms，默认值为500ms

# AccelerometerSuccessCallback

获取设备加速度信息成功的回调函数

    void onSuccess( acceleration ) {
    	// Get acceleration code.
    }

## 参数：

- acceleration: ( Acceleration ) 必选 设备的加速度信息
  Acceleration类型对象，用于获取各方向的详细加速度值。

## 返回值：

void : 无

# AccelerometerErrorCallback

获取设备加速度信息失败的回调函数

    function void onAccelerometerError(Exception error) {
    	// Handle error
    	var code = error.code; // 错误编码
    	var message = error.message; // 错误描述信息
    }

## 参数：

- error: ( Exception ) 必选 获取加速度操作的错误信息
  可通过error.code（Number类型）获取错误编码； 可通过error.message（String类型）获取错误描述信息。

## 返回值：

void : 无