js-apis-sensor.md 111.4 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

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

Z
zengyawen 已提交
13

C
cff-gite 已提交
14
## sensor.on(SensorType.SENSOR_TYPE_ID_ACCELEROMETER)
Z
zengyawen 已提交
15

C
cff-gite 已提交
16
on(type:  SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<AccelerometerResponse>,options?: Options): void
Z
zengyawen 已提交
17 18 19

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

C
cff-gite 已提交
20 21 22 23
**需要权限**:ohos.permission.ACCELEROMETER ,该权限为系统权限

**系统能力**:SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
24

H
HelloCrease 已提交
25 26 27 28 29 30
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要订阅的加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。 |
| callback | Callback<[AccelerometerResponse](#accelerometerresponse)> | 是    | 注册加速度传感器的回调函数,上报的数据类型为AccelerometerResponse。 |
| options  | [Options](#options)                      | 否    | 可选参数列表,设置上报频率,默认值为200000000ns。           |
Z
zengyawen 已提交
31

H
HelloCrease 已提交
32
**示例:** 
Z
zengyawen 已提交
33
  ```
C
cff-gite 已提交
34
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER,function(data){
35
      console.info('X-coordinate component: ' + data.x);
Z
zengyawen 已提交
36 37
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
38 39
  },
      {interval: 10000000}
Z
zengyawen 已提交
40 41
  );
  ```
Z
zengyawen 已提交
42 43


C
cff-gite 已提交
44
## sensor.on(SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION)
Z
zengyawen 已提交
45

C
cff-gite 已提交
46
on(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<LinearAccelerometerResponse>, options?: Options): void
Z
zengyawen 已提交
47

Z
zengyawen 已提交
48 49
监听线性加速度传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。

C
cff-gite 已提交
50 51 52 53
**需要权限**:ohos.permission.ACCELEROMETER ,该权限为系统权限

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
54 55 56 57 58 59
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要订阅的线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。 |
| callback | Callback<[LinearAccelerometerResponse](#linearaccelerometerresponse)> | 是    | 注册线性加速度传感器的回调函数,上报的数据类型为LinearAccelerometerResponse。 |
| options  | [Options](#options)                      | 否    | 可选参数列表,设置上报频率,默认值为200000000ns。           |
Z
zengyawen 已提交
60

H
HelloCrease 已提交
61
**示例:** 
Z
zengyawen 已提交
62
  ```
C
cff-gite 已提交
63
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,function(data){
Z
zengyawen 已提交
64 65 66
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
67 68
  },
      {interval: 10000000}
Z
zengyawen 已提交
69 70
  );
  ```
Z
zengyawen 已提交
71 72


C
cff-gite 已提交
73
## sensor.on(SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED)
Z
zengyawen 已提交
74

C
cff-gite 已提交
75
on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback<AccelerometerUncalibratedResponse>, options?: Options): void
Z
zengyawen 已提交
76

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

C
cff-gite 已提交
79 80 81 82
**需要权限**:ohos.permission.ACCELEROMETER ,该权限为系统权限

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
83 84 85 86 87 88
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要订阅的未校准加速度计传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 |
| callback | Callback<[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)> | 是    | 注册未校准加速度计传感器的回调函数,上报的数据类型为AccelerometerUncalibratedResponse。 |
| options  | [Options](#options)                      | 否    | 可选参数列表,设置上报频率,默认值为200000000ns。           |
Z
zengyawen 已提交
89

H
HelloCrease 已提交
90
**示例:** 
Z
zengyawen 已提交
91
  ```
C
cff-gite 已提交
92
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,function(data){
Z
zengyawen 已提交
93 94 95 96 97 98
      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);
99 100
  },
      {interval: 10000000}
Z
zengyawen 已提交
101 102
  );
  ```
Z
zengyawen 已提交
103 104


C
cff-gite 已提交
105
## sensor.on(SensorType.SENSOR_TYPE_ID_GRAVITY)
Z
zengyawen 已提交
106

C
cff-gite 已提交
107
on(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback<GravityResponse>,options?: Options): void
Z
zengyawen 已提交
108

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

C
cff-gite 已提交
111 112
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
113 114 115 116 117 118
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                    |
| -------- | ---------------------------------------- | ---- | ------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要订阅的重力传感器类型为SENSOR_TYPE_ID_GRAVITY。   |
| callback | Callback<[GravityResponse](#gravityresponse)> | 是    | 注册重力传感器的回调函数,上报的数据类型为GravityResponse。 |
| options  | [Options](#options)                      | 否    | 可选参数列表,设置上报频率,默认值为200000000ns。        |
Z
zengyawen 已提交
119

H
HelloCrease 已提交
120
**示例:** 
Z
zengyawen 已提交
121
  ```
C
cff-gite 已提交
122
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY,function(data){
123
      console.info('X-coordinate component: ' + data.x);
Z
zengyawen 已提交
124 125
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
126 127
  },
      {interval: 10000000}
Z
zengyawen 已提交
128 129
  );
  ```
Z
zengyawen 已提交
130 131


C
cff-gite 已提交
132
## sensor.on(SensorType.SENSOR_TYPE_ID_GYROSCOPE)
Z
zengyawen 已提交
133

C
cff-gite 已提交
134
on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback<GyroscopeResponse>, options?: Options): void
Z
zengyawen 已提交
135

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

C
cff-gite 已提交
138
**需要权限**:ohos.permission.GYROSCOPE ,该权限为系统权限
C
cff-gite 已提交
139 140 141

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
142 143 144 145 146 147
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要订阅的陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。   |
| callback | Callback<[GyroscopeResponse](#gyroscoperesponse)> | 是    | 注册陀螺仪传感器的回调函数,上报的数据类型为GyroscopeResponse。 |
| options  | [Options](#options)                      | 否    | 可选参数列表,设置上报频率,默认值为200000000ns。           |
Z
zengyawen 已提交
148

H
HelloCrease 已提交
149
**示例:** 
Z
zengyawen 已提交
150
  ```
C
cff-gite 已提交
151
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE,function(data){
152
      console.info('X-coordinate component: ' + data.x);
Z
zengyawen 已提交
153 154
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
155 156
  },
      {interval: 10000000}
Z
zengyawen 已提交
157 158
  );
  ```
Z
zengyawen 已提交
159 160


C
cff-gite 已提交
161
## sensor.on(SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED)
Z
zengyawen 已提交
162

C
cff-gite 已提交
163
on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback:Callback<GyroscopeUncalibratedResponse>, options?: Options): void
Z
zengyawen 已提交
164

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

C
cff-gite 已提交
167
**需要权限**:ohos.permission.GYROSCOPE ,该权限为系统权限
C
cff-gite 已提交
168 169 170

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
171 172 173 174 175 176
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要订阅的未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 |
| callback | Callback<[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)> | 是    | 注册未校准陀螺仪传感器的回调函数,上报的数据类型为GyroscopeUncalibratedResponse。 |
| options  | [Options](#options)                      | 否    | 可选参数列表,设置上报频率。                           |
Z
zengyawen 已提交
177

H
HelloCrease 已提交
178
**示例:** 
Z
zengyawen 已提交
179
  ```
C
cff-gite 已提交
180
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,function(data){
181
      console.info('X-coordinate component: ' + data.x);
Z
zengyawen 已提交
182 183
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
184
      console.info('X-coordinate bias: ' + data.biasX);
Z
zengyawen 已提交
185 186
      console.info('Y-coordinate bias: ' + data.biasY);
      console.info('Z-coordinate bias: ' + data.biasZ);
187 188
  },
      {interval: 10000000}
Z
zengyawen 已提交
189 190
  );
  ```
Z
zengyawen 已提交
191 192


C
cff-gite 已提交
193
## sensor.on(SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION)
Z
zengyawen 已提交
194

C
cff-gite 已提交
195
on(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback: Callback<SignificantMotionResponse>, options?: Options): void
Z
zengyawen 已提交
196

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

C
cff-gite 已提交
199 200
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
201 202 203 204 205 206
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要订阅的大幅动作传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。 |
| callback | Callback<[SignificantMotionResponse](#significantmotionresponse)> | 是    | 注册有效运动传感器的回调函数,上报的数据类型为SignificantMotionResponse。 |
| options  | [Options](#options)                      | 否    | 可选参数列表,设置上报频率,默认值为200000000ns。           |
Z
zengyawen 已提交
207

H
HelloCrease 已提交
208
**示例:** 
Z
zengyawen 已提交
209
  ```
C
cff-gite 已提交
210
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,function(data){
Z
zengyawen 已提交
211
      console.info('Scalar data: ' + data.scalar);
212 213
  },
      {interval: 10000000}
Z
zengyawen 已提交
214 215
  );
  ```
Z
zengyawen 已提交
216 217


C
cff-gite 已提交
218
## sensor.on(SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION)
Z
zengyawen 已提交
219

C
cff-gite 已提交
220
on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback: Callback<PedometerDetectionResponse>, options?: Options): void
Z
zengyawen 已提交
221

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

C
cff-gite 已提交
224
**需要权限**:ohos.permission.ACTIVITY_MOTION
C
cff-gite 已提交
225 226 227

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
228 229 230 231 232 233
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要订阅的计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。 |
| callback | Callback<[PedometerDetectionResponse](#pedometerdetectionresponse)> | 是    | 注册计步检测传感器的回调函数,上报的数据类型为PedometerDetectionResponse。 |
| options  | [Options](#options)                      | 否    | 可选参数列表,设置上报频率,默认值为200000000ns。           |
Z
zengyawen 已提交
234

H
HelloCrease 已提交
235
**示例:** 
Z
zengyawen 已提交
236
  ```
C
cff-gite 已提交
237
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,function(data){
Z
zengyawen 已提交
238
      console.info('Scalar data: ' + data.scalar);
239 240
  },
      {interval: 10000000}
Z
zengyawen 已提交
241 242
  );
  ```
Z
zengyawen 已提交
243 244


C
cff-gite 已提交
245
## sensor.on(SensorType.SENSOR_TYPE_ID_PEDOMETER)
Z
zengyawen 已提交
246

C
cff-gite 已提交
247
on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback<PedometerResponse>, options?: Options): void
Z
zengyawen 已提交
248

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

C
cff-gite 已提交
251
**需要权限**:ohos.permission.ACTIVITY_MOTION 
C
cff-gite 已提交
252 253 254

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
255 256 257 258 259 260
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                      |
| -------- | ---------------------------------------- | ---- | --------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要订阅的计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。   |
| callback | Callback<[PedometerResponse](#pedometerresponse)> | 是    | 注册计步传感器的回调函数,上报的数据类型为PedometerResponse。 |
| options  | [Options](#options)                      | 否    | 可选参数列表,设置上报频率,默认值为200000000ns。          |
Z
zengyawen 已提交
261

H
HelloCrease 已提交
262
**示例:** 
Z
zengyawen 已提交
263
  ```
C
cff-gite 已提交
264
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER,function(data){
Z
zengyawen 已提交
265
      console.info('Steps: ' + data.steps);
266 267
  },
      {interval: 10000000}
Z
zengyawen 已提交
268 269
  );
  ```
Z
zengyawen 已提交
270 271


C
cff-gite 已提交
272
## sensor.on(SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE)
Z
zengyawen 已提交
273

C
cff-gite 已提交
274
on(type:SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback:Callback<AmbientTemperatureResponse>,  options?: Options): void
Z
zengyawen 已提交
275

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

C
cff-gite 已提交
278 279
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
280 281 282 283 284 285
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要订阅的环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 |
| callback | Callback<[AmbientTemperatureResponse](#ambienttemperatureresponse)> | 是    | 注册环境温度传感器的回调函数,上报的数据类型为AmbientTemperatureResponse。 |
| options  | [Options](#options)                      | 否    | 可选参数列表,设置上报频率,默认值为200000000ns。           |
Z
zengyawen 已提交
286

H
HelloCrease 已提交
287
**示例:** 
Z
zengyawen 已提交
288
  ```
C
cff-gite 已提交
289
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,function(data){
Z
zengyawen 已提交
290
      console.info('Temperature: ' + data.temperature);
291 292
  },
      {interval: 10000000}
Z
zengyawen 已提交
293 294
  );
  ```
Z
zengyawen 已提交
295 296


C
cff-gite 已提交
297
## sensor.on(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD)
Z
zengyawen 已提交
298

C
cff-gite 已提交
299
on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback<MagneticFieldResponse>,options?: Options): void
Z
zengyawen 已提交
300

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

C
cff-gite 已提交
303 304
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
305 306 307 308 309 310
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要订阅的磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。 |
| callback | Callback<[MagneticFieldResponse](#magneticfieldresponse)> | 是    | 注册磁场传感器的回调函数,上报的数据类型为MagneticFieldResponse。 |
| options  | [Options](#options)                      | 否    | 可选参数列表,设置上报频率,默认值为200000000ns。           |
Z
zengyawen 已提交
311

H
HelloCrease 已提交
312
**示例:** 
Z
zengyawen 已提交
313
  ```
C
cff-gite 已提交
314
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD,function(data){
Z
zengyawen 已提交
315 316 317
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
318 319
  },
      {interval: 10000000}
Z
zengyawen 已提交
320 321
  );
  ```
Z
zengyawen 已提交
322 323


C
cff-gite 已提交
324
## sensor.on(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED)
Z
zengyawen 已提交
325

H
HelloCrease 已提交
326
on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callback<MagneticFieldUncalibratedResponse>, options?: Options): void
Z
zengyawen 已提交
327

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

C
cff-gite 已提交
330 331
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
332 333 334 335 336 337
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要订阅的未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 |
| callback | Callback<[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)> | 是    | 注册未校准磁场传感器的回调函数,上报的数据类型为MagneticFieldUncalibratedResponse。 |
| options  | [Options](#options)                      | 否    | 可选参数列表,设置上报频率,默认值为200000000ns。           |
Z
zengyawen 已提交
338

H
HelloCrease 已提交
339
**示例:** 
Z
zengyawen 已提交
340
  ```
C
cff-gite 已提交
341
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,function(data){
342 343 344 345
      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 已提交
346 347
      console.info('Y-coordinate bias: ' + data.biasY);
      console.info('Z-coordinate bias: ' + data.biasZ);
348 349
  },
      {interval: 10000000}
Z
zengyawen 已提交
350 351
  );
  ```
Z
zengyawen 已提交
352 353


C
cff-gite 已提交
354
## sensor.on(SensorType.SENSOR_TYPE_ID_PROXIMITY)
Z
zengyawen 已提交
355

C
cff-gite 已提交
356
on(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback<ProximityResponse>,options?: Options): void
Z
zengyawen 已提交
357

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

C
cff-gite 已提交
360 361
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
362 363 364 365 366 367
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要订阅的接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。   |
| callback | Callback<[ProximityResponse](#proximityresponse)> | 是    | 注册接近光传感器的回调函数,上报的数据类型为ProximityResponse。 |
| options  | [Options](#options)                      | 否    | 可选参数列表,设置上报频率,默认值为200000000ns。           |
Z
zengyawen 已提交
368

H
HelloCrease 已提交
369
**示例:** 
Z
zengyawen 已提交
370
  ```
C
cff-gite 已提交
371
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY,function(data){
Z
zengyawen 已提交
372
      console.info('Distance: ' + data.distance);
373 374
  },
      {interval: 10000000}
Z
zengyawen 已提交
375 376
  );
  ```
Z
zengyawen 已提交
377 378


C
cff-gite 已提交
379
## sensor.on(SensorType.SENSOR_TYPE_ID_HUMIDITY)
Z
zengyawen 已提交
380

C
cff-gite 已提交
381
on(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback<HumidityResponse>,options?: Options): void
Z
zengyawen 已提交
382

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

C
cff-gite 已提交
385 386
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
387 388 389 390 391 392
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                     |
| -------- | ---------------------------------------- | ---- | -------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要订阅的湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。   |
| callback | Callback<[HumidityResponse](#humidityresponse)> | 是    | 注册湿度传感器的回调函数,上报的数据类型为HumidityResponse。 |
| options  | [Options](#options)                      | 否    | 可选参数列表,设置上报频率,默认值为200000000ns。         |
Z
zengyawen 已提交
393

H
HelloCrease 已提交
394
**示例:** 
Z
zengyawen 已提交
395
  ```
C
cff-gite 已提交
396
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY,function(data){
Z
zengyawen 已提交
397
      console.info('Humidity: ' + data.humidity);
398 399
  },
      {interval: 10000000}
Z
zengyawen 已提交
400 401
  );
  ```
Z
zengyawen 已提交
402 403


C
cff-gite 已提交
404
## sensor.on(SensorType.SENSOR_TYPE_ID_BAROMETER)
Z
zengyawen 已提交
405

C
cff-gite 已提交
406
on(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback<BarometerResponse>,options?: Options): void
Z
zengyawen 已提交
407

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

C
cff-gite 已提交
410 411
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
412 413 414 415 416 417
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要订阅的气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。   |
| callback | Callback<[BarometerResponse](#barometerresponse)> | 是    | 注册气压计传感器的回调函数,上报的数据类型为BarometerResponse。 |
| options  | [Options](#options)                      | 否    | 可选参数列表,设置上报频率,默认值为200000000ns。           |
Z
zengyawen 已提交
418

H
HelloCrease 已提交
419
**示例:** 
Z
zengyawen 已提交
420
  ```
C
cff-gite 已提交
421
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER,function(data){
Z
zengyawen 已提交
422
      console.info('Atmospheric pressure: ' + data.pressure);
423 424
  },
      {interval: 10000000}
Z
zengyawen 已提交
425 426
  );
  ```
Z
zengyawen 已提交
427 428


C
cff-gite 已提交
429
## sensor.on(SensorType.SENSOR_TYPE_ID_HALL)
Z
zengyawen 已提交
430

C
cff-gite 已提交
431
on(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback<HallResponse>, options?: Options): void
Z
zengyawen 已提交
432

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

C
cff-gite 已提交
435 436
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
437 438 439 440 441 442
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要订阅的霍尔传感器类型为SENSOR_TYPE_ID_HALL。         |
| callback | Callback<[HallResponse](#hallresponse)> | 是    | 注册霍尔传感器的回调函数,上报的数据类型为 HallResponse。 |
| options  | [Options](#options)                      | 否    | 可选参数列表,设置上报频率,默认值为200000000ns。           |
Z
zengyawen 已提交
443

H
HelloCrease 已提交
444
**示例:** 
Z
zengyawen 已提交
445
  ```
C
cff-gite 已提交
446
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HALL,function(data){
Z
zengyawen 已提交
447
      console.info('Status: ' + data.status);
448 449
  },
      {interval: 10000000}
Z
zengyawen 已提交
450 451
  );
  ```
Z
zengyawen 已提交
452 453


C
cff-gite 已提交
454
## sensor.on(SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT)
Z
zengyawen 已提交
455

C
cff-gite 已提交
456
on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback<LightResponse>, options?: Options): void
Z
zengyawen 已提交
457

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

C
cff-gite 已提交
460 461
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
462 463 464 465 466 467
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要订阅的环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。 |
| callback | Callback<[LightResponse](#lightresponse)> | 是    | 注册环境光传感器的回调函数,上报的数据类型为LightResponse。     |
| options  | [Options](#options)                      | 否    | 可选参数列表,设置上报频率,默认值为200000000ns。           |
Z
zengyawen 已提交
468

H
HelloCrease 已提交
469
**示例:** 
Z
zengyawen 已提交
470
  ```
C
cff-gite 已提交
471
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT,function(data){
472 473 474
      console.info(' Illumination: ' + data.intensity);
  },
      {interval: 10000000}
Z
zengyawen 已提交
475 476
  );
  ```
Z
zengyawen 已提交
477 478


C
cff-gite 已提交
479
## sensor.on(SensorType.SENSOR_TYPE_ID_ORIENTATION)
Z
zengyawen 已提交
480

C
cff-gite 已提交
481
on(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<OrientationResponse>, options?: Options): void
Z
zengyawen 已提交
482

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

C
cff-gite 已提交
485 486
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
487 488 489 490 491 492
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要订阅的方向传感器类型为SENSOR_TYPE_ID_ORIENTATION   |
| callback | Callback<[OrientationResponse](#orientationresponse)> | 是    | 注册方向传感器的回调函数,上报的数据类型为OrientationResponse。 |
| options  | [Options](#options)                      | 否    | 可选参数列表,设置上报频率,默认值为200000000ns。           |
Z
zengyawen 已提交
493

H
HelloCrease 已提交
494
**示例:** 
Z
zengyawen 已提交
495
  ```
C
cff-gite 已提交
496
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION,function(data){
C
cff-gite 已提交
497 498 499
      console.info('The device rotates at an angle around the X axis: ' + data.beta);
      console.info('The device rotates at an angle around the Y axis: ' + data.gamma);
      console.info('The device rotates at an angle around the Z axis: ' + data.alpha);
500 501
  },
      {interval: 10000000}
Z
zengyawen 已提交
502 503
  );
  ```
Z
zengyawen 已提交
504

C
cff-gite 已提交
505
## sensor.on(SensorType.SENSOR_TYPE_ID_HEART_RATE)
C
cff-gite 已提交
506

C
cff-gite 已提交
507
on(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback<HeartRateResponse>, options?: Options): void
C
cff-gite 已提交
508 509 510 511 512 513 514

监听心率传感器数据变化一次。

**需要权限**:ohos.permission.READ_HEALTH_DATA 

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
515
**参数:** 
C
cff-gite 已提交
516

H
HelloCrease 已提交
517 518 519 520
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要订阅的心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。   |
| callback | Callback<[HeartRateResponse](#heartrateresponse)> | 是    | 注册一次心率传感器的回调函数,上报的数据类型为HeartRateResponse。 |
C
cff-gite 已提交
521

H
HelloCrease 已提交
522
**示例:** 
C
cff-gite 已提交
523 524 525 526 527 528 529 530

```
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE,function(data){
    console.info("Heart rate: " + data.heartRate);
},
    {interval: 10000000}
);
```
Z
zengyawen 已提交
531

C
cff-gite 已提交
532
## sensor.on(SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR)
Z
zengyawen 已提交
533

C
cff-gite 已提交
534
on(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,callback: Callback<RotationVectorResponse>,options?: Options): void
Z
zengyawen 已提交
535

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

C
cff-gite 已提交
538 539
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
540 541 542 543 544 545
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要订阅的旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。 |
| callback | Callback<[RotationVectorResponse](#rotationvectorresponse)> | 是    | 注册旋转矢量传感器的回调函数,上报的数据类型为RotationVectorResponse。 |
| options  | [Options](#options)                      | 否    | 可选参数列表,设置上报频率,默认值为200000000ns。           |
Z
zengyawen 已提交
546

H
HelloCrease 已提交
547
**示例:** 
Z
zengyawen 已提交
548
  ```
C
cff-gite 已提交
549
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,function(data){
Z
zengyawen 已提交
550 551 552
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
C
cff-gite 已提交
553
      console.info('Scalar quantity: ' + data.w);
554 555
  },
      {interval: 10000000}
Z
zengyawen 已提交
556 557
  );
  ```
Z
zengyawen 已提交
558 559


C
cff-gite 已提交
560
## sensor.on(SensorType.SENSOR_TYPE_ID_WEAR_DETECTION)
Z
zengyawen 已提交
561

C
cff-gite 已提交
562
on(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback<WearDetectionResponse>,options?: Options): void
Z
zengyawen 已提交
563

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

C
cff-gite 已提交
566 567
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
568 569 570 571 572 573
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要订阅的佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。 |
| callback | Callback<[WearDetectionResponse](#weardetectionresponse)> | 是    | 注册佩戴检测传感器的回调函数,上报的数据类型为WearDetectionResponse。 |
| options  | [Options](#options)                      | 否    | 可选参数列表,设置上报频率,默认值为200000000ns。           |
Z
zengyawen 已提交
574

H
HelloCrease 已提交
575
**示例:** 
Z
zengyawen 已提交
576
  ```
C
cff-gite 已提交
577
  sensor.on(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION,function(data){
Z
zengyawen 已提交
578
      console.info('Wear status: ' + data.value);
579 580
  },
      {interval: 10000000}
Z
zengyawen 已提交
581 582
  );
  ```
Z
zengyawen 已提交
583 584


C
cff-gite 已提交
585
## sensor.once(SensorType.SENSOR_TYPE_ID_ACCELEROMETER)
Z
zengyawen 已提交
586

C
cff-gite 已提交
587
once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<AccelerometerResponse>): void
Z
zengyawen 已提交
588

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

C
cff-gite 已提交
591 592 593 594
**需要权限**:ohos.permission.ACCELEROMETER ,该权限为系统权限

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
595 596 597 598 599
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。   |
| callback | Callback<[AccelerometerResponse](#accelerometerresponse)> | 是    | 注册一次加速度传感器的回调函数,上报的数据类型为AccelerometerResponse。 |
Z
zengyawen 已提交
600

H
HelloCrease 已提交
601
**示例:** 
Z
zengyawen 已提交
602
  ```
C
cff-gite 已提交
603
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER,function(data){
Z
zengyawen 已提交
604 605 606
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
Z
zengyawen 已提交
607
    }
Z
zengyawen 已提交
608 609
  );
  ```
Z
zengyawen 已提交
610 611


C
cff-gite 已提交
612
## sensor.once(SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION)
Z
zengyawen 已提交
613

C
cff-gite 已提交
614
once(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<LinearAccelerometerResponse>): void
Z
zengyawen 已提交
615

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

C
cff-gite 已提交
618 619 620 621
**需要权限**:ohos.permission.ACCELEROMETER ,该权限为系统权限

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
622 623 624 625 626
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。 |
| callback | Callback<[LinearAccelerometerResponse](#linearaccelerometerresponse)> | 是    | 注册一次线性加速度传感器的回调函数,上报的数据类型为LinearAccelerometerResponse。 |
Z
zengyawen 已提交
627

H
HelloCrease 已提交
628
**示例:** 
Z
zengyawen 已提交
629
  ```
C
cff-gite 已提交
630
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, function(data) {
Z
zengyawen 已提交
631 632 633
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
Z
zengyawen 已提交
634
    }
Z
zengyawen 已提交
635 636
  );
  ```
Z
zengyawen 已提交
637 638


C
cff-gite 已提交
639
## sensor.once(SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED)
Z
zengyawen 已提交
640

C
cff-gite 已提交
641
once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback<AccelerometerUncalibratedResponse>): void
Z
zengyawen 已提交
642

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

C
cff-gite 已提交
645 646 647 648
**需要权限**:ohos.permission.ACCELEROMETER ,该权限为系统权限

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
649 650 651 652 653
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 未校准加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 |
| callback | Callback<[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)> | 是    | 注册一次未校准加速度传感器的回调函数,上报的数据类型为AccelerometerUncalibratedResponse。 |
Z
zengyawen 已提交
654

H
HelloCrease 已提交
655
**示例:** 
Z
zengyawen 已提交
656
  ```
C
cff-gite 已提交
657
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, function(data) {
Z
zengyawen 已提交
658 659 660 661 662 663
      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 已提交
664
    }
Z
zengyawen 已提交
665 666
  );
  ```
Z
zengyawen 已提交
667 668


C
cff-gite 已提交
669
## sensor.once(SensorType.SENSOR_TYPE_ID_GRAVITY)
Z
zengyawen 已提交
670

C
cff-gite 已提交
671
once(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback<GravityResponse>): void
Z
zengyawen 已提交
672

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

C
cff-gite 已提交
675 676
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
677 678 679 680 681
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                      |
| -------- | ---------------------------------------- | ---- | --------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 重力传感器类型为SENSOR_TYPE_ID_GRAVITY。         |
| callback | Callback<[GravityResponse](#gravityresponse)> | 是    | 注册一次重力传感器的回调函数,上报的数据类型为GravityResponse。 |
Z
zengyawen 已提交
682

H
HelloCrease 已提交
683
**示例:** 
Z
zengyawen 已提交
684
  ```
C
cff-gite 已提交
685
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, function(data) {
Z
zengyawen 已提交
686 687 688
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
Z
zengyawen 已提交
689
    }
Z
zengyawen 已提交
690 691
  );
  ```
Z
zengyawen 已提交
692 693


C
cff-gite 已提交
694
## sensor.once(SensorType.SENSOR_TYPE_ID_GYROSCOPE)
Z
zengyawen 已提交
695

C
cff-gite 已提交
696
once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback<GyroscopeResponse>): void
Z
zengyawen 已提交
697

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

C
cff-gite 已提交
700 701 702 703
**需要权限**:ohos.permission.GYROSCOPE ,该权限为系统权限

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
704 705 706 707 708
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。       |
| callback | Callback<[GyroscopeResponse](#gyroscoperesponse)> | 是    | 注册一次陀螺仪传感器的回调函数,上报的数据类型为GyroscopeResponse。 |
Z
zengyawen 已提交
709

H
HelloCrease 已提交
710
**示例:** 
Z
zengyawen 已提交
711
  ```
C
cff-gite 已提交
712
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, function(data) {
Z
zengyawen 已提交
713 714 715
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
Z
zengyawen 已提交
716
    }
Z
zengyawen 已提交
717 718
  );
  ```
Z
zengyawen 已提交
719 720


C
cff-gite 已提交
721
## sensor.once(SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED)
Z
zengyawen 已提交
722

C
cff-gite 已提交
723
once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback: Callback<GyroscopeUncalibratedResponse>): void
Z
zengyawen 已提交
724

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

C
cff-gite 已提交
727 728 729 730
**需要权限**:ohos.permission.GYROSCOPE ,该权限为系统权限

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
731 732 733 734 735
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 |
| callback | Callback<[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)> | 是    | 注册一次未校准陀螺仪传感器的回调函数,上报的数据类型为GyroscopeUncalibratedResponse。 |
Z
zengyawen 已提交
736

H
HelloCrease 已提交
737
**示例:** 
Z
zengyawen 已提交
738
  ```
C
cff-gite 已提交
739
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, function(data) {
Z
zengyawen 已提交
740 741 742 743 744 745
      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 已提交
746
    }
Z
zengyawen 已提交
747 748
  );
  ```
Z
zengyawen 已提交
749 750


C
cff-gite 已提交
751
## sensor.once(SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION)
Z
zengyawen 已提交
752

C
cff-gite 已提交
753
once(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,callback: Callback<SignificantMotionResponse>): void
Z
zengyawen 已提交
754

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

C
cff-gite 已提交
757 758
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
759 760 761 762 763
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 有效运动传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。 |
| callback | Callback<[SignificantMotionResponse](#significantmotionresponse)> | 是    | 注册一次有效运动传感器的回调函数,上报的数据类型为SignificantMotionResponse。 |
Z
zengyawen 已提交
764

H
HelloCrease 已提交
765
**示例:** 
Z
zengyawen 已提交
766
  ```
C
cff-gite 已提交
767
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, function(data) {
Z
zengyawen 已提交
768
      console.info('Scalar data: ' + data.scalar);
Z
zengyawen 已提交
769
    }
Z
zengyawen 已提交
770 771
  );
  ```
Z
zengyawen 已提交
772 773


C
cff-gite 已提交
774
## sensor.once(SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION)
Z
zengyawen 已提交
775

C
cff-gite 已提交
776
once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,callback: Callback<PedometerDetectionResponse>): void
Z
zengyawen 已提交
777

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

C
cff-gite 已提交
780
**需要权限**:ohos.permission.ACTIVITY_MOTION
C
cff-gite 已提交
781 782 783

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
784 785 786 787 788
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。 |
| callback | Callback<[PedometerDetectionResponse](#pedometerdetectionresponse)> | 是    | 注册一次计步检测传感器的回调函数,上报的数据类型为PedometerDetectionResponse。 |
Z
zengyawen 已提交
789

H
HelloCrease 已提交
790
**示例:** 
Z
zengyawen 已提交
791
  ```
C
cff-gite 已提交
792
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, function(data) {
Z
zengyawen 已提交
793
      console.info('Scalar data: ' + data.scalar);
Z
zengyawen 已提交
794
    }
Z
zengyawen 已提交
795 796
  );
  ```
Z
zengyawen 已提交
797 798


C
cff-gite 已提交
799
## sensor.once(SensorType.SENSOR_TYPE_ID_PEDOMETER)
Z
zengyawen 已提交
800

C
cff-gite 已提交
801
once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback<PedometerResponse>): void
Z
zengyawen 已提交
802

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

C
cff-gite 已提交
805
**需要权限**:ohos.permission.ACTIVITY_MOTION
C
cff-gite 已提交
806 807 808

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
809 810 811 812 813
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。        |
| callback | Callback<[PedometerResponse](#pedometerresponse)> | 是    | 注册一次计步传感器的回调函数,上报的数据类型为PedometerResponse。 |
Z
zengyawen 已提交
814

H
HelloCrease 已提交
815
**示例:** 
Z
zengyawen 已提交
816
  ```
C
cff-gite 已提交
817
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, function(data) {
Z
zengyawen 已提交
818
      console.info('Steps: ' + data.steps);
Z
zengyawen 已提交
819
    }
Z
zengyawen 已提交
820 821
  );
  ```
Z
zengyawen 已提交
822 823


C
cff-gite 已提交
824
## sensor.once(SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE)
Z
zengyawen 已提交
825

C
cff-gite 已提交
826
once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback: Callback<AmbientTemperatureResponse>): void
Z
zengyawen 已提交
827

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

C
cff-gite 已提交
830 831
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
832 833 834 835 836
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 |
| callback | Callback<[AmbientTemperatureResponse](#ambienttemperatureresponse)> | 是    | 注册一次环境温度传感器的回调函数,上报的数据类型为AmbientTemperatureResponse。 |
Z
zengyawen 已提交
837

H
HelloCrease 已提交
838
**示例:** 
Z
zengyawen 已提交
839
  ```
C
cff-gite 已提交
840
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, function(data) {
Z
zengyawen 已提交
841
      console.info('Temperature: ' + data.temperature);
Z
zengyawen 已提交
842
    }
Z
zengyawen 已提交
843 844
  );
  ```
Z
zengyawen 已提交
845 846


C
cff-gite 已提交
847
## sensor.once(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD)
Z
zengyawen 已提交
848

C
cff-gite 已提交
849
once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback<MagneticFieldResponse>): void
Z
zengyawen 已提交
850

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

C
cff-gite 已提交
853 854
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
855 856 857 858 859
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。   |
| callback | Callback<[MagneticFieldResponse](#magneticfieldresponse)> | 是    | 注册一次磁场传感器的回调函数,上报的数据类型为MagneticFieldResponse。 |
Z
zengyawen 已提交
860

H
HelloCrease 已提交
861
**示例:** 
Z
zengyawen 已提交
862
  ```
C
cff-gite 已提交
863
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, function(data) {
Z
zengyawen 已提交
864 865 866
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
Z
zengyawen 已提交
867
    }
Z
zengyawen 已提交
868 869
  );
  ```
Z
zengyawen 已提交
870 871


C
cff-gite 已提交
872
## sensor.once(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED)
Z
zengyawen 已提交
873

C
cff-gite 已提交
874
once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callback<MagneticFieldUncalibratedResponse>): void
Z
zengyawen 已提交
875

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

C
cff-gite 已提交
878 879
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
880 881 882 883 884
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 |
| callback | Callback<[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)> | 是    | 注册一次未校准磁场传感器的回调函数,上报的数据类型为MagneticFieldUncalibratedResponse。 |
Z
zengyawen 已提交
885

H
HelloCrease 已提交
886
**示例:** 
Z
zengyawen 已提交
887
  ```
C
cff-gite 已提交
888
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, function(data) {
Z
zengyawen 已提交
889 890 891 892 893 894
      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 已提交
895
    }
Z
zengyawen 已提交
896 897
  );
  ```
Z
zengyawen 已提交
898 899


C
cff-gite 已提交
900
## sensor.once(SensorType.SENSOR_TYPE_ID_PROXIMITY)
Z
zengyawen 已提交
901

C
cff-gite 已提交
902
once(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback<ProximityResponse>): void
Z
zengyawen 已提交
903

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

C
cff-gite 已提交
906 907
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
908 909 910 911 912
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。       |
| callback | Callback<[ProximityResponse](#proximityresponse)> | 是    | 注册一次接近光传感器的回调函数,上报的数据类型为ProximityResponse。 |
Z
zengyawen 已提交
913

H
HelloCrease 已提交
914
**示例:** 
Z
zengyawen 已提交
915
  ```
916
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, function(error, data) {
Z
zengyawen 已提交
917 918 919 920 921
      if (error) {
          console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
          return;
      }
      console.info('Distance: ' + data.distance);
Z
zengyawen 已提交
922
    }
Z
zengyawen 已提交
923 924
  );
  ```
Z
zengyawen 已提交
925 926


C
cff-gite 已提交
927
## sensor.once(SensorType.SENSOR_TYPE_ID_HUMIDITY)
Z
zengyawen 已提交
928

C
cff-gite 已提交
929
once(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback<HumidityResponse>): void
Z
zengyawen 已提交
930

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

C
cff-gite 已提交
933 934
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
935 936 937 938 939
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。         |
| callback | Callback<[HumidityResponse](#humidityresponse)> | 是    | 注册一次湿度传感器的回调函数,上报的数据类型为HumidityResponse。 |
Z
zengyawen 已提交
940

H
HelloCrease 已提交
941
**示例:** 
Z
zengyawen 已提交
942
  ```
C
cff-gite 已提交
943
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, function(data) {
Z
zengyawen 已提交
944
      console.info('Humidity: ' + data.humidity);
Z
zengyawen 已提交
945
    }
Z
zengyawen 已提交
946 947
  );
  ```
Z
zengyawen 已提交
948 949


C
cff-gite 已提交
950
## sensor.once(SensorType.SENSOR_TYPE_ID_BAROMETER)
Z
zengyawen 已提交
951

C
cff-gite 已提交
952
once(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback<BarometerResponse>): void
Z
zengyawen 已提交
953

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

C
cff-gite 已提交
956 957
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
958 959 960 961 962
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。       |
| callback | Callback<[BarometerResponse](#barometerresponse)> | 是    | 注册一次气压计传感器的回调函数,上报的数据类型为BarometerResponse。 |
Z
zengyawen 已提交
963

H
HelloCrease 已提交
964
**示例:** 
Z
zengyawen 已提交
965
  ```
C
cff-gite 已提交
966
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, function(data) {
Z
zengyawen 已提交
967
      console.info('Atmospheric pressure: ' + data.pressure);
Z
zengyawen 已提交
968
    }
Z
zengyawen 已提交
969 970
  );
  ```
Z
zengyawen 已提交
971 972


C
cff-gite 已提交
973
## sensor.once(SensorType.SENSOR_TYPE_ID_HALL)
Z
zengyawen 已提交
974

C
cff-gite 已提交
975
once(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback<HallResponse>): void
Z
zengyawen 已提交
976

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

C
cff-gite 已提交
979 980
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
981 982 983 984 985
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                   |
| -------- | ---------------------------------------- | ---- | ------------------------------------ |
| type     | [SensorType](#sensortype)                | 是    | 霍尔传感器类型为SENSOR_TYPE_ID_HALL。         |
| callback | Callback<[HallResponse](#hallresponse)> | 是    | 注册一次霍尔传感器的回调函数,上报的数据类型为HallResponse。 |
Z
zengyawen 已提交
986

H
HelloCrease 已提交
987
**示例:** 
Z
zengyawen 已提交
988
  ```
C
cff-gite 已提交
989
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HALL, function(data) {
Z
zengyawen 已提交
990
      console.info('Status: ' + data.status);
Z
zengyawen 已提交
991
    }
Z
zengyawen 已提交
992 993
  );
  ```
Z
zengyawen 已提交
994 995


C
cff-gite 已提交
996
## sensor.once(SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT)
Z
zengyawen 已提交
997

C
cff-gite 已提交
998
once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback<LightResponse>): void
Z
zengyawen 已提交
999

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

C
cff-gite 已提交
1002 1003
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1004 1005 1006 1007 1008
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                     |
| -------- | ---------------------------------------- | ---- | -------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。 |
| callback | Callback<[LightResponse](#lightresponse)> | 是    | 注册一次环境光传感器的回调函数,上报的数据类型为LightResponse。 |
Z
zengyawen 已提交
1009

H
HelloCrease 已提交
1010
**示例:** 
Z
zengyawen 已提交
1011
  ```
C
cff-gite 已提交
1012
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, function(data) {
1013
      console.info(' Illumination: ' + data.intensity);
Z
zengyawen 已提交
1014
    }
Z
zengyawen 已提交
1015 1016
  );
  ```
Z
zengyawen 已提交
1017 1018


C
cff-gite 已提交
1019
## sensor.once(SensorType.SENSOR_TYPE_ID_ORIENTATION)
Z
zengyawen 已提交
1020

C
cff-gite 已提交
1021
once(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<OrientationResponse>): void
Z
zengyawen 已提交
1022

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

C
cff-gite 已提交
1025 1026
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1027 1028 1029 1030 1031
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 方向传感器类型为SENSOR_TYPE_ID_ORIENTATION。      |
| callback | Callback<[OrientationResponse](#orientationresponse)> | 是    | 注册一次方向传感器的回调函数,上报的数据类型为OrientationResponse。 |
Z
zengyawen 已提交
1032

H
HelloCrease 已提交
1033
**示例:** 
Z
zengyawen 已提交
1034
  ```
C
cff-gite 已提交
1035
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, function(data) {
C
cff-gite 已提交
1036 1037 1038
      console.info('The device rotates at an angle around the X axis: ' + data.beta);
      console.info('The device rotates at an angle around the Y axis: ' + data.gamma);
      console.info('The device rotates at an angle around the Z axis: ' + data.alpha);
Z
zengyawen 已提交
1039
    }
Z
zengyawen 已提交
1040 1041
  );
  ```
Z
zengyawen 已提交
1042 1043


C
cff-gite 已提交
1044
## sensor.once(SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR)
Z
zengyawen 已提交
1045

C
cff-gite 已提交
1046
once(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback: Callback<RotationVectorResponse>): void
Z
zengyawen 已提交
1047

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

C
cff-gite 已提交
1050 1051
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1052 1053 1054 1055 1056
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。 |
| callback | Callback<[RotationVectorResponse](#rotationvectorresponse)> | 是    | 注册一次旋转矢量传感器的回调函数,上报的数据类型为RotationVectorResponse。 |
Z
zengyawen 已提交
1057

H
HelloCrease 已提交
1058
**示例:** 
Z
zengyawen 已提交
1059
  ```
C
cff-gite 已提交
1060
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, function(data) {
Z
zengyawen 已提交
1061 1062 1063
      console.info('X-coordinate component: ' + data.x);
      console.info('Y-coordinate component: ' + data.y);
      console.info('Z-coordinate component: ' + data.z);
C
cff-gite 已提交
1064
      console.info('Scalar quantity: ' + data.w);
Z
zengyawen 已提交
1065
    }
Z
zengyawen 已提交
1066 1067
  );
  ```
Z
zengyawen 已提交
1068 1069


C
cff-gite 已提交
1070
## sensor.once(SensorType.SENSOR_TYPE_ID_HEART_RATE)
Z
zengyawen 已提交
1071

C
cff-gite 已提交
1072
once(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback<HeartRateResponse>): void
Z
zengyawen 已提交
1073

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

C
cff-gite 已提交
1076
**需要权限**:ohos.permission.READ_HEALTH_DATA 
C
cff-gite 已提交
1077 1078 1079

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1080 1081 1082 1083 1084
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。       |
| callback | Callback<[HeartRateResponse](#heartrateresponse)> | 是    | 注册一次心率传感器的回调函数,上报的数据类型为HeartRateResponse。 |
Z
zengyawen 已提交
1085

H
HelloCrease 已提交
1086
**示例:** 
Z
zengyawen 已提交
1087
  ```
C
cff-gite 已提交
1088
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE, function(data) {
Z
zengyawen 已提交
1089
      console.info("Heart rate: " + data.heartRate);
Z
zengyawen 已提交
1090
    }
Z
zengyawen 已提交
1091 1092
  );
  ```
Z
zengyawen 已提交
1093 1094


C
cff-gite 已提交
1095
## sensor.once(SensorType.SENSOR_TYPE_ID_WEAR_DETECTION)
Z
zengyawen 已提交
1096

C
cff-gite 已提交
1097
once(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback<WearDetectionResponse>): void
Z
zengyawen 已提交
1098

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

C
cff-gite 已提交
1101 1102
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1103 1104 1105 1106 1107
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。 |
| callback | Callback<[WearDetectionResponse](#weardetectionresponse)> | 是    | 注册一次穿戴检测传感器的回调函数,上报的数据类型为WearDetectionResponse。 |
Z
zengyawen 已提交
1108

H
HelloCrease 已提交
1109
**示例:** 
Z
zengyawen 已提交
1110
  ```
C
cff-gite 已提交
1111
  sensor.once(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, function(data) {
Z
zengyawen 已提交
1112
      console.info("Wear status: "+ data.value);
Z
zengyawen 已提交
1113
    }
Z
zengyawen 已提交
1114 1115
  );
  ```
Z
zengyawen 已提交
1116

C
cff-gite 已提交
1117
## sensor.off(SensorType.SENSOR_TYPE_ID_ACCELEROMETER)
Z
zengyawen 已提交
1118

C
cff-gite 已提交
1119
off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback?: Callback<AccelerometerResponse>): void
C
cff-gite 已提交
1120 1121

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

C
cff-gite 已提交
1123 1124 1125 1126
**需要权限**:ohos.permission.ACCELEROMETER, 该权限为系统权限

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1127
**参数:** 
C
cff-gite 已提交
1128

H
HelloCrease 已提交
1129 1130 1131 1132
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要取消订阅的加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。 |
| callback | Callback<[AccelerometerResponse](#accelerometerresponse)> | 是    | 取消注册加速度传感器的回调函数,上报的数据类型为AccelerometerResponse。 |
C
cff-gite 已提交
1133

H
HelloCrease 已提交
1134
**示例:** 
C
cff-gite 已提交
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144

```
function callback(data) {
    console.info('x-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback);
```

C
cff-gite 已提交
1145
## sensor.off(SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED)
C
cff-gite 已提交
1146

C
cff-gite 已提交
1147
off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, callback?: Callback<AccelerometerUncalibratedResponse>): void
Z
zengyawen 已提交
1148

Z
zengyawen 已提交
1149
取消订阅传感器数据。
Z
zengyawen 已提交
1150

C
cff-gite 已提交
1151 1152
**需要权限**:ohos.permission.ACCELEROMETER, 该权限为系统权限

C
cff-gite 已提交
1153 1154
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1155
**参数:** 
C
cff-gite 已提交
1156

H
HelloCrease 已提交
1157 1158 1159 1160
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要取消订阅的未校准加速度计传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 |
| callback | Callback<[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)> | 是    | 取消注册未校准加速度计传感器的回调函数,上报的数据类型为AccelerometerUncalibratedResponse。 |
Z
zengyawen 已提交
1161

H
HelloCrease 已提交
1162
**示例:** 
C
cff-gite 已提交
1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175

```
function callback(data) {
    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);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, callback);
```

C
cff-gite 已提交
1176
## sensor.off(SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT)
C
cff-gite 已提交
1177

C
cff-gite 已提交
1178
off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback?: Callback<LightResponse>): void
C
cff-gite 已提交
1179 1180 1181 1182 1183

取消订阅传感器数据。

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1184
**参数:** 
C
cff-gite 已提交
1185

H
HelloCrease 已提交
1186 1187 1188 1189
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要取消订阅的环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。 |
| callback | Callback<[LightResponse](#lightresponse)> | 是    | 取消注册环境光传感器的回调函数,上报的数据类型为LightResponse。   |
C
cff-gite 已提交
1190

H
HelloCrease 已提交
1191
**示例:** 
C
cff-gite 已提交
1192 1193 1194 1195 1196 1197 1198 1199

```
function callback(data) {
    console.info(' Illumination: ' + data.intensity);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback);
```

C
cff-gite 已提交
1200
## sensor.off(SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE)
C
cff-gite 已提交
1201

C
cff-gite 已提交
1202
off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback?: Callback<AmbientTemperatureResponse>): void
C
cff-gite 已提交
1203 1204 1205 1206 1207

取消订阅传感器数据。

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1208
**参数:** 
C
cff-gite 已提交
1209

H
HelloCrease 已提交
1210 1211 1212 1213
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要取消订阅的环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 |
| callback | Callback<[AmbientTemperatureResponse](#ambienttemperatureresponse)> | 是    | 取消注册环境温度传感器的回调函数,上报的数据类型为AmbientTemperatureResponse。 |
C
cff-gite 已提交
1214

H
HelloCrease 已提交
1215
**示例:** 
C
cff-gite 已提交
1216 1217 1218 1219 1220 1221 1222 1223

```
function callback(data) {
     console.info('Temperature: ' + data.temperature);
}
sensor.off( sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback);
```

C
cff-gite 已提交
1224
## sensor.off(SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE)
C
cff-gite 已提交
1225

C
cff-gite 已提交
1226
off(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback?: Callback<BarometerResponse>): void
C
cff-gite 已提交
1227 1228 1229 1230 1231

取消订阅传感器数据。

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1232
**参数:** 
C
cff-gite 已提交
1233

H
HelloCrease 已提交
1234 1235 1236 1237
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要取消订阅的气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。 |
| callback | Callback<[BarometerResponse](#barometerresponse)> | 是    | 取消注册气压计传感器的回调函数,上报的数据类型为BarometerResponse。 |
C
cff-gite 已提交
1238

H
HelloCrease 已提交
1239
**示例:** 
C
cff-gite 已提交
1240 1241 1242 1243 1244 1245 1246 1247

```
function callback(data) {
     console.info('Atmospheric pressure: ' + data.pressure);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, callback);
```

C
cff-gite 已提交
1248
## sensor.off(SensorType.SENSOR_TYPE_ID_GRAVITY)
C
cff-gite 已提交
1249

C
cff-gite 已提交
1250
off(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback?: Callback<GravityResponse>): void
C
cff-gite 已提交
1251 1252 1253 1254 1255

取消订阅传感器数据。

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1256
**参数:** 
C
cff-gite 已提交
1257

H
HelloCrease 已提交
1258 1259 1260 1261
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要取消订阅的重力传感器类型为SENSOR_TYPE_ID_GRAVITY。    |
| callback | Callback<[GravityResponse](#gravityresponse)> | 是    | 取消注册注册重力传感器的回调函数,上报的数据类型为GravityResponse。 |
C
cff-gite 已提交
1262

H
HelloCrease 已提交
1263
**示例:** 
C
cff-gite 已提交
1264 1265 1266 1267 1268 1269 1270 1271 1272 1273

```
function callback(data) {
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
}
sensor.off( sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, callback);
```

C
cff-gite 已提交
1274
## sensor.off(SensorType.SENSOR_TYPE_ID_GYROSCOPE)
C
cff-gite 已提交
1275

C
cff-gite 已提交
1276
off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback?: Callback<GyroscopeResponse>): void
C
cff-gite 已提交
1277 1278 1279 1280 1281 1282 1283

取消订阅传感器数据。

**需要权限**:ohos.permission.GYROSCOPE, 该权限为系统权限

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1284
**参数:** 
C
cff-gite 已提交
1285

H
HelloCrease 已提交
1286 1287 1288 1289
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要取消订阅的陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。 |
| callback | Callback<[GyroscopeResponse](#gyroscoperesponse)> | 是    | 取消注册陀螺仪传感器的回调函数,上报的数据类型为GyroscopeResponse。 |
C
cff-gite 已提交
1290

H
HelloCrease 已提交
1291
**示例:** 
C
cff-gite 已提交
1292 1293 1294 1295 1296 1297 1298 1299 1300 1301

```
function callback(data) {
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback);
```

C
cff-gite 已提交
1302
## sensor.off(SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED)
C
cff-gite 已提交
1303

H
HelloCrease 已提交
1304
off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback?: Callback<GyroscopeUncalibratedResponse>): void
C
cff-gite 已提交
1305 1306 1307 1308 1309 1310 1311

取消订阅传感器数据。

**需要权限**:ohos.permission.GYROSCOPE, 该权限为系统权限

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1312
**参数:** 
C
cff-gite 已提交
1313

H
HelloCrease 已提交
1314 1315 1316 1317
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要取消订阅的未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 |
| callback | Callback<[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)> | 是    | 取消注册未校准陀螺仪传感器的回调函数,上报的数据类型为GyroscopeUncalibratedResponse。 |
C
cff-gite 已提交
1318

H
HelloCrease 已提交
1319
**示例:** 
C
cff-gite 已提交
1320 1321 1322 1323 1324 1325 1326 1327 1328 1329

```
function callback(data) {
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback);
```

C
cff-gite 已提交
1330
## sensor.off(SensorType.SENSOR_TYPE_ID_HALL)
C
cff-gite 已提交
1331

C
cff-gite 已提交
1332
off(type: SensorType.SENSOR_TYPE_ID_HALL, callback?: Callback<HallResponse>): void
C
cff-gite 已提交
1333 1334 1335 1336 1337

取消订阅传感器数据。

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1338
**参数:** 
C
cff-gite 已提交
1339

H
HelloCrease 已提交
1340 1341 1342 1343
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要取消订阅的霍尔传感器类型为SENSOR_TYPE_ID_HALL。       |
| callback | Callback<[HallResponse](#hallresponse)> | 是    | 取消注册霍尔传感器的回调函数,上报的数据类型为 HallResponse。 |
C
cff-gite 已提交
1344

H
HelloCrease 已提交
1345
**示例:** 
C
cff-gite 已提交
1346 1347 1348 1349 1350 1351 1352 1353

```
function callback(data) {
    console.info('Status: ' + data.status);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_HALL, callback);
```

C
cff-gite 已提交
1354
## sensor.off(SensorType.SENSOR_TYPE_ID_HEART_RATE)
C
cff-gite 已提交
1355

C
cff-gite 已提交
1356
off(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback?: Callback<HeartRateResponse>): void
C
cff-gite 已提交
1357 1358 1359 1360 1361 1362 1363

取消订阅传感器数据。

**需要权限**:ohos.permission.READ_HEALTH_DATA

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1364
**参数:** 
C
cff-gite 已提交
1365

H
HelloCrease 已提交
1366 1367 1368 1369
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)[SensorType](#sensortype) | 是    | 要取消订阅的心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。 |
| callback | Callback<[HeartRateResponse](#heartrateresponse)> | 是    | 取消注册一次心率传感器的回调函数,上报的数据类型为HeartRateResponse。 |
C
cff-gite 已提交
1370

H
HelloCrease 已提交
1371
**示例:** 
C
cff-gite 已提交
1372 1373 1374 1375 1376 1377 1378 1379

```
function callback(data) {
    console.info("Heart rate: " + data.heartRate);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE, callback);
```

C
cff-gite 已提交
1380
## sensor.off(SensorType.SENSOR_TYPE_ID_HUMIDITY)
C
cff-gite 已提交
1381

C
cff-gite 已提交
1382
off(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback?: Callback<HumidityResponse>): void
C
cff-gite 已提交
1383 1384 1385 1386 1387 1388 1389

取消订阅传感器数据。

**需要权限**:ohos.permission.READ_HEALTH_DATA,该权限为系统权限

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1390
**参数:** 
C
cff-gite 已提交
1391

H
HelloCrease 已提交
1392 1393 1394 1395
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要取消订阅的湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。   |
| callback | Callback<[HumidityResponse](#humidityresponse)> | 是    | 取消注册湿度传感器的回调函数,上报的数据类型为HumidityResponse。 |
C
cff-gite 已提交
1396

H
HelloCrease 已提交
1397
**示例:** 
C
cff-gite 已提交
1398 1399 1400 1401 1402 1403 1404 1405

```
function callback(data) {
    console.info('Humidity: ' + data.humidity);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, callback);
```

C
cff-gite 已提交
1406
## sensor.off(SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION)
C
cff-gite 已提交
1407

C
cff-gite 已提交
1408
off(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback?: Callback<LinearAccelerometerResponse>): void
C
cff-gite 已提交
1409 1410 1411 1412 1413 1414 1415

取消订阅传感器数据。

**需要权限**:ohos.permission.ACCELEROMETER,该权限为系统权限

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1416
**参数:** 
C
cff-gite 已提交
1417

H
HelloCrease 已提交
1418 1419 1420 1421
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要取消订阅的线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。 |
| callback | Callback<[LinearAccelerometerResponse](#linearaccelerometerresponse)> | 是    | 取消注册性加速度传感器的回调函数,上报的数据类型为LinearAccelerometerResponse。 |
C
cff-gite 已提交
1422

H
HelloCrease 已提交
1423
**示例:** 
C
cff-gite 已提交
1424 1425 1426 1427 1428 1429 1430 1431 1432 1433

```
function callback(data) {
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback);
```

C
cff-gite 已提交
1434
## sensor.off(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD)
C
cff-gite 已提交
1435

C
cff-gite 已提交
1436
 off(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback?: Callback<MagneticFieldResponse>): void
C
cff-gite 已提交
1437 1438 1439 1440 1441 1442 1443

取消订阅传感器数据。

**需要权限**:ohos.permission.ACCELEROMETER,该权限为系统权限

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1444
**参数:** 
C
cff-gite 已提交
1445

H
HelloCrease 已提交
1446 1447 1448 1449
| 参数名              | 类型                                       | 必填   | 说明                                       |
| ---------------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type             | [SensorType](#sensortype)                | 是    | 要取消订阅的磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。 |
| callbackcallback | Callback<[MagneticFieldResponse](#magneticfieldresponse)> | 是    | 取消注册磁场传感器的回调函数,上报的数据类型为MagneticFieldResponse。 |
C
cff-gite 已提交
1450

H
HelloCrease 已提交
1451
**示例:** 
C
cff-gite 已提交
1452 1453 1454 1455 1456 1457 1458 1459 1460 1461

```
function callback(data) {
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback);
```

C
cff-gite 已提交
1462
## sensor.off(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED)
C
cff-gite 已提交
1463

C
cff-gite 已提交
1464
 off(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, callback?: Callback<MagneticFieldUncalibratedResponse>): void
C
cff-gite 已提交
1465 1466 1467 1468 1469

取消订阅传感器数据。

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1470
**参数:** 
C
cff-gite 已提交
1471

H
HelloCrease 已提交
1472 1473 1474 1475
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要取消订阅的未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 |
| callback | Callback<[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)> | 是    | 取消注册未校准磁场传感器的回调函数,上报的数据类型为MagneticFieldUncalibratedResponse。 |
C
cff-gite 已提交
1476

H
HelloCrease 已提交
1477
**示例:** 
C
cff-gite 已提交
1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490

```
function callback(data) {
    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);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, callback);
```

C
cff-gite 已提交
1491
## sensor.off(SensorType.SENSOR_TYPE_ID_ORIENTATION)
C
cff-gite 已提交
1492

C
cff-gite 已提交
1493
 off(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback?: Callback<OrientationResponse>): void
C
cff-gite 已提交
1494 1495 1496 1497 1498

取消订阅传感器数据。

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1499
**参数:** 
C
cff-gite 已提交
1500

H
HelloCrease 已提交
1501 1502 1503 1504
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要取消订阅的方向传感器类型为SENSOR_TYPE_ID_ORIENTATION |
| callback | Callback<[OrientationResponse](#orientationresponse)> | 是    | 取消注册方向传感器的回调函数,上报的数据类型为OrientationResponse。 |
C
cff-gite 已提交
1505

H
HelloCrease 已提交
1506
**示例:** 
C
cff-gite 已提交
1507 1508 1509

```
function callback(data) {
C
cff-gite 已提交
1510 1511 1512
    console.info('The device rotates at an angle around the X axis: ' + data.beta);
    console.info('The device rotates at an angle around the Y axis: ' + data.gamma);
    console.info('The device rotates at an angle around the Z axis: ' + data.alpha);
C
cff-gite 已提交
1513 1514 1515 1516
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, callback);
```

C
cff-gite 已提交
1517
## sensor.off(SensorType.SENSOR_TYPE_ID_PEDOMETER)
C
cff-gite 已提交
1518

C
cff-gite 已提交
1519
off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback?: Callback<PedometerResponse>): void
C
cff-gite 已提交
1520 1521 1522 1523 1524

取消订阅传感器数据。

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1525
**参数:** 
C
cff-gite 已提交
1526

H
HelloCrease 已提交
1527 1528 1529 1530
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要取消订阅的计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。  |
| callback | Callback<[PedometerResponse](#pedometerresponse)> | 是    | 取消注册计步传感器的回调函数,上报的数据类型为PedometerResponse。 |
C
cff-gite 已提交
1531

H
HelloCrease 已提交
1532
**返回值:** ;
C
cff-gite 已提交
1533 1534 1535 1536 1537 1538 1539 1540

```
function callback(data) {
    console.info('Steps: ' + data.steps);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, callback);
```

C
cff-gite 已提交
1541
## sensor.off(SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION)
C
cff-gite 已提交
1542

C
cff-gite 已提交
1543
off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback?: Callback<PedometerDetectionResponse>): void
C
cff-gite 已提交
1544 1545 1546 1547 1548 1549 1550

取消订阅传感器数据。

**需要权限**:ohos.permission.ACTIVITY_MOTION

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1551
**参数:** 
C
cff-gite 已提交
1552

H
HelloCrease 已提交
1553 1554 1555 1556
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要取消订阅的计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。 |
| callback | Callback<[PedometerDetectionResponse](#pedometerdetectionresponse)> | 是    | 取消注册计步检测传感器的回调函数,上报的数据类型为PedometerDetectionResponse。 |
C
cff-gite 已提交
1557

H
HelloCrease 已提交
1558
**示例:** 
C
cff-gite 已提交
1559 1560 1561 1562 1563 1564 1565 1566

```
function callback(data) {
    console.info('Scalar data: ' + data.scalar);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback);
```

C
cff-gite 已提交
1567
## sensor.off(SensorType.SENSOR_TYPE_ID_PROXIMITY)
C
cff-gite 已提交
1568

C
cff-gite 已提交
1569
off(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback?: Callback<ProximityResponse>): void
C
cff-gite 已提交
1570 1571 1572 1573 1574

取消订阅传感器数据。

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1575
**参数:** 
C
cff-gite 已提交
1576

H
HelloCrease 已提交
1577 1578 1579 1580
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要取消订阅的接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。 |
| callback | Callback<[ProximityResponse](#proximityresponse)> | 是    | 取消注册接近光传感器的回调函数,上报的数据类型为ProximityResponse。 |
C
cff-gite 已提交
1581

H
HelloCrease 已提交
1582
**示例:** 
C
cff-gite 已提交
1583 1584 1585 1586 1587 1588 1589 1590

```
function callback(data) {
    console.info('Distance: ' + data.distance);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, callback);
```

C
cff-gite 已提交
1591
## sensor.off(SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR)
C
cff-gite 已提交
1592

C
cff-gite 已提交
1593
off(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback?: Callback<RotationVectorResponse>): void
C
cff-gite 已提交
1594 1595 1596 1597 1598

取消订阅传感器数据。

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1599
**参数:** 
C
cff-gite 已提交
1600

H
HelloCrease 已提交
1601 1602 1603 1604
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要取消订阅的旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。 |
| callback | Callback<[RotationVectorResponse](#rotationvectorresponse)> | 是    | 取消注册旋转矢量传感器的回调函数,上报的数据类型为RotationVectorResponse。 |
C
cff-gite 已提交
1605

H
HelloCrease 已提交
1606
**示例:** 
C
cff-gite 已提交
1607 1608 1609 1610 1611 1612

```
function callback(data) {
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
C
cff-gite 已提交
1613
    console.info('Scalar quantity: ' + data.w);
C
cff-gite 已提交
1614 1615 1616 1617
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback);
```

C
cff-gite 已提交
1618
## sensor.off(SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION)
C
cff-gite 已提交
1619

C
cff-gite 已提交
1620
off(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback?: Callback<SignificantMotionResponse>): void
C
cff-gite 已提交
1621 1622 1623 1624 1625

取消订阅传感器数据。

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1626
**参数:** 
C
cff-gite 已提交
1627

H
HelloCrease 已提交
1628 1629 1630 1631
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要取消订阅的大幅动作传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。 |
| callback | Callback<[SignificantMotionResponse](#significantmotionresponse)> | 是    | 取消注册有效运动传感器的回调函数,上报的数据类型为SignificantMotionResponse。 |
C
cff-gite 已提交
1632

H
HelloCrease 已提交
1633
**示例:** 
C
cff-gite 已提交
1634 1635 1636 1637 1638 1639 1640 1641

```
function callback(data) {
    console.info('Scalar data: ' + data.scalar);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback);
```

C
cff-gite 已提交
1642
## sensor.off(SensorType.SENSOR_TYPE_ID_WEAR_DETECTION)
C
cff-gite 已提交
1643

C
cff-gite 已提交
1644
off(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback?: Callback<WearDetectionResponse>): void
C
cff-gite 已提交
1645 1646 1647 1648 1649

取消订阅传感器数据。

**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1650
**参数:** 
C
cff-gite 已提交
1651

H
HelloCrease 已提交
1652 1653 1654 1655
| 参数名      | 类型                                       | 必填   | 说明                                       |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type     | [SensorType](#sensortype)                | 是    | 要取消订阅的佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。 |
| callback | Callback<[WearDetectionResponse](#weardetectionresponse)> | 是    | 取消注册佩戴检测传感器的回调函数,上报的数据类型为WearDetectionResponse。 |
C
cff-gite 已提交
1656

H
HelloCrease 已提交
1657
**示例:** 
C
cff-gite 已提交
1658 1659 1660 1661 1662 1663 1664

```
function accCallback(data) {
    console.info('Wear status: ' + data.value);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, accCallback);
```
Z
zengyawen 已提交
1665

Z
zengyawen 已提交
1666 1667 1668 1669 1670 1671
## sensor.transformCoordinateSystem

transformCoordinateSystem(inRotationVector: Array<number>, coordinates: CoordinatesOptions, callback: AsyncCallback<Array<number>>): void

旋转提供的旋转矩阵,使其可以以不同的方式表示坐标系。

C
cff-gite 已提交
1672 1673
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1674
**参数:** 
Z
zengyawen 已提交
1675

H
HelloCrease 已提交
1676 1677 1678 1679 1680
| 参数名              | 类型                                       | 必填   | 说明          |
| ---------------- | ---------------------------------------- | ---- | ----------- |
| inRotationVector | Array<number>                      | 是    | 表示旋转矩阵。     |
| coordinates      | [CoordinatesOptions](#coordinatesoptions) | 是    | 表示坐标系方向。    |
| callback         | AsyncCallback<Array<number>> | 是    | 返回转换后的旋转矩阵。 |
Z
zengyawen 已提交
1681

H
HelloCrease 已提交
1682
**示例:** 
Z
zengyawen 已提交
1683

H
HelloCrease 已提交
1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695
```
sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], {'axisX':2, 'axisY':3}, function(err, data) {
    if (err) {
        console.error("Operation failed. Error code: " + err.code + ", message: " + err.message);
        return;
    }
    console.info("Operation successed. Data obtained: " + data.x);
    for (var i=0; i < data.length; i++) {
        console.info("transformCoordinateSystem data[ " + i + "] = " + data[i]);
    }
 })
```
Z
zengyawen 已提交
1696 1697 1698 1699 1700 1701
## sensor.transformCoordinateSystem

transformCoordinateSystem(inRotationVector: Array&lt;number&gt;, coordinates: CoordinatesOptions): Promise&lt;Array&lt;number&gt;&gt;

旋转提供的旋转矩阵,使其可以以不同的方式表示坐标系。

C
cff-gite 已提交
1702 1703
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1704
**参数:** 
Z
zengyawen 已提交
1705

H
HelloCrease 已提交
1706 1707 1708 1709
| 参数名              | 类型                                       | 必填   | 说明       |
| ---------------- | ---------------------------------------- | ---- | -------- |
| inRotationVector | Array&lt;number&gt;                      | 是    | 表示旋转矩阵。  |
| coordinates      | [CoordinatesOptions](#coordinatesoptions) | 是    | 表示坐标系方向。 |
Z
zengyawen 已提交
1710

H
HelloCrease 已提交
1711
**返回值:** 
Z
zengyawen 已提交
1712

H
HelloCrease 已提交
1713 1714 1715
| 类型                                 | 说明          |
| ---------------------------------- | ----------- |
| Promise&lt;Array&lt;number&gt;&gt; | 返回转换后的旋转矩阵。 |
Z
zengyawen 已提交
1716

H
HelloCrease 已提交
1717
**示例:** 
Z
zengyawen 已提交
1718

H
HelloCrease 已提交
1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729
```
const promise = sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], {'axisX':2, 'axisY':3});
    promise.then((data) => {
        console.info("Operation successed.");
        for (var i=0; i < data.length; i++) {
            console.info("transformCoordinateSystem data[ " + i + "] = " + data[i]);
        }
    }).catch((err) => {
           console.info("Operation failed");
})
```
Z
zengyawen 已提交
1730

Z
zengyawen 已提交
1731
## sensor.getGeomagneticField
Z
zengyawen 已提交
1732

Z
zengyawen 已提交
1733
getGeomagneticField(locationOptions: LocationOptions, timeMillis: number, callback: AsyncCallback&lt;GeomagneticResponse&gt;): void
Z
zengyawen 已提交
1734

Z
zengyawen 已提交
1735
获取地球上特定位置的地磁场。
Z
zengyawen 已提交
1736

C
cff-gite 已提交
1737 1738
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1739 1740 1741 1742 1743 1744
**参数:** 
| 参数名             | 类型                                       | 必填   | 说明                |
| --------------- | ---------------------------------------- | ---- | ----------------- |
| locationOptions | [LocationOptions](#locationoptions)      | 是    | 地理位置。             |
| timeMillis      | number                                   | 是    | 表示获取磁偏角的时间,单位为毫秒。 |
| callback        | AsyncCallback&lt;[GeomagneticResponse](#geomagneticresponse)&gt; | 是    | 返回磁场信息。           |
Z
zengyawen 已提交
1745

H
HelloCrease 已提交
1746 1747
**示例:** 
```
C
cff-gite 已提交
1748
sensor.getGeomagneticField([80, 0, 0], 1580486400000, function(err, data)  {
H
HelloCrease 已提交
1749 1750 1751 1752 1753 1754 1755 1756 1757
    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);
});
```
Z
zengyawen 已提交
1758 1759 1760 1761 1762 1763
## sensor.getGeomagneticField

getGeomagneticField(locationOptions: LocationOptions, timeMillis: number): Promise&lt;GeomagneticResponse&gt;

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

C
cff-gite 已提交
1764 1765
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1766 1767 1768 1769 1770
**参数:** 
| 参数名             | 类型                                  | 必填   | 说明                |
| --------------- | ----------------------------------- | ---- | ----------------- |
| locationOptions | [LocationOptions](#locationoptions) | 是    | 地理位置。             |
| timeMillis      | number                              | 是    | 表示获取磁偏角的时间,单位为毫秒。 |
Z
zengyawen 已提交
1771

H
HelloCrease 已提交
1772 1773 1774 1775
**返回值:** 
| 类型                                       | 说明      |
| ---------------------------------------- | ------- |
| Promise&lt;[GeomagneticResponse](#geomagneticresponse)&gt; | 返回磁场信息。 |
Z
zengyawen 已提交
1776

H
HelloCrease 已提交
1777
**返回值:** 
Z
zengyawen 已提交
1778
  ```
C
cff-gite 已提交
1779
  const promise = sensor.getGeomagneticField([80, 0, 0], 1580486400000);
Z
zengyawen 已提交
1780
      promise.then((data) => {
Z
zengyawen 已提交
1781 1782 1783
          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 已提交
1784
      }).catch((reason) => {
Z
zengyawen 已提交
1785 1786
          console.info('Operation failed.');
  })
Z
zengyawen 已提交
1787 1788
  ```

Z
zengyawen 已提交
1789 1790 1791 1792 1793 1794
## sensor.getAltitude

getAltitude(seaPressure: number, currentPressure: number, callback: AsyncCallback&lt;number&gt;): void

根据气压值获取设备所在的海拔高度。

C
cff-gite 已提交
1795 1796
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1797
**参数:** 
Z
zengyawen 已提交
1798

H
HelloCrease 已提交
1799 1800 1801 1802 1803
| 参数名             | 类型                          | 必填   | 说明                   |
| --------------- | --------------------------- | ---- | -------------------- |
| seaPressure     | number                      | 是    | 表示海平面气压值,单位为hPa。     |
| currentPressure | number                      | 是    | 表示设备所在高度的气压值,单位为hPa。 |
| callback        | AsyncCallback&lt;number&gt; | 是    | 返回设备所在的海拔高度,单位为米。    |
Z
zengyawen 已提交
1804

H
HelloCrease 已提交
1805
**返回值:** 
Z
zengyawen 已提交
1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823

  ```
  sensor.getAltitude(0, 200, function(err, data)  {
      if (err) {
          console.error(
  "Operation failed. Error code: " + err.code + ", message: " + err.message);
          return;
      }
          console.info("Successed to get getAltitude interface get data: " + data);
  });
  ```

## sensor.getAltitude

getAltitude(seaPressure: number, currentPressure: number): Promise&lt;number&gt;

根据气压值获取设备所在的海拔高度。

C
cff-gite 已提交
1824 1825
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1826
**参数:** 
Z
zengyawen 已提交
1827

H
HelloCrease 已提交
1828 1829 1830 1831
| 参数名             | 类型     | 必填   | 说明                   |
| --------------- | ------ | ---- | -------------------- |
| seaPressure     | number | 是    | 表示海平面气压值,单位为hPa。     |
| currentPressure | number | 是    | 表示设备所在高度的气压值,单位为hPa。 |
Z
zengyawen 已提交
1832

H
HelloCrease 已提交
1833
**返回值:** 
Z
zengyawen 已提交
1834

H
HelloCrease 已提交
1835 1836 1837
| 类型                    | 说明                 |
| --------------------- | ------------------ |
| Promise&lt;number&gt; | 返回设备所在的海拔高度(单位:米)。 |
Z
zengyawen 已提交
1838

H
HelloCrease 已提交
1839
**返回值:** 
Z
zengyawen 已提交
1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856

  ```
  const promise = sensor.getAltitude(0, 200);
      promise.then((data) => {
          console.info(' sensor_getAltitude_Promise success', data);
      }).catch((err) => {
          console.error("Operation failed");
  })
  ```


## sensor.getGeomagneticDip

getGeomagneticDip(inclinationMatrix: Array&lt;number&gt;, callback: AsyncCallback&lt;number&gt;): void

根据倾斜矩阵计算地磁倾斜角。

C
cff-gite 已提交
1857 1858
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1859
**参数:** 
Z
zengyawen 已提交
1860

H
HelloCrease 已提交
1861 1862 1863 1864
| 参数名               | 类型                          | 必填   | 说明             |
| ----------------- | --------------------------- | ---- | -------------- |
| inclinationMatrix | Array&lt;number&gt;         | 是    | 表示倾斜矩阵。        |
| callback          | AsyncCallback&lt;number&gt; | 是    | 返回地磁倾斜角,单位为弧度。 |
Z
zengyawen 已提交
1865

H
HelloCrease 已提交
1866
**返回值:** 
Z
zengyawen 已提交
1867 1868 1869 1870 1871 1872 1873 1874

  ```
  sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1], function(err, data)  {
      if (err) {
          console.error(LABEL + 'SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' + 
                        err.message);
          return;
      }
H
HelloCrease 已提交
1875
          console.info("Successed to get getGeomagneticDip interface get data: " + data);
Z
zengyawen 已提交
1876 1877 1878 1879 1880 1881 1882 1883 1884
  })
  ```

## sensor.getGeomagneticDip

getGeomagneticDip(inclinationMatrix: Array&lt;number&gt;): Promise&lt;number&gt;

根据倾斜矩阵计算地磁倾斜角。

C
cff-gite 已提交
1885 1886
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1887
**参数:** 
Z
zengyawen 已提交
1888

H
HelloCrease 已提交
1889 1890 1891
| 参数名               | 类型                  | 必填   | 说明      |
| ----------------- | ------------------- | ---- | ------- |
| inclinationMatrix | Array&lt;number&gt; | 是    | 表示倾斜矩阵。 |
Z
zengyawen 已提交
1892

H
HelloCrease 已提交
1893
**返回值:** 
Z
zengyawen 已提交
1894

H
HelloCrease 已提交
1895 1896 1897
| 类型                    | 说明             |
| --------------------- | -------------- |
| Promise&lt;number&gt; | 返回地磁倾斜角,单位为弧度。 |
Z
zengyawen 已提交
1898

H
HelloCrease 已提交
1899
**返回值:** 
Z
zengyawen 已提交
1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911

  ```
  const promise = sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1]);
      promise.then((data) => {
          console.info(' getGeomagneticDip_promise successed', data);
      }).catch((err) => {
           console.error("Operation failed");
  })
  ```

## sensor. getAngleModify

H
HelloCrease 已提交
1912
getAngleModify(currentRotationMatrix: Array&lt;number&gt;, preRotationMatrix: Array&lt;number&gt;, callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void
Z
zengyawen 已提交
1913 1914 1915

获取两个旋转矩阵之间的角度变化。

C
cff-gite 已提交
1916 1917
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1918
**参数:** 
Z
zengyawen 已提交
1919

H
HelloCrease 已提交
1920 1921 1922 1923 1924
| 参数名                   | 类型                                       | 必填   | 说明                 |
| --------------------- | ---------------------------------------- | ---- | ------------------ |
| currentRotationMatrix | Array&lt;number&gt;                      | 是    | 表示当前旋转矩阵。          |
| preRotationMatrix     | Array&lt;number&gt;                      | 是    | 表示旋转矩阵。            |
| callback              | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是    | 返回z、x、y轴方向的旋转角度变化。 |
Z
zengyawen 已提交
1925

H
HelloCrease 已提交
1926
**返回值:** 
Z
zengyawen 已提交
1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948

  ```
  sensor. getAngleModify([1,0,0,0,1,0,0,0,1], [1, 0, 0, 0, 0.87, -0.50, 0, 0.50, 0.87], function(err, data)  {
      if (err) {
          console.error(LABEL + 'Failed to register data, error code is: ' + err.code + ', message: ' + 
                        err.message);
          return;
      }
      console.info("SensorJsAPI--->Successed to get  getAngleModifiy interface get data: " + data.x);
      for (var i=0; i < data.length; i++) {
          console.info(LABEL + "data[" + i + "]: " + data[i]);
      }
  })
  ```


## sensor. getAngleModify

getAngleModify(currentRotationMatrix: Array&lt;number&gt;, preRotationMatrix: Array&lt;number&gt;): Promise&lt;Array&lt;number&gt;&gt;

获取两个旋转矩阵之间的角度变化。

C
cff-gite 已提交
1949 1950
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1951
**参数:** 
Z
zengyawen 已提交
1952

H
HelloCrease 已提交
1953 1954 1955 1956
| 参数名                   | 类型                  | 必填   | 说明        |
| --------------------- | ------------------- | ---- | --------- |
| currentRotationMatrix | Array&lt;number&gt; | 是    | 表示当前旋转矩阵。 |
| preRotationMatrix     | Array&lt;number&gt; | 是    | 表示旋转矩阵。   |
Z
zengyawen 已提交
1957

H
HelloCrease 已提交
1958
**返回值:** 
Z
zengyawen 已提交
1959

H
HelloCrease 已提交
1960 1961 1962
| 类型                                 | 说明                 |
| ---------------------------------- | ------------------ |
| Promise&lt;Array&lt;number&gt;&gt; | 返回z、x、y轴方向的旋转角度变化。 |
Z
zengyawen 已提交
1963

H
HelloCrease 已提交
1964
**返回值:** 
Z
zengyawen 已提交
1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984

  ```
  const promise = sensor.getAngleModify([1,0,0,0,1,0,0,0,1], [1,0,0,0,0.87,-0.50,0,0.50,0.87]);
      promise.then((data) => {
          console.info(LABEL + 'getAngleModifiy_promise success');
          for (var i=0; i < data.length; i++) {
              console.info(LABEL + "data[" + i + "]: " + data[i]);
          }
      }).catch((reason) => {
          console.info(LABEL + "promise::catch", reason);
  })
  ```


## sensor.createRotationMatrix

createRotationMatrix(rotationVector: Array&lt;number&gt;, callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void

将旋转矢量转换为旋转矩阵。

C
cff-gite 已提交
1985 1986
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
1987
**参数:** 
Z
zengyawen 已提交
1988

H
HelloCrease 已提交
1989 1990 1991 1992
| 参数名            | 类型                                       | 必填   | 说明      |
| -------------- | ---------------------------------------- | ---- | ------- |
| rotationVector | Array&lt;number&gt;                      | 是    | 表示旋转矢量。 |
| callback       | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是    | 返回旋转矩阵。 |
Z
zengyawen 已提交
1993

H
HelloCrease 已提交
1994
**返回值:** 
Z
zengyawen 已提交
1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016

  ```
  sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877], function(err, data) {
      if (err) {
          console.error(LABEL + 'SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' + 
                        err.message);
          return;
      }
      console.info("SensorJsAPI--->Successed to get createRotationMatrix interface get data: " + data.x);
      for (var i=0; i < data.length; i++) {
          console.info(LABEL + "data[" + i + "]: " + data[i]);
      }
  })
  ```


## sensor.createRotationMatrix

createRotationMatrix(rotationVector: Array&lt;number&gt;): Promise&lt;Array&lt;number&gt;&gt;

将旋转矢量转换为旋转矩阵。

C
cff-gite 已提交
2017 2018
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
2019
**参数:** 
Z
zengyawen 已提交
2020

H
HelloCrease 已提交
2021 2022 2023
| 参数名            | 类型                  | 必填   | 说明      |
| -------------- | ------------------- | ---- | ------- |
| rotationVector | Array&lt;number&gt; | 是    | 表示旋转矢量。 |
Z
zengyawen 已提交
2024

H
HelloCrease 已提交
2025
**返回值:** 
Z
zengyawen 已提交
2026

H
HelloCrease 已提交
2027 2028 2029
| 类型                                 | 说明      |
| ---------------------------------- | ------- |
| Promise&lt;Array&lt;number&gt;&gt; | 返回旋转矩阵。 |
Z
zengyawen 已提交
2030

H
HelloCrease 已提交
2031
**返回值:** 
Z
zengyawen 已提交
2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051

  ```
  const promise = sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877]);
      promise.then((data) => {
          console.info(LABEL + 'createRotationMatrix_promise success');
          for (var i=0; i < data.length; i++) {
              console.info(LABEL + "data[" + i + "]: " + data[i]);
          }
      }).catch((reason) => {
          console.info(LABEL + "promise::catch", reason);
  })	
  ```


## sensor.createQuaternion

createQuaternion(rotationVector: Array&lt;number&gt;, callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void

将旋转矢量转换为四元数。

C
cff-gite 已提交
2052 2053
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
2054
**参数:** 
Z
zengyawen 已提交
2055

H
HelloCrease 已提交
2056 2057 2058 2059
| 参数名            | 类型                                       | 必填   | 说明      |
| -------------- | ---------------------------------------- | ---- | ------- |
| rotationVector | Array&lt;number&gt;                      | 是    | 表示旋转矢量。 |
| callback       | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是    | 返回四元数。  |
Z
zengyawen 已提交
2060

H
HelloCrease 已提交
2061
**返回值:** 
Z
zengyawen 已提交
2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083

  ```
  sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877], function(err, data)  {
      if (err) {
          console.error(LABEL + 'SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' + 
                        err.message);
          return;
      }
      console.info("SensorJsAPI--->Successed to get  createQuaternion interface get data: " + data.x);
      for (var i=0; i < data.length; i++) {
          console.info(LABEL + "data[" + i + "]: " + data[i]);
      }
  })
  ```


## sensor.createQuaternion

createQuaternion(rotationVector: Array&lt;number&gt;): Promise&lt;Array&lt;number&gt;&gt;

将旋转矢量转换为四元数。

C
cff-gite 已提交
2084 2085
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
2086
**参数:** 
Z
zengyawen 已提交
2087

H
HelloCrease 已提交
2088 2089 2090
| 参数名            | 类型                  | 必填   | 说明      |
| -------------- | ------------------- | ---- | ------- |
| rotationVector | Array&lt;number&gt; | 是    | 表示旋转矢量。 |
Z
zengyawen 已提交
2091

H
HelloCrease 已提交
2092
**返回值:** 
Z
zengyawen 已提交
2093

H
HelloCrease 已提交
2094 2095 2096
| 类型                                 | 说明     |
| ---------------------------------- | ------ |
| Promise&lt;Array&lt;number&gt;&gt; | 返回四元数。 |
Z
zengyawen 已提交
2097

H
HelloCrease 已提交
2098
**返回值:** 
Z
zengyawen 已提交
2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118

  ```
  const promise = sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877]);
      promise.then((data) => {
          console.info('createQuaternion_promise successed');
          for (var i=0; i < data.length; i++) {
              console.info(LABEL + "data[" + i + "]: " + data[i]);
          }
      }).catch((err) => {
          console.info('promise failed');
  })
  ```


## sensor.getDirection

getDirection(rotationMatrix: Array&lt;number&gt;, callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void

根据旋转矩阵计算设备的方向。

C
cff-gite 已提交
2119 2120
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
2121
**参数:** 
Z
zengyawen 已提交
2122

H
HelloCrease 已提交
2123 2124 2125 2126
| 参数名            | 类型                                       | 必填   | 说明                 |
| -------------- | ---------------------------------------- | ---- | ------------------ |
| rotationMatrix | Array&lt;number&gt;                      | 是    | 表示旋转矩阵。            |
| callback       | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是    | 返回围绕z、x、y轴方向的旋转角度。 |
Z
zengyawen 已提交
2127

H
HelloCrease 已提交
2128
**返回值:** 
Z
zengyawen 已提交
2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150

  ```
  sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1], function(err, data)  {
      if (err) {
          console.error(LABEL + 'SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' +
                        err.message);
          return;
      }
      console.info(LABEL + "SensorJsAPI--->Successed to get getDirection interface get data: " + data.x);
      for (var i = 1; i < data.length; i++) {
          console.info(TAG +"sensor_getDirection_callback" + data[i]);
      }
  })
  ```


## sensor.getDirection

getDirection(rotationMatrix: Array&lt;number&gt;): Promise&lt;Array&lt;number&gt;&gt;

根据旋转矩阵计算设备的方向。

C
cff-gite 已提交
2151 2152
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
2153
**参数:** 
Z
zengyawen 已提交
2154

H
HelloCrease 已提交
2155 2156 2157
| 参数名            | 类型                  | 必填   | 说明      |
| -------------- | ------------------- | ---- | ------- |
| rotationMatrix | Array&lt;number&gt; | 是    | 表示旋转矩阵。 |
Z
zengyawen 已提交
2158

H
HelloCrease 已提交
2159
**返回值:** 
Z
zengyawen 已提交
2160

H
HelloCrease 已提交
2161 2162 2163
| 类型                                 | 说明                 |
| ---------------------------------- | ------------------ |
| Promise&lt;Array&lt;number&gt;&gt; | 返回围绕z、x、y轴方向的旋转角度。 |
Z
zengyawen 已提交
2164

H
HelloCrease 已提交
2165
**返回值:** 
Z
zengyawen 已提交
2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185

  ```
  const promise = sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1]);
      promise.then((data) => {
          console.info(' sensor_getAltitude_Promise success', data.x);
          for (var i = 1; i < data.length; i++) {
              console.info(TAG +"sensor_getDirection_promise" + data[i]);
          }
      }).catch((err) => {
          console.info('promise failed');
  })
  ```


## sensor.createRotationMatrix

createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&gt;, callback: AsyncCallback&lt;RotationMatrixResponse&gt;): void

根据重力矢量和地磁矢量计算旋转矩阵。

C
cff-gite 已提交
2186 2187
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
2188
**参数:** 
Z
zengyawen 已提交
2189

H
HelloCrease 已提交
2190 2191 2192 2193 2194
| 参数名         | 类型                                       | 必填   | 说明      |
| ----------- | ---------------------------------------- | ---- | ------- |
| gravity     | Array&lt;number&gt;                      | 是    | 表示重力向量。 |
| geomagnetic | Array&lt;number&gt;                      | 是    | 表示地磁矢量。 |
| callback    | AsyncCallback&lt;[RotationMatrixResponse](#rotationmatrixresponse)&gt; | 是    | 返回旋转矩阵。 |
Z
zengyawen 已提交
2195

H
HelloCrease 已提交
2196
**返回值:** 
Z
zengyawen 已提交
2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218

  ```
  sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444], function(err, data)  {
      if (err) {
          console.error(LABEL + 'SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' +
                        err.message);
          return;
      }
      console.info("SensorJsAPI--->Successed to get createRotationMatrix interface get data: " + data.x);
      for (var i=0; i < data.length; i++) {
          console.info(LABEL + "data[" + i + "]: " + data[i])
      }
  })
  ```


## sensor.createRotationMatrix

createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&gt;,): Promise&lt;RotationMatrixResponse&gt;

根据重力矢量和地磁矢量计算旋转矩阵。

C
cff-gite 已提交
2219 2220
**系统能力**:SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
2221
**参数:** 
Z
zengyawen 已提交
2222

H
HelloCrease 已提交
2223 2224 2225 2226
| 参数名         | 类型                  | 必填   | 说明      |
| ----------- | ------------------- | ---- | ------- |
| gravity     | Array&lt;number&gt; | 是    | 表示重力向量。 |
| geomagnetic | Array&lt;number&gt; | 是    | 表示地磁矢量。 |
Z
zengyawen 已提交
2227

H
HelloCrease 已提交
2228
**返回值:** 
Z
zengyawen 已提交
2229

H
HelloCrease 已提交
2230 2231 2232
| 类型                                       | 说明      |
| ---------------------------------------- | ------- |
| Promise&lt;[RotationMatrixResponse](#rotationmatrixresponse)&gt; | 返回旋转矩阵。 |
Z
zengyawen 已提交
2233

H
HelloCrease 已提交
2234
**返回值:** 
Z
zengyawen 已提交
2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247

  ```
  const promise = sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444]);
      promise.then((data) => {
          console.info(LABEL + 'createRotationMatrix_promise successed');
          for (var i=0; i < data.length; i++) {
              console.info(LABEL + "data[" + i + "]: " + data[i]);
          }
      }).catch((err) => {
          console.info(LABEL + 'promise failed');
  })
  ```

Z
zengyawen 已提交
2248

Z
zengyawen 已提交
2249
## SensorType
Z
zengyawen 已提交
2250 2251 2252

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

C
cff-gite 已提交
2253 2254
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
2255

H
HelloCrease 已提交
2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278
| 名称                                       | 默认值  | 说明          |
| ---------------------------------------- | ---- | ----------- |
| 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 已提交
2279 2280


Z
zengyawen 已提交
2281 2282 2283 2284
## Response

传感器数据的时间戳。

C
cff-gite 已提交
2285 2286
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
2287 2288 2289
| 名称        | 参数类型   | 可读   | 可写   | 说明           |
| --------- | ------ | ---- | ---- | ------------ |
| timestamp | number | 是    | 是    | 传感器数据上报的时间戳。 |
Z
zengyawen 已提交
2290 2291


Z
zengyawen 已提交
2292
## AccelerometerResponse
Z
zengyawen 已提交
2293

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

C
cff-gite 已提交
2296 2297
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
2298

H
HelloCrease 已提交
2299 2300 2301 2302 2303
| 名称   | 参数类型   | 可读   | 可写   | 说明                     |
| ---- | ------ | ---- | ---- | ---------------------- |
| x    | number | 是    | 是    | 施加在设备x轴的加速度,单位 : m/s2。 |
| y    | number | 是    | 是    | 施加在设备y轴的加速度,单位 : m/s2。 |
| z    | number | 是    | 是    | 施加在设备z轴的加速度,单位 : m/s2。 |
Z
zengyawen 已提交
2304 2305 2306


## LinearAccelerometerResponse
Z
zengyawen 已提交
2307

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

C
cff-gite 已提交
2310 2311
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
2312

H
HelloCrease 已提交
2313 2314 2315 2316 2317
| 名称   | 参数类型   | 可读   | 可写   | 说明                       |
| ---- | ------ | ---- | ---- | ------------------------ |
| x    | number | 是    | 是    | 施加在设备x轴的线性加速度,单位 : m/s2。 |
| y    | number | 是    | 是    | 施加在设备y轴的线性加速度,单位 : m/s2。 |
| z    | number | 是    | 是    | 施加在设备z轴的线性加速度,单位 : m/s2。 |
Z
zengyawen 已提交
2318 2319 2320


## AccelerometerUncalibratedResponse
Z
zengyawen 已提交
2321

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

C
cff-gite 已提交
2324 2325
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
2326

H
HelloCrease 已提交
2327 2328 2329 2330 2331 2332 2333 2334
| 名称    | 参数类型   | 可读   | 可写   | 说明                           |
| ----- | ------ | ---- | ---- | ---------------------------- |
| 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 已提交
2335 2336 2337


## GravityResponse
Z
zengyawen 已提交
2338

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

C
cff-gite 已提交
2341 2342
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
2343

H
HelloCrease 已提交
2344 2345 2346 2347 2348
| 名称   | 参数类型   | 可读   | 可写   | 说明                       |
| ---- | ------ | ---- | ---- | ------------------------ |
| x    | number | 是    | 是    | 施加在设备x轴的重力加速度,单位 : m/s2。 |
| y    | number | 是    | 是    | 施加在设备y轴的重力加速度,单位 : m/s2。 |
| z    | number | 是    | 是    | 施加在设备z轴的重力加速度,单位 : m/s2。 |
Z
zengyawen 已提交
2349 2350 2351


## OrientationResponse
Z
zengyawen 已提交
2352

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

C
cff-gite 已提交
2355 2356
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
2357

H
HelloCrease 已提交
2358 2359
| 名称    | 参数类型   | 可读   | 可写   | 说明                       |
| ----- | ------ | ---- | ---- | ------------------------ |
2360 2361 2362
| alpha | number | 是    | 是    | 设备围绕Z轴的旋转角度,单位 : 度。 |
| beta  | number | 是    | 是    | 设备围绕X轴的旋转角度,单位 : 度。  |
| gamma | number | 是    | 是    | 设备围绕Y轴的旋转角度,单位 : 度。  |
Z
zengyawen 已提交
2363 2364 2365


## RotationVectorResponse
Z
zengyawen 已提交
2366

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

C
cff-gite 已提交
2369 2370
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
2371

H
HelloCrease 已提交
2372 2373 2374 2375 2376 2377
| 名称   | 参数类型   | 可读   | 可写   | 说明        |
| ---- | ------ | ---- | ---- | --------- |
| x    | number | 是    | 是    | 旋转矢量x轴分量。 |
| y    | number | 是    | 是    | 旋转矢量y轴分量。 |
| z    | number | 是    | 是    | 旋转矢量z轴分量。 |
| w    | number | 是    | 是    | 标量。       |
Z
zengyawen 已提交
2378 2379 2380


## GyroscopeResponse
Z
zengyawen 已提交
2381

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

C
cff-gite 已提交
2384 2385
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
2386

H
HelloCrease 已提交
2387 2388 2389 2390 2391
| 名称   | 参数类型   | 可读   | 可写   | 说明                  |
| ---- | ------ | ---- | ---- | ------------------- |
| x    | number | 是    | 是    | 设备x轴的旋转角速度,单位rad/s。 |
| y    | number | 是    | 是    | 设备y轴的旋转角速度,单位rad/s。 |
| z    | number | 是    | 是    | 设备z轴的旋转角速度,单位rad/s。 |
Z
zengyawen 已提交
2392 2393 2394


## GyroscopeUncalibratedResponse
Z
zengyawen 已提交
2395

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

C
cff-gite 已提交
2398 2399
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
2400

H
HelloCrease 已提交
2401 2402 2403 2404 2405 2406 2407 2408
| 名称    | 参数类型   | 可读   | 可写   | 说明                       |
| ----- | ------ | ---- | ---- | ------------------------ |
| 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 已提交
2409 2410 2411


## SignificantMotionResponse
Z
zengyawen 已提交
2412

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

C
cff-gite 已提交
2415 2416
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
2417

H
HelloCrease 已提交
2418 2419 2420
| 名称     | 参数类型   | 可读   | 可写   | 说明                                       |
| ------ | ------ | ---- | ---- | ---------------------------------------- |
| scalar | number | 是    | 是    | 表示剧烈运动程度。测量三个物理轴(x、y&nbsp;&nbsp;z)上,设备是否存在大幅度运动;如果取值为1则代表存在大幅度运动,取值为0则代表没有大幅度运动。 |
Z
zengyawen 已提交
2421 2422 2423


## ProximityResponse
Z
zengyawen 已提交
2424

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

C
cff-gite 已提交
2427 2428
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
2429

H
HelloCrease 已提交
2430 2431 2432
| 名称       | 参数类型   | 可读   | 可写   | 说明                           |
| -------- | ------ | ---- | ---- | ---------------------------- |
| distance | number | 是    | 是    | 可见物体与设备显示器的接近程度。0表示接近,1表示远离。 |
Z
zengyawen 已提交
2433 2434 2435


## LightResponse
Z
zengyawen 已提交
2436

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

C
cff-gite 已提交
2439 2440
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
2441

H
HelloCrease 已提交
2442 2443 2444
| 名称        | 参数类型   | 可读   | 可写   | 说明          |
| --------- | ------ | ---- | ---- | ----------- |
| intensity | number | 是    | 是    | 光强(单位:勒克斯)。 |
Z
zengyawen 已提交
2445 2446 2447


## HallResponse
Z
zengyawen 已提交
2448

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

C
cff-gite 已提交
2451 2452
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
2453

H
HelloCrease 已提交
2454 2455 2456
| 名称     | 参数类型   | 可读   | 可写   | 说明                                |
| ------ | ------ | ---- | ---- | --------------------------------- |
| status | number | 是    | 是    | 显示霍尔状态。测量设备周围是否存在磁力吸引,0表示有,1表示没有。 |
Z
zengyawen 已提交
2457 2458 2459


## MagneticFieldResponse
Z
zengyawen 已提交
2460

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

C
cff-gite 已提交
2463 2464
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
2465

H
HelloCrease 已提交
2466 2467 2468 2469 2470
| 名称   | 参数类型   | 可读   | 可写   | 说明                 |
| ---- | ------ | ---- | ---- | ------------------ |
| x    | number | 是    | 是    | x轴环境磁场强度,单位 : μT。  |
| y    | number | 是    | 是    | y轴环境磁场强度,单位 : μT。  |
| z    | number | 是    | 是    | z轴环境磁场强度,单位 : μT。。 |
Z
zengyawen 已提交
2471 2472 2473


## MagneticFieldUncalibratedResponse
Z
zengyawen 已提交
2474

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

C
cff-gite 已提交
2477 2478
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
2479

H
HelloCrease 已提交
2480 2481 2482 2483 2484 2485 2486 2487
| 名称    | 参数类型   | 可读   | 可写   | 说明                     |
| ----- | ------ | ---- | ---- | ---------------------- |
| 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 已提交
2488 2489 2490


## PedometerResponse
Z
zengyawen 已提交
2491

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

C
cff-gite 已提交
2494 2495
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
2496

H
HelloCrease 已提交
2497 2498 2499
| 名称    | 参数类型   | 可读   | 可写   | 说明       |
| ----- | ------ | ---- | ---- | -------- |
| steps | number | 是    | 是    | 用户的行走步数。 |
Z
zengyawen 已提交
2500 2501 2502


## HumidityResponse
Z
zengyawen 已提交
2503

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

C
cff-gite 已提交
2506 2507
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
2508

H
HelloCrease 已提交
2509 2510 2511
| 名称       | 参数类型   | 可读   | 可写   | 说明                                   |
| -------- | ------ | ---- | ---- | ------------------------------------ |
| humidity | number | 是    | 是    | 湿度值。测量环境的相对湿度,以百分比&nbsp;(%)&nbsp;表示。 |
Z
zengyawen 已提交
2512 2513


C
cff-gite 已提交
2514
## PedometerDetectionResponse
Z
zengyawen 已提交
2515

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

C
cff-gite 已提交
2518 2519
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
2520

H
HelloCrease 已提交
2521 2522 2523
| 名称     | 参数类型   | 可读   | 可写   | 说明                                       |
| ------ | ------ | ---- | ---- | ---------------------------------------- |
| scalar | number | 是    | 是    | 计步器检测。检测用户的计步动作,如果取值为1则代表用户产生了计步行走的动作,取值为0则代表用户没有发生运动。 |
Z
zengyawen 已提交
2524 2525 2526


## AmbientTemperatureResponse
Z
zengyawen 已提交
2527

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

C
cff-gite 已提交
2530 2531
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
2532

H
HelloCrease 已提交
2533 2534 2535
| 名称          | 参数类型   | 可读   | 可写   | 说明            |
| ----------- | ------ | ---- | ---- | ------------- |
| temperature | number | 是    | 是    | 环境温度(单位:摄氏度)。 |
Z
zengyawen 已提交
2536 2537 2538


## BarometerResponse
Z
zengyawen 已提交
2539

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

C
cff-gite 已提交
2542 2543
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
2544

H
HelloCrease 已提交
2545 2546 2547
| 名称       | 参数类型   | 可读   | 可写   | 说明           |
| -------- | ------ | ---- | ---- | ------------ |
| pressure | number | 是    | 是    | 压力值(单位:帕斯卡)。 |
Z
zengyawen 已提交
2548 2549 2550


## HeartRateResponse
Z
zengyawen 已提交
2551

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

C
cff-gite 已提交
2554 2555
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
2556

H
HelloCrease 已提交
2557 2558 2559
| 名称        | 参数类型   | 可读   | 可写   | 说明                    |
| --------- | ------ | ---- | ---- | --------------------- |
| heartRate | number | 是    | 是    | 心率值。测量用户的心率数值,单位:bpm。 |
Z
zengyawen 已提交
2560 2561 2562


## WearDetectionResponse
Z
zengyawen 已提交
2563

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

C
cff-gite 已提交
2566 2567
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

Z
zengyawen 已提交
2568

H
HelloCrease 已提交
2569 2570 2571
| 名称    | 参数类型   | 可读   | 可写   | 说明                        |
| ----- | ------ | ---- | ---- | ------------------------- |
| value | number | 是    | 是    | 表示设备是否被穿戴(1表示已穿戴,0表示未穿戴)。 |
Z
zengyawen 已提交
2572 2573 2574 2575


## Options

Z
zengyawen 已提交
2576
设置传感器上报频率。
Z
zengyawen 已提交
2577

C
cff-gite 已提交
2578 2579
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
2580 2581
| 名称       | 参数类型   | 说明                          |
| -------- | ------ | --------------------------- |
Z
zengyawen 已提交
2582 2583
| interval | number | 表示传感器的上报频率,默认值为200000000ns。 |

Z
zengyawen 已提交
2584 2585
## RotationMatrixResponse

C
cff-gite 已提交
2586 2587 2588
设置旋转矩阵响应对象。

**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
Z
zengyawen 已提交
2589

H
HelloCrease 已提交
2590 2591 2592 2593
| 名称          | 参数类型                | 可读   | 可写   | 说明    |
| ----------- | ------------------- | ---- | ---- | ----- |
| rotation    | Array&lt;number&gt; | 是    | 是    | 旋转矩阵。 |
| inclination | Array&lt;number&gt; | 是    | 是    | 倾斜矩阵。 |
Z
zengyawen 已提交
2594 2595 2596 2597


## CoordinatesOptions

C
cff-gite 已提交
2598 2599 2600
设置坐标选项对象。

**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
Z
zengyawen 已提交
2601

H
HelloCrease 已提交
2602 2603 2604 2605
| 名称   | 参数类型   | 可读   | 可写   | 说明     |
| ---- | ------ | ---- | ---- | ------ |
| x    | number | 是    | 是    | x坐标方向。 |
| y    | number | 是    | 是    | y坐标方向。 |
Z
zengyawen 已提交
2606

Z
zengyawen 已提交
2607 2608 2609

## GeomagneticResponse

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

C
cff-gite 已提交
2612 2613
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
2614 2615 2616 2617 2618 2619 2620 2621 2622
| 名称              | 参数类型   | 可读   | 可写   | 说明                        |
| --------------- | ------ | ---- | ---- | ------------------------- |
| x               | number | 是    | 是    | 地磁场的北分量。                  |
| y               | number | 是    | 是    | 地磁场的东分量。                  |
| z               | number | 是    | 是    | 地磁场的垂直分量。                 |
| geomagneticDip  | number | 是    | 是    | 地磁倾角,即地球磁场线与水平面的夹角。       |
| deflectionAngle | number | 是    | 是    | 地磁偏角,即地磁北方向与正北方向在水平面上的角度。 |
| levelIntensity  | number | 是    | 是    | 地磁场的水平强度。                 |
| totalIntensity  | number | 是    | 是    | 地磁场的总强度。                  |
Z
zengyawen 已提交
2623 2624 2625

## LocationOptions

C
cff-gite 已提交
2626 2627 2628 2629
指示地理位置。

**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

H
HelloCrease 已提交
2630 2631 2632 2633 2634
| 名称        | 参数类型   | 可读   | 可写   | 说明    |
| --------- | ------ | ---- | ---- | ----- |
| latitude  | number | 是    | 是    | 纬度。   |
| longitude | number | 是    | 是    | 经度。   |
| altitude  | number | 是    | 是    | 海拔高度。 |