js-apis-sensor.md 61.0 KB
Newer Older
Z
zengyawen 已提交
1
# 传感器
Z
zengyawen 已提交
2

Z
zengyawen 已提交
3 4
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
Z
zengyawen 已提交
5

Z
zengyawen 已提交
6 7

## 导入模块
Z
zengyawen 已提交
8 9 10 11 12 13

```
import sensor from '@ohos.sensor';
```


Z
zengyawen 已提交
14 15 16
## 权限列表

计步器:ohos.permission.ACTIVITY_MOTION
Z
zengyawen 已提交
17

Z
zengyawen 已提交
18
心率:ohos.permission.READ_HEALTH_DATA
Z
zengyawen 已提交
19 20 21

加速度:ohos.permission.ACCELEROMETER

Z
zengyawen 已提交
22 23 24
陀螺仪:ohos.permission.GYROSCOPE


25
## sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER)
Z
zengyawen 已提交
26

27
on(type:  sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: AsyncCallback<AccelerometerResponse>,options?: Options): void
Z
zengyawen 已提交
28 29 30 31 32


监听加速度传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。


Z
zengyawen 已提交
33 34 35 36 37 38
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 要订阅的加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。 |
  | callback | AsyncCallback<[AccelerometerResponse](#accelerometerresponse)> | 是 | 注册加速度传感器的回调函数,上报的数据类型为AccelerometerResponse。 |
  | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |
Z
zengyawen 已提交
39

Z
zengyawen 已提交
40 41
- 示例:
  ```
42
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER,function(error,data){
Z
zengyawen 已提交
43 44 45 46
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
47
      console.info('X-coordinate component: ' + data.x);
Z
zengyawen 已提交
48 49
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
50 51
  },
      {interval: 10000000}
Z
zengyawen 已提交
52 53
  );
  ```
Z
zengyawen 已提交
54 55


56
## sensor.on(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION)
Z
zengyawen 已提交
57

58
on(type:sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:AsyncCallback<LinearAccelerometerResponse>, options?: Options): void
Z
zengyawen 已提交
59

Z
zengyawen 已提交
60 61 62 63 64 65 66 67 68 69 70
监听线性加速度传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 要订阅的线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。 |
  | callback | AsyncCallback<[LinearAccelerometerResponse](#linearaccelerometerresponse)> | 是 | 注册线性加速度传感器的回调函数,上报的数据类型为LinearAccelerometerResponse。 |
  | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |

- 示例:
  ```
71 72
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELEROMETER,function(error,data){
      if (error) {
Z
zengyawen 已提交
73 74 75 76 77 78
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
79 80
  },
      {interval: 10000000}
Z
zengyawen 已提交
81 82
  );
  ```
Z
zengyawen 已提交
83 84


85
## sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED)
Z
zengyawen 已提交
86

87
on(type:sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback:AsyncCallback<AccelerometerUncalibratedResponse>, options?: Options): void
Z
zengyawen 已提交
88

Z
zengyawen 已提交
89
监听未校准加速度计传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。
Z
zengyawen 已提交
90

Z
zengyawen 已提交
91 92 93 94 95 96 97 98 99
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 要订阅的未校准加速度计传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 |
  | callback | AsyncCallback<[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)> | 是 | 注册未校准加速度计传感器的回调函数,上报的数据类型为AccelerometerUncalibratedResponse。 |
  | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |

- 示例:
  ```
100
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,function(error,data){
Z
zengyawen 已提交
101 102 103 104 105 106 107 108 109 110
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
      console.info('X-coordinate bias: ' + data.biasX);
      console.info('Y-coordinate bias: ' + data.biasY);
      console.info('Z-coordinate bias: ' + data.biasZ);
111 112
  },
      {interval: 10000000}
Z
zengyawen 已提交
113 114
  );
  ```
Z
zengyawen 已提交
115 116


117
## sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY)
Z
zengyawen 已提交
118

119
on(type: sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, callback: AsyncCallback<GravityResponse>,options?: Options): void
Z
zengyawen 已提交
120

Z
zengyawen 已提交
121
监听重力传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。
Z
zengyawen 已提交
122

Z
zengyawen 已提交
123 124 125 126 127 128 129 130 131
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 要订阅的重力传感器类型为SENSOR_TYPE_ID_GRAVITY。 |
  | callback | AsyncCallback<[GravityResponse](#gravityresponse)> | 是 | 注册重力传感器的回调函数,上报的数据类型为GravityResponse。 |
  | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |

- 示例:
  ```
132
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY,function(error,data){
Z
zengyawen 已提交
133 134 135 136
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
137
      console.info('X-coordinate component: ' + data.x);
Z
zengyawen 已提交
138 139
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
140 141
  },
      {interval: 10000000}
Z
zengyawen 已提交
142 143
  );
  ```
Z
zengyawen 已提交
144 145


146
## sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE)
Z
zengyawen 已提交
147

148
on(type: sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: AsyncCallback<GyroscopeResponse>, options?: Options): void
Z
zengyawen 已提交
149

Z
zengyawen 已提交
150
监听陀螺仪传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。
Z
zengyawen 已提交
151

Z
zengyawen 已提交
152 153 154 155 156 157 158 159 160
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 要订阅的陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。 |
  | callback | AsyncCallback<[GyroscopeResponse](#gyroscoperesponse)> | 是 | 注册陀螺仪传感器的回调函数,上报的数据类型为GyroscopeResponse。 |
  | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |

- 示例:
  ```
161
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE,function(error,data){
Z
zengyawen 已提交
162 163 164 165
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
166
      console.info('X-coordinate component: ' + data.x);
Z
zengyawen 已提交
167 168
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
169 170
  },
      {interval: 10000000}
Z
zengyawen 已提交
171 172
  );
  ```
Z
zengyawen 已提交
173 174


175
## sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED)
Z
zengyawen 已提交
176

177
on(type:sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback:AsyncCallback<GyroscopeUncalibratedResponse>, options?: Options): void
Z
zengyawen 已提交
178

Z
zengyawen 已提交
179
监听未校准陀螺仪传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。
Z
zengyawen 已提交
180

Z
zengyawen 已提交
181 182 183 184 185 186 187 188 189
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 要订阅的未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 |
  | callback | AsyncCallback<[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)> | 是 | 注册未校准陀螺仪传感器的回调函数,上报的数据类型为GyroscopeUncalibratedResponse。 |
  | options | [Options](#options) | 否 | 可选参数列表,设置上报频率。 |

- 示例:
  ```
190
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,function(error,data){
Z
zengyawen 已提交
191 192 193 194
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
195
      console.info('X-coordinate component: ' + data.x);
Z
zengyawen 已提交
196 197
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
198
      console.info('X-coordinate bias: ' + data.biasX);
Z
zengyawen 已提交
199 200
      console.info('Y-coordinate bias: ' + data.biasY);
      console.info('Z-coordinate bias: ' + data.biasZ);
201 202
  },
      {interval: 10000000}
Z
zengyawen 已提交
203 204
  );
  ```
Z
zengyawen 已提交
205 206


207
## sensor.on(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION)
Z
zengyawen 已提交
208

209
on(type: sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback: AsyncCallback<SignificantMotionResponse>, options?: Options): void
Z
zengyawen 已提交
210

Z
zengyawen 已提交
211
监听大幅动作传感器数据变化。如果多次调用该接口,仅最后一次调用生效。
Z
zengyawen 已提交
212

Z
zengyawen 已提交
213 214 215
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
216
  | type | [SensorType](#sensortype) | 是 | 要订阅的大幅动作传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。 |
Z
zengyawen 已提交
217 218 219 220 221
  | callback | AsyncCallback<[SignificantMotionResponse](#significantmotionresponse)> | 是 | 注册有效运动传感器的回调函数,上报的数据类型为SignificantMotionResponse。 |
  | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |

- 示例:
  ```
222
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,function(error,data){
Z
zengyawen 已提交
223 224 225 226 227
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('Scalar data: ' + data.scalar);
228 229
  },
      {interval: 10000000}
Z
zengyawen 已提交
230 231
  );
  ```
Z
zengyawen 已提交
232 233


234
## sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION)
Z
zengyawen 已提交
235

236
on(type: sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback: AsyncCallback<PedometerDetectResponse>, options?: Options): void
Z
zengyawen 已提交
237

Z
zengyawen 已提交
238
监听计步检测传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。
Z
zengyawen 已提交
239

Z
zengyawen 已提交
240 241 242 243 244 245 246 247 248
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 要订阅的计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。 |
  | callback | AsyncCallback<[PedometerDetectResponse](#pedometerdetectresponse)> | 是 | 注册计步检测传感器的回调函数,上报的数据类型为PedometerDetectResponse。 |
  | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |

- 示例:
  ```
249
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,function(error,data){
Z
zengyawen 已提交
250
      if (error) {
251
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
Z
zengyawen 已提交
252 253 254
          return;
      }
      console.info('Scalar data: ' + data.scalar);
255 256
  },
      {interval: 10000000}
Z
zengyawen 已提交
257 258
  );
  ```
Z
zengyawen 已提交
259 260


261
## sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER)
Z
zengyawen 已提交
262

263
on(type: sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: AsyncCallback<PedometerResponse>, options?: Options): void
Z
zengyawen 已提交
264

Z
zengyawen 已提交
265
监听计步传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。
Z
zengyawen 已提交
266

Z
zengyawen 已提交
267 268 269 270 271 272 273 274 275
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 要订阅的计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。 |
  | callback | AsyncCallback<[PedometerResponse](#pedometerresponse)> | 是 | 注册计步传感器的回调函数,上报的数据类型为PedometerResponse。 |
  | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |

- 示例:
  ```
276
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER,function(error,data){
Z
zengyawen 已提交
277 278 279 280 281
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('Steps: ' + data.steps);
282 283
  },
      {interval: 10000000}
Z
zengyawen 已提交
284 285
  );
  ```
Z
zengyawen 已提交
286 287


288
## sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE)
Z
zengyawen 已提交
289

290
on(type:sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback:AsyncCallback<AmbientTemperatureResponse>,  options?: Options): void
Z
zengyawen 已提交
291

Z
zengyawen 已提交
292
监听环境温度传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。
Z
zengyawen 已提交
293

Z
zengyawen 已提交
294 295 296 297 298 299 300 301 302
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 要订阅的环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 |
  | callback | AsyncCallback<[AmbientTemperatureResponse](#ambienttemperatureresponse)> | 是 | 注册环境温度传感器的回调函数,上报的数据类型为AmbientTemperatureResponse。 |
  | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |

- 示例:
  ```
303
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,function(error,data){
Z
zengyawen 已提交
304 305 306 307 308
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('Temperature: ' + data.temperature);
309 310
  },
      {interval: 10000000}
Z
zengyawen 已提交
311 312
  );
  ```
Z
zengyawen 已提交
313 314


315
## sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD)
Z
zengyawen 已提交
316

317
on(type: sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: AsyncCallback<MagneticFieldResponse>,options?: Options): void
Z
zengyawen 已提交
318

Z
zengyawen 已提交
319
监听磁场传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。
Z
zengyawen 已提交
320

Z
zengyawen 已提交
321 322 323 324 325 326 327 328 329
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 要订阅的磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。 |
  | callback | AsyncCallback<[MagneticFieldResponse](#magneticfieldresponse)> | 是 | 注册磁场传感器的回调函数,上报的数据类型为MagneticFieldResponse。 |
  | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |

- 示例:
  ```
330
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD,function(error,data){
Z
zengyawen 已提交
331 332 333 334 335 336 337
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
338 339
  },
      {interval: 10000000}
Z
zengyawen 已提交
340 341
  );
  ```
Z
zengyawen 已提交
342 343


344
## sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED)
Z
zengyawen 已提交
345

346
on(type:sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback:AsyncCallback<MagneticFieldUncalibratedResponse>, options: Options): void
Z
zengyawen 已提交
347

Z
zengyawen 已提交
348
监听未校准磁场传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。
Z
zengyawen 已提交
349

Z
zengyawen 已提交
350 351 352 353 354 355 356 357 358
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 要订阅的未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 |
  | callback | AsyncCallback<[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)> | 是 | 注册未校准磁场传感器的回调函数,上报的数据类型为MagneticFieldUncalibratedResponse。 |
  | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |

- 示例:
  ```
359
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,function(error,data){
Z
zengyawen 已提交
360 361 362 363
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
364 365 366 367
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
      console.info('X-coordinate bias: ' + data.biasX);
Z
zengyawen 已提交
368 369
      console.info('Y-coordinate bias: ' + data.biasY);
      console.info('Z-coordinate bias: ' + data.biasZ);
370 371
  },
      {interval: 10000000}
Z
zengyawen 已提交
372 373
  );
  ```
Z
zengyawen 已提交
374 375


376
## sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY)
Z
zengyawen 已提交
377

378
on(type:sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: AsyncCallback<ProximityResponse>,options?: Options): void
Z
zengyawen 已提交
379

Z
zengyawen 已提交
380
监听接近光传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。
Z
zengyawen 已提交
381

Z
zengyawen 已提交
382 383 384 385 386 387 388 389 390
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 要订阅的接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。 |
  | callback | AsyncCallback<[ProximityResponse](#proximityresponse)> | 是 | 注册接近光传感器的回调函数,上报的数据类型为ProximityResponse。 |
  | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |

- 示例:
  ```
391
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY,function(error,data){
Z
zengyawen 已提交
392 393 394 395 396
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('Distance: ' + data.distance);
397 398
  },
      {interval: 10000000}
Z
zengyawen 已提交
399 400
  );
  ```
Z
zengyawen 已提交
401 402


403
## sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY)
Z
zengyawen 已提交
404

405
on(type: sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: AsyncCallback<HumidityResponse>,options?: Options): void
Z
zengyawen 已提交
406

Z
zengyawen 已提交
407
监听湿度传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。
Z
zengyawen 已提交
408

Z
zengyawen 已提交
409 410 411 412 413 414 415 416 417
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 要订阅的湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。 |
  | callback | AsyncCallback<[HumidityResponse](#humidityresponse)> | 是 | 注册湿度传感器的回调函数,上报的数据类型为HumidityResponse。 |
  | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |

- 示例:
  ```
418
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY,function(error,data){
Z
zengyawen 已提交
419 420 421 422 423
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('Humidity: ' + data.humidity);
424 425
  },
      {interval: 10000000}
Z
zengyawen 已提交
426 427
  );
  ```
Z
zengyawen 已提交
428 429


430
## sensor.on(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER)
Z
zengyawen 已提交
431

432
on(type:sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, callback: AsyncCallback<BarometerResponse>,options?: Options): void
Z
zengyawen 已提交
433

Z
zengyawen 已提交
434
监听气压计传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。
Z
zengyawen 已提交
435

Z
zengyawen 已提交
436 437 438 439 440 441 442 443 444
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 要订阅的气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。 |
  | callback | AsyncCallback<[BarometerResponse](#barometerresponse)> | 是 | 注册气压计传感器的回调函数,上报的数据类型为BarometerResponse。 |
  | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |

- 示例:
  ```
445
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER,function(error,data){
Z
zengyawen 已提交
446 447 448 449 450
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('Atmospheric pressure: ' + data.pressure);
451 452
  },
      {interval: 10000000}
Z
zengyawen 已提交
453 454
  );
  ```
Z
zengyawen 已提交
455 456


457
## sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HALL)
Z
zengyawen 已提交
458

459
on(type: sensor.SensorType.SENSOR_TYPE_ID_HALL, callback: AsyncCallback<HallResponse>, options?: Options): void
Z
zengyawen 已提交
460

Z
zengyawen 已提交
461
监听霍尔传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。
Z
zengyawen 已提交
462

Z
zengyawen 已提交
463 464 465 466 467 468 469 470 471
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 要订阅的霍尔传感器类型为SENSOR_TYPE_ID_HALL。 |
  | callback | AsyncCallback<[HallResponse](#hallresponse)> | 是 | 注册霍尔传感器的回调函数,上报的数据类型为 HallResponse。 |
  | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |

- 示例:
  ```
472
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HALL,function(error,data){
Z
zengyawen 已提交
473 474 475 476 477
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('Status: ' + data.status);
478 479
  },
      {interval: 10000000}
Z
zengyawen 已提交
480 481
  );
  ```
Z
zengyawen 已提交
482 483


484
## sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT)
Z
zengyawen 已提交
485

486
on(type:sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: AsyncCallback<LightResponse>, options?: Options): void
Z
zengyawen 已提交
487

Z
zengyawen 已提交
488
监听环境光传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。
Z
zengyawen 已提交
489

Z
zengyawen 已提交
490 491 492 493 494 495 496 497 498
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 要订阅的环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。 |
  | callback | AsyncCallback<[LightResponse](#lightresponse)> | 是 | 注册环境光传感器的回调函数,上报的数据类型为LightResponse。 |
  | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |

- 示例:
  ```
499
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT,function(error,data){
Z
zengyawen 已提交
500 501 502 503
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
504 505 506
      console.info(' Illumination: ' + data.intensity);
  },
      {interval: 10000000}
Z
zengyawen 已提交
507 508
  );
  ```
Z
zengyawen 已提交
509 510


511
## sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION)
Z
zengyawen 已提交
512

513
on(type: sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: AsyncCallback<OrientationResponse>, options?: Options): void
Z
zengyawen 已提交
514

Z
zengyawen 已提交
515
监听方向传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。
Z
zengyawen 已提交
516

Z
zengyawen 已提交
517 518 519 520 521 522 523 524 525
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 要订阅的方向传感器类型为SENSOR_TYPE_ID_ORIENTATION |
  | callback | AsyncCallback<[OrientationResponse](#orientationresponse)> | 是 | 注册方向传感器的回调函数,上报的数据类型为OrientationResponse。 |
  | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |

- 示例:
  ```
526
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION,function(error,data){
Z
zengyawen 已提交
527 528 529 530 531 532 533
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
534 535
  },
      {interval: 10000000}
Z
zengyawen 已提交
536 537
  );
  ```
Z
zengyawen 已提交
538 539


540
## sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR)
Z
zengyawen 已提交
541

542
on(type:sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,callback:AsyncCallback<RotationVectorResponse>,options?: Options): void
Z
zengyawen 已提交
543

Z
zengyawen 已提交
544
监听旋转矢量传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。
Z
zengyawen 已提交
545

Z
zengyawen 已提交
546 547 548 549 550 551 552 553 554
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 要订阅的旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。 |
  | callback | AsyncCallback<[RotationVectorResponse](#rotationvectorresponse)> | 是 | 注册旋转矢量传感器的回调函数,上报的数据类型为RotationVectorResponse。 |
  | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |

- 示例:
  ```
555
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,function(error,data){
Z
zengyawen 已提交
556 557 558 559 560 561 562
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
563 564
  },
      {interval: 10000000}
Z
zengyawen 已提交
565 566
  );
  ```
Z
zengyawen 已提交
567 568


569
## sensor.on(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION)
Z
zengyawen 已提交
570

571
on(type: sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: AsyncCallback<WearDetectionResponse>,options?: Options): void
Z
zengyawen 已提交
572

Z
zengyawen 已提交
573
监听佩戴检测传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。
Z
zengyawen 已提交
574

Z
zengyawen 已提交
575 576 577 578 579 580 581 582 583
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 要订阅的佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。 |
  | callback | AsyncCallback<[WearDetectionResponse](#weardetectionresponse)> | 是 | 注册佩戴检测传感器的回调函数,上报的数据类型为WearDetectionResponse。 |
  | options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 |

- 示例:
  ```
584
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION,function(error,data){
Z
zengyawen 已提交
585 586 587 588 589
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('Wear status: ' + data.value);
590 591
  },
      {interval: 10000000}
Z
zengyawen 已提交
592 593
  );
  ```
Z
zengyawen 已提交
594 595


596
## sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER)
Z
zengyawen 已提交
597

598
once(type: sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: AsyncCallback<AccelerometerResponse>): void
Z
zengyawen 已提交
599

Z
zengyawen 已提交
600
监听加速度传感器的数据变化一次。
Z
zengyawen 已提交
601

Z
zengyawen 已提交
602 603 604 605 606 607 608 609
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。 |
  | callback | AsyncCallback<[AccelerometerResponse](#accelerometerresponse)> | 是 | 注册一次加速度传感器的回调函数,上报的数据类型为AccelerometerResponse。 |

- 示例:
  ```
610
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER,function(error,data){
Z
zengyawen 已提交
611 612 613 614 615 616 617
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
Z
zengyawen 已提交
618
    }
Z
zengyawen 已提交
619 620
  );
  ```
Z
zengyawen 已提交
621 622


623
## sensor.once(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION)
Z
zengyawen 已提交
624

625
once(type:sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:AsyncCallback<LinearAccelerometerResponse>): void
Z
zengyawen 已提交
626

Z
zengyawen 已提交
627
监听线性加速度传感器数据变化一次。
Z
zengyawen 已提交
628

Z
zengyawen 已提交
629 630 631 632 633 634 635 636
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。 |
  | callback | AsyncCallback<[LinearAccelerometerResponse](#linearaccelerometerresponse)> | 是 | 注册一次线性加速度传感器的回调函数,上报的数据类型为LinearAccelerometerResponse。 |

- 示例:
  ```
637
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, function(error, data) {
Z
zengyawen 已提交
638 639 640 641 642 643 644
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
Z
zengyawen 已提交
645
    }
Z
zengyawen 已提交
646 647
  );
  ```
Z
zengyawen 已提交
648 649


650
## sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED)
Z
zengyawen 已提交
651

652
once(type:sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback:AsyncCallback<AccelerometerUncalibratedResponse>): void
Z
zengyawen 已提交
653

Z
zengyawen 已提交
654
监听未校准加速度传感器的数据变化一次。
Z
zengyawen 已提交
655

Z
zengyawen 已提交
656 657 658 659 660 661 662 663
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 未校准加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 |
  | callback | AsyncCallback<[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)> | 是 | 注册一次未校准加速度传感器的回调函数,上报的数据类型为AccelerometerUncalibratedResponse。 |

- 示例:
  ```
664
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, function(error, data) {
Z
zengyawen 已提交
665 666 667 668 669 670 671 672 673 674
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
      console.info('X-coordinate bias: ' + data.biasX);
      console.info('Y-coordinate bias: ' + data.biasY);
      console.info('Z-coordinate bias: ' + data.biasZ);
Z
zengyawen 已提交
675
    }
Z
zengyawen 已提交
676 677
  );
  ```
Z
zengyawen 已提交
678 679


680
## sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY)
Z
zengyawen 已提交
681

682
once(type:sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, callback: AsyncCallback<GravityResponse>): void
Z
zengyawen 已提交
683

Z
zengyawen 已提交
684
监听重力传感器的数据变化一次。
Z
zengyawen 已提交
685

Z
zengyawen 已提交
686 687 688 689 690 691 692 693
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 重力传感器类型为SENSOR_TYPE_ID_GRAVITY。 |
  | callback | AsyncCallback<[GravityResponse](#gravityresponse)> | 是 | 注册一次重力传感器的回调函数,上报的数据类型为GravityResponse。 |

- 示例:
  ```
694
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, function(error, data) {
Z
zengyawen 已提交
695 696 697 698 699 700 701
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
Z
zengyawen 已提交
702
    }
Z
zengyawen 已提交
703 704
  );
  ```
Z
zengyawen 已提交
705 706


707
## sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE)
Z
zengyawen 已提交
708

709
once(type: sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: AsyncCallback<GyroscopeResponse>): void
Z
zengyawen 已提交
710

Z
zengyawen 已提交
711
监听陀螺仪传感器的数据变化一次。
Z
zengyawen 已提交
712

Z
zengyawen 已提交
713 714 715 716 717 718 719 720
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。 |
  | callback | AsyncCallback<[GyroscopeResponse](#gyroscoperesponse)> | 是 | 注册一次陀螺仪传感器的回调函数,上报的数据类型为GyroscopeResponse。 |

- 示例:
  ```
721
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, function(error, data) {
Z
zengyawen 已提交
722 723 724 725 726 727 728
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
Z
zengyawen 已提交
729
    }
Z
zengyawen 已提交
730 731
  );
  ```
Z
zengyawen 已提交
732 733


734
## sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED)
Z
zengyawen 已提交
735

736
once(type:sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback:AsyncCallback<GyroscopeUncalibratedResponse>): void
Z
zengyawen 已提交
737

Z
zengyawen 已提交
738
监听未校准陀螺仪传感器的数据变化一次。
Z
zengyawen 已提交
739

Z
zengyawen 已提交
740 741 742 743 744 745 746 747
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 |
  | callback | AsyncCallback<[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)> | 是 | 注册一次未校准陀螺仪传感器的回调函数,上报的数据类型为GyroscopeUncalibratedResponse。 |

- 示例:
  ```
748
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, function(error, data) {
Z
zengyawen 已提交
749 750 751 752 753 754 755 756 757 758
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
      console.info('X-coordinate bias: ' + data.biasX);
      console.info('Y-coordinate bias: ' + data.biasY);
      console.info('Z-coordinate bias: ' + data.biasZ);
Z
zengyawen 已提交
759
    }
Z
zengyawen 已提交
760 761
  );
  ```
Z
zengyawen 已提交
762 763


764
## sensor.once(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION)
Z
zengyawen 已提交
765

766
once(type: sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,callback:AsyncCallback<SignificantMotionResponse>): void
Z
zengyawen 已提交
767

Z
zengyawen 已提交
768
监听有效运动传感器的数据变化一次。
Z
zengyawen 已提交
769

Z
zengyawen 已提交
770 771 772 773 774 775 776 777
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 有效运动传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。 |
  | callback | AsyncCallback<[SignificantMotionResponse](#significantmotionresponse)> | 是 | 注册一次有效运动传感器的回调函数,上报的数据类型为SignificantMotionResponse。 |

- 示例:
  ```
778
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, function(error, data) {
Z
zengyawen 已提交
779 780 781 782 783
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('Scalar data: ' + data.scalar);
Z
zengyawen 已提交
784
    }
Z
zengyawen 已提交
785 786
  );
  ```
Z
zengyawen 已提交
787 788


789
## sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION)
Z
zengyawen 已提交
790

791
once(type:sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,callback:AsyncCallback<PedometerDetectResponse>): void
Z
zengyawen 已提交
792

Z
zengyawen 已提交
793
监听计步检测传感器数据变化一次。
Z
zengyawen 已提交
794

Z
zengyawen 已提交
795 796 797 798 799 800 801 802
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。 |
  | callback | AsyncCallback<[PedometerDetectResponse](#pedometerdetectresponse)> | 是 | 注册一次计步检测传感器的回调函数,上报的数据类型为PedometerDetectResponse。 |

- 示例:
  ```
803
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, function(error, data) {
Z
zengyawen 已提交
804 805 806 807 808
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('Scalar data: ' + data.scalar);
Z
zengyawen 已提交
809
    }
Z
zengyawen 已提交
810 811
  );
  ```
Z
zengyawen 已提交
812 813


814
## sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER)
Z
zengyawen 已提交
815

816
once(type: sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: AsyncCallback<PedometerResponse>): void
Z
zengyawen 已提交
817

Z
zengyawen 已提交
818
监听计步器传感器数据变化一次。
Z
zengyawen 已提交
819

Z
zengyawen 已提交
820 821 822 823 824 825 826 827
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。 |
  | callback | AsyncCallback<[PedometerResponse](#pedometerresponse)> | 是 | 注册一次计步传感器的回调函数,上报的数据类型为PedometerResponse。 |

- 示例:
  ```
828
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, function(error, data) {
Z
zengyawen 已提交
829 830 831 832 833
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('Steps: ' + data.steps);
Z
zengyawen 已提交
834
    }
Z
zengyawen 已提交
835 836
  );
  ```
Z
zengyawen 已提交
837 838


839
## sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE)
Z
zengyawen 已提交
840

841
once(type:sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback:AsyncCallback<AmbientTemperatureResponse>): void
Z
zengyawen 已提交
842

Z
zengyawen 已提交
843
监听环境温度传感器数据变化一次。
Z
zengyawen 已提交
844

Z
zengyawen 已提交
845 846 847 848 849 850 851 852
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 |
  | callback | AsyncCallback<[AmbientTemperatureResponse](#ambienttemperatureresponse)> | 是 | 注册一次环境温度传感器的回调函数,上报的数据类型为AmbientTemperatureResponse。 |

- 示例:
  ```
853
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, function(error, data) {
Z
zengyawen 已提交
854 855 856 857 858
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('Temperature: ' + data.temperature);
Z
zengyawen 已提交
859
    }
Z
zengyawen 已提交
860 861
  );
  ```
Z
zengyawen 已提交
862 863


864
## sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD)
Z
zengyawen 已提交
865

866
once(type: sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: AsyncCallback<MagneticFieldResponse>): void
Z
zengyawen 已提交
867

Z
zengyawen 已提交
868
监听磁场传感器数据变化一次。
Z
zengyawen 已提交
869

Z
zengyawen 已提交
870 871 872 873 874 875 876 877
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。 |
  | callback | AsyncCallback<[MagneticFieldResponse](#magneticfieldresponse)> | 是 | 注册一次磁场传感器的回调函数,上报的数据类型为MagneticFieldResponse。 |

- 示例:
  ```
878
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, function(error, data) {
Z
zengyawen 已提交
879 880 881 882 883 884 885
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
Z
zengyawen 已提交
886
    }
Z
zengyawen 已提交
887 888
  );
  ```
Z
zengyawen 已提交
889 890


891
## sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED)
Z
zengyawen 已提交
892

893
once(type:sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback:AsyncCallback<MagneticFieldUncalibratedResponse>): void
Z
zengyawen 已提交
894

Z
zengyawen 已提交
895
监听未校准磁场传感器数据变化一次。
Z
zengyawen 已提交
896

Z
zengyawen 已提交
897 898 899 900 901 902 903 904
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 |
  | callback | AsyncCallback<[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)> | 是 | 注册一次未校准磁场传感器的回调函数,上报的数据类型为MagneticFieldUncalibratedResponse。 |

- 示例:
  ```
905
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, function(error, data) {
Z
zengyawen 已提交
906 907 908 909 910 911 912 913 914 915
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
      console.info('X-coordinate bias: ' + data.biasX);
      console.info('Y-coordinate bias: ' + data.biasY);
      console.info('Z-coordinate bias: ' + data.biasZ);
Z
zengyawen 已提交
916
    }
Z
zengyawen 已提交
917 918
  );
  ```
Z
zengyawen 已提交
919 920


921
## sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY)
Z
zengyawen 已提交
922

923
once(type: sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: AsyncCallback<ProximityResponse>): void
Z
zengyawen 已提交
924

Z
zengyawen 已提交
925
监听接近光传感器数据变化一次。
Z
zengyawen 已提交
926

Z
zengyawen 已提交
927 928 929 930 931 932 933 934
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。 |
  | callback | AsyncCallback<[ProximityResponse](#proximityresponse)> | 是 | 注册一次接近光传感器的回调函数,上报的数据类型为ProximityResponse。 |

- 示例:
  ```
935
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, function(error, data) {
Z
zengyawen 已提交
936 937 938 939 940
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('Distance: ' + data.distance);
Z
zengyawen 已提交
941
    }
Z
zengyawen 已提交
942 943
  );
  ```
Z
zengyawen 已提交
944 945


946
## sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY)
Z
zengyawen 已提交
947

948
once(type: sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: AsyncCallback<HumidityResponse>): void
Z
zengyawen 已提交
949

Z
zengyawen 已提交
950
监听湿度传感器数据变化一次。
Z
zengyawen 已提交
951

Z
zengyawen 已提交
952 953 954 955 956 957 958 959
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。 |
  | callback | AsyncCallback<[HumidityResponse](#humidityresponse)> | 是 | 注册一次湿度传感器的回调函数,上报的数据类型为HumidityResponse。 |

- 示例:
  ```
960
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, function(error, data) {
Z
zengyawen 已提交
961 962 963 964 965
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('Humidity: ' + data.humidity);
Z
zengyawen 已提交
966
    }
Z
zengyawen 已提交
967 968
  );
  ```
Z
zengyawen 已提交
969 970


971
## sensor.once(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER)
Z
zengyawen 已提交
972

973
once(type: sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, callback: AsyncCallback<BarometerResponse>): void
Z
zengyawen 已提交
974

Z
zengyawen 已提交
975
监听气压计传感器数据变化一次。
Z
zengyawen 已提交
976

Z
zengyawen 已提交
977 978 979 980 981 982 983 984
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。 |
  | callback | AsyncCallback<[BarometerResponse](#barometerresponse)> | 是 | 注册一次气压计传感器的回调函数,上报的数据类型为BarometerResponse。 |

- 示例:
  ```
985
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, function(error, data) {
Z
zengyawen 已提交
986 987 988 989 990
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('Atmospheric pressure: ' + data.pressure);
Z
zengyawen 已提交
991
    }
Z
zengyawen 已提交
992 993
  );
  ```
Z
zengyawen 已提交
994 995


996
## sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HALL)
Z
zengyawen 已提交
997

998
once(type: sensor.SensorType.SENSOR_TYPE_ID_HALL, callback:   AsyncCallback<HallResponse>): void
Z
zengyawen 已提交
999

Z
zengyawen 已提交
1000
监听霍尔传感器数据变化一次。
Z
zengyawen 已提交
1001

Z
zengyawen 已提交
1002 1003 1004 1005 1006 1007 1008 1009
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 霍尔传感器类型为SENSOR_TYPE_ID_HALL。 |
  | callback | AsyncCallback<[HallResponse](#hallresponse)> | 是 | 注册一次霍尔传感器的回调函数,上报的数据类型为HallResponse。 |

- 示例:
  ```
1010
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HALL, function(error, data) {
Z
zengyawen 已提交
1011 1012 1013 1014 1015
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('Status: ' + data.status);
Z
zengyawen 已提交
1016
    }
Z
zengyawen 已提交
1017 1018
  );
  ```
Z
zengyawen 已提交
1019 1020


1021
## sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT)
Z
zengyawen 已提交
1022

1023
once(type: sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: AsyncCallback<LightResponse>): void
Z
zengyawen 已提交
1024

Z
zengyawen 已提交
1025
监听环境光传感器数据变化一次。
Z
zengyawen 已提交
1026

Z
zengyawen 已提交
1027 1028 1029 1030 1031 1032 1033 1034
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。 |
  | callback | AsyncCallback<[LightResponse](#lightresponse)> | 是 | 注册一次环境光传感器的回调函数,上报的数据类型为LightResponse。 |

- 示例:
  ```
1035
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, function(error, data) {
Z
zengyawen 已提交
1036 1037 1038 1039
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
1040
      console.info(' Illumination: ' + data.intensity);
Z
zengyawen 已提交
1041
    }
Z
zengyawen 已提交
1042 1043
  );
  ```
Z
zengyawen 已提交
1044 1045


1046
## sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION)
Z
zengyawen 已提交
1047

1048
once(type: sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: AsyncCallback<OrientationResponse>): void
Z
zengyawen 已提交
1049

Z
zengyawen 已提交
1050
监听方向传感器数据变化一次。
Z
zengyawen 已提交
1051

Z
zengyawen 已提交
1052 1053 1054 1055 1056 1057 1058 1059
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 方向传感器类型为SENSOR_TYPE_ID_ORIENTATION。 |
  | callback | AsyncCallback<[OrientationResponse](#orientationresponse)> | 是 | 注册一次方向传感器的回调函数,上报的数据类型为OrientationResponse。 |

- 示例:
  ```
1060
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, function(error, data) {
Z
zengyawen 已提交
1061 1062 1063 1064 1065 1066 1067
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
Z
zengyawen 已提交
1068
    }
Z
zengyawen 已提交
1069 1070
  );
  ```
Z
zengyawen 已提交
1071 1072


1073
## sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR)
Z
zengyawen 已提交
1074

1075
once(type: sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback: AsyncCallback<RotationVectorResponse>): void
Z
zengyawen 已提交
1076

Z
zengyawen 已提交
1077
监听旋转矢量传感器数据变化一次。
Z
zengyawen 已提交
1078

Z
zengyawen 已提交
1079 1080 1081 1082 1083 1084 1085 1086
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。 |
  | callback | AsyncCallback<[RotationVectorResponse](#rotationvectorresponse)> | 是 | 注册一次旋转矢量传感器的回调函数,上报的数据类型为RotationVectorResponse。 |

- 示例:
  ```
1087
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, function(error, data) {
Z
zengyawen 已提交
1088 1089 1090 1091 1092 1093 1094
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
Z
zengyawen 已提交
1095
    }
Z
zengyawen 已提交
1096 1097
  );
  ```
Z
zengyawen 已提交
1098 1099


1100
## sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE)
Z
zengyawen 已提交
1101

1102
once(type: sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: AsyncCallback<HeartRateResponse>): void
Z
zengyawen 已提交
1103

Z
zengyawen 已提交
1104
监听心率传感器数据变化一次。
Z
zengyawen 已提交
1105

Z
zengyawen 已提交
1106 1107 1108 1109 1110 1111 1112 1113
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。 |
  | callback | AsyncCallback<[HeartRateResponse](#heartrateresponse)> | 是 | 注册一次心率传感器的回调函数,上报的数据类型为HeartRateResponse。 |

- 示例:
  ```
1114
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE, function(error, data) {
Z
zengyawen 已提交
1115 1116 1117 1118 1119
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info("Heart rate: " + data.heartRate);
Z
zengyawen 已提交
1120
    }
Z
zengyawen 已提交
1121 1122
  );
  ```
Z
zengyawen 已提交
1123 1124


1125
## sensor.once(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION)
Z
zengyawen 已提交
1126

1127
once(type: sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: AsyncCallback<WearDetectionResponse>): void
Z
zengyawen 已提交
1128

Z
zengyawen 已提交
1129
监听佩戴检测传感器数据变化一次。
Z
zengyawen 已提交
1130

Z
zengyawen 已提交
1131 1132 1133 1134 1135 1136 1137 1138
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。 |
  | callback | AsyncCallback<[WearDetectionResponse](#weardetectionresponse)> | 是 | 注册一次穿戴检测传感器的回调函数,上报的数据类型为WearDetectionResponse。 |

- 示例:
  ```
1139
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, function(error, data) {
Z
zengyawen 已提交
1140 1141 1142 1143 1144
      if (error) {
          console.error("Failed to register data, error code is" + error.code + ", message: " + error.message);
          return;
      }
      console.info("Wear status: "+ data.value);
Z
zengyawen 已提交
1145
    }
Z
zengyawen 已提交
1146 1147
  );
  ```
Z
zengyawen 已提交
1148 1149


Z
zengyawen 已提交
1150
## sensor.off
Z
zengyawen 已提交
1151

Z
zengyawen 已提交
1152
off(type: SensorType, callback?: AsyncCallback<void>): void
Z
zengyawen 已提交
1153

Z
zengyawen 已提交
1154
取消订阅传感器数据。
Z
zengyawen 已提交
1155

Z
zengyawen 已提交
1156 1157 1158 1159 1160 1161 1162 1163
- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | type | [SensorType](#sensortype) | 是 | 要取消订阅的传感器类型。 |
  | callback | AsyncCallback<void> | 是 | 取消订阅的传感器的回调函数,表示接口调用是否成功。 |

- 示例:
  ```
1164
  sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, function(error) {
Z
zengyawen 已提交
1165 1166 1167 1168 1169
      if (error) {
          console.error("Failed to unsubscribe from acceleration sensor data. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info("Succeeded in unsubscribing from acceleration sensor data.");
Z
zengyawen 已提交
1170
    }
Z
zengyawen 已提交
1171 1172 1173
  );
  
  ```
Z
zengyawen 已提交
1174 1175


Z
zengyawen 已提交
1176
## sensor.getGeomagneticField
Z
zengyawen 已提交
1177

Z
zengyawen 已提交
1178
getGeomagneticField(locationOptions: LocationOptions, timeMillis: number, callback: AsyncCallback<GeomagneticResponse>): void
Z
zengyawen 已提交
1179

Z
zengyawen 已提交
1180
获取地球上特定位置的地磁场。
Z
zengyawen 已提交
1181 1182 1183 1184

- 参数
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
  | locationOptions | [LocationOptions](#locationoptions) | 是 | 地理位置。 |
  | timeMillis | number | 是 | 表示获取磁偏角的时间,单位为毫秒。 |
  | callback | AsyncCallback<[GeomagneticResponse](#geomagneticresponse)> | 是 | 返回磁场信息。 |

- 示例
  ```
  sensor.getGeomagneticField([80, 0, 0], {'timeMillis':1580486400000}, function(err, data)  {
      if (err) {
          console.error('Operation failed. Error code: ' + err.code + '; message: ' + err.message);
          return;
      }
      console.info('sensor_getGeomagneticField_promise x: ' + data.x + ',y: ' + data.y + ',z: ' +
  	             data.z + ',geomagneticDip: ' + data.geomagneticDip + ',deflectionAngle: ' + data.deflectionAngle +
  		     ',levelIntensity: ' + data.levelIntensity + ',totalIntensity: ' + data.totalIntensity);
  });
  ```


## sensor.getGeomagneticField

getGeomagneticField(locationOptions: LocationOptions, timeMillis: number): Promise<GeomagneticResponse>

获取地球上特定位置的地磁场。

- 参数
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | locationOptions | [LocationOptions](#locationoptions) | 是 | 地理位置。 |
  | timeMillis | number | 是 | 表示获取磁偏角的时间,单位为毫秒。 |
Z
zengyawen 已提交
1214 1215 1216 1217

- 返回值
  | 类型 | 说明 |
  | -------- | -------- |
Z
zengyawen 已提交
1218
  | Promise<[GeomagneticResponse](#geomagneticresponse)> | 返回磁场信息。 |
Z
zengyawen 已提交
1219 1220 1221

- 示例
  ```
Z
zengyawen 已提交
1222
  const promise = sensor.getGeomagneticField([80, 0, 0], {'timeMillis':1580486400000});
Z
zengyawen 已提交
1223
      promise.then((data) => {
Z
zengyawen 已提交
1224 1225 1226
          console.info('sensor_getGeomagneticField_promise x: ' + data.x + ',y: ' + data.y + ',z: ' +
  	             data.z + ',geomagneticDip: ' + data.geomagneticDip + ',deflectionAngle: ' + data.deflectionAngle +
  		     ',levelIntensity: ' + data.levelIntensity + ',totalIntensity: ' + data.totalIntensity);
Z
zengyawen 已提交
1227
      }).catch((reason) => {
Z
zengyawen 已提交
1228 1229
          console.info('Operation failed.');
  })
Z
zengyawen 已提交
1230 1231
  ```

Z
zengyawen 已提交
1232

Z
zengyawen 已提交
1233
## SensorType
Z
zengyawen 已提交
1234 1235 1236

表示要订阅或取消订阅的传感器类型。

Z
zengyawen 已提交
1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262

| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| SENSOR_TYPE_ID_ACCELEROMETER | 1 | 加速度传感器。 |
| SENSOR_TYPE_ID_GYROSCOPE | 2 | 陀螺仪传感器。 |
| SENSOR_TYPE_ID_AMBIENT_LIGHT | 5 | 环境光传感器。 |
| SENSOR_TYPE_ID_MAGNETIC_FIELD | 6 | 磁场传感器。 |
| SENSOR_TYPE_ID_BAROMETER | 8 | 气压计传感器。 |
| SENSOR_TYPE_ID_HALL | 10 | 霍尔传感器。 |
| SENSOR_TYPE_ID_PROXIMITY | 12 | 接近光传感器。 |
| SENSOR_TYPE_ID_HUMIDITY | 13 | 湿度传感器。 |
| SENSOR_TYPE_ID_ORIENTATION | 256 | 方向传感器。 |
| SENSOR_TYPE_ID_GRAVITY | 257 | 重力传感器。 |
| SENSOR_TYPE_ID_LINEAR_ACCELERATION | 258 | 线性加速度传感器。 |
| SENSOR_TYPE_ID_ROTATION_VECTOR | 259 | 旋转矢量传感器。 |
| SENSOR_TYPE_ID_AMBIENT_TEMPERATURE | 260 | 环境温度传感器。 |
| SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED | 261 | 未校准磁场传感器。 |
| SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED | 263 | 未校准陀螺仪传感器。 |
| SENSOR_TYPE_ID_SIGNIFICANT_MOTION | 264 | 有效运动传感器。 |
| SENSOR_TYPE_ID_PEDOMETER_DETECTION | 265 | 计步检测传感器。 |
| SENSOR_TYPE_ID_PEDOMETER | 266 | 计步传感器。 |
| SENSOR_TYPE_ID_HEART_RATE | 278 | 心率传感器。 |
| SENSOR_TYPE_ID_WEAR_DETECTION | 280 | 佩戴检测传感器。 |
| SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED | 281 | 未校准加速度计传感器。 |


Z
zengyawen 已提交
1263 1264 1265 1266 1267 1268 1269 1270 1271
## Response

传感器数据的时间戳。

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| timestamp | number | 是 | 是 | 传感器数据上报的时间戳。 |


Z
zengyawen 已提交
1272
## AccelerometerResponse
Z
zengyawen 已提交
1273

Z
zengyawen 已提交
1274
加速度传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
1275

Z
zengyawen 已提交
1276 1277 1278

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1279 1280 1281
| x | number | 是 | 是 | 施加在设备x轴的加速度,单位 : m/s2。 |
| y | number | 是 | 是 | 施加在设备y轴的加速度,单位 : m/s2。 |
| z | number | 是 | 是 | 施加在设备z轴的加速度,单位 : m/s2。 |
Z
zengyawen 已提交
1282 1283 1284


## LinearAccelerometerResponse
Z
zengyawen 已提交
1285

Z
zengyawen 已提交
1286
线性加速度传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
1287

Z
zengyawen 已提交
1288 1289 1290

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1291 1292 1293
| x | number | 是 | 是 | 施加在设备x轴的线性加速度,单位 : m/s2。 |
| y | number | 是 | 是 | 施加在设备y轴的线性加速度,单位 : m/s2。 |
| z | number | 是 | 是 | 施加在设备z轴的线性加速度,单位 : m/s2。 |
Z
zengyawen 已提交
1294 1295 1296


## AccelerometerUncalibratedResponse
Z
zengyawen 已提交
1297

Z
zengyawen 已提交
1298
未校准加速度计传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
1299

Z
zengyawen 已提交
1300 1301 1302

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1303 1304 1305 1306 1307 1308
| x | number | 是 | 是 | 施加在设备x轴未校准的加速度,单位 : m/s2。 |
| y | number | 是 | 是 | 施加在设备y轴未校准的加速度,单位 : m/s2。 |
| z | number | 是 | 是 | 施加在设备z轴未校准的加速度,单位 : m/s2。 |
| biasX | number | 是 | 是 | 施加在设备x轴未校准的加速度偏量,单位 : m/s2。 |
| biasY | number | 是 | 是 | 施加在设备上y轴未校准的加速度偏量,单位 : m/s2。 |
| biasZ | number | 是 | 是 | 施加在设备z轴未校准的加速度偏量,单位 : m/s2。 |
Z
zengyawen 已提交
1309 1310 1311


## GravityResponse
Z
zengyawen 已提交
1312

Z
zengyawen 已提交
1313
重力传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
1314

Z
zengyawen 已提交
1315 1316 1317

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1318 1319 1320
| x | number | 是 | 是 | 施加在设备x轴的重力加速度,单位 : m/s2。 |
| y | number | 是 | 是 | 施加在设备y轴的重力加速度,单位 : m/s2。 |
| z | number | 是 | 是 | 施加在设备z轴的重力加速度,单位 : m/s2。 |
Z
zengyawen 已提交
1321 1322 1323


## OrientationResponse
Z
zengyawen 已提交
1324

Z
zengyawen 已提交
1325
方向传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
1326

Z
zengyawen 已提交
1327 1328 1329

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1330 1331 1332
| x | number | 是 | 是 | 设备围绕x轴的旋转角度,单位 : rad。 |
| y | number | 是 | 是 | 设备围绕y轴的旋转角度,单位 : rad。 |
| z | number | 是 | 是 | 设备围绕z轴的旋转角度,单位 : rad。 |
Z
zengyawen 已提交
1333 1334 1335


## RotationVectorResponse
Z
zengyawen 已提交
1336

Z
zengyawen 已提交
1337
旋转矢量传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
1338

Z
zengyawen 已提交
1339 1340 1341

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1342 1343 1344
| x | number | 是 | 是 | 旋转矢量x轴分量。 |
| y | number | 是 | 是 | 旋转矢量y轴分量。 |
| z | number | 是 | 是 | 旋转矢量z轴分量。 |
Z
zengyawen 已提交
1345 1346 1347


## GyroscopeResponse
Z
zengyawen 已提交
1348

Z
zengyawen 已提交
1349
陀螺仪传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
1350

Z
zengyawen 已提交
1351 1352 1353

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1354 1355 1356
| x | number | 是 | 是 | 设备x轴的旋转角速度,单位rad/s。 |
| y | number | 是 | 是 | 设备y轴的旋转角速度,单位rad/s。 |
| z | number | 是 | 是 | 设备z轴的旋转角速度,单位rad/s。 |
Z
zengyawen 已提交
1357 1358 1359


## GyroscopeUncalibratedResponse
Z
zengyawen 已提交
1360

Z
zengyawen 已提交
1361
未校准陀螺仪传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
1362

Z
zengyawen 已提交
1363 1364 1365

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1366 1367 1368 1369 1370 1371
| x | number | 是 | 是 | 设备x轴未校准的旋转角速度,单位rad/s。 |
| y | number | 是 | 是 | 设备y轴未校准的旋转角速度,单位rad/s。 |
| z | number | 是 | 是 | 设备z轴未校准的旋转角速度,单位rad/s。 |
| biasX | number | 是 | 是 | 设备x轴未校准的旋转角速度偏量,单位rad/s。 |
| biasY | number | 是 | 是 | 设备y轴未校准的旋转角速度偏量,单位rad/s。 |
| biasZ | number | 是 | 是 | 设备z轴未校准的旋转角速度偏量,单位rad/s。 |
Z
zengyawen 已提交
1372 1373 1374


## SignificantMotionResponse
Z
zengyawen 已提交
1375

Z
zengyawen 已提交
1376
有效运动传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
1377

Z
zengyawen 已提交
1378 1379 1380 1381 1382 1383 1384

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| scalar | number | 是 | 是 | 表示剧烈运动程度。测量三个物理轴(x、y  z)上,设备是否存在大幅度运动;如果取值为1则代表存在大幅度运动,取值为0则代表没有大幅度运动。 |


## ProximityResponse
Z
zengyawen 已提交
1385

Z
zengyawen 已提交
1386
接近光传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
1387

Z
zengyawen 已提交
1388 1389 1390 1391 1392 1393 1394

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| distance | number | 是 | 是 | 可见物体与设备显示器的接近程度。0表示接近,1表示远离。 |


## LightResponse
Z
zengyawen 已提交
1395

Z
zengyawen 已提交
1396
环境光传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
1397

Z
zengyawen 已提交
1398 1399 1400 1401 1402 1403 1404

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| intensity | number | 是 | 是 | 光强(单位:勒克斯)。 |


## HallResponse
Z
zengyawen 已提交
1405

Z
zengyawen 已提交
1406
霍尔传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
1407

Z
zengyawen 已提交
1408 1409 1410 1411 1412 1413 1414

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| status | number | 是 | 是 | 显示霍尔状态。测量设备周围是否存在磁力吸引,0表示有,1表示没有。 |


## MagneticFieldResponse
Z
zengyawen 已提交
1415

Z
zengyawen 已提交
1416
磁场传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
1417

Z
zengyawen 已提交
1418 1419 1420

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1421 1422 1423
| x | number | 是 | 是 | x轴环境磁场强度,单位 : μT。 |
| y | number | 是 | 是 | y轴环境磁场强度,单位 : μT。 |
| z | number | 是 | 是 | z轴环境磁场强度,单位 : μT。。 |
Z
zengyawen 已提交
1424 1425 1426


## MagneticFieldUncalibratedResponse
Z
zengyawen 已提交
1427

Z
zengyawen 已提交
1428
未校准磁场传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
1429

Z
zengyawen 已提交
1430 1431 1432

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1433 1434 1435 1436 1437 1438
| x | number | 是 | 是 | x轴未校准环境磁场强度,单位 : μT。 |
| y | number | 是 | 是 | y轴未校准环境磁场强度,单位 : μT。 |
| z | number | 是 | 是 | z轴未校准环境磁场强度,单位 : μT。 |
| biasX | number | 是 | 是 | x轴未校准环境磁场强度偏量,单位 : μT。 |
| biasY | number | 是 | 是 | y轴未校准环境磁场强度偏量,单位 : μT。 |
| biasZ | number | 是 | 是 | z轴未校准环境磁场强度偏量,单位 : μT。 |
Z
zengyawen 已提交
1439 1440 1441


## PedometerResponse
Z
zengyawen 已提交
1442

Z
zengyawen 已提交
1443
计步传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
1444

Z
zengyawen 已提交
1445 1446 1447

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1448
| steps | number | 是 | 是 | 用户的行走步数。 |
Z
zengyawen 已提交
1449 1450 1451


## HumidityResponse
Z
zengyawen 已提交
1452

Z
zengyawen 已提交
1453
湿度传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
1454

Z
zengyawen 已提交
1455 1456 1457 1458 1459 1460 1461

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| humidity | number | 是 | 是 | 湿度值。测量环境的相对湿度,以百分比 (%) 表示。 |


## PedometerDetectResponse
Z
zengyawen 已提交
1462

Z
zengyawen 已提交
1463
计步检测传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
1464

Z
zengyawen 已提交
1465 1466 1467 1468 1469 1470 1471

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| scalar | number | 是 | 是 | 计步器检测。检测用户的计步动作,如果取值为1则代表用户产生了计步行走的动作,取值为0则代表用户没有发生运动。 |


## AmbientTemperatureResponse
Z
zengyawen 已提交
1472

Z
zengyawen 已提交
1473
温度传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
1474

Z
zengyawen 已提交
1475 1476 1477 1478 1479 1480 1481

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| temperature | number | 是 | 是 | 环境温度(单位:摄氏度)。 |


## BarometerResponse
Z
zengyawen 已提交
1482

Z
zengyawen 已提交
1483
气压计传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
1484

Z
zengyawen 已提交
1485 1486 1487 1488 1489 1490 1491

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| pressure | number | 是 | 是 | 压力值(单位:帕斯卡)。 |


## HeartRateResponse
Z
zengyawen 已提交
1492

Z
zengyawen 已提交
1493
心率传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
1494

Z
zengyawen 已提交
1495 1496 1497

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1498
| heartRate | number | 是 | 是 | 心率值。测量用户的心率数值,单位:bpm。 |
Z
zengyawen 已提交
1499 1500 1501


## WearDetectionResponse
Z
zengyawen 已提交
1502

Z
zengyawen 已提交
1503
佩戴检测传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
1504 1505


Z
zengyawen 已提交
1506 1507
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1508
| value | number | 是 | 是 | 表示设备是否被穿戴(1表示已穿戴,0表示未穿戴)。 |
Z
zengyawen 已提交
1509 1510 1511 1512


## Options

Z
zengyawen 已提交
1513
设置传感器上报频率。
Z
zengyawen 已提交
1514 1515 1516 1517 1518 1519 1520 1521

| 名称 | 参数类型 | 说明 |
| -------- | -------- | -------- |
| interval | number | 表示传感器的上报频率,默认值为200000000ns。 |


## GeomagneticResponse

Z
zengyawen 已提交
1522
设置地磁响应对象,继承于[Response](#response)
Z
zengyawen 已提交
1523 1524 1525

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
1526 1527 1528 1529 1530 1531 1532
| x | number | 是 | 是 | 地磁场的北分量。 |
| y | number | 是 | 是 | 地磁场的东分量。 |
| z | number | 是 | 是 | 地磁场的垂直分量。 |
| geomagneticDip | number | 是 | 是 | 地磁倾角,即地球磁场线与水平面的夹角。 |
| deflectionAngle | number | 是 | 是 | 地磁偏角,即地磁北方向与正北方向在水平面上的角度。 |
| levelIntensity | number | 是 | 是 | 地磁场的水平强度。 |
| totalIntensity | number | 是 | 是 | 地磁场的总强度。 |
Z
zengyawen 已提交
1533 1534 1535 1536 1537 1538 1539 1540


## LocationOptions

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| latitude | number | 是 | 是 | 纬度。 |
| longitude | number | 是 | 是 | 经度。 |
Z
zengyawen 已提交
1541
| altitude | number | 是 | 是 | 海拔高度。 |