js-apis-sensor.md 289.9 KB
Newer Older
1
# @ohos.sensor (传感器)
Z
zengyawen 已提交
2

H
h00514358 已提交
3
sensor模块提供了获取传感器数据的能力,包括获取传感器属性列表,订阅传感器数据,以及一些通用的传感器算法。
C
cff-gite 已提交
4

H
HelloCrease 已提交
5
> **说明:**
6
>
Z
zengyawen 已提交
7
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
Z
zengyawen 已提交
8

Z
zengyawen 已提交
9 10

## 导入模块
Z
zengyawen 已提交
11

L
li-yaoyao777 已提交
12
```ts
Z
zengyawen 已提交
13 14
import sensor from '@ohos.sensor';
```
L
li-yaoyao777 已提交
15
## sensor.on
Z
zengyawen 已提交
16

L
li-yaoyao777 已提交
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
### COLOR<sup>10+</sup>

on(type: SensorId.COLOR, callback: Callback\<ColorResponse>,options?: Options): void

订阅颜色传感器数据。

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

**系统API**:此接口为系统接口

**错误码**

以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

**参数:**

| 参数名   | 类型                                            | 必填 | 说明                                                        |
| -------- | ----------------------------------------------- | ---- | ----------------------------------------------------------- |
| type     | [SensorId](#sensorid9).COLOR                    | 是   | 传感器类型,该值固定为SensorId.COLOR。                      |
| callback | Callback&lt;[ColorResponse](#colorresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为ColorResponse。         |
| options  | [Options](#options)                             | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。 |

**示例:**

L
li-yaoyao777 已提交
45
```ts
L
li-yaoyao777 已提交
46 47 48 49 50 51 52
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

try{
  sensor.on(sensor.SensorId.COLOR, (data: sensor.ColorResponse) => {
    console.log('Succeeded in getting the intensity of light: ' + data.lightIntensity);
    console.log('Succeeded in getting the color temperature: ' + data.colorTemperature);
L
li-yaoyao777 已提交
53 54
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
55 56
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
L
li-yaoyao777 已提交
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
}
```

### SAR<sup>10+</sup>

on(type: SensorId.SAR, callback: Callback\<SarResponse>,options?: Options): void

订阅吸收比率传感器数据。

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

**系统API**:此接口为系统接口

**错误码**

以下错误码的详细介绍请参见[ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

**参数:**

| 参数名   | 类型                                     | 必填 | 说明                                                        |
| -------- | ---------------------------------------- | ---- | ----------------------------------------------------------- |
| type     | [SensorId](#sensorid9).SAR               | 是   | 传感器类型,该值固定为SensorId.SAR。                        |
| callback | Callback&lt;[SarResponse](#sarresponse)> | 是   | 回调函数,异步上报的传感器数据固定为SarResponse。           |
| options  | [Options](#options)                      | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。 |

**示例:**

L
li-yaoyao777 已提交
88
```ts
L
li-yaoyao777 已提交
89 90 91
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

L
li-yaoyao777 已提交
92
try {
L
li-yaoyao777 已提交
93
  sensor.on(sensor.SensorId.SAR, (data: sensor.SarResponse) => {
L
li-yaoyao777 已提交
94 95 96
    console.info('Succeeded in getting specific absorption rate : ' + data.absorptionRatio);
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
97 98
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
L
li-yaoyao777 已提交
99 100
}
```
Z
zengyawen 已提交
101

C
cff-gite 已提交
102
### ACCELEROMETER<sup>9+</sup>
C
cff-gite 已提交
103 104 105

on(type: SensorId.ACCELEROMETER, callback: Callback&lt;AccelerometerResponse&gt;,options?: Options): void

H
h00514358 已提交
106
订阅加速度传感器数据。
C
cff-gite 已提交
107

H
h00514358 已提交
108
**需要权限**:ohos.permission.ACCELEROMETER
C
cff-gite 已提交
109 110 111 112 113

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

**参数:** 

C
cff-gite 已提交
114 115 116
| 参数名   | 类型                                                         | 必填 | 说明                                                        |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
| type     | [SensorId](#sensorid9).ACCELEROMETER                         | 是   | 传感器类型,该值固定为SensorId.ACCELEROMETER。              |
H
h00514358 已提交
117
| callback | Callback&lt;[AccelerometerResponse](#accelerometerresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为AccelerometerResponse。 |
L
li-yaoyao777 已提交
118
| options  | [Options](#options)                                          | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。 |
C
cff-gite 已提交
119

C
cff-gite 已提交
120 121
**错误码**

C
cff-gite 已提交
122
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
123 124 125 126 127

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
128 129
**示例:** 

L
li-yaoyao777 已提交
130
```ts
L
li-yaoyao777 已提交
131 132 133
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
134
try {
L
li-yaoyao777 已提交
135
  sensor.on(sensor.SensorId.ACCELEROMETER, (data: sensor.AccelerometerResponse) => {
L
li-yaoyao777 已提交
136 137 138 139 140
    console.info('Succeeded in invoking on. X-coordinate component: ' + data.x);
    console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y);
    console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z);
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
141 142
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
143
}
C
cff-gite 已提交
144 145
```

C
cff-gite 已提交
146
### ACCELEROMETER_UNCALIBRATED<sup>9+</sup>
C
cff-gite 已提交
147

C
cff-gite 已提交
148
on(type: SensorId.ACCELEROMETER_UNCALIBRATED, callback: Callback&lt;AccelerometerUncalibratedResponse&gt;,options?: Options): void
C
cff-gite 已提交
149

H
h00514358 已提交
150
订阅未校准加速度传感器数据。
C
cff-gite 已提交
151 152 153 154 155 156 157 158 159

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

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

**参数:** 

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
160
| type     | [SensorId](#sensorid9).ACCELEROMETER_UNCALIBRATED            | 是   | 传感器类型,该值固定为SensorId.ACCELEROMETER_UNCALIBRATED。  |
H
h00514358 已提交
161
| callback | Callback&lt;[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为AccelerometerUncalibratedResponse。 |
L
li-yaoyao777 已提交
162
| options  | [Options](#options)                                          | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
C
cff-gite 已提交
163

C
cff-gite 已提交
164 165
**错误码**

C
cff-gite 已提交
166
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
167 168 169 170 171

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
172 173
**示例:** 

L
li-yaoyao777 已提交
174
```ts
L
li-yaoyao777 已提交
175 176 177
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
178
try {
L
li-yaoyao777 已提交
179
  sensor.on(sensor.SensorId.ACCELEROMETER_UNCALIBRATED, (data: sensor.AccelerometerUncalibratedResponse) => {
L
li-yaoyao777 已提交
180 181 182 183 184 185 186 187
    console.info('Succeeded in invoking on. X-coordinate component: ' + data.x);
    console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y);
    console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z);
    console.info('Succeeded in invoking on. X-coordinate bias: ' + data.biasX);
    console.info('Succeeded in invoking on. Y-coordinate bias: ' + data.biasY);
    console.info('Succeeded in invoking on. Z-coordinate bias: ' + data.biasZ);
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
188 189
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
190
}
C
cff-gite 已提交
191 192
```

C
cff-gite 已提交
193
### AMBIENT_LIGHT<sup>9+</sup>
C
cff-gite 已提交
194 195 196 197 198 199 200 201 202

on(type: SensorId.AMBIENT_LIGHT, callback: Callback&lt;LightResponse&gt;, options?: Options): void

订阅环境光传感器数据。

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

**参数:** 

L
li-yaoyao777 已提交
203 204 205 206 207
| 参数名   | 类型                                            | 必填 | 说明                                                        |
| -------- | ----------------------------------------------- | ---- | ----------------------------------------------------------- |
| type     | [SensorId](#sensorid9).AMBIENT_LIGHT            | 是   | 传感器类型,该值固定为SensorId.AMBIENT_LIGHT。              |
| callback | Callback&lt;[LightResponse](#lightresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为LightResponse。         |
| options  | [Options](#options)                             | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。 |
C
cff-gite 已提交
208

C
cff-gite 已提交
209 210
**错误码**

C
cff-gite 已提交
211
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
212 213 214 215 216

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
217 218
**示例:** 

L
li-yaoyao777 已提交
219
```ts
L
li-yaoyao777 已提交
220 221 222
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
223
try {
L
li-yaoyao777 已提交
224
  sensor.on(sensor.SensorId.AMBIENT_LIGHT, (data: sensor.LightResponse) => {
L
li-yaoyao777 已提交
225 226 227
    console.info('Succeeded in getting the ambient light intensity: ' + data.intensity);
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
228 229
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
230
}
C
cff-gite 已提交
231 232
```

C
cff-gite 已提交
233
###  AMBIENT_TEMPERATURE<sup>9+</sup>
C
cff-gite 已提交
234 235 236

on(type: SensorId.AMBIENT_TEMPERATURE, callback: Callback&lt;AmbientTemperatureResponse&gt;,options?: Options): void

H
h00514358 已提交
237
订阅温度传感器数据。
C
cff-gite 已提交
238 239 240 241 242 243 244

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

**参数:** 

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
245
| type     | [SensorId](#sensorid9).AMBIENT_TEMPERATURE                   | 是   | 传感器类型,该值固定为SensorId.AMBIENT_TEMPERATURE。         |
H
h00514358 已提交
246
| callback | Callback&lt;[AmbientTemperatureResponse](#ambienttemperatureresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为AmbientTemperatureResponse。 |
L
li-yaoyao777 已提交
247
| options  | [Options](#options)                                          | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
C
cff-gite 已提交
248

C
cff-gite 已提交
249 250
**错误码**

C
cff-gite 已提交
251
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
252 253 254 255 256

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
257 258
**示例:**

L
li-yaoyao777 已提交
259
```ts
L
li-yaoyao777 已提交
260 261 262
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
263
try {
L
li-yaoyao777 已提交
264
  sensor.on(sensor.SensorId.AMBIENT_TEMPERATURE, (data: sensor.AmbientTemperatureResponse) => {
L
li-yaoyao777 已提交
265 266 267
    console.info('Succeeded in invoking on. Temperature: ' + data.temperature);
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
268 269
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
270
}
C
cff-gite 已提交
271 272
```

C
cff-gite 已提交
273
### BAROMETER<sup>9+</sup>
C
cff-gite 已提交
274 275 276 277 278 279 280 281 282

on(type: SensorId.BAROMETER, callback: Callback&lt;BarometerResponse&gt;, options?: Options): void

订阅气压计传感器数据。

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

**参数:**

L
li-yaoyao777 已提交
283 284 285 286 287
| 参数名   | 类型                                                    | 必填 | 说明                                                        |
| -------- | ------------------------------------------------------- | ---- | ----------------------------------------------------------- |
| type     | [SensorId](#sensorid9).BAROMETER                        | 是   | 传感器类型,该值固定为SensorId.BAROMETER。                  |
| callback | Callback&lt;[BarometerResponse](#barometerresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为BarometerResponse。     |
| options  | [Options](#options)                                     | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。 |
C
cff-gite 已提交
288

C
cff-gite 已提交
289 290
**错误码**

C
cff-gite 已提交
291
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
292 293 294 295 296

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
297 298
**示例:**

L
li-yaoyao777 已提交
299
```ts
L
li-yaoyao777 已提交
300 301 302
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
303
try {
L
li-yaoyao777 已提交
304
  sensor.on(sensor.SensorId.BAROMETER, (data: sensor.BarometerResponse) => {
L
li-yaoyao777 已提交
305 306 307
    console.info('Succeeded in invoking on. Atmospheric pressure: ' + data.pressure);
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
308 309
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
310
}
C
cff-gite 已提交
311 312
```

C
cff-gite 已提交
313
###  GRAVITY<sup>9+</sup>
C
cff-gite 已提交
314 315 316 317 318 319 320 321 322

on(type: SensorId.GRAVITY, callback: Callback&lt;GravityResponse&gt;,options?: Options): void

订阅重力传感器数据。

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

**参数:** 

L
li-yaoyao777 已提交
323 324 325 326 327
| 参数名   | 类型                                                | 必填 | 说明                                                        |
| -------- | --------------------------------------------------- | ---- | ----------------------------------------------------------- |
| type     | [SensorId](#sensorid9).GRAVITY                      | 是   | 传感器类型,该值固定为SensorId.GRAVITY。                    |
| callback | Callback&lt;[GravityResponse](#gravityresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为GravityResponse。       |
| options  | [Options](#options)                                 | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。 |
C
cff-gite 已提交
328

C
cff-gite 已提交
329 330
**错误码**

C
cff-gite 已提交
331
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
332 333 334 335 336

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
337 338
**示例:**

L
li-yaoyao777 已提交
339
```ts
L
li-yaoyao777 已提交
340 341 342
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
343
try {
L
li-yaoyao777 已提交
344
  sensor.on(sensor.SensorId.GRAVITY, (data: sensor.GravityResponse) => {
L
li-yaoyao777 已提交
345 346 347 348 349
    console.info('Succeeded in invoking on. X-coordinate component: ' + data.x);
    console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y);
    console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z);
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
350 351
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
352
}
C
cff-gite 已提交
353 354
```

C
cff-gite 已提交
355
###  GYROSCOPE<sup>9+</sup>
C
cff-gite 已提交
356 357 358 359 360

on(type: SensorId.GYROSCOPE, callback: Callback&lt;GyroscopeResponse&gt;,options?: Options): void

订阅校准的陀螺仪传感器数据。

C
cff-gite 已提交
361
**需要权限**:ohos.permission.GYROSCOPE 
C
cff-gite 已提交
362 363 364 365 366

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

**参数:** 

L
li-yaoyao777 已提交
367 368 369 370 371
| 参数名   | 类型                                                    | 必填 | 说明                                                        |
| -------- | ------------------------------------------------------- | ---- | ----------------------------------------------------------- |
| type     | [SensorId](#sensorid9).GYROSCOPE                        | 是   | 传感器类型,该值固定为SensorId.GYROSCOPE。                  |
| callback | Callback&lt;[GyroscopeResponse](#gyroscoperesponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为GyroscopeResponse。     |
| options  | [Options](#options)                                     | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。 |
C
cff-gite 已提交
372

C
cff-gite 已提交
373 374
**错误码**

C
cff-gite 已提交
375
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
376 377 378 379 380

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
381 382
**示例:**

L
li-yaoyao777 已提交
383
```ts
L
li-yaoyao777 已提交
384 385 386
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
387
try {
L
li-yaoyao777 已提交
388
  sensor.on(sensor.SensorId.GYROSCOPE, (data: sensor.GyroscopeResponse) => {
L
li-yaoyao777 已提交
389 390 391 392 393
    console.info('Succeeded in invoking on. X-coordinate component: ' + data.x);
    console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y);
    console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z);
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
394 395
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
396
}
C
cff-gite 已提交
397 398
```

C
cff-gite 已提交
399
###  GYROSCOPE_UNCALIBRATED<sup>9+</sup>
C
cff-gite 已提交
400 401 402 403

on(type: SensorId.GYROSCOPE_UNCALIBRATED, callback: Callback&lt;GyroscopeUncalibratedResponse&gt;,
      options?: Options): void

L
li-yaoyao777 已提交
404
订阅未校准陀螺仪传感器数据。
C
cff-gite 已提交
405

C
cff-gite 已提交
406
**需要权限**:ohos.permission.GYROSCOPE 
C
cff-gite 已提交
407 408 409 410 411 412 413

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

**参数:** 

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
414
| type     | [SensorId](#sensorid9).GYROSCOPE_UNCALIBRATED                | 是   | 传感器类型,该值固定为SensorId.GYROSCOPE_UNCALIBRATED。      |
H
h00514358 已提交
415
| callback | Callback&lt;[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为GyroscopeUncalibratedResponse。 |
L
li-yaoyao777 已提交
416
| options  | [Options](#options)                                          | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
C
cff-gite 已提交
417

C
cff-gite 已提交
418 419
**错误码**

C
cff-gite 已提交
420
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
421 422 423 424 425

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
426 427
**示例:**

L
li-yaoyao777 已提交
428
```ts
L
li-yaoyao777 已提交
429 430 431
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
432
try {
L
li-yaoyao777 已提交
433
  sensor.on(sensor.SensorId.GYROSCOPE_UNCALIBRATED, (data: sensor.GyroscopeUncalibratedResponse) => {
L
li-yaoyao777 已提交
434 435 436 437 438 439 440 441
    console.info('Succeeded in invoking on. X-coordinate component: ' + data.x);
    console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y);
    console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z);
    console.info('Succeeded in invoking on. X-coordinate bias: ' + data.biasX);
    console.info('Succeeded in invoking on. Y-coordinate bias: ' + data.biasY);
    console.info('Succeeded in invoking on. Z-coordinate bias: ' + data.biasZ);
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
442 443
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
444
}
L
li-yaoyao777 已提交
445

C
cff-gite 已提交
446 447
```

C
cff-gite 已提交
448
###  HALL<sup>9+</sup>
C
cff-gite 已提交
449 450 451

on(type: SensorId.HALL, callback: Callback&lt;HallResponse&gt;, options?: Options): void

C
cff-gite 已提交
452
订阅霍尔传感器数据。
C
cff-gite 已提交
453 454 455 456 457

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

**参数:** 

L
li-yaoyao777 已提交
458 459 460 461 462
| 参数名   | 类型                                          | 必填 | 说明                                                        |
| -------- | --------------------------------------------- | ---- | ----------------------------------------------------------- |
| type     | [SensorId](#sensorid9).HALL                   | 是   | 传感器类型,该值固定为SensorId.HALL。                       |
| callback | Callback&lt;[HallResponse](#hallresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为HallResponse。          |
| options  | [Options](#options)                           | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。 |
C
cff-gite 已提交
463

C
cff-gite 已提交
464 465
**错误码**

C
cff-gite 已提交
466
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
467 468 469 470 471

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
472 473
**示例:**

L
li-yaoyao777 已提交
474
```ts
L
li-yaoyao777 已提交
475 476 477
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
478
try {
L
li-yaoyao777 已提交
479
  sensor.on(sensor.SensorId.HALL, (data: sensor.HallResponse) => {
L
li-yaoyao777 已提交
480 481 482
    console.info('Succeeded in invoking on. Hall status: ' + data.status);
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
483 484
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
485
}
L
li-yaoyao777 已提交
486

C
cff-gite 已提交
487 488
```

C
cff-gite 已提交
489 490 491 492 493 494 495 496 497 498 499 500
###   HEART_RATE<sup>9+</sup>

on(type: SensorId.HEART_RATE, callback: Callback&lt;HeartRateResponse&gt;,options?: Options): void

订阅心率传感器数据。

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

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

**参数:** 

L
li-yaoyao777 已提交
501 502 503 504 505
| 参数名   | 类型                                                    | 必填 | 说明                                                        |
| -------- | ------------------------------------------------------- | ---- | ----------------------------------------------------------- |
| type     | [SensorId](#sensorid9).HEART_RATE                       | 是   | 传感器类型,该值固定为SensorId.HEART_RATE。                 |
| callback | Callback&lt;[HeartRateResponse](#heartrateresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为HeartRateResponse。     |
| options  | [Options](#options)                                     | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。 |
C
cff-gite 已提交
506 507 508 509 510 511 512 513 514 515 516

**错误码**

以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

**示例:**

L
li-yaoyao777 已提交
517
```ts
L
li-yaoyao777 已提交
518 519 520
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
521
try {
L
li-yaoyao777 已提交
522
  sensor.on(sensor.SensorId.HEART_RATE, (data: sensor.HeartRateResponse) => {
L
li-yaoyao777 已提交
523 524 525
    console.info('Succeeded in invoking on. Heart rate: ' + data.heartRate);
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
526 527
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
528 529 530
}
```

C
cff-gite 已提交
531
###  HUMIDITY<sup>9+</sup>
C
cff-gite 已提交
532 533 534 535 536 537 538 539 540

on(type: SensorId.HUMIDITY, callback: Callback&lt;HumidityResponse&gt;,options?: Options): void

订阅湿度传感器数据。

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

**参数:** 

L
li-yaoyao777 已提交
541 542 543 544 545
| 参数名   | 类型                                                  | 必填 | 说明                                                        |
| -------- | ----------------------------------------------------- | ---- | ----------------------------------------------------------- |
| type     | [SensorId](#sensorid9).HUMIDITY                       | 是   | 传感器类型,该值固定为SensorId.HUMIDITY。                   |
| callback | Callback&lt;[HumidityResponse](#humidityresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为HumidityResponse。      |
| options  | [Options](#options)                                   | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。 |
C
cff-gite 已提交
546

C
cff-gite 已提交
547 548
**错误码**

C
cff-gite 已提交
549
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
550 551 552 553 554

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
555 556
**示例:**

L
li-yaoyao777 已提交
557
```ts
L
li-yaoyao777 已提交
558 559 560
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
561
try {
L
li-yaoyao777 已提交
562
  sensor.on(sensor.SensorId.HUMIDITY, (data: sensor.HumidityResponse) => {
L
li-yaoyao777 已提交
563 564 565
    console.info('Succeeded in invoking on. Humidity: ' + data.humidity);
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
566 567
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
568
}
C
cff-gite 已提交
569 570
```

C
cff-gite 已提交
571
###   LINEAR_ACCELEROMETER<sup>9+</sup>
C
cff-gite 已提交
572 573 574 575 576 577 578 579 580 581 582 583 584 585

on(type: SensorId.LINEAR_ACCELEROMETER, callback: Callback&lt;LinearAccelerometerResponse&gt;,
        options?: Options): void

订阅线性加速度传感器数据。

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

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

**参数:** 

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
586
| type     | [SensorId](#sensorid9).LINEAR_ACCELEROMETER                  | 是   | 传感器类型,该值固定为SensorId.LINEAR_ACCELEROMETER。        |
H
h00514358 已提交
587
| callback | Callback&lt;[LinearAccelerometerResponse](#linearaccelerometerresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为LinearAccelerometerResponse。 |
L
li-yaoyao777 已提交
588
| options  | [Options](#options)                                          | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
C
cff-gite 已提交
589 590 591 592 593 594 595 596 597 598 599

**错误码**

以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

**示例:**

L
li-yaoyao777 已提交
600
```ts
L
li-yaoyao777 已提交
601 602 603
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
604
try {
L
li-yaoyao777 已提交
605
  sensor.on(sensor.SensorId.LINEAR_ACCELEROMETER, (data: sensor.LinearAccelerometerResponse) => {
L
li-yaoyao777 已提交
606 607 608 609 610
    console.info('Succeeded in invoking on. X-coordinate component: ' + data.x);
    console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y);
    console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z);
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
611 612
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
613 614 615
}
```

C
cff-gite 已提交
616
###  MAGNETIC_FIELD<sup>9+</sup>
C
cff-gite 已提交
617 618 619

on(type: SensorId.MAGNETIC_FIELD, callback: Callback&lt;MagneticFieldResponse&gt;,options?: Options): void

H
h00514358 已提交
620
订阅地磁传感器数据。
C
cff-gite 已提交
621 622 623 624 625

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

**参数:**

C
cff-gite 已提交
626 627 628
| 参数名   | 类型                                                         | 必填 | 说明                                                        |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
| type     | [SensorId](#sensorid9).MAGNETIC_FIELD                        | 是   | 传感器类型,该值固定为SensorId.MAGNETIC_FIELD。             |
H
h00514358 已提交
629
| callback | Callback&lt;[MagneticFieldResponse](#magneticfieldresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为MagneticFieldResponse。 |
L
li-yaoyao777 已提交
630
| options  | [Options](#options)                                          | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。 |
C
cff-gite 已提交
631

C
cff-gite 已提交
632 633
**错误码**

C
cff-gite 已提交
634
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
635 636 637 638 639

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
640 641
**示例:**

L
li-yaoyao777 已提交
642
```ts
L
li-yaoyao777 已提交
643 644 645
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
646
try {
L
li-yaoyao777 已提交
647
  sensor.on(sensor.SensorId.MAGNETIC_FIELD, (data: sensor.MagneticFieldResponse) => {
L
li-yaoyao777 已提交
648 649 650 651 652
    console.info('Succeeded in invoking on. X-coordinate component: ' + data.x);
    console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y);
    console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z);
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
653 654
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
655
}
C
cff-gite 已提交
656 657
```

C
cff-gite 已提交
658
### MAGNETIC_FIELD_UNCALIBRATED<sup>9+</sup>
C
cff-gite 已提交
659

C
cff-gite 已提交
660
on(type: SensorId.MAGNETIC_FIELD_UNCALIBRATED, callback: Callback&lt;MagneticFieldUncalibratedResponse&gt;, options?: Options): void
C
cff-gite 已提交
661

H
h00514358 已提交
662
订阅未校准地磁传感器数据
C
cff-gite 已提交
663 664 665 666 667 668 669

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

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
670
| type     | [SensorId](#sensorid9).MAGNETIC_FIELD_UNCALIBRATED           | 是   | 传感器类型,该值固定为SensorId.MAGNETIC_FIELD_UNCALIBRATED。 |
H
h00514358 已提交
671
| callback | Callback&lt;[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为MagneticFieldUncalibratedResponse。 |
L
li-yaoyao777 已提交
672
| options  | [Options](#options)                                          | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
C
cff-gite 已提交
673

C
cff-gite 已提交
674 675
**错误码**

C
cff-gite 已提交
676
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
677 678 679 680 681

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
682 683
**示例:**

L
li-yaoyao777 已提交
684
```ts
L
li-yaoyao777 已提交
685 686 687
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
688
try {
L
li-yaoyao777 已提交
689
  sensor.on(sensor.SensorId.MAGNETIC_FIELD_UNCALIBRATED, (data: sensor.MagneticFieldUncalibratedResponse) => {
L
li-yaoyao777 已提交
690 691 692 693 694 695 696 697
    console.info('Succeeded in invoking on. X-coordinate component: ' + data.x);
    console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y);
    console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z);
    console.info('Succeeded in invoking on. X-coordinate bias: ' + data.biasX);
    console.info('Succeeded in invoking on. Y-coordinate bias: ' + data.biasY);
    console.info('Succeeded in invoking on. Z-coordinate bias: ' + data.biasZ);
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
698 699
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
700
}
C
cff-gite 已提交
701 702
```

C
cff-gite 已提交
703
### ORIENTATION<sup>9+</sup>
C
cff-gite 已提交
704 705 706

on(type: SensorId.ORIENTATION, callback: Callback&lt;OrientationResponse&gt;,options?: Options): void

H
h00514358 已提交
707
订阅方向传感器数据。
C
cff-gite 已提交
708 709 710

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

C
cff-gite 已提交
711 712
**错误码**

C
cff-gite 已提交
713
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
714 715 716 717 718

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
719 720
**参数:**

L
li-yaoyao777 已提交
721 722 723 724 725
| 参数名   | 类型                                                        | 必填 | 说明                                                        |
| -------- | ----------------------------------------------------------- | ---- | ----------------------------------------------------------- |
| type     | [SensorId](#sensorid9).ORIENTATION                          | 是   | 传感器类型,该值固定为SensorId.ORIENTATION。                |
| callback | Callback&lt;[OrientationResponse](#orientationresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为OrientationResponse。   |
| options  | [Options](#options)                                         | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。 |
C
cff-gite 已提交
726 727 728

**示例:**

L
li-yaoyao777 已提交
729
```ts
L
li-yaoyao777 已提交
730 731 732
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
733
try {
L
li-yaoyao777 已提交
734
  sensor.on(sensor.SensorId.ORIENTATION, (data: sensor.OrientationResponse) => {
L
li-yaoyao777 已提交
735 736 737 738 739
    console.info('Succeeded in the device rotating at an angle around the Z axis: ' + data.alpha);
    console.info('Succeeded in the device rotating at an angle around the X axis: ' + data.beta);
    console.info('Succeeded in the device rotating at an angle around the Y axis: ' + data.gamma);
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
740 741
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
742
}
C
cff-gite 已提交
743 744
```

C
cff-gite 已提交
745
### PEDOMETER<sup>9+</sup>
C
cff-gite 已提交
746 747 748 749 750 751 752 753 754

on(type: SensorId.PEDOMETER, callback: Callback&lt;PedometerResponse&gt;, options?: Options): void

订阅计步器传感器数据。

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

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

C
cff-gite 已提交
755 756
**错误码**

C
cff-gite 已提交
757
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
758 759 760 761 762

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
763 764
**参数:**

L
li-yaoyao777 已提交
765 766 767 768 769
| 参数名   | 类型                                                    | 必填 | 说明                                                        |
| -------- | ------------------------------------------------------- | ---- | ----------------------------------------------------------- |
| type     | [SensorId](#sensorid9).PEDOMETER                        | 是   | 传感器类型,该值固定为SensorId.PEDOMETER。                  |
| callback | Callback&lt;[PedometerResponse](#pedometerresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为PedometerResponse。     |
| options  | [Options](#options)                                     | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。 |
C
cff-gite 已提交
770 771 772

**示例:**

L
li-yaoyao777 已提交
773
```ts
L
li-yaoyao777 已提交
774 775 776
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
777
try {
L
li-yaoyao777 已提交
778
  sensor.on(sensor.SensorId.PEDOMETER, (data: sensor.PedometerResponse) => {
L
li-yaoyao777 已提交
779 780 781
    console.info('Succeeded in invoking on. Step count: ' + data.steps);
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
782 783
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
784
}
C
cff-gite 已提交
785 786
```

C
cff-gite 已提交
787
### PEDOMETER_DETECTION<sup>9+</sup>
C
cff-gite 已提交
788 789 790 791

on(type: SensorId.PEDOMETER_DETECTION, callback: Callback&lt;PedometerDetectionResponse&gt;,
        options?: Options): void

H
h00514358 已提交
792
订阅计步检测器传感器数据。
C
cff-gite 已提交
793 794 795 796 797 798 799 800 801

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

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

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
802
| type     | [SensorId](#sensorid9).PEDOMETER_DETECTION                   | 是   | 传感器类型,该值固定为SensorId.PEDOMETER_DETECTION。         |
H
h00514358 已提交
803
| callback | Callback&lt;[PedometerDetectionResponse](#pedometerdetectionresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为PedometerDetectionResponse。 |
L
li-yaoyao777 已提交
804
| options  | [Options](#options)                                          | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
C
cff-gite 已提交
805

C
cff-gite 已提交
806 807
**错误码**

C
cff-gite 已提交
808
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
809 810 811 812 813

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
814 815
**示例:**

L
li-yaoyao777 已提交
816
```ts
L
li-yaoyao777 已提交
817 818 819
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
820
try {
L
li-yaoyao777 已提交
821
  sensor.on(sensor.SensorId.PEDOMETER_DETECTION, (data: sensor.PedometerDetectionResponse) => {
L
li-yaoyao777 已提交
822 823 824
    console.info('Succeeded in invoking on. Pedometer scalar: ' + data.scalar);
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
825 826
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
827
}
C
cff-gite 已提交
828 829
```

C
cff-gite 已提交
830
### PROXIMITY<sup>9+</sup>
C
cff-gite 已提交
831 832 833

on(type: SensorId.PROXIMITY, callback: Callback&lt;ProximityResponse&gt;, options?: Options): void

H
h00514358 已提交
834
订阅接近光传感器数据。
C
cff-gite 已提交
835 836 837 838 839

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

**参数:**

L
li-yaoyao777 已提交
840 841 842 843 844
| 参数名   | 类型                                                    | 必填 | 说明                                                        |
| -------- | ------------------------------------------------------- | ---- | ----------------------------------------------------------- |
| type     | [SensorId](#sensorid9).PROXIMITY                        | 是   | 传感器类型,该值固定为SensorId.PROXIMITY。                  |
| callback | Callback&lt;[ProximityResponse](#proximityresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为ProximityResponse。     |
| options  | [Options](#options)                                     | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。 |
C
cff-gite 已提交
845

C
cff-gite 已提交
846 847
**错误码**

C
cff-gite 已提交
848
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
849 850 851 852 853

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
854 855
**示例:** 

L
li-yaoyao777 已提交
856
```ts
L
li-yaoyao777 已提交
857 858 859
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
860
try {
L
li-yaoyao777 已提交
861
  sensor.on(sensor.SensorId.PROXIMITY, (data: sensor.ProximityResponse) => {
L
li-yaoyao777 已提交
862 863 864
    console.info('Succeeded in invoking on. Distance: ' + data.distance);
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
865 866
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
867
}
C
cff-gite 已提交
868 869
```

C
cff-gite 已提交
870
### ROTATION_VECTOR<sup>9+</sup>
C
cff-gite 已提交
871 872 873 874 875 876 877 878 879 880 881 882

on(type: SensorId.ROTATION_VECTOR, callback: Callback&lt;RotationVectorResponse&gt;,
        options?: Options): void

订阅旋转矢量传感器数据。

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

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
883
| type     | [SensorId](#sensorid9).ROTATION_VECTOR                       | 是   | 传感器类型,该值固定为SensorId.ROTATION_VECTOR。             |
H
h00514358 已提交
884
| callback | Callback&lt;[RotationVectorResponse](#rotationvectorresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为RotationVectorResponse。 |
L
li-yaoyao777 已提交
885
| options  | [Options](#options)                                          | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
C
cff-gite 已提交
886

C
cff-gite 已提交
887 888
**错误码**

C
cff-gite 已提交
889
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
890 891 892 893 894

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
895 896
**示例:** 

L
li-yaoyao777 已提交
897
```ts
L
li-yaoyao777 已提交
898 899 900
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
901
try {
L
li-yaoyao777 已提交
902
  sensor.on(sensor.SensorId.ROTATION_VECTOR, (data: sensor.RotationVectorResponse) => {
L
li-yaoyao777 已提交
903 904 905 906 907 908
    console.info('Succeeded in invoking on. X-coordinate component: ' + data.x);
    console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y);
    console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z);
    console.info('Succeeded in invoking on. Scalar quantity: ' + data.w);
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
909 910
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
911
}
C
cff-gite 已提交
912 913
```

C
cff-gite 已提交
914
### SIGNIFICANT_MOTION<sup>9+</sup>
C
cff-gite 已提交
915 916 917 918

on(type: SensorId.SIGNIFICANT_MOTION, callback: Callback&lt;SignificantMotionResponse&gt;,
        options?: Options): void

H
h00514358 已提交
919
订阅大幅动作检测传感器数据。
C
cff-gite 已提交
920 921 922 923 924 925 926

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

**参数:** 

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
927
| type     | [SensorId](#sensorid9).SIGNIFICANT_MOTION                    | 是   | 传感器类型,该值固定为SensorId.SIGNIFICANT_MOTION。          |
H
h00514358 已提交
928
| callback | Callback&lt;[SignificantMotionResponse](#significantmotionresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为SignificantMotionResponse。 |
L
li-yaoyao777 已提交
929
| options  | [Options](#options)                                          | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
C
cff-gite 已提交
930

C
cff-gite 已提交
931 932
**错误码**

C
cff-gite 已提交
933
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
934 935 936 937 938

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
939 940
**示例:** 

L
li-yaoyao777 已提交
941
```ts
L
li-yaoyao777 已提交
942 943 944
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
945
try {
L
li-yaoyao777 已提交
946
  sensor.on(sensor.SensorId.SIGNIFICANT_MOTION, (data: sensor.SignificantMotionResponse) => {
L
li-yaoyao777 已提交
947 948 949
    console.info('Succeeded in invoking on. Scalar data: ' + data.scalar);
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
950 951
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
952
}
C
cff-gite 已提交
953 954
```

C
cff-gite 已提交
955
###  WEAR_DETECTION<sup>9+</sup>
C
cff-gite 已提交
956 957 958 959

on(type: SensorId.WEAR_DETECTION, callback: Callback&lt;WearDetectionResponse&gt;,
        options?: Options): void

C
cff-gite 已提交
960
订阅佩戴检测传感器数据。
C
cff-gite 已提交
961 962 963 964 965

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

**参数:** 

C
cff-gite 已提交
966 967 968
| 参数名   | 类型                                                         | 必填 | 说明                                                        |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
| type     | [SensorId](#sensorid9).WEAR_DETECTION                        | 是   | 传感器类型,该值固定为SensorId.WEAR_DETECTION。             |
H
h00514358 已提交
969
| callback | Callback&lt;[WearDetectionResponse](#weardetectionresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为WearDetectionResponse。 |
L
li-yaoyao777 已提交
970
| options  | [Options](#options)                                          | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。 |
C
cff-gite 已提交
971

C
cff-gite 已提交
972 973
**错误码**

C
cff-gite 已提交
974
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
975 976 977 978 979

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
980 981
**示例:** 

L
li-yaoyao777 已提交
982
```ts
L
li-yaoyao777 已提交
983 984 985
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
986
try {
L
li-yaoyao777 已提交
987
  sensor.on(sensor.SensorId.WEAR_DETECTION, (data: sensor.WearDetectionResponse) => {
L
li-yaoyao777 已提交
988 989 990
    console.info('Succeeded in invoking on. Wear status: ' + data.value);
  }, { interval: 100000000 });
} catch (error) {
L
li-yaoyao777 已提交
991 992
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke on. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
993
}
C
cff-gite 已提交
994 995
```

C
cff-gite 已提交
996
## sensor.once<sup>9+</sup>
C
cff-gite 已提交
997

C
cff-gite 已提交
998
### ACCELEROMETER<sup>9+</sup>
C
cff-gite 已提交
999 1000 1001

once(type: SensorId.ACCELEROMETER, callback: Callback&lt;AccelerometerResponse&gt;): void

H
h00514358 已提交
1002
获取一次加速度传感器数据。
C
cff-gite 已提交
1003 1004 1005 1006 1007 1008 1009

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

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

**参数:** 

C
cff-gite 已提交
1010 1011 1012
| 参数名   | 类型                                                         | 必填 | 说明                                                        |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
| type     | [SensorId](#sensorid9).ACCELEROMETER                         | 是   | 传感器类型,该值固定为SensorId.ACCELEROMETER。              |
H
h00514358 已提交
1013
| callback | Callback&lt;[AccelerometerResponse](#accelerometerresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为AccelerometerResponse。 |
C
cff-gite 已提交
1014

C
cff-gite 已提交
1015 1016
**错误码**

C
cff-gite 已提交
1017
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
1018 1019 1020 1021 1022

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
1023 1024
**示例:** 

L
li-yaoyao777 已提交
1025
```ts
L
li-yaoyao777 已提交
1026 1027 1028
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
1029
try {
L
li-yaoyao777 已提交
1030
  sensor.once(sensor.SensorId.ACCELEROMETER, (data: sensor.AccelerometerResponse) => {
L
li-yaoyao777 已提交
1031 1032 1033 1034 1035
    console.info('Succeeded in invoking once. X-coordinate component: ' + data.x);
    console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y);
    console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z);
  });
} catch (error) {
L
li-yaoyao777 已提交
1036 1037
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
1038
}
C
cff-gite 已提交
1039 1040
```

C
cff-gite 已提交
1041
### ACCELEROMETER_UNCALIBRATED<sup>9+</sup>
C
cff-gite 已提交
1042

L
li-yaoyao777 已提交
1043
once(type: SensorId.ACCELEROMETER_UNCALIBRATED, callback: Callback&lt;AccelerometerUncalibratedResponse&gt;): voidMAGNETIC_FIELD
C
cff-gite 已提交
1044

H
h00514358 已提交
1045
获取一次未校准加速度传感器数据。
C
cff-gite 已提交
1046 1047 1048 1049 1050 1051 1052 1053 1054

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

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

**参数:** 

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
1055
| type     | [SensorId](#sensorid9).ACCELEROMETER_UNCALIBRATED            | 是   | 传感器类型,该值固定为SensorId.ACCELEROMETER_UNCALIBRATED。  |
H
h00514358 已提交
1056
| callback | Callback&lt;[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为AccelerometerUncalibratedResponse。 |
C
cff-gite 已提交
1057

C
cff-gite 已提交
1058 1059
**错误码**

C
cff-gite 已提交
1060
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
1061 1062 1063 1064 1065

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
1066 1067
**示例:** 

L
li-yaoyao777 已提交
1068
```ts
L
li-yaoyao777 已提交
1069 1070 1071
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
1072
try {
L
li-yaoyao777 已提交
1073
  sensor.once(sensor.SensorId.ACCELEROMETER_UNCALIBRATED, (data: sensor.AccelerometerUncalibratedResponse) => {
L
li-yaoyao777 已提交
1074 1075 1076 1077 1078 1079 1080 1081
    console.info('Succeeded in invoking once. X-coordinate component: ' + data.x);
    console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y);
    console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z);
    console.info('Succeeded in invoking once. X-coordinate bias: ' + data.biasX);
    console.info('Succeeded in invoking once. Y-coordinate bias: ' + data.biasY);
    console.info('Succeeded in invoking once. Z-coordinate bias: ' + data.biasZ);
  });
} catch (error) {
L
li-yaoyao777 已提交
1082 1083
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
1084
}
C
cff-gite 已提交
1085 1086
```

C
cff-gite 已提交
1087
### AMBIENT_LIGHT<sup>9+</sup>
C
cff-gite 已提交
1088 1089 1090

once(type: SensorId.AMBIENT_LIGHT, callback: Callback&lt;LightResponse&gt;): void

H
h00514358 已提交
1091
获取一次环境光传感器数据。
C
cff-gite 已提交
1092 1093 1094 1095 1096

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

**参数:** 

C
cff-gite 已提交
1097 1098 1099
| 参数名   | 类型                                            | 必填 | 说明                                                |
| -------- | ----------------------------------------------- | ---- | --------------------------------------------------- |
| type     | [SensorId](#sensorid9).AMBIENT_LIGHT            | 是   | 传感器类型,该值固定为SensorId.AMBIENT_LIGHT。      |
H
h00514358 已提交
1100
| callback | Callback&lt;[LightResponse](#lightresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为LightResponse。 |
C
cff-gite 已提交
1101

C
cff-gite 已提交
1102 1103
**错误码**

C
cff-gite 已提交
1104
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
1105 1106 1107 1108 1109

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
1110 1111
**示例:** 

L
li-yaoyao777 已提交
1112
```ts
L
li-yaoyao777 已提交
1113 1114 1115
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
1116
try {
L
li-yaoyao777 已提交
1117
  sensor.once(sensor.SensorId.AMBIENT_LIGHT, (data: sensor.LightResponse) => {
L
li-yaoyao777 已提交
1118 1119 1120
    console.info('Succeeded in invoking once. the ambient light intensity: ' + data.intensity);
  });
} catch (error) {
L
li-yaoyao777 已提交
1121 1122
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
1123
}
C
cff-gite 已提交
1124 1125
```

C
cff-gite 已提交
1126
### AMBIENT_TEMPERATURE<sup>9+</sup>
C
cff-gite 已提交
1127 1128 1129

once(type: SensorId.AMBIENT_TEMPERATURE, callback: Callback&lt;AmbientTemperatureResponse&gt;): void

H
h00514358 已提交
1130
获取一次温度传感器数据。
C
cff-gite 已提交
1131 1132

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

C
cff-gite 已提交
1134 1135 1136 1137
**参数:** 

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
1138
| type     | [SensorId](#sensorid9).AMBIENT_TEMPERATURE                   | 是   | 传感器类型,该值固定为SensorId.AMBIENT_TEMPERATURE。         |
H
h00514358 已提交
1139
| callback | Callback&lt;[AmbientTemperatureResponse](#ambienttemperatureresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为AmbientTemperatureResponse。 |
C
cff-gite 已提交
1140

C
cff-gite 已提交
1141 1142
**错误码**

C
cff-gite 已提交
1143
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
1144 1145 1146 1147 1148

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
1149 1150
**示例:** 

L
li-yaoyao777 已提交
1151
```ts
L
li-yaoyao777 已提交
1152 1153 1154
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
1155
try {
L
li-yaoyao777 已提交
1156
  sensor.once(sensor.SensorId.AMBIENT_TEMPERATURE, (data: sensor.AmbientTemperatureResponse) => {
L
li-yaoyao777 已提交
1157 1158 1159
    console.info('Succeeded in invoking once. Temperature: ' + data.temperature);
  });
} catch (error) {
L
li-yaoyao777 已提交
1160 1161
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
1162
}
C
cff-gite 已提交
1163 1164
```

C
cff-gite 已提交
1165
### BAROMETER<sup>9+</sup>
C
cff-gite 已提交
1166 1167 1168

once(type: SensorId.BAROMETER, callback: Callback&lt;BarometerResponse&gt;): void

H
h00514358 已提交
1169
获取一次气压计传感器数据。
C
cff-gite 已提交
1170 1171

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

C
cff-gite 已提交
1173 1174
**参数:**

C
cff-gite 已提交
1175 1176 1177
| 参数名   | 类型                                                    | 必填 | 说明                                                    |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------- |
| type     | [SensorId](#sensorid9).BAROMETER                        | 是   | 传感器类型,该值固定为SensorId.BAROMETER。              |
H
h00514358 已提交
1178
| callback | Callback&lt;[BarometerResponse](#barometerresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为BarometerResponse。 |
C
cff-gite 已提交
1179

C
cff-gite 已提交
1180 1181
**错误码**

C
cff-gite 已提交
1182
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
1183 1184 1185 1186 1187

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
1188 1189
**示例:** 

L
li-yaoyao777 已提交
1190
```ts
L
li-yaoyao777 已提交
1191 1192 1193
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
1194
try {
L
li-yaoyao777 已提交
1195
  sensor.once(sensor.SensorId.BAROMETER, (data: sensor.BarometerResponse) => {
L
li-yaoyao777 已提交
1196 1197 1198
    console.info('Succeeded in invoking once. Atmospheric pressure: ' + data.pressure);
  });
} catch (error) {
L
li-yaoyao777 已提交
1199 1200
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
1201
}
C
cff-gite 已提交
1202 1203
```

C
cff-gite 已提交
1204
### GRAVITY<sup>9+</sup>
C
cff-gite 已提交
1205 1206 1207

once(type: SensorId.GRAVITY, callback: Callback&lt;GravityResponse&gt;): void

H
h00514358 已提交
1208
获取一次重力传感器数据。
C
cff-gite 已提交
1209 1210 1211 1212 1213

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

**参数:**

C
cff-gite 已提交
1214 1215 1216
| 参数名   | 类型                                                | 必填 | 说明                                                  |
| -------- | --------------------------------------------------- | ---- | ----------------------------------------------------- |
| type     | [SensorId](#sensorid9).GRAVITY                      | 是   | 传感器类型,该值固定为SensorId.GRAVITY。              |
H
h00514358 已提交
1217
| callback | Callback&lt;[GravityResponse](#gravityresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为GravityResponse。 |
C
cff-gite 已提交
1218

C
cff-gite 已提交
1219 1220
**错误码**

C
cff-gite 已提交
1221
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
1222 1223 1224 1225 1226

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
1227 1228
**示例:**

L
li-yaoyao777 已提交
1229
```ts
L
li-yaoyao777 已提交
1230 1231 1232
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
1233
try {
L
li-yaoyao777 已提交
1234
  sensor.once(sensor.SensorId.GRAVITY, (data: sensor.GravityResponse) => {
L
li-yaoyao777 已提交
1235 1236 1237 1238 1239
    console.info('Succeeded in invoking once. X-coordinate component: ' + data.x);
    console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y);
    console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z);
  });
} catch (error) {
L
li-yaoyao777 已提交
1240 1241
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
1242
}
C
cff-gite 已提交
1243 1244
```

C
cff-gite 已提交
1245
### GYROSCOPE<sup>9+</sup>
C
cff-gite 已提交
1246 1247 1248

once(type: SensorId.GYROSCOPE, callback: Callback&lt;GyroscopeResponse&gt;): void

H
h00514358 已提交
1249
获取一次陀螺仪传感器数据。
C
cff-gite 已提交
1250 1251 1252 1253 1254 1255 1256

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

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

**参数:** 

C
cff-gite 已提交
1257 1258 1259
| 参数名   | 类型                                                    | 必填 | 说明                                                    |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------- |
| type     | [SensorId](#sensorid9).GYROSCOPE                        | 是   | 传感器类型,该值固定为SensorId.GYROSCOPE。              |
H
h00514358 已提交
1260
| callback | Callback&lt;[GyroscopeResponse](#gyroscoperesponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为GyroscopeResponse。 |
C
cff-gite 已提交
1261

C
cff-gite 已提交
1262 1263
**错误码**

C
cff-gite 已提交
1264
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
1265 1266 1267 1268 1269

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
1270 1271
**示例:**

L
li-yaoyao777 已提交
1272 1273
```ts
import sensor from '@ohos.sensor';
L
li-yaoyao777 已提交
1274
import BusinessError from "@ohos.base"
L
li-yaoyao777 已提交
1275

C
cff-gite 已提交
1276
try {
L
li-yaoyao777 已提交
1277
  sensor.once(sensor.SensorId.GYROSCOPE, (data: sensor.GyroscopeResponse) => {
L
li-yaoyao777 已提交
1278 1279 1280 1281 1282
    console.info('Succeeded in invoking once. X-coordinate component: ' + data.x);
    console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y);
    console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z);
  });
} catch (error) {
L
li-yaoyao777 已提交
1283 1284
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
1285
}
C
cff-gite 已提交
1286 1287
```

C
cff-gite 已提交
1288
### GYROSCOPE_UNCALIBRATED<sup>9+</sup>
C
cff-gite 已提交
1289

C
cff-gite 已提交
1290
once(type: SensorId.GYROSCOPE_UNCALIBRATED, callback: Callback&lt;GyroscopeUncalibratedResponse&gt;): void
C
cff-gite 已提交
1291

H
h00514358 已提交
1292
获取一次未校准陀螺仪传感器数据。
C
cff-gite 已提交
1293 1294 1295 1296 1297 1298 1299 1300 1301

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

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

**参数:** 

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
1302
| type     | [SensorId](#sensorid9).GYROSCOPE_UNCALIBRATED                | 是   | 传感器类型,该值固定为SensorId.GYROSCOPE_UNCALIBRATED。      |
H
h00514358 已提交
1303
| callback | Callback&lt;[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为GyroscopeUncalibratedResponse。 |
C
cff-gite 已提交
1304

C
cff-gite 已提交
1305 1306
**错误码**

C
cff-gite 已提交
1307
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
1308 1309 1310 1311 1312

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
1313 1314
**示例:**

L
li-yaoyao777 已提交
1315
```ts
L
li-yaoyao777 已提交
1316 1317 1318
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
1319
try {
L
li-yaoyao777 已提交
1320
  sensor.once(sensor.SensorId.GYROSCOPE_UNCALIBRATED, (data: sensor.GyroscopeUncalibratedResponse) => {
L
li-yaoyao777 已提交
1321 1322 1323 1324 1325 1326 1327 1328
    console.info('Succeeded in invoking once. X-coordinate component: ' + data.x);
    console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y);
    console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z);
    console.info('Succeeded in invoking once. X-coordinate bias: ' + data.biasX);
    console.info('Succeeded in invoking once. Y-coordinate bias: ' + data.biasY);
    console.info('Succeeded in invoking once. Z-coordinate bias: ' + data.biasZ);
  });
} catch (error) {
L
li-yaoyao777 已提交
1329 1330
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
1331
}
C
cff-gite 已提交
1332 1333
```

C
cff-gite 已提交
1334
### HALL<sup>9+</sup>
C
cff-gite 已提交
1335 1336 1337

once(type: SensorId.HALL, callback: Callback&lt;HallResponse&gt;): void

H
h00514358 已提交
1338
获取霍尔传感器数据。
C
cff-gite 已提交
1339 1340 1341 1342 1343

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

**参数:** 

C
cff-gite 已提交
1344 1345 1346
| 参数名   | 类型                                          | 必填 | 说明                                               |
| -------- | --------------------------------------------- | ---- | -------------------------------------------------- |
| type     | [SensorId](#sensorid9).HALL                   | 是   | 传感器类型,该值固定为SensorId.HALL。              |
H
h00514358 已提交
1347
| callback | Callback&lt;[HallResponse](#hallresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为HallResponse。 |
C
cff-gite 已提交
1348

C
cff-gite 已提交
1349 1350
**错误码**

C
cff-gite 已提交
1351
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
1352 1353 1354 1355 1356

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
1357 1358
**示例:**

L
li-yaoyao777 已提交
1359
```ts
L
li-yaoyao777 已提交
1360 1361 1362
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
1363
try {
L
li-yaoyao777 已提交
1364
  sensor.once(sensor.SensorId.HALL, (data: sensor.HallResponse) => {
L
li-yaoyao777 已提交
1365 1366 1367
    console.info('Succeeded in invoking once. Status: ' + data.status);
  });
} catch (error) {
L
li-yaoyao777 已提交
1368 1369
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
1370
}
C
cff-gite 已提交
1371 1372
```

C
cff-gite 已提交
1373 1374 1375 1376
### HEART_RATE<sup>9+</sup>

once(type: SensorId.HEART_RATE, callback: Callback&lt;HeartRateResponse&gt;): void

H
h00514358 已提交
1377
获取一次心率传感器数据。
C
cff-gite 已提交
1378 1379 1380 1381 1382 1383 1384

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

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

**参数:** 

C
cff-gite 已提交
1385 1386 1387
| 参数名   | 类型                                                    | 必填 | 说明                                                    |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------- |
| type     | [SensorId](#sensorid9).HEART_RATE                       | 是   | 传感器类型,该值固定为SensorId.HEART_RATE。             |
H
h00514358 已提交
1388
| callback | Callback&lt;[HeartRateResponse](#heartrateresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为HeartRateResponse。 |
C
cff-gite 已提交
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399

**错误码**

以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

**示例:**

L
li-yaoyao777 已提交
1400
```ts
L
li-yaoyao777 已提交
1401 1402 1403
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
1404
try {
L
li-yaoyao777 已提交
1405
  sensor.once(sensor.SensorId.HEART_RATE, (data: sensor.HeartRateResponse) => {
L
li-yaoyao777 已提交
1406 1407 1408
    console.info('Succeeded in invoking once. Heart rate: ' + data.heartRate);
  });
} catch (error) {
L
li-yaoyao777 已提交
1409 1410
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
1411 1412 1413
}
```

C
cff-gite 已提交
1414 1415 1416 1417
### HUMIDITY<sup>9+</sup>

once(type: SensorId.HUMIDITY, callback: Callback&lt;HumidityResponse&gt;): void

H
h00514358 已提交
1418
获取一次湿度传感器数据。
C
cff-gite 已提交
1419 1420 1421 1422 1423

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

**参数:** 

C
cff-gite 已提交
1424 1425 1426
| 参数名   | 类型                                                  | 必填 | 说明                                                   |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------ |
| type     | [SensorId](#sensorid9).HUMIDITY                       | 是   | 传感器类型,该值固定为SensorId.HUMIDITY。              |
H
h00514358 已提交
1427
| callback | Callback&lt;[HumidityResponse](#humidityresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为HumidityResponse。 |
C
cff-gite 已提交
1428

C
cff-gite 已提交
1429 1430
**错误码**

C
cff-gite 已提交
1431
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
1432 1433 1434 1435 1436

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
1437 1438
**示例:**

L
li-yaoyao777 已提交
1439
```ts
L
li-yaoyao777 已提交
1440 1441 1442
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
1443
try {
L
li-yaoyao777 已提交
1444 1445
  sensor.once(sensor.SensorId.HEART_RATE, (data: sensor.HeartRateResponse) => {
    console.info('Succeeded in invoking once. Heart rate: ' + data.heartRate);
L
li-yaoyao777 已提交
1446 1447
  });
} catch (error) {
L
li-yaoyao777 已提交
1448 1449
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
1450
}
C
cff-gite 已提交
1451 1452
```

C
cff-gite 已提交
1453
### LINEAR_ACCELEROMETER<sup>9+</sup>
C
cff-gite 已提交
1454 1455 1456

once(type: SensorId.LINEAR_ACCELEROMETER, callback: Callback&lt;LinearAccelerometerResponse&gt;): void

H
h00514358 已提交
1457
获取一次线性加速度传感器数据。
C
cff-gite 已提交
1458 1459 1460 1461 1462 1463 1464 1465 1466

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

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

**参数:** 

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
1467
| type     | [SensorId](#sensorid9).LINEAR_ACCELEROMETER                  | 是   | 传感器类型,该值固定为SensorId.LINEAR_ACCELEROMETER。        |
H
h00514358 已提交
1468
| callback | Callback&lt;[LinearAccelerometerResponse](#linearaccelerometerresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为LinearAccelerometerResponse。 |
C
cff-gite 已提交
1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479

**错误码**

以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

**示例:**

L
li-yaoyao777 已提交
1480
```ts
L
li-yaoyao777 已提交
1481 1482 1483
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
1484
try {
L
li-yaoyao777 已提交
1485
  sensor.once(sensor.SensorId.LINEAR_ACCELEROMETER, (data: sensor.LinearAccelerometerResponse) => {
L
li-yaoyao777 已提交
1486 1487 1488 1489 1490
    console.info('Succeeded in invoking once. X-coordinate component: ' + data.x);
    console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y);
    console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z);
  });
} catch (error) {
L
li-yaoyao777 已提交
1491 1492
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
1493 1494 1495
}
```

C
cff-gite 已提交
1496 1497 1498 1499
### MAGNETIC_FIELD<sup>9+</sup>

once(type: SensorId.MAGNETIC_FIELD, callback: Callback&lt;MagneticFieldResponse&gt;): void

H
h00514358 已提交
1500
获取一次磁场传感器数据。
C
cff-gite 已提交
1501 1502 1503 1504 1505

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

**参数:**

C
cff-gite 已提交
1506 1507 1508
| 参数名   | 类型                                                         | 必填 | 说明                                                        |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
| type     | [SensorId](#sensorid9).MAGNETIC_FIELD                        | 是   | 传感器类型,该值固定为SensorId.MAGNETIC_FIELD。             |
H
h00514358 已提交
1509
| callback | Callback&lt;[MagneticFieldResponse](#magneticfieldresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为MagneticFieldResponse。 |
C
cff-gite 已提交
1510

C
cff-gite 已提交
1511 1512
**错误码**

C
cff-gite 已提交
1513
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
1514 1515 1516 1517 1518

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
1519 1520
**示例:**

L
li-yaoyao777 已提交
1521
```ts
L
li-yaoyao777 已提交
1522 1523 1524
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
1525
try {
L
li-yaoyao777 已提交
1526
  sensor.once(sensor.SensorId.MAGNETIC_FIELD, (data: sensor.MagneticFieldResponse) => {
L
li-yaoyao777 已提交
1527 1528 1529 1530 1531
    console.info('Succeeded in invoking once. X-coordinate component: ' + data.x);
    console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y);
    console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z);
  });
} catch (error) {
L
li-yaoyao777 已提交
1532 1533
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
1534
}
C
cff-gite 已提交
1535 1536 1537 1538
```

### MAGNETIC_FIELD_UNCALIBRATED<sup>9+</sup>

C
cff-gite 已提交
1539
once(type: SensorId.MAGNETIC_FIELD_UNCALIBRATED, callback: Callback&lt;MagneticFieldUncalibratedResponse&gt;): void
C
cff-gite 已提交
1540

H
h00514358 已提交
1541
获取一次未经校准的磁场传感器数据。
C
cff-gite 已提交
1542 1543 1544 1545 1546 1547 1548

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

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
1549
| type     | [SensorId](#sensorid9).MAGNETIC_FIELD_UNCALIBRATED           | 是   | 传感器类型,该值固定为SensorId.MAGNETIC_FIELD_UNCALIBRATED。 |
H
h00514358 已提交
1550
| callback | Callback&lt;[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为MagneticFieldUncalibratedResponse。 |
C
cff-gite 已提交
1551

C
cff-gite 已提交
1552 1553
**错误码**

C
cff-gite 已提交
1554
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
1555 1556 1557 1558 1559

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
1560 1561
**示例:**

L
li-yaoyao777 已提交
1562
```ts
L
li-yaoyao777 已提交
1563 1564 1565
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
1566
try {
L
li-yaoyao777 已提交
1567
  sensor.once(sensor.SensorId.MAGNETIC_FIELD_UNCALIBRATED, (data: sensor.MagneticFieldUncalibratedResponse) => {
L
li-yaoyao777 已提交
1568 1569 1570 1571 1572 1573 1574 1575
    console.info('Succeeded in invoking once. X-coordinate component: ' + data.x);
    console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y);
    console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z);
    console.info('Succeeded in invoking once. X-coordinate bias: ' + data.biasX);
    console.info('Succeeded in invoking once. Y-coordinate bias: ' + data.biasY);
    console.info('Succeeded in invoking once. Z-coordinate bias: ' + data.biasZ);
  });
} catch (error) {
L
li-yaoyao777 已提交
1576 1577
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
1578
}
C
cff-gite 已提交
1579 1580 1581 1582 1583 1584
```

### ORIENTATION<sup>9+</sup>

once(type: SensorId.ORIENTATION, callback: Callback&lt;OrientationResponse&gt;): void

H
h00514358 已提交
1585
获取一次方向传感器数据。
C
cff-gite 已提交
1586 1587 1588 1589 1590

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

**参数:** 

C
cff-gite 已提交
1591 1592 1593
| 参数名   | 类型                                                        | 必填 | 说明                                                      |
| -------- | ----------------------------------------------------------- | ---- | --------------------------------------------------------- |
| type     | [SensorId](#sensorid9).ORIENTATION                          | 是   | 传感器类型,该值固定为SensorId.ORIENTATION。              |
H
h00514358 已提交
1594
| callback | Callback&lt;[OrientationResponse](#orientationresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为OrientationResponse。 |
C
cff-gite 已提交
1595

C
cff-gite 已提交
1596 1597
**错误码**

L
li-yaoyao777 已提交
1598
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)。AMBIENT_LIGHT
C
cff-gite 已提交
1599 1600 1601 1602 1603

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
1604 1605
**示例:**

L
li-yaoyao777 已提交
1606
```ts
L
li-yaoyao777 已提交
1607 1608 1609
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
1610
try {
L
li-yaoyao777 已提交
1611
  sensor.once(sensor.SensorId.ORIENTATION, (data: sensor.OrientationResponse) => {
L
li-yaoyao777 已提交
1612 1613 1614 1615 1616
    console.info('Succeeded in the device rotating at an angle around the X axis: ' + data.beta);
    console.info('Succeeded in the device rotating at an angle around the Y axis: ' + data.gamma);
    console.info('Succeeded in the device rotating at an angle around the Z axis: ' + data.alpha);
  });
} catch (error) {
L
li-yaoyao777 已提交
1617 1618
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
1619
}
C
cff-gite 已提交
1620 1621 1622 1623 1624 1625
```

### PEDOMETER<sup>9+</sup>

once(type: SensorId.PEDOMETER, callback: Callback&lt;PedometerResponse&gt;): void

H
h00514358 已提交
1626
获取一次计步器传感器数据。
C
cff-gite 已提交
1627 1628 1629 1630 1631 1632 1633

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

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

**参数:**

C
cff-gite 已提交
1634 1635 1636
| 参数名   | 类型                                                    | 必填 | 说明                                                    |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------- |
| type     | [SensorId](#sensorid9).PEDOMETER                        | 是   | 传感器类型,该值固定为SensorId.PEDOMETER。              |
H
h00514358 已提交
1637
| callback | Callback&lt;[PedometerResponse](#pedometerresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为PedometerResponse。 |
C
cff-gite 已提交
1638

C
cff-gite 已提交
1639 1640
**错误码**

C
cff-gite 已提交
1641
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
1642 1643 1644 1645 1646

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
1647 1648
**示例:**

L
li-yaoyao777 已提交
1649
```ts
L
li-yaoyao777 已提交
1650 1651 1652
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
1653
try {
L
li-yaoyao777 已提交
1654
  sensor.once(sensor.SensorId.PEDOMETER, (data: sensor.PedometerResponse) => {
L
li-yaoyao777 已提交
1655 1656 1657
    console.info('Succeeded in invoking once. Step count: ' + data.steps);
  });
} catch (error) {
L
li-yaoyao777 已提交
1658 1659
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
1660
}
C
cff-gite 已提交
1661 1662 1663 1664 1665
```

### PEDOMETER_DETECTION<sup>9+</sup>

once(type: SensorId.PEDOMETER_DETECTION, callback: Callback&lt;PedometerDetectionResponse&gt;): void
H
update  
h00514358 已提交
1666

H
h00514358 已提交
1667
获取一次计步检测器传感器数据。
C
cff-gite 已提交
1668 1669 1670 1671 1672 1673 1674 1675 1676

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

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

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
1677
| type     | [SensorId](#sensorid9).PEDOMETER_DETECTION                   | 是   | 传感器类型,该值固定为SensorId.PEDOMETER_DETECTION。         |
H
h00514358 已提交
1678
| callback | Callback&lt;[PedometerDetectionResponse](#pedometerdetectionresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为PedometerDetectionResponse。 |
C
cff-gite 已提交
1679

C
cff-gite 已提交
1680 1681
**错误码**

C
cff-gite 已提交
1682
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
1683 1684 1685 1686 1687

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
1688 1689
**示例:**

L
li-yaoyao777 已提交
1690
```ts
L
li-yaoyao777 已提交
1691 1692 1693
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
1694
try {
L
li-yaoyao777 已提交
1695
  sensor.once(sensor.SensorId.PEDOMETER_DETECTION, (data: sensor.PedometerDetectionResponse) => {
L
li-yaoyao777 已提交
1696 1697 1698
    console.info('Succeeded in invoking once. Scalar data: ' + data.scalar);
  });
} catch (error) {
L
li-yaoyao777 已提交
1699 1700
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
1701
}
C
cff-gite 已提交
1702 1703 1704 1705 1706 1707
```

### PROXIMITY<sup>9+</sup>

once(type: SensorId.PROXIMITY, callback: Callback&lt;ProximityResponse&gt;): void

H
h00514358 已提交
1708
获取一次接近光传感器数据。
C
cff-gite 已提交
1709 1710 1711 1712 1713

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

**参数:**

C
cff-gite 已提交
1714 1715 1716
| 参数名   | 类型                                                    | 必填 | 说明                                                    |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------- |
| type     | [SensorId](#sensorid9).PROXIMITY                        | 是   | 传感器类型,该值固定为SensorId.PROXIMITY。              |
H
h00514358 已提交
1717
| callback | Callback&lt;[ProximityResponse](#proximityresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为ProximityResponse。 |
C
cff-gite 已提交
1718

C
cff-gite 已提交
1719 1720
**错误码**

C
cff-gite 已提交
1721
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
1722 1723 1724 1725 1726

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
1727 1728
**示例:**

L
li-yaoyao777 已提交
1729
```ts
L
li-yaoyao777 已提交
1730 1731 1732
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
1733
try {
L
li-yaoyao777 已提交
1734
  sensor.once(sensor.SensorId.PROXIMITY, (data: sensor.ProximityResponse) => {
L
li-yaoyao777 已提交
1735 1736 1737
    console.info('Succeeded in invoking once. Distance: ' + data.distance);
  });
} catch (error) {
L
li-yaoyao777 已提交
1738 1739
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
1740
}
C
cff-gite 已提交
1741 1742 1743 1744 1745 1746
```

### ROTATION_VECTOR<sup>9+</sup>

once(type: SensorId.ROTATION_VECTOR, callback: Callback&lt;RotationVectorResponse&gt;): void

H
h00514358 已提交
1747
获取一次旋转矢量传感器数据。
C
cff-gite 已提交
1748 1749 1750 1751 1752 1753 1754

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

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
1755
| type     | [SensorId](#sensorid9).ROTATION_VECTOR                       | 是   | 传感器类型,该值固定为SensorId.ROTATION_VECTOR。             |
H
h00514358 已提交
1756
| callback | Callback&lt;[RotationVectorResponse](#rotationvectorresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为RotationVectorResponse。 |
C
cff-gite 已提交
1757

C
cff-gite 已提交
1758 1759
**错误码**

C
cff-gite 已提交
1760
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
1761 1762 1763 1764 1765

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
1766 1767
**示例:** 

L
li-yaoyao777 已提交
1768
```ts
L
li-yaoyao777 已提交
1769 1770 1771
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
1772
try {
L
li-yaoyao777 已提交
1773
  sensor.once(sensor.SensorId.ROTATION_VECTOR, (data: sensor.RotationVectorResponse) => {
L
li-yaoyao777 已提交
1774 1775 1776 1777 1778 1779
    console.info('Succeeded in invoking once. X-coordinate component: ' + data.x);
    console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y);
    console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z);
    console.info('Succeeded in invoking once. Scalar quantity: ' + data.w);
  });
} catch (error) {
L
li-yaoyao777 已提交
1780 1781
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
1782
}
C
cff-gite 已提交
1783 1784 1785 1786 1787 1788
```

### SIGNIFICANT_MOTION<sup>9+</sup>

once(type: SensorId.SIGNIFICANT_MOTION, callback: Callback&lt;SignificantMotionResponse&gt;): void

H
h00514358 已提交
1789
获取一次大幅动作检测传感器数据。
C
cff-gite 已提交
1790 1791 1792 1793 1794 1795 1796

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

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
1797
| type     | [SensorId](#sensorid9).SIGNIFICANT_MOTION                    | 是   | 传感器类型,该值固定为SensorId.SIGNIFICANT_MOTION。          |
H
h00514358 已提交
1798
| callback | Callback&lt;[SignificantMotionResponse](#significantmotionresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为SignificantMotionResponse。 |
C
cff-gite 已提交
1799

C
cff-gite 已提交
1800 1801
**错误码**

C
cff-gite 已提交
1802
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
1803 1804 1805 1806 1807

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
1808 1809
**示例:** 

L
li-yaoyao777 已提交
1810
```ts
L
li-yaoyao777 已提交
1811 1812 1813
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
1814
try {
L
li-yaoyao777 已提交
1815
  sensor.once(sensor.SensorId.SIGNIFICANT_MOTION, (data: sensor.SignificantMotionResponse) => {
L
li-yaoyao777 已提交
1816 1817 1818
    console.info('Succeeded in invoking once. Scalar data: ' + data.scalar);
  });
} catch (error) {
L
li-yaoyao777 已提交
1819 1820
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
1821
}
C
cff-gite 已提交
1822 1823 1824 1825 1826 1827
```

### WEAR_DETECTION<sup>9+</sup>

once(type: SensorId.WEAR_DETECTION, callback: Callback&lt;WearDetectionResponse&gt;): void

H
h00514358 已提交
1828
获取一次佩戴检测传感器数据。
C
cff-gite 已提交
1829 1830 1831 1832 1833

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

**参数:**

C
cff-gite 已提交
1834 1835 1836
| 参数名   | 类型                                                         | 必填 | 说明                                                        |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- |
| type     | [SensorId](#sensorid9).WEAR_DETECTION                        | 是   | 传感器类型,该值固定为SensorId.WEAR_DETECTION。             |
H
h00514358 已提交
1837
| callback | Callback&lt;[WearDetectionResponse](#weardetectionresponse)&gt; | 是   | 回调函数,异步上报的传感器数据固定为WearDetectionResponse。 |
C
cff-gite 已提交
1838

C
cff-gite 已提交
1839 1840
**错误码**

C
cff-gite 已提交
1841
以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)
C
cff-gite 已提交
1842 1843 1844 1845 1846

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
1847 1848
**示例:** 

L
li-yaoyao777 已提交
1849
```ts
L
li-yaoyao777 已提交
1850 1851 1852
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
1853
try {
L
li-yaoyao777 已提交
1854
  sensor.once(sensor.SensorId.WEAR_DETECTION, (data: sensor.WearDetectionResponse) => {
L
li-yaoyao777 已提交
1855 1856 1857
    console.info('Succeeded in invoking once. Wear status: ' + data.value);
  });
} catch (error) {
L
li-yaoyao777 已提交
1858 1859
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke once. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
1860
}
C
cff-gite 已提交
1861 1862
```

L
li-yaoyao777 已提交
1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883
## sensor.off

### COLOR<sup>10+</sup>

off(type: SensorId.COLOR, callback?: Callback\<ColorResponse>): void

取消订阅颜色传感器数据。

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

**系统API**:此接口为系统接口

**参数:**

| 参数名   | 类型                                            | 必填 | 说明                                                         |
| -------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorId](#sensorid9).COLOR                    | 是   | 传感器类型,该值固定为SensorId.COLOR。                       |
| callback | Callback&lt;[ColorResponse](#colorresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |

**示例:**

L
li-yaoyao777 已提交
1884
```ts
L
li-yaoyao777 已提交
1885 1886 1887 1888
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
1889
  console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
L
li-yaoyao777 已提交
1890
}
L
li-yaoyao777 已提交
1891

L
li-yaoyao777 已提交
1892
function callback2(data: object) {
L
li-yaoyao777 已提交
1893
  console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
L
li-yaoyao777 已提交
1894
}
L
li-yaoyao777 已提交
1895

L
li-yaoyao777 已提交
1896
try {
L
li-yaoyao777 已提交
1897 1898 1899 1900 1901 1902 1903
  sensor.on(sensor.SensorId.COLOR, callback1);
  sensor.on(sensor.SensorId.COLOR, callback2);
  // 仅取消callback1的注册
  sensor.off(sensor.SensorId.COLOR, callback1);
  // 取消注册SensorId.COLOR的所有回调
  sensor.off(sensor.SensorId.COLOR);
} catch (error) {
L
li-yaoyao777 已提交
1904 1905
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
L
li-yaoyao777 已提交
1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927
}
```

### SAR<sup>10+</sup>

off(type: SensorId.SAR, callback?: Callback\<SarResponse>): void

取消订阅吸收比率传感器数据。

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

**系统API**:此接口为系统接口

**参数:**

| 参数名   | 类型                                     | 必填 | 说明                                                         |
| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorId](#sensorid9).SAR               | 是   | 传感器类型,该值固定为SensorId.SAR。                         |
| callback | Callback&lt;[SarResponse](#sarresponse)> | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |

**示例:**

L
li-yaoyao777 已提交
1928
```ts
L
li-yaoyao777 已提交
1929 1930 1931 1932
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
1933
  console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
L
li-yaoyao777 已提交
1934
}
L
li-yaoyao777 已提交
1935

L
li-yaoyao777 已提交
1936
function callback2(data: object) {
L
li-yaoyao777 已提交
1937
  console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
L
li-yaoyao777 已提交
1938
}
L
li-yaoyao777 已提交
1939

L
li-yaoyao777 已提交
1940
try {
L
li-yaoyao777 已提交
1941 1942 1943 1944 1945 1946 1947
  sensor.on(sensor.SensorId.SAR, callback1);
  sensor.on(sensor.SensorId.SAR, callback2);
  // 仅取消callback1的注册
  sensor.off(sensor.SensorId.SAR, callback1);
  // 取消注册SensorId.SAR的所有回调
  sensor.off(sensor.SensorId.SAR);
} catch (error) {
L
li-yaoyao777 已提交
1948 1949
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
L
li-yaoyao777 已提交
1950 1951
}
```
C
cff-gite 已提交
1952 1953 1954 1955 1956

### ACCELEROMETER<sup>9+</sup> 

off(type: SensorId.ACCELEROMETER, callback?: Callback&lt;AccelerometerResponse&gt;): void

H
h00514358 已提交
1957
取消订阅加速度传感器数据。
C
cff-gite 已提交
1958 1959 1960 1961 1962 1963 1964 1965 1966

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

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

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
1967
| type     | [SensorId](#sensorid9).ACCELEROMETER                         | 是   | 传感器类型,该值固定为SensorId.ACCELEROMETER。               |
H
h00514358 已提交
1968
| callback | Callback&lt;[AccelerometerResponse](#accelerometerresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
1969 1970 1971

**示例:**

L
li-yaoyao777 已提交
1972
```ts
L
li-yaoyao777 已提交
1973 1974 1975 1976
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
1977
  console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
H
h00514358 已提交
1978
}
L
li-yaoyao777 已提交
1979

L
li-yaoyao777 已提交
1980
function callback2(data: object) {
L
li-yaoyao777 已提交
1981
  console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
H
h00514358 已提交
1982
}
L
li-yaoyao777 已提交
1983

C
cff-gite 已提交
1984
try {
L
li-yaoyao777 已提交
1985 1986 1987 1988 1989 1990 1991
  sensor.on(sensor.SensorId.ACCELEROMETER, callback1);
  sensor.on(sensor.SensorId.ACCELEROMETER, callback2);
  // 仅取消callback1的注册
  sensor.off(sensor.SensorId.ACCELEROMETER, callback1);
  // 取消SensorId.ACCELEROMETER类型的所有回调
  sensor.off(sensor.SensorId.ACCELEROMETER);
} catch (error) {
L
li-yaoyao777 已提交
1992 1993
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
1994 1995 1996 1997 1998
}
```

### ACCELEROMETER_UNCALIBRATED<sup>9+</sup>  

C
cff-gite 已提交
1999
off(type: SensorId.ACCELEROMETER_UNCALIBRATED, callback?: Callback&lt;AccelerometerUncalibratedResponse&gt;): void
C
cff-gite 已提交
2000

H
h00514358 已提交
2001
取消订阅未校准加速度传感器数据。
C
cff-gite 已提交
2002 2003 2004 2005 2006 2007 2008 2009 2010

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

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

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
2011
| type     | [SensorId](#sensorid9).ACCELEROMETER_UNCALIBRATED            | 是   | 传感器类型,该值固定为SensorId.ACCELEROMETER_UNCALIBRATED。  |
H
update  
h00514358 已提交
2012
| callback | Callback&lt;[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
2013 2014 2015

**示例:**

L
li-yaoyao777 已提交
2016
```ts
L
li-yaoyao777 已提交
2017 2018 2019 2020
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
2021
  console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
H
h00514358 已提交
2022
}
L
li-yaoyao777 已提交
2023

L
li-yaoyao777 已提交
2024
function callback2(data: object) {
L
li-yaoyao777 已提交
2025
  console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
H
h00514358 已提交
2026
}
L
li-yaoyao777 已提交
2027

C
cff-gite 已提交
2028
try {
L
li-yaoyao777 已提交
2029 2030 2031 2032 2033 2034 2035
  sensor.on(sensor.SensorId.ACCELEROMETER_UNCALIBRATED, callback1);
  sensor.on(sensor.SensorId.ACCELEROMETER_UNCALIBRATED, callback2);
  // 仅取消callback1的注册
  sensor.off(sensor.SensorId.ACCELEROMETER_UNCALIBRATED, callback1);
  // 取消注册SensorId.ACCELEROMETER_UNCALIBRATED类型的所有回调
  sensor.off(sensor.SensorId.ACCELEROMETER_UNCALIBRATED);
} catch (error) {
L
li-yaoyao777 已提交
2036 2037
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052
}
```

### AMBIENT_LIGHT<sup>9+</sup> 

off(type: SensorId.AMBIENT_LIGHT, callback?: Callback&lt;LightResponse&gt;): void

取消订阅环境光传感器数据。

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

**参数:**

| 参数名   | 类型                                            | 必填 | 说明                                                         |
| -------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
2053
| type     | [SensorId](#sensorid9).AMBIENT_LIGHT            | 是   | 传感器类型,该值固定为SensorId.AMBIENT_LIGHT。               |
C
cff-gite 已提交
2054
| callback | Callback&lt;[LightResponse](#lightresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
2055 2056 2057

**示例:**

L
li-yaoyao777 已提交
2058
```ts
L
li-yaoyao777 已提交
2059 2060 2061 2062
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
2063
  console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
H
h00514358 已提交
2064
}
L
li-yaoyao777 已提交
2065

L
li-yaoyao777 已提交
2066
function callback2(data: object) {
L
li-yaoyao777 已提交
2067
  console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
C
cff-gite 已提交
2068
}
L
li-yaoyao777 已提交
2069

H
h00514358 已提交
2070
try {
L
li-yaoyao777 已提交
2071 2072 2073 2074 2075 2076 2077
  sensor.on(sensor.SensorId.AMBIENT_LIGHT, callback1);
  sensor.on(sensor.SensorId.AMBIENT_LIGHT, callback2);
  // 仅取消callback1的注册
  sensor.off(sensor.SensorId.AMBIENT_LIGHT, callback1);
  // 取消注册SensorId.AMBIENT_LIGHT
  sensor.off(sensor.SensorId.AMBIENT_LIGHT);
} catch (error) {
L
li-yaoyao777 已提交
2078 2079
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
2080
}
C
cff-gite 已提交
2081 2082 2083 2084 2085 2086
```

### AMBIENT_TEMPERATURE<sup>9+</sup> 

off(type: SensorId.AMBIENT_TEMPERATURE, callback?: Callback&lt;AmbientTemperatureResponse&gt;): void

H
h00514358 已提交
2087
取消订阅温度传感器数据。
C
cff-gite 已提交
2088 2089 2090 2091 2092 2093 2094

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

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
2095
| type     | [SensorId](#sensorid9).AMBIENT_TEMPERATURE                   | 是   | 传感器类型,该值固定为SensorId.AMBIENT_TEMPERATURE。         |
C
cff-gite 已提交
2096
| callback | Callback&lt;[AmbientTemperatureResponse](#ambienttemperatureresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
2097 2098 2099

**示例:**

L
li-yaoyao777 已提交
2100
```ts
L
li-yaoyao777 已提交
2101 2102 2103 2104
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
2105
  console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
H
h00514358 已提交
2106
}
L
li-yaoyao777 已提交
2107

L
li-yaoyao777 已提交
2108
function callback2(data: object) {
L
li-yaoyao777 已提交
2109
  console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
H
h00514358 已提交
2110
}
L
li-yaoyao777 已提交
2111

C
cff-gite 已提交
2112
try {
L
li-yaoyao777 已提交
2113 2114 2115 2116 2117 2118 2119
  sensor.on(sensor.SensorId.AMBIENT_TEMPERATURE, callback1);
  sensor.on(sensor.SensorId.AMBIENT_TEMPERATURE, callback2);
  // 仅取消callback1的注册
  sensor.off(sensor.SensorId.AMBIENT_TEMPERATURE, callback1);
  // 取消注册SensorId.AMBIENT_TEMPERATURE的所有回调
  sensor.off(sensor.SensorId.AMBIENT_TEMPERATURE);
} catch (error) {
L
li-yaoyao777 已提交
2120 2121
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136
}
```

### BAROMETER<sup>9+</sup>  

off(type: SensorId.BAROMETER, callback?: Callback&lt;BarometerResponse&gt;): void

取消订阅气压计传感器数据。

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

**参数:**

| 参数名   | 类型                                                    | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
2137
| type     | [SensorId](#sensorid9).BAROMETER                        | 是   | 传感器类型,该值固定为SensorId.BAROMETER。                   |
C
cff-gite 已提交
2138
| callback | Callback&lt;[BarometerResponse](#barometerresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
2139 2140 2141

**示例:**

L
li-yaoyao777 已提交
2142
```ts
L
li-yaoyao777 已提交
2143 2144 2145 2146
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
2147
    console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
H
h00514358 已提交
2148
}
L
li-yaoyao777 已提交
2149

L
li-yaoyao777 已提交
2150
function callback2(data: object) {
L
li-yaoyao777 已提交
2151
    console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
H
h00514358 已提交
2152
}
L
li-yaoyao777 已提交
2153

C
cff-gite 已提交
2154
try {
H
h00514358 已提交
2155 2156 2157 2158 2159 2160
    sensor.on(sensor.SensorId.BAROMETER, callback1);
    sensor.on(sensor.SensorId.BAROMETER, callback2);
    // 仅取消callback1的注册
    sensor.off(sensor.SensorId.BAROMETER, callback1);
    // 取消注册SensorId.BAROMETER的所有回调
    sensor.off(sensor.SensorId.BAROMETER);
L
li-yaoyao777 已提交
2161
} catch (error) {
L
li-yaoyao777 已提交
2162 2163
    let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
    console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178
}
```

### GRAVITY<sup>9+</sup> 

off(type: SensorId.GRAVITY, callback?: Callback&lt;GravityResponse&gt;): void

取消订阅重力传感器数据。

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

**参数:** 

| 参数名   | 类型                                                | 必填 | 说明                                                         |
| -------- | --------------------------------------------------- | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
2179
| type     | [SensorId](#sensorid9).GRAVITY                      | 是   | 传感器类型,该值固定为SensorId.GRAVITY。                     |
C
cff-gite 已提交
2180
| callback | Callback&lt;[GravityResponse](#gravityresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
2181 2182 2183

**示例:**

L
li-yaoyao777 已提交
2184
```ts
L
li-yaoyao777 已提交
2185 2186 2187 2188
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
2189
  console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
H
h00514358 已提交
2190
}
L
li-yaoyao777 已提交
2191

L
li-yaoyao777 已提交
2192
function callback2(data: object) {
L
li-yaoyao777 已提交
2193
  console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
H
h00514358 已提交
2194
}
L
li-yaoyao777 已提交
2195

C
cff-gite 已提交
2196
try {
L
li-yaoyao777 已提交
2197 2198 2199 2200 2201 2202 2203
  sensor.on(sensor.SensorId.GRAVITY, callback1);
  sensor.on(sensor.SensorId.GRAVITY, callback2);
  // 仅取消callback1的注册
  sensor.off(sensor.SensorId.GRAVITY, callback1);
  // 取消注册SensorId.GRAVITY的所有回调
  sensor.off(sensor.SensorId.GRAVITY);
} catch (error) {
L
li-yaoyao777 已提交
2204 2205
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
2206
}
L
li-yaoyao777 已提交
2207

C
cff-gite 已提交
2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223
```

### GYROSCOPE<sup>9+</sup> 

off(type: SensorId.GYROSCOPE, callback?: Callback&lt;GyroscopeResponse&gt;): void

取消订阅陀螺仪传感器数据。

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

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

**参数:**

| 参数名   | 类型                                                    | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
2224
| type     | [SensorId](#sensorid9).GYROSCOPE                        | 是   | 传感器类型,该值固定为SensorId.GYROSCOPE。                   |
C
cff-gite 已提交
2225
| callback | Callback&lt;[GyroscopeResponse](#gyroscoperesponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
2226 2227 2228

**示例:**

L
li-yaoyao777 已提交
2229
```ts
L
li-yaoyao777 已提交
2230 2231 2232 2233
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
2234
  console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
H
h00514358 已提交
2235
}
L
li-yaoyao777 已提交
2236

L
li-yaoyao777 已提交
2237
function callback2(data: object) {
L
li-yaoyao777 已提交
2238
  console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
H
h00514358 已提交
2239
}
L
li-yaoyao777 已提交
2240

C
cff-gite 已提交
2241
try {
L
li-yaoyao777 已提交
2242 2243 2244 2245 2246 2247 2248
  sensor.on(sensor.SensorId.GYROSCOPE, callback1);
  sensor.on(sensor.SensorId.GYROSCOPE, callback2);
  // 仅取消callback1的注册
  sensor.off(sensor.SensorId.GYROSCOPE, callback1);
  // 取消注册SensorId.GYROSCOPE的所有回调
  sensor.off(sensor.SensorId.GYROSCOPE);
} catch (error) {
L
li-yaoyao777 已提交
2249 2250
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
2251 2252 2253 2254 2255
}
```

### GYROSCOPE_UNCALIBRATED<sup>9+</sup> 

C
cff-gite 已提交
2256
off(type: SensorId.GYROSCOPE_UNCALIBRATED, callback?: Callback&lt;GyroscopeUncalibratedResponse&gt;): void
C
cff-gite 已提交
2257

H
h00514358 已提交
2258
 取消订阅未校准陀螺仪传感器数据。
C
cff-gite 已提交
2259 2260 2261 2262 2263 2264 2265 2266 2267

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

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

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
2268
| type     | [SensorId](#sensorid9).GYROSCOPE_UNCALIBRATED                | 是   | 传感器类型,该值固定为SensorId.GYROSCOPE_UNCALIBRATED。      |
C
cff-gite 已提交
2269
| callback | Callback&lt;[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
2270 2271 2272

**示例:**

L
li-yaoyao777 已提交
2273
```ts
L
li-yaoyao777 已提交
2274 2275 2276 2277
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
2278
  console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
H
h00514358 已提交
2279
}
L
li-yaoyao777 已提交
2280

L
li-yaoyao777 已提交
2281
function callback2(data: object) {
L
li-yaoyao777 已提交
2282
  console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
H
h00514358 已提交
2283
}
L
li-yaoyao777 已提交
2284

C
cff-gite 已提交
2285
try {
L
li-yaoyao777 已提交
2286 2287 2288 2289 2290 2291 2292
  sensor.on(sensor.SensorId.GYROSCOPE_UNCALIBRATED, callback1);
  sensor.on(sensor.SensorId.GYROSCOPE_UNCALIBRATED, callback2);
  // 仅取消callback1的注册
  sensor.off(sensor.SensorId.GYROSCOPE_UNCALIBRATED, callback1);
  // 取消注册SensorId.GYROSCOPE_UNCALIBRATED的所有回调
  sensor.off(sensor.SensorId.GYROSCOPE_UNCALIBRATED);
} catch (error) {
L
li-yaoyao777 已提交
2293 2294
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309
}
```

### HALL<sup>9+</sup> 

off(type: SensorId.HALL, callback?: Callback&lt;HallResponse&gt;): void

取消订阅霍尔传感器数据。

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

**参数:**

| 参数名   | 类型                                          | 必填 | 说明                                                         |
| -------- | --------------------------------------------- | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
2310
| type     | [SensorId](#sensorid9).HALL                   | 是   | 传感器类型,该值固定为SensorId.HALL。                        |
C
cff-gite 已提交
2311
| callback | Callback&lt;[HallResponse](#hallresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
2312 2313 2314

**示例:**

L
li-yaoyao777 已提交
2315
```ts
L
li-yaoyao777 已提交
2316 2317 2318 2319
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
2320
  console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
H
h00514358 已提交
2321
}
L
li-yaoyao777 已提交
2322

L
li-yaoyao777 已提交
2323
function callback2(data: object) {
L
li-yaoyao777 已提交
2324
  console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
H
h00514358 已提交
2325
}
L
li-yaoyao777 已提交
2326

C
cff-gite 已提交
2327
try {
L
li-yaoyao777 已提交
2328 2329 2330 2331 2332 2333 2334
  sensor.on(sensor.SensorId.HALL, callback1);
  sensor.on(sensor.SensorId.HALL, callback2);
  // 仅取消callback1的注册
  sensor.off(sensor.SensorId.HALL, callback1);
  // 取消注册SensorId.HALL的所有回调
  sensor.off(sensor.SensorId.HALL);
} catch (error) {
L
li-yaoyao777 已提交
2335 2336
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
2337 2338 2339
}
```

C
cff-gite 已提交
2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353
### HEART_RATE<sup>9+</sup> 

off(type: SensorId.HEART_RATE, callback?: Callback&lt;HeartRateResponse&gt;): void

取消订阅心率传感器数据。

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

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

**参数:**

| 参数名   | 类型                                                    | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
2354
| type     | [SensorId](#sensorid9).HEART_RATE                       | 是   | 传感器类型,该值固定为SensorId.HEART_RATE。                  |
C
cff-gite 已提交
2355
| callback | Callback&lt;[HeartRateResponse](#heartrateresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
2356 2357 2358

**示例:**

L
li-yaoyao777 已提交
2359
```ts
L
li-yaoyao777 已提交
2360 2361 2362 2363
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
2364
  console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
H
h00514358 已提交
2365
}
L
li-yaoyao777 已提交
2366

L
li-yaoyao777 已提交
2367
function callback2(data: object) {
L
li-yaoyao777 已提交
2368
  console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
H
h00514358 已提交
2369
}
L
li-yaoyao777 已提交
2370

C
cff-gite 已提交
2371
try {
L
li-yaoyao777 已提交
2372 2373 2374 2375 2376 2377 2378
  sensor.on(sensor.SensorId.HEART_RATE, callback1);
  sensor.on(sensor.SensorId.HEART_RATE, callback2);
  // 仅取消callback1的注册
  sensor.off(sensor.SensorId.HEART_RATE, callback1);
  // 取消注册SensorId.HEART_RATE的所有回调
  sensor.off(sensor.SensorId.HEART_RATE);
} catch (error) {
L
li-yaoyao777 已提交
2379 2380
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
2381 2382 2383
}
```

C
cff-gite 已提交
2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395
### HUMIDITY<sup>9+</sup> 

off(type: SensorId.HUMIDITY, callback?: Callback&lt;HumidityResponse&gt;): void

取消订阅湿度传感器数据。

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

**参数:**

| 参数名   | 类型                                                  | 必填 | 说明                                                         |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
2396
| type     | [SensorId](#sensorid9).HUMIDITY                       | 是   | 传感器类型,该值固定为SensorId.HUMIDITY。                    |
C
cff-gite 已提交
2397
| callback | Callback&lt;[HumidityResponse](#humidityresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
2398 2399 2400

**示例:**

L
li-yaoyao777 已提交
2401
```ts
L
li-yaoyao777 已提交
2402 2403 2404 2405
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
2406
  console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
H
h00514358 已提交
2407
}
L
li-yaoyao777 已提交
2408

L
li-yaoyao777 已提交
2409
function callback2(data: object) {
L
li-yaoyao777 已提交
2410
  console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
H
h00514358 已提交
2411
}
L
li-yaoyao777 已提交
2412

C
cff-gite 已提交
2413
try {
L
li-yaoyao777 已提交
2414 2415 2416 2417 2418 2419 2420
  sensor.on(sensor.SensorId.HUMIDITY, callback1);
  sensor.on(sensor.SensorId.HUMIDITY, callback2);
  // 仅取消callback1的注册
  sensor.off(sensor.SensorId.HUMIDITY, callback1);
  // 取消注册SensorId.HUMIDITY的所有回调
  sensor.off(sensor.SensorId.HUMIDITY);
} catch (error) {
L
li-yaoyao777 已提交
2421 2422
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
2423 2424 2425
}
```

C
cff-gite 已提交
2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439
### LINEAR_ACCELEROMETER<sup>9+</sup> 

off(type: SensorId.LINEAR_ACCELEROMETER, callback?: Callback&lt;LinearAccelerometerResponse&gt;): void

取消订阅线性加速度传感器数据。

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

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

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
2440
| type     | [SensorId](#sensorid9).LINEAR_ACCELEROMETER                  | 是   | 传感器类型,该值固定为SensorId.LINEAR_ACCELERATION。         |
C
cff-gite 已提交
2441
| callback | Callback&lt;[LinearAccelerometerResponse](#linearaccelerometerresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
2442 2443 2444

**示例:**

L
li-yaoyao777 已提交
2445
```ts
L
li-yaoyao777 已提交
2446 2447 2448 2449
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
2450
  console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
H
h00514358 已提交
2451
}
L
li-yaoyao777 已提交
2452

L
li-yaoyao777 已提交
2453
function callback2(data: object) {
L
li-yaoyao777 已提交
2454
  console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
H
h00514358 已提交
2455
}
L
li-yaoyao777 已提交
2456

C
cff-gite 已提交
2457
try {
L
li-yaoyao777 已提交
2458 2459 2460 2461 2462 2463 2464
  sensor.on(sensor.SensorId.LINEAR_ACCELEROMETER, callback1);
  sensor.on(sensor.SensorId.LINEAR_ACCELEROMETER, callback2);
  // 仅取消callback1的注册
  sensor.off(sensor.SensorId.LINEAR_ACCELEROMETER, callback1);
  // 取消注册SensorId.LINEAR_ACCELEROMETER的所有回调
  sensor.off(sensor.SensorId.LINEAR_ACCELEROMETER);
} catch (error) {
L
li-yaoyao777 已提交
2465 2466
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
2467 2468 2469
}
```

C
cff-gite 已提交
2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481
### MAGNETIC_FIELD<sup>9+</sup> 

off(type: SensorId.MAGNETIC_FIELD, callback?: Callback&lt;MagneticFieldResponse&gt;): void

取消订阅磁场传感器数据。

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

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
2482
| type     | [SensorId](#sensorid9).MAGNETIC_FIELD                        | 是   | 传感器类型,该值固定为SensorId.MAGNETIC_FIELD。              |
C
cff-gite 已提交
2483
| callback | Callback&lt;[MagneticFieldResponse](#magneticfieldresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
2484 2485 2486

**示例:**

L
li-yaoyao777 已提交
2487
```ts
L
li-yaoyao777 已提交
2488 2489 2490 2491
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
2492
  console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
H
h00514358 已提交
2493
}
L
li-yaoyao777 已提交
2494

L
li-yaoyao777 已提交
2495
function callback2(data: object) {
L
li-yaoyao777 已提交
2496
  console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
H
h00514358 已提交
2497
}
L
li-yaoyao777 已提交
2498

C
cff-gite 已提交
2499
try {
L
li-yaoyao777 已提交
2500 2501 2502 2503 2504 2505 2506
  sensor.on(sensor.SensorId.MAGNETIC_FIELD, callback1);
  sensor.on(sensor.SensorId.MAGNETIC_FIELD, callback2);
  // 仅取消callback1的注册
  sensor.off(sensor.SensorId.MAGNETIC_FIELD, callback1);
  // 取消注册SensorId.MAGNETIC_FIELD的所有回调
  sensor.off(sensor.SensorId.MAGNETIC_FIELD);
} catch (error) {
L
li-yaoyao777 已提交
2507 2508
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
2509 2510 2511 2512 2513
}
```

### MAGNETIC_FIELD_UNCALIBRATED<sup>9+</sup> 

C
cff-gite 已提交
2514
off(type: SensorId.MAGNETIC_FIELD_UNCALIBRATED, callback?: Callback&lt;MagneticFieldUncalibratedResponse&gt;): void
C
cff-gite 已提交
2515 2516 2517 2518 2519 2520 2521 2522 2523

取消订阅未校准的磁场传感器数据。

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

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
2524
| type     | [SensorId](#sensorid9).MAGNETIC_FIELD_UNCALIBRATED           | 是   | 传感器类型,该值固定为SensorId.MAGNETIC_FIELD_UNCALIBRATED。 |
C
cff-gite 已提交
2525
| callback | Callback&lt;[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
2526 2527 2528

**示例:**

L
li-yaoyao777 已提交
2529
```ts
L
li-yaoyao777 已提交
2530 2531 2532 2533
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
2534
  console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
H
h00514358 已提交
2535
}
L
li-yaoyao777 已提交
2536

L
li-yaoyao777 已提交
2537
function callback2(data: object) {
L
li-yaoyao777 已提交
2538
  console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
H
h00514358 已提交
2539
}
L
li-yaoyao777 已提交
2540

C
cff-gite 已提交
2541
try {
L
li-yaoyao777 已提交
2542 2543 2544 2545 2546 2547 2548
  sensor.on(sensor.SensorId.MAGNETIC_FIELD_UNCALIBRATED, callback1);
  sensor.on(sensor.SensorId.MAGNETIC_FIELD_UNCALIBRATED, callback2);
  // 仅取消callback1的注册
  sensor.off(sensor.SensorId.MAGNETIC_FIELD_UNCALIBRATED, callback1);
  // 取消注册SensorId.MAGNETIC_FIELD_UNCALIBRATED的所有回调
  sensor.off(sensor.SensorId.MAGNETIC_FIELD_UNCALIBRATED);
} catch (error) {
L
li-yaoyao777 已提交
2549 2550
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565
}
```

### ORIENTATION<sup>9+</sup> 

off(type: SensorId.ORIENTATION, callback?: Callback&lt;OrientationResponse&gt;): void

取消订阅方向传感器数据。

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

**参数:**

| 参数名   | 类型                                                        | 必填 | 说明                                                         |
| -------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
2566
| type     | [SensorId](#sensorid9).ORIENTATION                          | 是   | 传感器类型,该值固定为SensorId.ORIENTATION。                 |
C
cff-gite 已提交
2567
| callback | Callback&lt;[OrientationResponse](#orientationresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
2568 2569 2570

**示例:**

L
li-yaoyao777 已提交
2571
```ts
L
li-yaoyao777 已提交
2572 2573 2574 2575
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
2576
  console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
H
h00514358 已提交
2577
}
L
li-yaoyao777 已提交
2578

L
li-yaoyao777 已提交
2579
function callback2(data: object) {
L
li-yaoyao777 已提交
2580
  console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
H
h00514358 已提交
2581
}
L
li-yaoyao777 已提交
2582

C
cff-gite 已提交
2583
try {
L
li-yaoyao777 已提交
2584 2585 2586 2587 2588 2589 2590
  sensor.on(sensor.SensorId.ORIENTATION, callback1);
  sensor.on(sensor.SensorId.ORIENTATION, callback2);
  // 仅取消callback1的注册
  sensor.off(sensor.SensorId.ORIENTATION, callback1);
  // 取消注册SensorId.ORIENTATION的所有回调
  sensor.off(sensor.SensorId.ORIENTATION);
} catch (error) {
L
li-yaoyao777 已提交
2591 2592
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609
}
```

### PEDOMETER<sup>9+</sup>

off(type: SensorId.PEDOMETER, callback?: Callback&lt;PedometerResponse&gt;): void

取消订阅计步器传感器数据。

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

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

**参数:**

| 参数名   | 类型                                                    | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
2610
| type     | [SensorId](#sensorid9).PEDOMETER                        | 是   | 传感器类型,该值固定为SensorId.PEDOMETER。                   |
C
cff-gite 已提交
2611
| callback | Callback&lt;[PedometerResponse](#pedometerresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
2612 2613 2614

**示例:**

L
li-yaoyao777 已提交
2615
```ts
L
li-yaoyao777 已提交
2616 2617 2618 2619
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
2620
  console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
H
h00514358 已提交
2621
}
L
li-yaoyao777 已提交
2622

L
li-yaoyao777 已提交
2623
function callback2(data: object) {
L
li-yaoyao777 已提交
2624
  console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
H
h00514358 已提交
2625
}
L
li-yaoyao777 已提交
2626

C
cff-gite 已提交
2627
try {
L
li-yaoyao777 已提交
2628 2629 2630 2631
  sensor.on(sensor.SensorId.PEDOMETER, callback1);
  sensor.on(sensor.SensorId.PEDOMETER, callback2);
  // 仅取消callback1的注册
  sensor.off(sensor.SensorId.PEDOMETER, callback1);
L
li-yaoyao777 已提交
2632
  // 取消注册SensorId.ORIENTATION的所有回调
L
li-yaoyao777 已提交
2633 2634
  sensor.off(sensor.SensorId.PEDOMETER);
} catch (error) {
L
li-yaoyao777 已提交
2635 2636
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
2637 2638 2639 2640 2641 2642 2643
}
```

### PEDOMETER_DETECTION<sup>9+</sup> 

off(type: SensorId.PEDOMETER_DETECTION, callback?: Callback&lt;PedometerDetectionResponse&gt;): void

H
h00514358 已提交
2644
取消订阅计步检测器传感器数据。
C
cff-gite 已提交
2645 2646 2647 2648 2649 2650 2651 2652 2653

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

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

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
2654
| type     | [SensorId](#sensorid9).PEDOMETER_DETECTION                   | 是   | 传感器类型,该值固定为SensorId.PEDOMETER_DETECTION。         |
C
cff-gite 已提交
2655
| callback | Callback&lt;[PedometerDetectionResponse](#pedometerdetectionresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
2656 2657 2658

**示例:**

L
li-yaoyao777 已提交
2659
```ts
L
li-yaoyao777 已提交
2660 2661 2662 2663
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
2664
  console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
H
h00514358 已提交
2665
}
L
li-yaoyao777 已提交
2666

L
li-yaoyao777 已提交
2667
function callback2(data: object) {
L
li-yaoyao777 已提交
2668
  console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
H
h00514358 已提交
2669
}
L
li-yaoyao777 已提交
2670

C
cff-gite 已提交
2671
try {
L
li-yaoyao777 已提交
2672 2673 2674 2675 2676 2677 2678
  sensor.on(sensor.SensorId.PEDOMETER_DETECTION, callback1);
  sensor.on(sensor.SensorId.PEDOMETER_DETECTION, callback2);
  // 仅取消callback1的注册
  sensor.off(sensor.SensorId.PEDOMETER_DETECTION, callback1);
  // 取消注册SensorId.PEDOMETER_DETECTION的所有回调
  sensor.off(sensor.SensorId.PEDOMETER_DETECTION);
} catch (error) {
L
li-yaoyao777 已提交
2679 2680
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
2681 2682 2683 2684 2685 2686 2687
}
```

### PROXIMITY<sup>9+</sup>  

off(type: SensorId.PROXIMITY, callback?: Callback&lt;ProximityResponse&gt;): void

H
h00514358 已提交
2688
取消订阅接近光传感器数据。
C
cff-gite 已提交
2689 2690 2691 2692 2693 2694 2695

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

**参数:**

| 参数名   | 类型                                                    | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
2696
| type     | [SensorId](#sensorid9).PROXIMITY                        | 是   | 传感器类型,该值固定为SensorId.PROXIMITY。                   |
C
cff-gite 已提交
2697
| callback | Callback&lt;[ProximityResponse](#proximityresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
2698 2699 2700

**示例:**

L
li-yaoyao777 已提交
2701
```ts
L
li-yaoyao777 已提交
2702 2703 2704 2705
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
2706
  console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
H
h00514358 已提交
2707
}
L
li-yaoyao777 已提交
2708

L
li-yaoyao777 已提交
2709
function callback2(data: object) {
L
li-yaoyao777 已提交
2710
  console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
H
h00514358 已提交
2711
}
L
li-yaoyao777 已提交
2712

C
cff-gite 已提交
2713
try {
L
li-yaoyao777 已提交
2714 2715 2716 2717 2718 2719 2720
  sensor.on(sensor.SensorId.PROXIMITY, callback1);
  sensor.on(sensor.SensorId.PROXIMITY, callback2);
  // 仅取消callback1的注册
  sensor.off(sensor.SensorId.PROXIMITY, callback1);
  // 取消注册SensorId.PROXIMITY的所有回调
  sensor.off(sensor.SensorId.PROXIMITY);
} catch (error) {
L
li-yaoyao777 已提交
2721 2722
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737
}
```

### ROTATION_VECTOR<sup>9+</sup> 

off(type: SensorId.ROTATION_VECTOR, callback?: Callback&lt;RotationVectorResponse&gt;): void

取消订阅旋转矢量传感器数据。

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

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
2738
| type     | [SensorId](#sensorid9).ROTATION_VECTOR                       | 是   | 传感器类型,该值固定为SensorId.ROTATION_VECTOR。             |
C
cff-gite 已提交
2739
| callback | Callback&lt;[RotationVectorResponse](#rotationvectorresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
2740 2741 2742

**示例:**

L
li-yaoyao777 已提交
2743
```ts
L
li-yaoyao777 已提交
2744 2745 2746 2747
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
2748
  console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
H
h00514358 已提交
2749
}
L
li-yaoyao777 已提交
2750

L
li-yaoyao777 已提交
2751
function callback2(data: object) {
L
li-yaoyao777 已提交
2752
  console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
H
h00514358 已提交
2753
}
L
li-yaoyao777 已提交
2754

C
cff-gite 已提交
2755
try {
L
li-yaoyao777 已提交
2756 2757 2758 2759 2760 2761 2762
  sensor.on(sensor.SensorId.ROTATION_VECTOR, callback1);
  sensor.on(sensor.SensorId.ROTATION_VECTOR, callback2);
  // 仅取消callback1的注册
  sensor.off(sensor.SensorId.ROTATION_VECTOR, callback1);
  // 取消注册SensorId.ROTATION_VECTOR的所有回调
  sensor.off(sensor.SensorId.ROTATION_VECTOR);
} catch (error) {
L
li-yaoyao777 已提交
2763 2764
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
2765 2766 2767 2768 2769 2770 2771
}
```

### SIGNIFICANT_MOTION<sup>9+</sup> 

off(type: SensorId.SIGNIFICANT_MOTION, callback?: Callback&lt;SignificantMotionResponse&gt;): void

H
h00514358 已提交
2772
取消大幅动作检测传感器数据。
C
cff-gite 已提交
2773 2774 2775 2776 2777 2778 2779

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

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
2780
| type     | [SensorId](#sensorid9).SIGNIFICANT_MOTION                    | 是   | 传感器类型,该值固定为SensorId.SIGNIFICANT_MOTION。          |
C
cff-gite 已提交
2781
| callback | Callback&lt;[SignificantMotionResponse](#significantmotionresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
2782 2783 2784

**示例:**

L
li-yaoyao777 已提交
2785
```ts
L
li-yaoyao777 已提交
2786 2787 2788 2789
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
2790
  console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
H
h00514358 已提交
2791
}
L
li-yaoyao777 已提交
2792

L
li-yaoyao777 已提交
2793
function callback2(data: object) {
L
li-yaoyao777 已提交
2794
  console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
H
h00514358 已提交
2795
}
L
li-yaoyao777 已提交
2796

C
cff-gite 已提交
2797
try {
L
li-yaoyao777 已提交
2798 2799 2800 2801 2802 2803 2804
  sensor.on(sensor.SensorId.SIGNIFICANT_MOTION, callback1);
  sensor.on(sensor.SensorId.SIGNIFICANT_MOTION, callback2);
  // 仅取消callback1的注册
  sensor.off(sensor.SensorId.SIGNIFICANT_MOTION, callback1);
  // 取消注册SensorId.SIGNIFICANT_MOTION的所有回调
  sensor.off(sensor.SensorId.SIGNIFICANT_MOTION);
} catch (error) {
L
li-yaoyao777 已提交
2805 2806
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
2807 2808 2809 2810 2811 2812 2813
}
```

### WEAR_DETECTION<sup>9+</sup> 

off(type: SensorId.WEAR_DETECTION, callback?: Callback&lt;WearDetectionResponse&gt;): void

C
cff-gite 已提交
2814
取消订阅佩戴检测传感器数据。
C
cff-gite 已提交
2815 2816 2817 2818 2819 2820 2821

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

**参数:**

| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
2822
| type     | [SensorId](#sensorid9).WEAR_DETECTION                        | 是   | 传感器类型,该值固定为SensorId.WEAR_DETECTION。              |
C
cff-gite 已提交
2823
| callback | Callback&lt;[WearDetectionResponse](#weardetectionresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
2824 2825 2826

**示例:**

L
li-yaoyao777 已提交
2827
```ts
L
li-yaoyao777 已提交
2828 2829 2830 2831
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

function callback1(data: object) {
L
li-yaoyao777 已提交
2832
  console.info('Succeeded in getting callback1 data: ' + JSON.stringify(data));
H
h00514358 已提交
2833
}
L
li-yaoyao777 已提交
2834

L
li-yaoyao777 已提交
2835
function callback2(data: object) {
L
li-yaoyao777 已提交
2836
  console.info('Succeeded in getting callback2 data: ' + JSON.stringify(data));
H
h00514358 已提交
2837
}
L
li-yaoyao777 已提交
2838

C
cff-gite 已提交
2839
try {
L
li-yaoyao777 已提交
2840 2841 2842 2843 2844 2845 2846
  sensor.on(sensor.SensorId.WEAR_DETECTION, callback1);
  sensor.on(sensor.SensorId.WEAR_DETECTION, callback2);
  // 仅取消callback1的注册
  sensor.off(sensor.SensorId.WEAR_DETECTION, callback1);
  // 取消注册SensorId.WEAR_DETECTION的所有回调
  sensor.off(sensor.SensorId.WEAR_DETECTION);
} catch (error) {
L
li-yaoyao777 已提交
2847 2848
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to invoke off. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
2849 2850 2851
}
```

C
cff-gite 已提交
2852 2853 2854 2855
## sensor.getGeomagneticInfo<sup>9+</sup> 

getGeomagneticInfo(locationOptions: LocationOptions, timeMillis: number, callback: AsyncCallback&lt;GeomagneticResponse&gt;): void

H
h00514358 已提交
2856
获取某时刻地球上特定位置的地磁场信息。
C
cff-gite 已提交
2857 2858 2859 2860 2861 2862 2863

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

**参数:** 

| 参数名          | 类型                                                         | 必填 | 说明                               |
| --------------- | ------------------------------------------------------------ | ---- | ---------------------------------- |
H
h00514358 已提交
2864 2865 2866
| locationOptions | [LocationOptions](#locationoptions)                          | 是   | 地理位置,包括经度、纬度和海拔高度。                         |
| timeMillis      | number                                                       | 是   | 获取磁偏角的时间,unix时间戳,单位毫秒。 |
| callback        | AsyncCallback&lt;[GeomagneticResponse](#geomagneticresponse)&gt; | 是   | 回调函数,返回地磁场信息。                     |
C
cff-gite 已提交
2867

C
cff-gite 已提交
2868 2869 2870 2871 2872 2873 2874 2875
**错误码**

以下错误码的详细介绍请参见 [sensor.getGeomagneticInfo错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
2876 2877
**示例:** 

L
li-yaoyao777 已提交
2878
```ts
L
li-yaoyao777 已提交
2879 2880 2881
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
2882
try {
L
li-yaoyao777 已提交
2883 2884
  sensor.getGeomagneticInfo({ latitude: 80, longitude: 0, altitude: 0 }, 1580486400000,
      (err: BusinessError.BusinessError, data: sensor.GeomagneticResponse) => {
L
li-yaoyao777 已提交
2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897
    if (err) {
      console.error(`Failed to get geomagneticInfo. Code: ${err.code}, message: ${err.message}`);
      return;
    }
    console.info("Succeeded in getting geomagneticInfo x" + data.x);
    console.info("Succeeded in getting geomagneticInfo y" + data.y);
    console.info("Succeeded in getting geomagneticInfo z" + data.z);
    console.info("Succeeded in getting geomagneticInfo geomagneticDip" + data.geomagneticDip);
    console.info("Succeeded in getting geomagneticInfo deflectionAngle" + data.deflectionAngle);
    console.info("Succeeded in getting geomagneticInfo levelIntensity" + data.levelIntensity);
    console.info("Succeeded in getting geomagneticInfo totalIntensity" + data.totalIntensity);
  });
} catch (error) {
L
li-yaoyao777 已提交
2898 2899
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to get geomagneticInfo. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
2900 2901 2902 2903 2904 2905 2906
}
```

## sensor.getGeomagneticInfo<sup>9+</sup> 

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

H
h00514358 已提交
2907
获取某时刻地球上特定位置的地磁场信息。
C
cff-gite 已提交
2908 2909 2910 2911 2912 2913 2914

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

**参数:** 

| 参数名          | 类型                                | 必填 | 说明                               |
| --------------- | ----------------------------------- | ---- | ---------------------------------- |
H
h00514358 已提交
2915 2916
| locationOptions | [LocationOptions](#locationoptions) | 是   | 地理位置,包括经度、纬度和海拔高度。                         |
| timeMillis      | number                              | 是   | 获取磁偏角的时间,unix时间戳,单位毫秒。 |
C
cff-gite 已提交
2917 2918 2919 2920 2921

**返回值:** 

| 类型                                                       | 说明           |
| ---------------------------------------------------------- | -------------- |
H
h00514358 已提交
2922
| Promise&lt;[GeomagneticResponse](#geomagneticresponse)&gt; | Promise对象,返回地磁场信息。 |
C
cff-gite 已提交
2923

C
cff-gite 已提交
2924 2925 2926 2927 2928 2929 2930 2931
**错误码**

以下错误码的详细介绍请参见 [sensor.getGeomagneticInfo错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
2932 2933
**示例:** 

L
li-yaoyao777 已提交
2934
```ts
L
li-yaoyao777 已提交
2935 2936 2937
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
2938
try {
L
li-yaoyao777 已提交
2939
  const promise = sensor.getGeomagneticInfo({ latitude: 80, longitude: 0, altitude: 0 }, 1580486400000);
L
li-yaoyao777 已提交
2940
  promise.then((data: sensor.GeomagneticResponse) => {
L
li-yaoyao777 已提交
2941 2942 2943 2944 2945 2946 2947
    console.info("Succeeded in getting geomagneticInfo x" + data.x);
    console.info("Succeeded in getting geomagneticInfo y" + data.y);
    console.info("Succeeded in getting geomagneticInfo z" + data.z);
    console.info("Succeeded in getting geomagneticInfo geomagneticDip" + data.geomagneticDip);
    console.info("Succeeded in getting geomagneticInfo deflectionAngle" + data.deflectionAngle);
    console.info("Succeeded in getting geomagneticInfo levelIntensity" + data.levelIntensity);
    console.info("Succeeded in getting geomagneticInfo totalIntensity" + data.totalIntensity);
L
li-yaoyao777 已提交
2948
  }, (err: BusinessError.BusinessError) => {
L
li-yaoyao777 已提交
2949 2950 2951
    console.error(`Failed to get geomagneticInfo. Code: ${err.code}, message: ${err.message}`);
  });
} catch (error) {
L
li-yaoyao777 已提交
2952 2953
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to get geomagneticInfo. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
2954 2955 2956
}
```

C
cff-gite 已提交
2957
## sensor.getDeviceAltitude<sup>9+</sup> 
C
cff-gite 已提交
2958 2959 2960

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

H
h00514358 已提交
2961
根据气压值获取海拔高度。
C
cff-gite 已提交
2962 2963 2964 2965 2966 2967 2968

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

**参数:** 

| 参数名          | 类型                        | 必填 | 说明                                  |
| --------------- | --------------------------- | ---- | ------------------------------------- |
H
h00514358 已提交
2969 2970 2971
| seaPressure     | number                      | 是   | 海平面气压值,单位为hPa。         |
| currentPressure | number                      | 是   | 指定的气压值,单位为hPa。 |
| callback        | AsyncCallback&lt;number&gt; | 是   | 回调函数,返回指定的气压值对应的海拔高度,单位为米。    |
C
cff-gite 已提交
2972

C
cff-gite 已提交
2973 2974 2975 2976 2977 2978 2979 2980
**错误码**

以下错误码的详细介绍请参见 [sensor.getDeviceAltitude错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
2981 2982
**示例:**

L
li-yaoyao777 已提交
2983
```ts
L
li-yaoyao777 已提交
2984 2985 2986
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
2987
try {
L
li-yaoyao777 已提交
2988 2989
  let seaPressure = 1013.2;
  let currentPressure = 1500.0;
L
li-yaoyao777 已提交
2990
  sensor.getDeviceAltitude(seaPressure, currentPressure, (err: BusinessError.BusinessError, data: number) => {
L
li-yaoyao777 已提交
2991 2992 2993 2994 2995 2996 2997
    if (err) {
      console.error(`Failed to get altitude. Code: ${err.code}, message: ${err.message}`);
      return;
    }
    console.info('Succeeded in getting altitude: ' + data);
  });
} catch (error) {
L
li-yaoyao777 已提交
2998 2999
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to get altitude. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
3000 3001 3002
}
```

C
cff-gite 已提交
3003
## sensor.getDeviceAltitude<sup>9+</sup> 
C
cff-gite 已提交
3004 3005 3006

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

H
h00514358 已提交
3007
根据气压值获取海拔高度。
C
cff-gite 已提交
3008 3009 3010 3011 3012 3013 3014

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

**参数:** 

| 参数名          | 类型   | 必填 | 说明                                  |
| --------------- | ------ | ---- | ------------------------------------- |
H
h00514358 已提交
3015 3016
| seaPressure     | number | 是   | 海平面气压值,单位为hPa。         |
| currentPressure | number | 是   | 指定的气压值,单位为hPa。 |
C
cff-gite 已提交
3017 3018 3019 3020 3021

**返回值:** 

| 类型                  | 说明                                 |
| --------------------- | ------------------------------------ |
H
h00514358 已提交
3022
| Promise&lt;number&gt; | Promise对象,返回指定的气压值对应的海拔高度,单位为米。 |
C
cff-gite 已提交
3023

C
cff-gite 已提交
3024 3025 3026 3027 3028 3029 3030 3031
**错误码**

以下错误码的详细介绍请参见 [sensor.getDeviceAltitude错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
3032 3033
**示例:** 

L
li-yaoyao777 已提交
3034
```ts
L
li-yaoyao777 已提交
3035 3036 3037
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
3038
try {
L
li-yaoyao777 已提交
3039 3040 3041
  let seaPressure = 1013.2;
  let currentPressure = 1500.0;
  const promise = sensor.getDeviceAltitude(seaPressure, currentPressure);
L
li-yaoyao777 已提交
3042
  promise.then((data: number) => {
L
li-yaoyao777 已提交
3043
    console.info('Succeeded in getting sensor_getDeviceAltitude_Promise', data);
L
li-yaoyao777 已提交
3044
  }, (err: BusinessError.BusinessError) => {
L
li-yaoyao777 已提交
3045 3046 3047
    console.error(`Failed to get altitude. Code: ${err.code}, message: ${err.message}`);
  });
} catch (error) {
L
li-yaoyao777 已提交
3048 3049
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to get altitude. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
3050 3051 3052
}
```

C
cff-gite 已提交
3053
## sensor.getInclination<sup>9+</sup> 
C
cff-gite 已提交
3054 3055 3056

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

H
h00514358 已提交
3057
根据倾斜矩阵计算地磁倾角。
C
cff-gite 已提交
3058 3059 3060 3061 3062 3063 3064

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

**参数:**

| 参数名            | 类型                        | 必填 | 说明                         |
| ----------------- | --------------------------- | ---- | ---------------------------- |
H
h00514358 已提交
3065 3066
| inclinationMatrix | Array&lt;number&gt;         | 是   | 倾斜矩阵。               |
| callback          | AsyncCallback&lt;number&gt; | 是   | 回调函数,返回地磁倾角,单位为弧度。 |
C
cff-gite 已提交
3067

C
cff-gite 已提交
3068 3069 3070 3071 3072 3073 3074 3075
**错误码**

以下错误码的详细介绍请参见 [sensor.getInclination错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
3076 3077
**示例:** 

L
li-yaoyao777 已提交
3078
```ts
L
li-yaoyao777 已提交
3079 3080 3081
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
3082
try {
L
li-yaoyao777 已提交
3083 3084 3085 3086 3087 3088
  // inclinationMatrix可以为3*3,或者4*4
  let inclinationMatrix = [
    1, 0, 0,
    0, 1, 0,
    0, 0, 1
  ]
L
li-yaoyao777 已提交
3089
  sensor.getInclination(inclinationMatrix, (err: BusinessError.BusinessError, data: number) => {
L
li-yaoyao777 已提交
3090 3091 3092 3093 3094 3095 3096
    if (err) {
      console.error(`Failed to get inclination. Code: ${err.code}, message: ${err.message}`);
      return;
    }
    console.info('Succeeded in getting inclination: ' + data);
  })
} catch (error) {
L
li-yaoyao777 已提交
3097 3098
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to get inclination. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
3099 3100 3101
}
```

C
cff-gite 已提交
3102
## sensor.getInclination<sup>9+</sup> 
C
cff-gite 已提交
3103 3104 3105

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

H
h00514358 已提交
3106
根据倾斜矩阵计算地磁倾角。
C
cff-gite 已提交
3107 3108 3109 3110 3111 3112 3113

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

**参数:**

| 参数名            | 类型                | 必填 | 说明           |
| ----------------- | ------------------- | ---- | -------------- |
H
h00514358 已提交
3114
| inclinationMatrix | Array&lt;number&gt; | 是   | 倾斜矩阵。 |
C
cff-gite 已提交
3115 3116 3117 3118 3119

**返回值:** 

| 类型                  | 说明                         |
| --------------------- | ---------------------------- |
H
h00514358 已提交
3120
| Promise&lt;number&gt; | Promise对象,返回地磁倾斜角,单位为弧度。 |
C
cff-gite 已提交
3121

C
cff-gite 已提交
3122 3123 3124 3125 3126 3127 3128 3129
**错误码**

以下错误码的详细介绍请参见 [sensor.getInclination错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
3130 3131
**示例:** 

L
li-yaoyao777 已提交
3132
```ts
L
li-yaoyao777 已提交
3133 3134 3135
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
3136
try {
L
li-yaoyao777 已提交
3137 3138 3139 3140 3141 3142 3143
  // inclinationMatrix可以为3*3,或者4*4
  let inclinationMatrix = [
    1, 0, 0,
    0, 1, 0,
    0, 0, 1
  ]
  const promise = sensor.getInclination(inclinationMatrix);
L
li-yaoyao777 已提交
3144
  promise.then((data: number) => {
L
li-yaoyao777 已提交
3145
    console.info('Succeeded in getting inclination: ' + data);
L
li-yaoyao777 已提交
3146
  }, (err: BusinessError.BusinessError) => {
L
li-yaoyao777 已提交
3147 3148 3149
    console.error(`Failed to get inclination. Code: ${err.code}, message: ${err.message}`);
  });
} catch (error) {
L
li-yaoyao777 已提交
3150 3151
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to get inclination. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
3152 3153 3154
}
```

C
cff-gite 已提交
3155
## sensor.getAngleVariation<sup>9+</sup>
C
cff-gite 已提交
3156 3157

 getAngleVariation(currentRotationMatrix: Array&lt;number&gt;, preRotationMatrix: Array&lt;number&gt;,
C
cff-gite 已提交
3158
        callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void
C
cff-gite 已提交
3159

H
h00514358 已提交
3160
计算两个旋转矩阵之间的角度变化。
C
cff-gite 已提交
3161 3162 3163 3164 3165 3166 3167

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

**参数:**

| 参数名                | 类型                                     | 必填 | 说明                              |
| --------------------- | ---------------------------------------- | ---- | --------------------------------- |
H
h00514358 已提交
3168 3169 3170
| currentRotationMatrix | Array&lt;number&gt;                      | 是   | 当前旋转矩阵。                |
| preRotationMatrix     | Array&lt;number&gt;                      | 是   | 相对旋转矩阵。                    |
| callback              | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是   | 回调函数,返回绕z、x、y轴方向的旋转角度。 |
C
cff-gite 已提交
3171

C
cff-gite 已提交
3172 3173 3174 3175 3176 3177 3178 3179
**错误码**

以下错误码的详细介绍请参见 [sensor.getAngleVariation错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
3180 3181
**示例:** 

L
li-yaoyao777 已提交
3182
```ts
L
li-yaoyao777 已提交
3183 3184 3185
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
3186
try {
L
li-yaoyao777 已提交
3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197
  // 旋转矩阵可以为3*3,或者4*4
  let currentRotationMatrix = [
    1, 0, 0,
    0, 1, 0,
    0, 0, 1
  ];
  let preRotationMatrix = [
    1, 0, 0,
    0, 0.87, -0.50,
    0, 0.50, 0.87
  ];
L
li-yaoyao777 已提交
3198
  sensor.getAngleVariation(currentRotationMatrix, preRotationMatrix, (err: BusinessError.BusinessError, data: Array<number>) => {
L
li-yaoyao777 已提交
3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210
    if (err) {
      console.error(`Failed to get angle variation. Code: ${err.code}, message: ${err.message}`);
      return;
    }
    if (data.length < 3) {
      console.error("Failed to get angle variation, length" + data.length);
    }
    console.info("Z: " + data[0]);
    console.info("X: " + data[1]);
    console.info("Y  : " + data[2]);
  })
} catch (error) {
L
li-yaoyao777 已提交
3211 3212
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to get angle variation. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
3213 3214 3215
}
```

C
cff-gite 已提交
3216
## sensor.getAngleVariation<sup>9+</sup>
C
cff-gite 已提交
3217

C
cff-gite 已提交
3218
getAngleVariation(currentRotationMatrix: Array&lt;number&gt;, preRotationMatrix: Array&lt;number&gt;): Promise&lt;Array&lt;number&gt;&gt; 
C
cff-gite 已提交
3219 3220 3221 3222 3223 3224 3225 3226 3227

得到两个旋转矩阵之间的角度变化。

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

**参数:**

| 参数名                | 类型                | 必填 | 说明               |
| --------------------- | ------------------- | ---- | ------------------ |
H
h00514358 已提交
3228
| currentRotationMatrix | Array&lt;number&gt; | 是   | 当前旋转矩阵。 |
L
li-yaoyao777 已提交
3229
| preRotationMatrix     | Array&lt;number&gt; | 是   | 相对旋转矩阵。                  |
C
cff-gite 已提交
3230 3231 3232 3233 3234

**返回值:** 

| 类型                               | 说明                              |
| ---------------------------------- | --------------------------------- |
H
h00514358 已提交
3235
| Promise&lt;Array&lt;number&gt;&gt; | Promise对象,返回绕z、x、y轴方向的旋转角度。 |
C
cff-gite 已提交
3236

C
cff-gite 已提交
3237 3238 3239 3240 3241 3242 3243 3244
**错误码**

以下错误码的详细介绍请参见 [sensor.getAngleVariation错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
3245 3246
**示例:** 

L
li-yaoyao777 已提交
3247
```ts
L
li-yaoyao777 已提交
3248 3249 3250
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
3251
try {
L
li-yaoyao777 已提交
3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263
  // 旋转矩阵可以为3*3,或者4*4
  let currentRotationMatrix = [
    1, 0, 0,
    0, 1, 0,
    0, 0, 1
  ];
  let preRotationMatrix = [
    1, 0, 0,
    0, 0.87, -0.50,
    0, 0.50, 0.87
  ];
  const promise = sensor.getAngleVariation(currentRotationMatrix, preRotationMatrix);
L
li-yaoyao777 已提交
3264
  promise.then((data: Array<number>) => {
L
li-yaoyao777 已提交
3265 3266 3267 3268 3269 3270
    if (data.length < 3) {
      console.error("Failed to get angle variation, length" + data.length);
    }
    console.info("Z: " + data[0]);
    console.info("X: " + data[1]);
    console.info("Y  : " + data[2]);
L
li-yaoyao777 已提交
3271
  }, (err: BusinessError.BusinessError) => {
L
li-yaoyao777 已提交
3272 3273 3274
    console.error(`Failed to get angle variation. Code: ${err.code}, message: ${err.message}`);
  });
} catch (error) {
L
li-yaoyao777 已提交
3275 3276
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to get angle variation. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
3277 3278 3279
}
```

C
cff-gite 已提交
3280
## sensor.getRotationMatrix<sup>9+</sup> 
C
cff-gite 已提交
3281

C
cff-gite 已提交
3282
getRotationMatrix(rotationVector: Array&lt;number&gt;, callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void
C
cff-gite 已提交
3283

H
h00514358 已提交
3284
根据旋转矢量获取旋转矩阵。
C
cff-gite 已提交
3285 3286 3287 3288 3289 3290 3291

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

**参数:** 

| 参数名         | 类型                                     | 必填 | 说明           |
| -------------- | ---------------------------------------- | ---- | -------------- |
H
h00514358 已提交
3292 3293
| rotationVector | Array&lt;number&gt;                      | 是   | 旋转矢量。 |
| callback       | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是   | 回调函数,返回3*3旋转矩阵。 |
C
cff-gite 已提交
3294

C
cff-gite 已提交
3295 3296 3297 3298 3299 3300 3301 3302
**错误码**

以下错误码的详细介绍请参见 [sensor.getRotationMatrix错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
3303 3304
**示例:** 

L
li-yaoyao777 已提交
3305
```ts
L
li-yaoyao777 已提交
3306 3307 3308
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
3309
try {
L
li-yaoyao777 已提交
3310
  let rotationVector = [0.20046076, 0.21907, 0.73978853, 0.60376877];
L
li-yaoyao777 已提交
3311
  sensor.getRotationMatrix(rotationVector, (err: BusinessError.BusinessError, data: Array<number>) => {
L
li-yaoyao777 已提交
3312 3313 3314 3315
    if (err) {
      console.error(`Failed to get rotationMatrix. Code: ${err.code}, message: ${err.message}`);
      return;
    }
L
li-yaoyao777 已提交
3316
    for (let i = 0; i < data.length; i++) {
L
li-yaoyao777 已提交
3317 3318 3319 3320
      console.info('Succeeded in getting data[' + i + ']: ' + data[i]);
    }
  })
} catch (error) {
L
li-yaoyao777 已提交
3321 3322
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to get rotationMatrix. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
3323 3324 3325
}
```

C
cff-gite 已提交
3326
## sensor.getRotationMatrix<sup>9+</sup>
C
cff-gite 已提交
3327

C
cff-gite 已提交
3328
getRotationMatrix(rotationVector: Array&lt;number&gt;): Promise&lt;Array&lt;number&gt;&gt; 
C
cff-gite 已提交
3329

H
h00514358 已提交
3330
根据旋转矢量获取旋转矩阵。
C
cff-gite 已提交
3331 3332 3333 3334 3335 3336 3337

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

**参数:**

| 参数名         | 类型                | 必填 | 说明           |
| -------------- | ------------------- | ---- | -------------- |
H
h00514358 已提交
3338
| rotationVector | Array&lt;number&gt; | 是   | 旋转矢量。 |
C
cff-gite 已提交
3339 3340 3341 3342 3343

**返回值:**

| 类型                               | 说明           |
| ---------------------------------- | -------------- |
H
h00514358 已提交
3344
| Promise&lt;Array&lt;number&gt;&gt; | Promise对象,返回旋转矩阵。 |
C
cff-gite 已提交
3345

C
cff-gite 已提交
3346 3347 3348 3349 3350 3351 3352 3353
**错误码**

以下错误码的详细介绍请参见 [sensor.getRotationMatrix错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
3354 3355
**示例:** 

L
li-yaoyao777 已提交
3356
```ts
L
li-yaoyao777 已提交
3357 3358 3359
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
3360
try {
L
li-yaoyao777 已提交
3361 3362
  let rotationVector = [0.20046076, 0.21907, 0.73978853, 0.60376877];
  const promise = sensor.getRotationMatrix(rotationVector);
L
li-yaoyao777 已提交
3363 3364
  promise.then((data: Array<number>) => {
    for (let i = 0; i < data.length; i++) {
L
li-yaoyao777 已提交
3365 3366
      console.info('Succeeded in getting data[' + i + ']: ' + data[i]);
    }
L
li-yaoyao777 已提交
3367
  }, (err: BusinessError.BusinessError) => {
L
li-yaoyao777 已提交
3368 3369 3370
    console.error(`Failed to get rotationMatrix. Code: ${err.code}, message: ${err.message}`);
  });
} catch (error) {
L
li-yaoyao777 已提交
3371 3372
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to get rotationMatrix. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
3373 3374 3375
}
```

C
cff-gite 已提交
3376
## sensor.transformRotationMatrix<sup>9+</sup> 
C
cff-gite 已提交
3377 3378

transformRotationMatrix(inRotationVector: Array&lt;number&gt;, coordinates: CoordinatesOptions,
C
cff-gite 已提交
3379
        callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void
C
cff-gite 已提交
3380

H
h00514358 已提交
3381
根据指定坐标系映射旋转矩阵。
C
cff-gite 已提交
3382 3383 3384 3385 3386 3387 3388

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

**参数:** 

| 参数名           | 类型                                      | 必填 | 说明                   |
| ---------------- | ----------------------------------------- | ---- | ---------------------- |
H
h00514358 已提交
3389 3390 3391
| inRotationVector | Array&lt;number&gt;                       | 是   | 旋转矩阵。         |
| coordinates      | [CoordinatesOptions](#coordinatesoptions) | 是   | 指定坐标系方向。       |
| callback         | AsyncCallback&lt;Array&lt;number&gt;&gt;  | 是   | 回调函数,返回映射后的旋转矩阵。 |
C
cff-gite 已提交
3392

H
h00514358 已提交
3393
**错误码**
C
cff-gite 已提交
3394 3395 3396 3397 3398 3399 3400

以下错误码的详细介绍请参见 [sensor.transformRotationMatrix错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
3401 3402
**示例:** 

L
li-yaoyao777 已提交
3403
```ts
L
li-yaoyao777 已提交
3404 3405 3406
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
3407
try {
L
li-yaoyao777 已提交
3408 3409 3410 3411 3412
  let rotationMatrix = [
    1, 0, 0,
    0, 0.87, -0.50,
    0, 0.50, 0.87
  ];
L
li-yaoyao777 已提交
3413
  sensor.transformRotationMatrix(rotationMatrix, { x: 1, y: 3 }, (err: BusinessError.BusinessError, data: Array<number>) => {
L
li-yaoyao777 已提交
3414 3415 3416 3417
    if (err) {
      console.error(`Failed to transform rotationMatrix. Code: ${err.code}, message: ${err.message}`);
      return;
    }
L
li-yaoyao777 已提交
3418
    for (let i = 0; i < data.length; i++) {
L
li-yaoyao777 已提交
3419 3420 3421 3422
      console.info('Succeeded in getting data[' + i + '] = ' + data[i]);
    }
  })
} catch (error) {
L
li-yaoyao777 已提交
3423 3424
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to transform rotationMatrix. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
3425 3426 3427
}
```

C
cff-gite 已提交
3428
## sensor.transformRotationMatrix<sup>9+</sup>
C
cff-gite 已提交
3429

C
cff-gite 已提交
3430
transformRotationMatrix(inRotationVector: Array&lt;number&gt;, coordinates: CoordinatesOptions): Promise&lt;Array&lt;number&gt;&gt;
C
cff-gite 已提交
3431

H
h00514358 已提交
3432
根据指定坐标系映射旋转矩阵。
C
cff-gite 已提交
3433 3434 3435 3436 3437 3438 3439

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

**参数:**

| 参数名           | 类型                                      | 必填 | 说明             |
| ---------------- | ----------------------------------------- | ---- | ---------------- |
H
h00514358 已提交
3440 3441
| inRotationVector | Array&lt;number&gt;                       | 是   | 旋转矩阵。   |
| coordinates      | [CoordinatesOptions](#coordinatesoptions) | 是   | 指定坐标系方向。 |
C
cff-gite 已提交
3442 3443 3444 3445 3446

**返回值:**

| 类型                               | 说明                   |
| ---------------------------------- | ---------------------- |
H
h00514358 已提交
3447
| Promise&lt;Array&lt;number&gt;&gt; | Promise对象,返回转换后的旋转矩阵。 |
C
cff-gite 已提交
3448

C
cff-gite 已提交
3449 3450 3451 3452 3453 3454 3455 3456
**错误码**

以下错误码的详细介绍请参见 [sensor.transformRotationMatrix错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
3457 3458
**示例:**

L
li-yaoyao777 已提交
3459
```ts
L
li-yaoyao777 已提交
3460 3461 3462
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
3463
try {
L
li-yaoyao777 已提交
3464 3465 3466 3467 3468 3469
  let rotationMatrix = [
    1, 0, 0,
    0, 0.87, -0.50,
    0, 0.50, 0.87
  ];
  const promise = sensor.transformRotationMatrix(rotationMatrix, { x: 1, y: 3 });
L
li-yaoyao777 已提交
3470 3471
  promise.then((data: Array<number>) => {
    for (let i = 0; i < data.length; i++) {
L
li-yaoyao777 已提交
3472 3473
      console.info('Succeeded in getting data[' + i + ']: ' + data[i]);
    }
L
li-yaoyao777 已提交
3474
  }, (err: BusinessError.BusinessError) => {
L
li-yaoyao777 已提交
3475 3476 3477
    console.error(`Failed to transform rotationMatrix. Code: ${err.code}, message: ${err.message}`);
  });
} catch (error) {
L
li-yaoyao777 已提交
3478 3479
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to transform rotationMatrix. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
3480 3481 3482 3483 3484
}
```

## sensor.getQuaternion<sup>9+</sup> 

C
cff-gite 已提交
3485
getQuaternion(rotationVector: Array&lt;number&gt;, callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void 
C
cff-gite 已提交
3486

H
h00514358 已提交
3487
根据旋转向量计算归一化四元数。
C
cff-gite 已提交
3488 3489 3490 3491 3492 3493 3494

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

**参数:** 

| 参数名         | 类型                                     | 必填 | 说明           |
| -------------- | ---------------------------------------- | ---- | -------------- |
H
h00514358 已提交
3495 3496
| rotationVector | Array&lt;number&gt;                      | 是   | 旋转矢量。 |
| callback       | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是   | 回调函数,返回归一化四元数。   |
C
cff-gite 已提交
3497

C
cff-gite 已提交
3498 3499 3500 3501 3502 3503 3504 3505
**错误码**

以下错误码的详细介绍请参见 [sensor.getQuaternion错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
3506 3507
**示例:**

L
li-yaoyao777 已提交
3508
```ts
L
li-yaoyao777 已提交
3509 3510 3511
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
3512
try {
L
li-yaoyao777 已提交
3513
  let rotationVector = [0.20046076, 0.21907, 0.73978853, 0.60376877];
L
li-yaoyao777 已提交
3514
  sensor.getQuaternion(rotationVector, (err: BusinessError.BusinessError, data: Array<number>) => {
L
li-yaoyao777 已提交
3515 3516 3517 3518
    if (err) {
      console.error(`Failed to get quaternion. Code: ${err.code}, message: ${err.message}`);
      return;
    }
L
li-yaoyao777 已提交
3519
    for (let i = 0; i < data.length; i++) {
L
li-yaoyao777 已提交
3520 3521 3522 3523
      console.info('Succeeded in getting data[' + i + ']: ' + data[i]);
    }
  })
} catch (error) {
L
li-yaoyao777 已提交
3524 3525
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to get quaternion. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
3526 3527 3528 3529 3530
}
```

## sensor.getQuaternion<sup>9+</sup>

C
cff-gite 已提交
3531
getQuaternion(rotationVector: Array&lt;number&gt;): Promise&lt;Array&lt;number&gt;&gt;
C
cff-gite 已提交
3532

H
h00514358 已提交
3533
根据旋转向量计算归一化四元数。
C
cff-gite 已提交
3534 3535 3536 3537 3538 3539 3540

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

**参数:**

| 参数名         | 类型                | 必填 | 说明           |
| -------------- | ------------------- | ---- | -------------- |
H
h00514358 已提交
3541
| rotationVector | Array&lt;number&gt; | 是   | 旋转矢量。 |
C
cff-gite 已提交
3542 3543 3544 3545 3546

**返回值:**

| 类型                               | 说明         |
| ---------------------------------- | ------------ |
H
h00514358 已提交
3547
| Promise&lt;Array&lt;number&gt;&gt; | Promise,对象返归一化回四元数。 |
C
cff-gite 已提交
3548

C
cff-gite 已提交
3549 3550 3551 3552 3553 3554 3555 3556
**错误码**

以下错误码的详细介绍请参见 [sensor.getQuaternion错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
3557 3558
**示例:** 

L
li-yaoyao777 已提交
3559
```ts
L
li-yaoyao777 已提交
3560 3561 3562
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
3563
try {
H
h00514358 已提交
3564 3565
    let rotationVector = [0.20046076, 0.21907, 0.73978853, 0.60376877];
    const promise = sensor.getQuaternion(rotationVector);
L
li-yaoyao777 已提交
3566 3567
    promise.then((data: Array<number>) => {
        for (let i = 0; i < data.length; i++) {
L
li-yaoyao777 已提交
3568
            console.info('Succeeded in getting data[' + i + ']: ' + data[i]);
H
h00514358 已提交
3569
        }
L
li-yaoyao777 已提交
3570
    }, (err: BusinessError.BusinessError) => {
L
li-yaoyao777 已提交
3571
        console.error(`Failed to get quaternion. Code: ${err.code}, message: ${err.message}`);
H
h00514358 已提交
3572
    });
L
li-yaoyao777 已提交
3573
} catch (error) {
L
li-yaoyao777 已提交
3574 3575
    let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
    console.error(`Failed to get quaternion. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
3576 3577 3578 3579 3580
}
```

## sensor.getOrientation<sup>9+</sup>

C
cff-gite 已提交
3581
getOrientation(rotationMatrix: Array&lt;number&gt;, callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void 
C
cff-gite 已提交
3582

H
h00514358 已提交
3583
根据旋转矩阵计算设备方向。
C
cff-gite 已提交
3584 3585 3586 3587 3588 3589 3590

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

**参数:**

| 参数名         | 类型                                     | 必填 | 说明                              |
| -------------- | ---------------------------------------- | ---- | --------------------------------- |
H
h00514358 已提交
3591 3592
| rotationMatrix | Array&lt;number&gt;                      | 是   | 旋转矩阵。                    |
| callback       | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是   | 回调函数,返回围绕z、x、y轴方向的旋转角度。 |
C
cff-gite 已提交
3593

C
cff-gite 已提交
3594 3595 3596 3597 3598 3599 3600 3601
**错误码**

以下错误码的详细介绍请参见 [sensor.getOrientation错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
3602 3603
**示例:** 

L
li-yaoyao777 已提交
3604
```ts
L
li-yaoyao777 已提交
3605 3606 3607
import sensor from "@ohos.sensor"
import BusinessError from "@ohos.base"

C
cff-gite 已提交
3608
try {
L
li-yaoyao777 已提交
3609 3610 3611 3612 3613
  let preRotationMatrix = [
    1, 0, 0,
    0, 0.87, -0.50,
    0, 0.50, 0.87
  ];
L
li-yaoyao777 已提交
3614
  sensor.getOrientation(preRotationMatrix, (err: BusinessError.BusinessError, data: Array<number>) => {
L
li-yaoyao777 已提交
3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626
    if (err) {
      console.error(`Failed to get orientation. Code: ${err.code}, message: ${err.message}`);
      return;
    }
    if (data.length < 3) {
      console.error("Failed to get orientation, length" + data.length);
    }
    console.info("Succeeded in getting data. Z: " + data[0]);
    console.info("Succeeded in getting data. X: " + data[1]);
    console.info("Succeeded in getting data. Y: " + data[2]);
  })
} catch (error) {
L
li-yaoyao777 已提交
3627 3628
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to get orientation. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
3629 3630 3631 3632 3633
}
```

## sensor.getOrientation<sup>9+</sup>

C
cff-gite 已提交
3634
getOrientation(rotationMatrix: Array&lt;number&gt;): Promise&lt;Array&lt;number&gt;&gt;
C
cff-gite 已提交
3635 3636 3637 3638 3639 3640 3641 3642 3643

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

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

**参数:**

| 参数名         | 类型                | 必填 | 说明           |
| -------------- | ------------------- | ---- | -------------- |
H
h00514358 已提交
3644
| rotationMatrix | Array&lt;number&gt; | 是   | 旋转矩阵。 |
C
cff-gite 已提交
3645 3646 3647 3648 3649

**返回值:**

| 类型                               | 说明                              |
| ---------------------------------- | --------------------------------- |
H
h00514358 已提交
3650
| Promise&lt;Array&lt;number&gt;&gt; | Promise对象,返回围绕z、x、y轴方向的旋转角度。 |
C
cff-gite 已提交
3651

C
cff-gite 已提交
3652 3653 3654 3655 3656 3657 3658 3659
**错误码**

以下错误码的详细介绍请参见 [sensor.getOrientation错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
3660 3661
**示例:** 

L
li-yaoyao777 已提交
3662
```ts
L
li-yaoyao777 已提交
3663 3664 3665
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

C
cff-gite 已提交
3666
try {
L
li-yaoyao777 已提交
3667 3668 3669 3670 3671 3672
  let preRotationMatrix = [
    1, 0, 0,
    0, 0.87, -0.50,
    0, 0.50, 0.87
  ];
  const promise = sensor.getOrientation(preRotationMatrix);
L
li-yaoyao777 已提交
3673 3674
  promise.then((data: Array<number>) => {
    for (let i = 0; i < data.length; i++) {
L
li-yaoyao777 已提交
3675 3676
      console.info('Succeeded in getting data[' + i + ']: ' + data[i]);
    }
L
li-yaoyao777 已提交
3677
  }, (err: BusinessError.BusinessError) => {
L
li-yaoyao777 已提交
3678 3679 3680
    console.error(`Failed to getOrientatin. Code: ${err.code}, message: ${err.message}`);
  });
} catch (error) {
L
li-yaoyao777 已提交
3681 3682
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to getOrientatin Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
3683 3684 3685
}
```

C
cff-gite 已提交
3686
## sensor.getRotationMatrix<sup>9+</sup> 
C
cff-gite 已提交
3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697

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

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

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

**参数:** 

| 参数名      | 类型                                                         | 必填 | 说明           |
| ----------- | ------------------------------------------------------------ | ---- | -------------- |
H
h00514358 已提交
3698 3699 3700
| gravity     | Array&lt;number&gt;                                          | 是   | 重力矢量。 |
| geomagnetic | Array&lt;number&gt;                                          | 是   | 地磁矢量。 |
| callback    | AsyncCallback&lt;[RotationMatrixResponse](#rotationmatrixresponse)&gt; | 是   | 回调函数,返回旋转矩阵。 |
C
cff-gite 已提交
3701

C
cff-gite 已提交
3702 3703 3704 3705 3706 3707 3708 3709
**错误码**

以下错误码的详细介绍请参见 [sensor.getRotationMatrix错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
3710 3711
**示例:**

L
li-yaoyao777 已提交
3712
```ts
L
li-yaoyao777 已提交
3713 3714 3715
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

C
cff-gite 已提交
3716
try {
L
li-yaoyao777 已提交
3717 3718
  let gravity = [-0.27775216, 0.5351276, 9.788099];
  let geomagnetic = [210.87253, -78.6096, -111.44444];
L
li-yaoyao777 已提交
3719
  sensor.getRotationMatrix(gravity, geomagnetic, (err: BusinessError.BusinessError, data: sensor.RotationMatrixResponse) => {
L
li-yaoyao777 已提交
3720 3721 3722 3723 3724 3725 3726
    if (err) {
      console.error(`Failed to get rotationMatrix. Code: ${err.code}, message: ${err.message}`);
      return;
    }
    console.info('Succeeded in getting rotationMatrix' + JSON.stringify(data));
  })
} catch (error) {
L
li-yaoyao777 已提交
3727 3728
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to get rotationMatrix. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
3729 3730 3731
}
```

C
cff-gite 已提交
3732
## sensor.getRotationMatrix<sup>9+</sup> 
C
cff-gite 已提交
3733

C
cff-gite 已提交
3734
getRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&gt;): Promise&lt;RotationMatrixResponse&gt;
C
cff-gite 已提交
3735 3736 3737 3738 3739 3740 3741 3742 3743

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

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

**参数:** 

| 参数名      | 类型                | 必填 | 说明           |
| ----------- | ------------------- | ---- | -------------- |
H
h00514358 已提交
3744 3745
| gravity     | Array&lt;number&gt; | 是   | 重力向量。 |
| geomagnetic | Array&lt;number&gt; | 是   | 地磁矢量。 |
C
cff-gite 已提交
3746 3747 3748 3749 3750

**返回值:** 

| 类型                                                         | 说明           |
| ------------------------------------------------------------ | -------------- |
H
h00514358 已提交
3751
| Promise&lt;[RotationMatrixResponse](#rotationmatrixresponse)&gt; | Promise对象,返回旋转矩阵。 |
C
cff-gite 已提交
3752

C
cff-gite 已提交
3753 3754 3755 3756 3757 3758 3759 3760
**错误码**

以下错误码的详细介绍请参见 [sensor.getRotationMatrix错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
3761 3762
**示例:** 

L
li-yaoyao777 已提交
3763
```ts
L
li-yaoyao777 已提交
3764 3765 3766
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

C
cff-gite 已提交
3767
try {
L
li-yaoyao777 已提交
3768 3769 3770
  let gravity = [-0.27775216, 0.5351276, 9.788099];
  let geomagnetic = [210.87253, -78.6096, -111.44444];
  const promise = sensor.getRotationMatrix(gravity, geomagnetic);
L
li-yaoyao777 已提交
3771
  promise.then((data: sensor.RotationMatrixResponse) => {
L
li-yaoyao777 已提交
3772
    console.info('Succeeded in getting rotationMatrix' + JSON.stringify(data));
L
li-yaoyao777 已提交
3773
  }, (err: BusinessError.BusinessError) => {
L
li-yaoyao777 已提交
3774 3775 3776
    console.error(`Failed to get rotationMatrix. Code: ${err.code}, message: ${err.message}`);
  });
} catch (error) {
L
li-yaoyao777 已提交
3777 3778
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to get rotationMatrix. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
3779 3780 3781
}
```

C
cff-gite 已提交
3782
## sensor.getSensorList<sup>9+</sup>
C
cff-gite 已提交
3783

C
cff-gite 已提交
3784
getSensorList(callback: AsyncCallback&lt;Array&lt;Sensor&gt;&gt;): void
C
cff-gite 已提交
3785

C
cff-gite 已提交
3786
获取设备上的所有传感器信息。
C
cff-gite 已提交
3787

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

C
cff-gite 已提交
3790
**参数:** 
C
cff-gite 已提交
3791

C
cff-gite 已提交
3792 3793
| 参数名   | 类型                                           | 必填 | 说明             |
| -------- | ---------------------------------------------- | ---- | ---------------- |
C
cff-gite 已提交
3794
| callback | AsyncCallback&lt;Array&lt;[Sensor](#sensor9)&gt;&gt; | 是   | 回调函数,返回传感器属性列表。 |
Z
zengyawen 已提交
3795

C
cff-gite 已提交
3796 3797 3798 3799 3800 3801 3802 3803
**错误码**

以下错误码的详细介绍请参见 [sensor.getSensorList错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
3804
**示例:** 
Z
zengyawen 已提交
3805

L
li-yaoyao777 已提交
3806
```ts
L
li-yaoyao777 已提交
3807 3808 3809
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

C
cff-gite 已提交
3810
try {
L
li-yaoyao777 已提交
3811
  sensor.getSensorList((err: BusinessError.BusinessError, data: Array<sensor.Sensor>) => {
L
li-yaoyao777 已提交
3812 3813 3814 3815
    if (err) {
      console.error(`Failed to get sensorList. Code: ${err.code}, message: ${err.message}`);
      return;
    }
L
li-yaoyao777 已提交
3816
    for (let i = 0; i < data.length; i++) {
L
li-yaoyao777 已提交
3817 3818 3819 3820
      console.info('Succeeded in getting data[' + i + ']: ' + JSON.stringify(data[i]));
    }
  });
} catch (error) {
L
li-yaoyao777 已提交
3821 3822
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to get sensorList. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
3823
}
C
cff-gite 已提交
3824
```
Z
zengyawen 已提交
3825

C
cff-gite 已提交
3826
## sensor.getSensorList<sup>9+</sup>
C
cff-gite 已提交
3827

C
cff-gite 已提交
3828
 getSensorList(): Promise&lt;Array&lt;Sensor&gt;&gt;
C
cff-gite 已提交
3829 3830

获取设备上的所有传感器信息。
C
cff-gite 已提交
3831 3832 3833

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

C
cff-gite 已提交
3834
**返回值:** 
C
cff-gite 已提交
3835

C
cff-gite 已提交
3836 3837
| 参数名  | 类型                                     | 必填 | 说明             |
| ------- | ---------------------------------------- | ---- | ---------------- |
C
cff-gite 已提交
3838
| promise | Promise&lt;Array&lt;[Sensor](#sensor9)&gt;&gt; | 是   | Promise对象,返回传感器属性列表。 |
Z
zengyawen 已提交
3839

C
cff-gite 已提交
3840 3841 3842 3843 3844 3845 3846 3847
**错误码**

以下错误码的详细介绍请参见 [sensor.getSensorList错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

H
HelloCrease 已提交
3848
**示例:** 
C
cff-gite 已提交
3849

L
li-yaoyao777 已提交
3850
```ts
L
li-yaoyao777 已提交
3851 3852 3853
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

C
cff-gite 已提交
3854
try {
L
li-yaoyao777 已提交
3855 3856
  sensor.getSensorList().then((data: Array<sensor.Sensor>) => {
    for (let i = 0; i < data.length; i++) {
L
li-yaoyao777 已提交
3857 3858
      console.info('Succeeded in getting data[' + i + ']: ' + JSON.stringify(data[i]));
    }
L
li-yaoyao777 已提交
3859
  }, (err: BusinessError.BusinessError) => {
L
li-yaoyao777 已提交
3860 3861 3862
    console.error(`Failed to get sensorList. Code: ${err.code}, message: ${err.message}`);
  });
} catch (error) {
L
li-yaoyao777 已提交
3863 3864
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to get sensorList. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
3865
}
C
cff-gite 已提交
3866
```
Z
zengyawen 已提交
3867

C
cff-gite 已提交
3868
##  sensor.getSingleSensor<sup>9+</sup>
Z
zengyawen 已提交
3869

C
cff-gite 已提交
3870
getSingleSensor(type: SensorId, callback: AsyncCallback&lt;Sensor&gt;): void
H
h00514358 已提交
3871

H
h00514358 已提交
3872
获取指定传感器类型的属性信息。
C
cff-gite 已提交
3873 3874 3875

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

H
HelloCrease 已提交
3876
**参数:** 
C
cff-gite 已提交
3877

C
cff-gite 已提交
3878 3879
| 参数名   | 类型                                    | 必填 | 说明             |
| -------- | --------------------------------------- | ---- | ---------------- |
H
h00514358 已提交
3880 3881
| type     | [SensorId](#sensorid9)                  | 是   | 指定传感器类型。     |
| callback | AsyncCallback&lt;[Sensor](#sensor9)&gt; | 是   | 回调函数,返回指定传感器的属性信息。 |
H
h00514358 已提交
3882

C
cff-gite 已提交
3883 3884 3885 3886 3887 3888 3889 3890
**错误码**

以下错误码的详细介绍请参见 [sensor.getSingleSensor错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
3891
**示例:**
H
h00514358 已提交
3892

L
li-yaoyao777 已提交
3893
```ts
L
li-yaoyao777 已提交
3894 3895 3896
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

C
cff-gite 已提交
3897
try {
L
li-yaoyao777 已提交
3898
  sensor.getSingleSensor(sensor.SensorId.ACCELEROMETER, (err: BusinessError.BusinessError, data: sensor.Sensor) => {
L
li-yaoyao777 已提交
3899 3900 3901 3902 3903 3904 3905
    if (err) {
      console.error(`Failed to get singleSensor. Code: ${err.code}, message: ${err.message}`);
      return;
    }
    console.info('Succeeded in getting sensor: ' + JSON.stringify(data));
  });
} catch (error) {
L
li-yaoyao777 已提交
3906 3907
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to get singleSensor. Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
3908
}
C
cff-gite 已提交
3909
```
H
h00514358 已提交
3910

C
cff-gite 已提交
3911
##  sensor.getSingleSensor<sup>9+</sup>
H
h00514358 已提交
3912

C
cff-gite 已提交
3913
 getSingleSensor(type: SensorId): Promise&lt;Sensor&gt;
H
h00514358 已提交
3914

C
cff-gite 已提交
3915
获取指定类型的传感器信息。
H
h00514358 已提交
3916

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

C
cff-gite 已提交
3919
**参数:** 
H
h00514358 已提交
3920

C
cff-gite 已提交
3921 3922 3923
| 参数名 | 类型                   | 必填 | 说明         |
| ------ | ---------------------- | ---- | ------------ |
| type   | [SensorId](#sensorid9) | 是   | 传感器类型。 |
Z
zengyawen 已提交
3924

C
cff-gite 已提交
3925
**返回值:** 
Z
zengyawen 已提交
3926

C
cff-gite 已提交
3927 3928 3929
| 参数名  | 类型                              | 必填 | 说明             |
| ------- | --------------------------------- | ---- | ---------------- |
| promise | Promise&lt;[Sensor](#sensor9)&gt; | 是   | 返回传感器信息。 |
Z
zengyawen 已提交
3930

C
cff-gite 已提交
3931 3932 3933 3934 3935 3936 3937 3938
**错误码**

以下错误码的详细介绍请参见 [sensor.getSingleSensor错误码](../errorcodes/errorcode-sensor.md)

| 错误码ID | 错误信息           |
| -------- | ------------------ |
| 14500101 | Service exception. |

C
cff-gite 已提交
3939
**示例:**
C
cff-gite 已提交
3940

L
li-yaoyao777 已提交
3941
```ts
L
li-yaoyao777 已提交
3942 3943 3944
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

C
cff-gite 已提交
3945
try {
L
li-yaoyao777 已提交
3946
  sensor.getSingleSensor(sensor.SensorId.ACCELEROMETER).then((data: sensor.Sensor) => {
L
li-yaoyao777 已提交
3947
    console.info('Succeeded in getting sensor: ' + JSON.stringify(data));
L
li-yaoyao777 已提交
3948
  }, (err: BusinessError.BusinessError) => {
L
li-yaoyao777 已提交
3949 3950 3951
    console.error(`Failed to get singleSensor . Code: ${err.code}, message: ${err.message}`);
  });
} catch (error) {
L
li-yaoyao777 已提交
3952 3953
  let e: BusinessError.BusinessError = error as BusinessError.BusinessError;
  console.error(`Failed to get singleSensor . Code: ${e.code}, message: ${e.message}`);
C
cff-gite 已提交
3954
}
C
cff-gite 已提交
3955
```
C
cff-gite 已提交
3956

C
cff-gite 已提交
3957
## SensorId<sup>9+</sup>
C
cff-gite 已提交
3958

N
ningning 已提交
3959
表示当前支持订阅或取消订阅的传感器类型。
C
cff-gite 已提交
3960

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

C
cff-gite 已提交
3963 3964 3965 3966 3967 3968 3969 3970 3971 3972
| 名称                        | 值   | 说明                   |
| --------------------------- | ---- | ---------------------- |
| ACCELEROMETER               | 1    | 加速度传感器。         |
| GYROSCOPE                   | 2    | 陀螺仪传感器。         |
| AMBIENT_LIGHT               | 5    | 环境光传感器。         |
| MAGNETIC_FIELD              | 6    | 磁场传感器。           |
| BAROMETER                   | 8    | 气压计传感器。         |
| HALL                        | 10   | 霍尔传感器。           |
| PROXIMITY                   | 12   | 接近光传感器。         |
| HUMIDITY                    | 13   | 湿度传感器。           |
3973 3974
| COLOR<sup>10+</sup>         | 14   | 颜色传感器。<br>系统API:此接口为系统接口     |
| SAR<sup>10+</sup>           | 15   | 吸收比率传感器。<br>系统API:此接口为系统接口 |
C
cff-gite 已提交
3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987
| ORIENTATION                 | 256  | 方向传感器。           |
| GRAVITY                     | 257  | 重力传感器。           |
| LINEAR_ACCELEROMETER        | 258  | 线性加速度传感器。     |
| ROTATION_VECTOR             | 259  | 旋转矢量传感器。       |
| AMBIENT_TEMPERATURE         | 260  | 环境温度传感器。       |
| MAGNETIC_FIELD_UNCALIBRATED | 261  | 未校准磁场传感器。     |
| GYROSCOPE_UNCALIBRATED      | 263  | 未校准陀螺仪传感器。   |
| SIGNIFICANT_MOTION          | 264  | 有效运动传感器。       |
| PEDOMETER_DETECTION         | 265  | 计步检测传感器。       |
| PEDOMETER                   | 266  | 计步传感器。           |
| HEART_RATE                  | 278  | 心率传感器。           |
| WEAR_DETECTION              | 280  | 佩戴检测传感器。       |
| ACCELEROMETER_UNCALIBRATED  | 281  | 未校准加速度计传感器。 |
Z
zengyawen 已提交
3988

C
cff-gite 已提交
3989
## SensorType<sup>(deprecated)</sup>
Z
zengyawen 已提交
3990

C
cff-gite 已提交
3991
表示要订阅或取消订阅的传感器类型。
Z
zengyawen 已提交
3992

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

C
cff-gite 已提交
3995

C
cff-gite 已提交
3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018
| 名称                                       | 值   | 说明                   |
| ------------------------------------------ | ---- | ---------------------- |
| 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  | 未校准加速度计传感器。 |
C
cff-gite 已提交
4019

C
cff-gite 已提交
4020
## Response
Z
zengyawen 已提交
4021

C
cff-gite 已提交
4022
传感器数据的时间戳。
Z
zengyawen 已提交
4023

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

C
cff-gite 已提交
4026 4027 4028
| 名称      | 类型   | 可读 | 可写 | 说明                     |
| --------- | ------ | ---- | ---- | ------------------------ |
| timestamp | number | 是   | 是   | 传感器数据上报的时间戳。 |
Z
zengyawen 已提交
4029

C
cff-gite 已提交
4030
## Sensor<sup>9+</sup>
Z
zengyawen 已提交
4031

C
cff-gite 已提交
4032
指示传感器信息。
C
cff-gite 已提交
4033

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

C
cff-gite 已提交
4036 4037
| 名称            | 类型 | 可读 | 可写 | 说明                   |
| --------------- | -------- | ---------------------- | ---------------------- | ---------------------- |
4038
| sensorName      | string   | 是  | 否  | 传感器名称。            |
4039 4040 4041 4042 4043 4044 4045 4046
| vendorName      | string   | 是  | 否  | 传感器供应商。         |
| firmwareVersion | string   | 是  | 否  | 传感器固件版本。       |
| hardwareVersion | string   | 是  | 否  | 传感器硬件版本。       |
| sensorId        | number   | 是  | 否  | 传感器类型id。         |
| maxRange        | number   | 是  | 否  | 传感器测量范围的最大值。 |
| minSamplePeriod | number   | 是  | 否  | 允许的最小采样周期。   |
| maxSamplePeriod | number   | 是  | 否  | 允许的最大采样周期。   |
| precision       | number   | 是  | 否  | 传感器精度。           |
4047
| power           | number   | 是  | 否  | 传感器功率的估计值,单位:mA。  |
C
cff-gite 已提交
4048

L
li-yaoyao777 已提交
4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075
## ColorResponse<sup>10+</sup>

颜色传感器数据,继承于[Response](#response)

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

**系统API**:此接口为系统接口


| 名称             | 类型   | 可读 | 可写 | 说明                          |
| ---------------- | ------ | ---- | ---- | ----------------------------- |
| lightIntensity   | number | 是   | 是   | 表示光的强度,单位 : 勒克斯。 |
| colorTemperature | number | 是   | 是   | 表示色温,单位 : 开尔文。     |

## SarResponse<sup>10+</sup>

吸收比率传感器数据,继承于[Response](#response)

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

**系统API**:此接口为系统接口


| 名称            | 类型   | 可读 | 可写 | 说明                            |
| --------------- | ------ | ---- | ---- | ------------------------------- |
| absorptionRatio | number | 是   | 是   | 表示具体的吸收率,单位 : W/kg。 |

C
cff-gite 已提交
4076
## AccelerometerResponse
C
cff-gite 已提交
4077

C
cff-gite 已提交
4078
加速度传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
4079

C
cff-gite 已提交
4080
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
Z
zengyawen 已提交
4081 4082


C
cff-gite 已提交
4083 4084
| 名称 | 类型   | 可读 | 可写 | 说明                                 |
| ---- | ------ | ---- | ---- | ------------------------------------ |
L
li-yaoyao777 已提交
4085 4086 4087
| x    | number | 是   | 是   | 施加在设备x轴的加速度,单位 : m/s²。 |
| y    | number | 是   | 是   | 施加在设备y轴的加速度,单位 : m/s²。 |
| z    | number | 是   | 是   | 施加在设备z轴的加速度,单位 : m/s²。 |
Z
zengyawen 已提交
4088 4089


C
cff-gite 已提交
4090
## LinearAccelerometerResponse
C
cff-gite 已提交
4091

C
cff-gite 已提交
4092
线性加速度传感器数据,继承于[Response](#response)
C
cff-gite 已提交
4093

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

C
cff-gite 已提交
4096

C
cff-gite 已提交
4097 4098
| 名称 | 类型   | 可读 | 可写 | 说明                                     |
| ---- | ------ | ---- | ---- | ---------------------------------------- |
L
li-yaoyao777 已提交
4099 4100 4101
| x    | number | 是   | 是   | 施加在设备x轴的线性加速度,单位 : m/s²。 |
| y    | number | 是   | 是   | 施加在设备y轴的线性加速度,单位 : m/s²。 |
| z    | number | 是   | 是   | 施加在设备z轴的线性加速度,单位 : m/s²。 |
Z
zengyawen 已提交
4102

Z
zengyawen 已提交
4103

C
cff-gite 已提交
4104
## AccelerometerUncalibratedResponse
Z
zengyawen 已提交
4105

C
cff-gite 已提交
4106
未校准加速度计传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
4107

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

C
cff-gite 已提交
4110

C
cff-gite 已提交
4111 4112
| 名称  | 类型   | 可读 | 可写 | 说明                                             |
| ----- | ------ | ---- | ---- | ------------------------------------------------ |
L
li-yaoyao777 已提交
4113 4114 4115 4116 4117 4118
| x     | number | 是   | 是   | 施加在设备x轴未校准的加速度,单位 : m/s²。       |
| y     | number | 是   | 是   | 施加在设备y轴未校准的加速度,单位 : m/s²。       |
| z     | number | 是   | 是   | 施加在设备z轴未校准的加速度,单位 : m/s²。       |
| biasX | number | 是   | 是   | 施加在设备x轴未校准的加速度偏量,单位 : m/s²。   |
| biasY | number | 是   | 是   | 施加在设备上y轴未校准的加速度偏量,单位 : m/s²。 |
| biasZ | number | 是   | 是   | 施加在设备z轴未校准的加速度偏量,单位 : m/s²。   |
C
cff-gite 已提交
4119

C
cff-gite 已提交
4120

C
cff-gite 已提交
4121
## GravityResponse
Z
zengyawen 已提交
4122

C
cff-gite 已提交
4123
重力传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
4124

C
cff-gite 已提交
4125
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
Z
zengyawen 已提交
4126 4127


C
cff-gite 已提交
4128 4129
| 名称 | 类型   | 可读 | 可写 | 说明                                     |
| ---- | ------ | ---- | ---- | ---------------------------------------- |
L
li-yaoyao777 已提交
4130 4131 4132
| x    | number | 是   | 是   | 施加在设备x轴的重力加速度,单位 : m/s²。 |
| y    | number | 是   | 是   | 施加在设备y轴的重力加速度,单位 : m/s²。 |
| z    | number | 是   | 是   | 施加在设备z轴的重力加速度,单位 : m/s²。 |
Z
zengyawen 已提交
4133

C
cff-gite 已提交
4134

C
cff-gite 已提交
4135
## OrientationResponse
C
cff-gite 已提交
4136

C
cff-gite 已提交
4137
方向传感器数据,继承于[Response](#response)
C
cff-gite 已提交
4138

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

Z
zengyawen 已提交
4141

C
cff-gite 已提交
4142 4143 4144 4145 4146
| 名称  | 类型   | 可读 | 可写 | 说明                              |
| ----- | ------ | ---- | ---- | --------------------------------- |
| alpha | number | 是   | 是   | 设备围绕Z轴的旋转角度,单位:度。 |
| beta  | number | 是   | 是   | 设备围绕X轴的旋转角度,单位:度。 |
| gamma | number | 是   | 是   | 设备围绕Y轴的旋转角度,单位:度。 |
Z
zengyawen 已提交
4147 4148


C
cff-gite 已提交
4149
## RotationVectorResponse
Z
zengyawen 已提交
4150

C
cff-gite 已提交
4151
旋转矢量传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
4152

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

C
cff-gite 已提交
4155

C
cff-gite 已提交
4156 4157 4158 4159 4160 4161
| 名称 | 类型   | 可读 | 可写 | 说明              |
| ---- | ------ | ---- | ---- | ----------------- |
| x    | number | 是   | 是   | 旋转矢量x轴分量。 |
| y    | number | 是   | 是   | 旋转矢量y轴分量。 |
| z    | number | 是   | 是   | 旋转矢量z轴分量。 |
| w    | number | 是   | 是   | 标量。            |
C
cff-gite 已提交
4162

C
cff-gite 已提交
4163

C
cff-gite 已提交
4164
## GyroscopeResponse
Z
zengyawen 已提交
4165

C
cff-gite 已提交
4166
陀螺仪传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
4167

C
cff-gite 已提交
4168
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
Z
zengyawen 已提交
4169 4170


C
cff-gite 已提交
4171 4172 4173 4174 4175
| 名称 | 类型   | 可读 | 可写 | 说明                             |
| ---- | ------ | ---- | ---- | -------------------------------- |
| x    | number | 是   | 是   | 设备x轴的旋转角速度,单位rad/s。 |
| y    | number | 是   | 是   | 设备y轴的旋转角速度,单位rad/s。 |
| z    | number | 是   | 是   | 设备z轴的旋转角速度,单位rad/s。 |
Z
zengyawen 已提交
4176

C
cff-gite 已提交
4177

C
cff-gite 已提交
4178
## GyroscopeUncalibratedResponse
C
cff-gite 已提交
4179

C
cff-gite 已提交
4180
未校准陀螺仪传感器数据,继承于[Response](#response)
C
cff-gite 已提交
4181

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

C
cff-gite 已提交
4184

C
cff-gite 已提交
4185 4186 4187 4188 4189 4190 4191 4192
| 名称  | 类型   | 可读 | 可写 | 说明                                       |
| ----- | ------ | ---- | ---- | ------------------------------------------ |
| 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 已提交
4193 4194


C
cff-gite 已提交
4195
## SignificantMotionResponse
Z
zengyawen 已提交
4196

C
cff-gite 已提交
4197
有效运动传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
4198

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

C
cff-gite 已提交
4201

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

Z
zengyawen 已提交
4206

C
cff-gite 已提交
4207
## ProximityResponse
C
cff-gite 已提交
4208

C
cff-gite 已提交
4209
接近光传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
4210

C
cff-gite 已提交
4211
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
Z
zengyawen 已提交
4212 4213


C
cff-gite 已提交
4214 4215 4216
| 名称     | 类型   | 可读 | 可写 | 说明                                                   |
| -------- | ------ | ---- | ---- | ------------------------------------------------------ |
| distance | number | 是   | 是   | 可见物体与设备显示器的接近程度。0表示接近,1表示远离。 |
Z
zengyawen 已提交
4217

C
cff-gite 已提交
4218

C
cff-gite 已提交
4219
## LightResponse
C
cff-gite 已提交
4220

C
cff-gite 已提交
4221
环境光传感器数据,继承于[Response](#response)
C
cff-gite 已提交
4222

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

Z
zengyawen 已提交
4225

C
cff-gite 已提交
4226 4227 4228
| 名称      | 类型   | 可读 | 可写 | 说明                   |
| --------- | ------ | ---- | ---- | ---------------------- |
| intensity | number | 是   | 是   | 光强(单位:勒克斯)。 |
Z
zengyawen 已提交
4229 4230


C
cff-gite 已提交
4231
## HallResponse
Z
zengyawen 已提交
4232

C
cff-gite 已提交
4233
霍尔传感器数据,继承于[Response](#response)
C
cff-gite 已提交
4234

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

C
cff-gite 已提交
4237

C
cff-gite 已提交
4238 4239 4240
| 名称   | 类型   | 可读 | 可写 | 说明                                                         |
| ------ | ------ | ---- | ---- | ------------------------------------------------------------ |
| status | number | 是   | 是   | 显示霍尔状态。测量设备周围是否存在磁力吸引,0表示没有,大于0表示有。 |
Z
zengyawen 已提交
4241

Z
zengyawen 已提交
4242

C
cff-gite 已提交
4243
## MagneticFieldResponse
Z
zengyawen 已提交
4244

C
cff-gite 已提交
4245
磁场传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
4246

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

C
cff-gite 已提交
4249

C
cff-gite 已提交
4250 4251 4252 4253 4254
| 名称 | 类型   | 可读 | 可写 | 说明                         |
| ---- | ------ | ---- | ---- | ---------------------------- |
| x    | number | 是   | 是   | x轴环境磁场强度,单位 : μT。 |
| y    | number | 是   | 是   | y轴环境磁场强度,单位 : μT。 |
| z    | number | 是   | 是   | z轴环境磁场强度,单位 : μT。 |
C
cff-gite 已提交
4255

C
cff-gite 已提交
4256

C
cff-gite 已提交
4257
## MagneticFieldUncalibratedResponse
Z
zengyawen 已提交
4258

C
cff-gite 已提交
4259
未校准磁场传感器数据,继承于[Response](#response)
C
cff-gite 已提交
4260

C
cff-gite 已提交
4261
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
Z
zengyawen 已提交
4262 4263


C
cff-gite 已提交
4264 4265 4266 4267 4268 4269 4270 4271
| 名称  | 类型   | 可读 | 可写 | 说明                                   |
| ----- | ------ | ---- | ---- | -------------------------------------- |
| 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 已提交
4272 4273


C
cff-gite 已提交
4274
## PedometerResponse
C
cff-gite 已提交
4275

C
cff-gite 已提交
4276
计步传感器数据,继承于[Response](#response)
C
cff-gite 已提交
4277

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

Z
zengyawen 已提交
4280

C
cff-gite 已提交
4281 4282 4283
| 名称  | 类型   | 可读 | 可写 | 说明             |
| ----- | ------ | ---- | ---- | ---------------- |
| steps | number | 是   | 是   | 用户的行走步数。 |
C
cff-gite 已提交
4284

Z
zengyawen 已提交
4285

C
cff-gite 已提交
4286
## HumidityResponse
Z
zengyawen 已提交
4287

C
cff-gite 已提交
4288
湿度传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
4289

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

C
cff-gite 已提交
4292

C
cff-gite 已提交
4293 4294 4295
| 名称     | 类型   | 可读 | 可写 | 说明                                                      |
| -------- | ------ | ---- | ---- | --------------------------------------------------------- |
| humidity | number | 是   | 是   | 湿度值。测量环境的相对湿度,以百分比&nbsp;(%)&nbsp;表示。 |
C
cff-gite 已提交
4296

C
cff-gite 已提交
4297

C
cff-gite 已提交
4298
## PedometerDetectionResponse
Z
zengyawen 已提交
4299

C
cff-gite 已提交
4300
计步检测传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
4301

C
cff-gite 已提交
4302
**系统能力**:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor
Z
zengyawen 已提交
4303 4304


C
cff-gite 已提交
4305 4306 4307
| 名称   | 类型   | 可读 | 可写 | 说明                                                         |
| ------ | ------ | ---- | ---- | ------------------------------------------------------------ |
| scalar | number | 是   | 是   | 计步器检测。检测用户的计步动作,如果取值为1则代表用户产生了计步行走的动作,取值为0则代表用户没有发生运动。 |
Z
zengyawen 已提交
4308

C
cff-gite 已提交
4309

C
cff-gite 已提交
4310
## AmbientTemperatureResponse
C
cff-gite 已提交
4311

C
cff-gite 已提交
4312
温度传感器数据,继承于[Response](#response)
C
cff-gite 已提交
4313

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

C
cff-gite 已提交
4316

C
cff-gite 已提交
4317 4318 4319
| 名称        | 类型   | 可读 | 可写 | 说明                       |
| ----------- | ------ | ---- | ---- | -------------------------- |
| temperature | number | 是   | 是   | 环境温度(单位:摄氏度)。 |
Z
zengyawen 已提交
4320 4321


C
cff-gite 已提交
4322
## BarometerResponse
Z
zengyawen 已提交
4323

C
cff-gite 已提交
4324
气压计传感器数据,继承于[Response](#response)
Z
zengyawen 已提交
4325

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

C
cff-gite 已提交
4328

C
cff-gite 已提交
4329 4330 4331
| 名称     | 类型   | 可读 | 可写 | 说明                     |
| -------- | ------ | ---- | ---- | ------------------------ |
| pressure | number | 是   | 是   | 压力值(单位:帕斯卡)。 |
C
cff-gite 已提交
4332

Z
zengyawen 已提交
4333

C
cff-gite 已提交
4334
## HeartRateResponse
Z
zengyawen 已提交
4335

C
cff-gite 已提交
4336
心率传感器数据,继承于[Response](#response)
C
cff-gite 已提交
4337

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


C
cff-gite 已提交
4341 4342 4343
| 名称      | 类型   | 可读 | 可写 | 说明                                    |
| --------- | ------ | ---- | ---- | --------------------------------------- |
| heartRate | number | 是   | 是   | 心率值。测量用户的心率数值,单位:bpm。 |
H
h00514358 已提交
4344

C
cff-gite 已提交
4345

C
cff-gite 已提交
4346
## WearDetectionResponse
C
cff-gite 已提交
4347

C
cff-gite 已提交
4348
佩戴检测传感器数据,继承于[Response](#response)
C
cff-gite 已提交
4349

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

H
h00514358 已提交
4352

C
cff-gite 已提交
4353 4354 4355
| 名称  | 类型   | 可读 | 可写 | 说明                                             |
| ----- | ------ | ---- | ---- | ------------------------------------------------ |
| value | number | 是   | 是   | 表示设备是否被穿戴(1表示已穿戴,0表示未穿戴)。 |
H
h00514358 已提交
4356 4357


C
cff-gite 已提交
4358
## Options
H
h00514358 已提交
4359

C
cff-gite 已提交
4360
设置传感器上报频率。
H
h00514358 已提交
4361

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

C
cff-gite 已提交
4364
| 名称     | 类型   | 可读 | 可写 | 说明                                        |
C
cff-gite 已提交
4365 4366
| -------- | ------ | ---- | ---- | ------------------------------------------- |
| interval | number | 是   | 是   | 表示传感器的上报频率,默认值为200000000ns。 |
H
h00514358 已提交
4367

C
cff-gite 已提交
4368
## RotationMatrixResponse
H
h00514358 已提交
4369

C
cff-gite 已提交
4370
设置旋转矩阵响应对象。
H
h00514358 已提交
4371

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

C
cff-gite 已提交
4374
| 名称        | 类型                | 可读 | 可写 | 说明       |
C
cff-gite 已提交
4375 4376 4377
| ----------- | ------------------- | ---- | ---- | ---------- |
| rotation    | Array&lt;number&gt; | 是   | 是   | 旋转矩阵。 |
| inclination | Array&lt;number&gt; | 是   | 是   | 倾斜矩阵。 |
Z
zengyawen 已提交
4378 4379


C
cff-gite 已提交
4380
## CoordinatesOptions
C
cff-gite 已提交
4381

C
cff-gite 已提交
4382
设置坐标选项对象。
C
cff-gite 已提交
4383

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

C
cff-gite 已提交
4386 4387 4388 4389
| 名称 | 类型   | 可读 | 可写 | 说明        |
| ---- | ------ | ---- | ---- | ----------- |
| x    | number | 是   | 是   | x坐标方向。 |
| y    | number | 是   | 是   | y坐标方向。 |
Z
zengyawen 已提交
4390

Z
zengyawen 已提交
4391

C
cff-gite 已提交
4392
## GeomagneticResponse
Z
zengyawen 已提交
4393

C
cff-gite 已提交
4394
设置地磁响应对象,继承于[Response](#response)
Z
zengyawen 已提交
4395

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

C
cff-gite 已提交
4398 4399 4400 4401 4402 4403 4404 4405 4406
| 名称            | 类型   | 可读 | 可写 | 说明                                               |
| --------------- | ------ | ---- | ---- | -------------------------------------------------- |
| x               | number | 是   | 是   | 地磁场的北分量。                                   |
| y               | number | 是   | 是   | 地磁场的东分量。                                   |
| z               | number | 是   | 是   | 地磁场的垂直分量。                                 |
| geomagneticDip  | number | 是   | 是   | 地磁倾角,即地球磁场线与水平面的夹角。             |
| deflectionAngle | number | 是   | 是   | 地磁偏角,即地磁北方向与正北方向在水平面上的角度。 |
| levelIntensity  | number | 是   | 是   | 地磁场的水平强度。                                 |
| totalIntensity  | number | 是   | 是   | 地磁场的总强度。                                   |
C
cff-gite 已提交
4407

C
cff-gite 已提交
4408
## LocationOptions
C
cff-gite 已提交
4409

C
cff-gite 已提交
4410
指示地理位置。
C
cff-gite 已提交
4411

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

C
cff-gite 已提交
4414 4415 4416 4417 4418
| 名称      | 类型   | 可读 | 可写 | 说明       |
| --------- | ------ | ---- | ---- | ---------- |
| latitude  | number | 是   | 是   | 纬度。     |
| longitude | number | 是   | 是   | 经度。     |
| altitude  | number | 是   | 是   | 海拔高度。 |
Z
zengyawen 已提交
4419

C
cff-gite 已提交
4420
## sensor.on<sup>(deprecated)</sup>
Z
zengyawen 已提交
4421

C
cff-gite 已提交
4422
### ACCELEROMETER<sup>(deprecated)</sup>
Z
zengyawen 已提交
4423

C
cff-gite 已提交
4424
on(type:  SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback&lt;AccelerometerResponse&gt;,options?: Options): void
Z
zengyawen 已提交
4425

C
cff-gite 已提交
4426
监听加速度传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。
Z
zengyawen 已提交
4427

C
cff-gite 已提交
4428
从API version 9 开始不再维护,建议使用[sensor.on.ACCELEROMETER](#accelerometer9)代替。
C
cff-gite 已提交
4429

L
li-yaoyao777 已提交
4430
**需要权限**:ohos.permission.ACCELEROMETER
C
cff-gite 已提交
4431 4432 4433

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

H
HelloCrease 已提交
4434
**参数:** 
C
cff-gite 已提交
4435

C
cff-gite 已提交
4436 4437 4438 4439
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_ACCELEROMETER       | 是   | 要订阅的加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。     |
| callback | Callback&lt;[AccelerometerResponse](#accelerometerresponse)&gt; | 是   | 注册加速度传感器的回调函数,上报的数据类型为AccelerometerResponse。 |
W
wusongqing 已提交
4440
| options  | [Options](#options)                                          | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。        |
Z
zengyawen 已提交
4441

H
HelloCrease 已提交
4442
**示例:** 
C
cff-gite 已提交
4443

L
li-yaoyao777 已提交
4444
```ts
L
li-yaoyao777 已提交
4445 4446 4447
import sensor from '@ohos.sensor';

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, (data: sensor.AccelerometerResponse) => {
L
li-yaoyao777 已提交
4448 4449 4450 4451 4452 4453 4454
  console.info('Succeeded in invoking on. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z);
},
  { interval: 100000000 }
);
```
Z
zengyawen 已提交
4455

C
cff-gite 已提交
4456
### LINEAR_ACCELERATION<sup>(deprecated)</sup>
Z
zengyawen 已提交
4457

C
cff-gite 已提交
4458
on(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback&lt;LinearAccelerometerResponse&gt;, options?: Options): void
Z
zengyawen 已提交
4459

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

C
cff-gite 已提交
4462
从API version 9 开始不再维护,建议使用[sensor.on.LINEAR_ACCELEROMETER](#linear_accelerometer9)代替。 
C
cff-gite 已提交
4463

C
cff-gite 已提交
4464
**需要权限**:ohos.permission.ACCELEROMETER
C
cff-gite 已提交
4465 4466 4467

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

H
HelloCrease 已提交
4468
**参数:** 
C
cff-gite 已提交
4469

C
cff-gite 已提交
4470 4471 4472 4473
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_LINEAR_ACCELERATION | 是   | 要订阅的线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。 |
| callback | Callback&lt;[LinearAccelerometerResponse](#linearaccelerometerresponse)&gt; | 是   | 注册线性加速度传感器的回调函数,上报的数据类型为LinearAccelerometerResponse。 |
L
li-yaoyao777 已提交
4474
| options  | [Options](#options)                                          | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
Z
zengyawen 已提交
4475

C
cff-gite 已提交
4476
### ACCELEROMETER_UNCALIBRATED<sup>(deprecated)</sup>
Z
zengyawen 已提交
4477

C
cff-gite 已提交
4478
on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback&lt;AccelerometerUncalibratedResponse&gt;, options?: Options): void
Z
zengyawen 已提交
4479

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

C
cff-gite 已提交
4482
从API version 9 开始不再维护,建议使用[sensor.on.ACCELEROMETER_UNCALIBRATED](#accelerometer_uncalibrated9)代替。
C
cff-gite 已提交
4483

L
li-yaoyao777 已提交
4484
**需要权限**:ohos.permission.ACCELEROMETER
C
cff-gite 已提交
4485 4486 4487

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

H
HelloCrease 已提交
4488
**参数:** 
C
cff-gite 已提交
4489

C
cff-gite 已提交
4490 4491 4492 4493
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED | 是   | 要订阅的未校准加速度计传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 |
| callback | Callback&lt;[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)&gt; | 是   | 注册未校准加速度计传感器的回调函数,上报的数据类型为AccelerometerUncalibratedResponse。 |
L
li-yaoyao777 已提交
4494
| options  | [Options](#options)                                          | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
Z
zengyawen 已提交
4495

H
HelloCrease 已提交
4496
**示例:** 
L
li-yaoyao777 已提交
4497 4498

```ts
L
li-yaoyao777 已提交
4499 4500 4501
import sensor from '@ohos.sensor';

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, (data: sensor.AccelerometerUncalibratedResponse) => {
L
li-yaoyao777 已提交
4502 4503 4504 4505 4506 4507 4508 4509 4510
  console.info('Succeeded in invoking on. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z);
  console.info('Succeeded in invoking on. X-coordinate bias: ' + data.biasX);
  console.info('Succeeded in invoking on. Y-coordinate bias: ' + data.biasY);
  console.info('Succeeded in invoking on. Z-coordinate bias: ' + data.biasZ);
},
  { interval: 100000000 }
);
L
li-yaoyao777 已提交
4511

L
li-yaoyao777 已提交
4512
```
Z
zengyawen 已提交
4513

C
cff-gite 已提交
4514
### GRAVITY<sup>(deprecated)</sup>
Z
zengyawen 已提交
4515

C
cff-gite 已提交
4516
on(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback&lt;GravityResponse&gt;,options?: Options): void
Z
zengyawen 已提交
4517

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

C
cff-gite 已提交
4520
从API version 9 开始不再维护,建议使用[sensor.on.GRAVITY](#gravity9)代替。
C
cff-gite 已提交
4521

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

H
HelloCrease 已提交
4524
**参数:** 
C
cff-gite 已提交
4525

C
cff-gite 已提交
4526 4527 4528 4529
| 参数名   | 类型                                                | 必填 | 说明                                                        |
| -------- | --------------------------------------------------- | ---- | ----------------------------------------------------------- |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_GRAVITY    | 是   | 要订阅的重力传感器类型为SENSOR_TYPE_ID_GRAVITY。            |
| callback | Callback&lt;[GravityResponse](#gravityresponse)&gt; | 是   | 注册重力传感器的回调函数,上报的数据类型为GravityResponse。 |
L
li-yaoyao777 已提交
4530
| options  | [Options](#options)                                 | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。 |
Z
zengyawen 已提交
4531

H
HelloCrease 已提交
4532
**示例:** 
L
li-yaoyao777 已提交
4533

L
li-yaoyao777 已提交
4534
```ts
L
li-yaoyao777 已提交
4535 4536 4537
import sensor from '@ohos.sensor';

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, (data: sensor.GravityResponse) => {
L
li-yaoyao777 已提交
4538 4539 4540 4541 4542 4543 4544
  console.info('Succeeded in invoking on. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z);
},
  { interval: 100000000 }
);
```
Z
zengyawen 已提交
4545

C
cff-gite 已提交
4546
### GYROSCOPE<sup>(deprecated)</sup>
Z
zengyawen 已提交
4547

C
cff-gite 已提交
4548
on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback&lt;GyroscopeResponse&gt;, options?: Options): void
Z
zengyawen 已提交
4549

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

C
cff-gite 已提交
4552
从API version 9 开始不再维护,建议使用[sensor.on.GYROSCOPE](#gyroscope9)代替。
C
cff-gite 已提交
4553

L
li-yaoyao777 已提交
4554
**需要权限**:ohos.permission.GYROSCOPE
C
cff-gite 已提交
4555 4556 4557

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

H
HelloCrease 已提交
4558
**参数:** 
C
cff-gite 已提交
4559

C
cff-gite 已提交
4560 4561 4562 4563
| 参数名   | 类型                                                    | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_GYROSCOPE      | 是   | 要订阅的陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。         |
| callback | Callback&lt;[GyroscopeResponse](#gyroscoperesponse)&gt; | 是   | 注册陀螺仪传感器的回调函数,上报的数据类型为GyroscopeResponse。 |
L
li-yaoyao777 已提交
4564
| options  | [Options](#options)                                     | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
Z
zengyawen 已提交
4565

H
HelloCrease 已提交
4566
**示例:** 
L
li-yaoyao777 已提交
4567 4568

```ts
L
li-yaoyao777 已提交
4569 4570 4571
import sensor from '@ohos.sensor';

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, (data: sensor.GyroscopeResponse) => {
L
li-yaoyao777 已提交
4572 4573 4574 4575 4576 4577 4578
  console.info('Succeeded in invoking on. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z);
},
  { interval: 100000000 }
);
```
Z
zengyawen 已提交
4579

C
cff-gite 已提交
4580
### GYROSCOPE_UNCALIBRATED<sup>(deprecated)</sup>
Z
zengyawen 已提交
4581

C
cff-gite 已提交
4582
on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback:Callback&lt;GyroscopeUncalibratedResponse&gt;, options?: Options): void
Z
zengyawen 已提交
4583

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

C
cff-gite 已提交
4586
从API version 9 开始不再维护,建议使用[sensor.on.GYROSCOPE_UNCALIBRATED](#gyroscope_uncalibrated9)代替。
C
cff-gite 已提交
4587

L
li-yaoyao777 已提交
4588
**需要权限**:ohos.permission.GYROSCOPE
C
cff-gite 已提交
4589 4590 4591

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

H
HelloCrease 已提交
4592
**参数:** 
C
cff-gite 已提交
4593

C
cff-gite 已提交
4594 4595 4596 4597
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED | 是   | 要订阅的未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 |
| callback | Callback&lt;[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)&gt; | 是   | 注册未校准陀螺仪传感器的回调函数,上报的数据类型为GyroscopeUncalibratedResponse。 |
L
li-yaoyao777 已提交
4598
| options  | [Options](#options)                                          | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
Z
zengyawen 已提交
4599

H
HelloCrease 已提交
4600
**示例:** 
L
li-yaoyao777 已提交
4601 4602

```ts
L
li-yaoyao777 已提交
4603 4604 4605
import sensor from '@ohos.sensor';

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, (data: sensor.GyroscopeUncalibratedResponse) => {
L
li-yaoyao777 已提交
4606 4607 4608 4609 4610 4611 4612 4613 4614 4615
  console.info('Succeeded in invoking on. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z);
  console.info('Succeeded in invoking on. X-coordinate bias: ' + data.biasX);
  console.info('Succeeded in invoking on. Y-coordinate bias: ' + data.biasY);
  console.info('Succeeded in invoking on. Z-coordinate bias: ' + data.biasZ);
},
  { interval: 100000000 }
);
```
Z
zengyawen 已提交
4616

C
cff-gite 已提交
4617
### SIGNIFICANT_MOTION<sup>(deprecated)</sup>
Z
zengyawen 已提交
4618

C
cff-gite 已提交
4619
on(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback: Callback&lt;SignificantMotionResponse&gt;, options?: Options): void
Z
zengyawen 已提交
4620

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

C
cff-gite 已提交
4623
从API version 9 开始不再维护,建议使用[sensor.on.SIGNIFICANT_MOTION](#significant_motion9) 代替。
C
cff-gite 已提交
4624

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

H
HelloCrease 已提交
4627
**参数:** 
C
cff-gite 已提交
4628

C
cff-gite 已提交
4629 4630 4631 4632
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_SIGNIFICANT_MOTION  | 是   | 要订阅的大幅动作传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。 |
| callback | Callback&lt;[SignificantMotionResponse](#significantmotionresponse)&gt; | 是   | 注册有效运动传感器的回调函数,上报的数据类型为SignificantMotionResponse。 |
L
li-yaoyao777 已提交
4633
| options  | [Options](#options)                                          | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
Z
zengyawen 已提交
4634

H
HelloCrease 已提交
4635
**示例:** 
L
li-yaoyao777 已提交
4636 4637

```ts
L
li-yaoyao777 已提交
4638 4639 4640
import sensor from '@ohos.sensor';

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, (data: sensor.SignificantMotionResponse) => {
L
li-yaoyao777 已提交
4641 4642 4643 4644 4645
  console.info('Succeeded in invoking on. Scalar data: ' + data.scalar);
},
  { interval: 100000000 }
);
```
Z
zengyawen 已提交
4646

C
cff-gite 已提交
4647
### PEDOMETER_DETECTION<sup>(deprecated)</sup>
Z
zengyawen 已提交
4648

C
cff-gite 已提交
4649
on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback: Callback&lt;PedometerDetectionResponse&gt;, options?: Options): void
Z
zengyawen 已提交
4650

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

C
cff-gite 已提交
4653
从API version 9 开始不再维护,建议使用[sensor.on.PEDOMETER_DETECTION](#pedometer_detection9)代替。 
C
cff-gite 已提交
4654

C
cff-gite 已提交
4655
**需要权限**:ohos.permission.ACTIVITY_MOTION
C
cff-gite 已提交
4656 4657 4658

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

H
HelloCrease 已提交
4659
**参数:** 
C
cff-gite 已提交
4660

C
cff-gite 已提交
4661 4662 4663 4664
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_PEDOMETER_DETECTION | 是   | 要订阅的计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。 |
| callback | Callback&lt;[PedometerDetectionResponse](#pedometerdetectionresponse)&gt; | 是   | 注册计步检测传感器的回调函数,上报的数据类型为PedometerDetectionResponse。 |
L
li-yaoyao777 已提交
4665
| options  | [Options](#options)                                          | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
Z
zengyawen 已提交
4666

H
HelloCrease 已提交
4667
**示例:** 
L
li-yaoyao777 已提交
4668 4669

```ts
L
li-yaoyao777 已提交
4670 4671 4672
import sensor from '@ohos.sensor';

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, (data: sensor.PedometerDetectionResponse) => {
L
li-yaoyao777 已提交
4673 4674 4675 4676 4677
  console.info('Succeeded in invoking on. Scalar data: ' + data.scalar);
},
  { interval: 100000000 }
);
```
Z
zengyawen 已提交
4678

C
cff-gite 已提交
4679
### PEDOMETER<sup>(deprecated)</sup>
Z
zengyawen 已提交
4680

C
cff-gite 已提交
4681
on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback&lt;PedometerResponse&gt;, options?: Options): void
Z
zengyawen 已提交
4682

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

C
cff-gite 已提交
4685
从API version 9 开始不再维护,建议使用[sensor.on.PEDOMETER](#pedometer9)代替。
C
cff-gite 已提交
4686

C
cff-gite 已提交
4687
**需要权限**:ohos.permission.ACTIVITY_MOTION 
C
cff-gite 已提交
4688 4689 4690

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

H
HelloCrease 已提交
4691
**参数:** 
C
cff-gite 已提交
4692

C
cff-gite 已提交
4693 4694 4695 4696
| 参数名   | 类型                                                    | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_PEDOMETER      | 是   | 要订阅的计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。           |
| callback | Callback&lt;[PedometerResponse](#pedometerresponse)&gt; | 是   | 注册计步传感器的回调函数,上报的数据类型为PedometerResponse。 |
L
li-yaoyao777 已提交
4697
| options  | [Options](#options)                                     | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
Z
zengyawen 已提交
4698

H
HelloCrease 已提交
4699
**示例:** 
L
li-yaoyao777 已提交
4700 4701

```ts
L
li-yaoyao777 已提交
4702 4703 4704
import sensor from '@ohos.sensor';

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, (data: sensor.PedometerResponse) => {
L
li-yaoyao777 已提交
4705 4706 4707 4708 4709
  console.info('Succeeded in invoking on. Steps: ' + data.steps);
},
  { interval: 100000000 }
);
```
Z
zengyawen 已提交
4710

C
cff-gite 已提交
4711
### AMBIENT_TEMPERATURE<sup>(deprecated)</sup>
Z
zengyawen 已提交
4712

C
cff-gite 已提交
4713
on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback:Callback&lt;AmbientTemperatureResponse&gt;,  options?: Options): void
Z
zengyawen 已提交
4714

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

C
cff-gite 已提交
4717
从API version 9 开始不再维护,建议使用[sensor.on.AMBIENT_TEMPERATURE](#ambient_temperature9)代替。
C
cff-gite 已提交
4718

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

H
HelloCrease 已提交
4721
**参数:** 
C
cff-gite 已提交
4722

C
cff-gite 已提交
4723 4724 4725 4726
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_AMBIENT_TEMPERATURE | 是   | 要订阅的环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 |
| callback | Callback&lt;[AmbientTemperatureResponse](#ambienttemperatureresponse)&gt; | 是   | 注册环境温度传感器的回调函数,上报的数据类型为AmbientTemperatureResponse。 |
L
li-yaoyao777 已提交
4727
| options  | [Options](#options)                                          | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
Z
zengyawen 已提交
4728

H
HelloCrease 已提交
4729
**示例:** 
C
cff-gite 已提交
4730

L
li-yaoyao777 已提交
4731
```ts
L
li-yaoyao777 已提交
4732 4733 4734
import sensor from '@ohos.sensor';

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, (data: sensor.AmbientTemperatureResponse) => {
L
li-yaoyao777 已提交
4735 4736 4737 4738 4739
  console.info('Succeeded in invoking on. Temperature: ' + data.temperature);
},
  { interval: 100000000 }
);
```
Z
zengyawen 已提交
4740

C
cff-gite 已提交
4741
### MAGNETIC_FIELD<sup>(deprecated)</sup>
Z
zengyawen 已提交
4742

C
cff-gite 已提交
4743
on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback&lt;MagneticFieldResponse&gt;,options?: Options): void
Z
zengyawen 已提交
4744

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

C
cff-gite 已提交
4747
从API version 9 开始不再维护,建议使用[sensor.on.MAGNETIC_FIELD](#magnetic_field9)代替。  
C
cff-gite 已提交
4748

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

H
HelloCrease 已提交
4751
**参数:** 
C
cff-gite 已提交
4752

C
cff-gite 已提交
4753 4754 4755 4756
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_MAGNETIC_FIELD      | 是   | 要订阅的磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。      |
| callback | Callback&lt;[MagneticFieldResponse](#magneticfieldresponse)&gt; | 是   | 注册磁场传感器的回调函数,上报的数据类型为MagneticFieldResponse。 |
L
li-yaoyao777 已提交
4757
| options  | [Options](#options)                                          | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
Z
zengyawen 已提交
4758

H
HelloCrease 已提交
4759
**示例:** 
C
cff-gite 已提交
4760

L
li-yaoyao777 已提交
4761
```ts
L
li-yaoyao777 已提交
4762 4763 4764
import sensor from '@ohos.sensor';

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, (data: sensor.MagneticFieldResponse) => {
L
li-yaoyao777 已提交
4765 4766 4767 4768 4769 4770 4771
  console.info('Succeeded in invoking on. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z);
},
  { interval: 100000000 }
);
```
Z
zengyawen 已提交
4772

C
cff-gite 已提交
4773
### MAGNETIC_FIELD_UNCALIBRATED<sup>(deprecated)</sup>
Z
zengyawen 已提交
4774

C
cff-gite 已提交
4775
on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callback&lt;MagneticFieldUncalibratedResponse&gt;, options?: Options): void
Z
zengyawen 已提交
4776

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

C
cff-gite 已提交
4779
从API version 9 开始不再维护,建议使用[sensor.on.MAGNETIC_FIELD_UNCALIBRATED](#magnetic_field_uncalibrated9)代替。 
C
cff-gite 已提交
4780

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

H
HelloCrease 已提交
4783
**参数:** 
C
cff-gite 已提交
4784

C
cff-gite 已提交
4785 4786 4787 4788
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED | 是   | 要订阅的未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 |
| callback | Callback&lt;[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)&gt; | 是   | 注册未校准磁场传感器的回调函数,上报的数据类型为MagneticFieldUncalibratedResponse。 |
L
li-yaoyao777 已提交
4789
| options  | [Options](#options)                                          | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
Z
zengyawen 已提交
4790

H
HelloCrease 已提交
4791
**示例:** 
L
li-yaoyao777 已提交
4792 4793

```ts
L
li-yaoyao777 已提交
4794 4795 4796
import sensor from '@ohos.sensor';

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, (data: sensor.MagneticFieldUncalibratedResponse) => {
L
li-yaoyao777 已提交
4797 4798 4799 4800 4801 4802 4803 4804 4805 4806
  console.info('Succeeded in invoking on. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z);
  console.info('Succeeded in invoking on. X-coordinate bias: ' + data.biasX);
  console.info('Succeeded in invoking on. Y-coordinate bias: ' + data.biasY);
  console.info('Succeeded in invoking on. Z-coordinate bias: ' + data.biasZ);
},
  { interval: 100000000 }
);
```
Z
zengyawen 已提交
4807

C
cff-gite 已提交
4808
### PROXIMITY<sup>(deprecated)</sup>
Z
zengyawen 已提交
4809

C
cff-gite 已提交
4810
on(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback&lt;ProximityResponse&gt;,options?: Options): void
Z
zengyawen 已提交
4811

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

C
cff-gite 已提交
4814
从API version 9 开始不再维护,建议使用[sensor.on.PROXIMITY](#proximity9)代替。 
C
cff-gite 已提交
4815

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

H
HelloCrease 已提交
4818
**参数:** 
C
cff-gite 已提交
4819

C
cff-gite 已提交
4820 4821 4822 4823
| 参数名   | 类型                                                    | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_PROXIMITY      | 是   | 要订阅的接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。         |
| callback | Callback&lt;[ProximityResponse](#proximityresponse)&gt; | 是   | 注册接近光传感器的回调函数,上报的数据类型为ProximityResponse。 |
L
li-yaoyao777 已提交
4824
| options  | [Options](#options)                                     | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
Z
zengyawen 已提交
4825

H
HelloCrease 已提交
4826
**示例:** 
L
li-yaoyao777 已提交
4827 4828

```ts
L
li-yaoyao777 已提交
4829 4830 4831
import sensor from '@ohos.sensor';

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, (data: sensor.ProximityResponse) => {
L
li-yaoyao777 已提交
4832 4833 4834 4835 4836
  console.info('Succeeded in invoking on. Distance: ' + data.distance);
},
  { interval: 100000000 }
);
```
Z
zengyawen 已提交
4837

C
cff-gite 已提交
4838
### HUMIDITY<sup>(deprecated)</sup>
Z
zengyawen 已提交
4839

C
cff-gite 已提交
4840
on(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback&lt;HumidityResponse&gt;,options?: Options): void
Z
zengyawen 已提交
4841

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

C
cff-gite 已提交
4844
从API version 9 开始不再维护,建议使用[sensor.on.HUMIDITY](#humidity9)代替。  
C
cff-gite 已提交
4845

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

H
HelloCrease 已提交
4848
**参数:** 
C
cff-gite 已提交
4849

C
cff-gite 已提交
4850 4851 4852 4853
| 参数名   | 类型                                                  | 必填 | 说明                                                         |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_HUMIDITY     | 是   | 要订阅的湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。            |
| callback | Callback&lt;[HumidityResponse](#humidityresponse)&gt; | 是   | 注册湿度传感器的回调函数,上报的数据类型为HumidityResponse。 |
L
li-yaoyao777 已提交
4854
| options  | [Options](#options)                                   | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
Z
zengyawen 已提交
4855

H
HelloCrease 已提交
4856
**示例:** 
C
cff-gite 已提交
4857

L
li-yaoyao777 已提交
4858
```ts
L
li-yaoyao777 已提交
4859 4860 4861
import sensor from '@ohos.sensor';

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, (data: sensor.HumidityResponse) => {
L
li-yaoyao777 已提交
4862 4863 4864 4865 4866
  console.info('Succeeded in invoking on. Humidity: ' + data.humidity);
},
  { interval: 100000000 }
);
```
Z
zengyawen 已提交
4867

C
cff-gite 已提交
4868
### BAROMETER<sup>(deprecated)</sup>
Z
zengyawen 已提交
4869

C
cff-gite 已提交
4870
on(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback&lt;BarometerResponse&gt;,options?: Options): void
Z
zengyawen 已提交
4871

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

C
cff-gite 已提交
4874
从API version 9 开始不再维护,建议使用[sensor.on.BAROMETER](#barometer9)代替。
C
cff-gite 已提交
4875

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

H
HelloCrease 已提交
4878
**参数:** 
C
cff-gite 已提交
4879

C
cff-gite 已提交
4880 4881 4882 4883
| 参数名   | 类型                                                    | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_BAROMETER      | 是   | 要订阅的气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。         |
| callback | Callback&lt;[BarometerResponse](#barometerresponse)&gt; | 是   | 注册气压计传感器的回调函数,上报的数据类型为BarometerResponse。 |
L
li-yaoyao777 已提交
4884
| options  | [Options](#options)                                     | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
Z
zengyawen 已提交
4885

H
HelloCrease 已提交
4886
**示例:** 
C
cff-gite 已提交
4887

L
li-yaoyao777 已提交
4888
```ts
L
li-yaoyao777 已提交
4889 4890 4891
import sensor from '@ohos.sensor';

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, (data: sensor.BarometerResponse) => {
L
li-yaoyao777 已提交
4892 4893 4894 4895 4896
  console.info('Succeeded in invoking on. Atmospheric pressure: ' + data.pressure);
},
  { interval: 100000000 }
);
```
Z
zengyawen 已提交
4897

C
cff-gite 已提交
4898
### HALL<sup>(deprecated)</sup>
Z
zengyawen 已提交
4899

C
cff-gite 已提交
4900
on(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback&lt;HallResponse&gt;, options?: Options): void
Z
zengyawen 已提交
4901

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

C
cff-gite 已提交
4904
从API version 9 开始不再维护,建议使用[sensor.on.HALL](#hall9)代替。
C
cff-gite 已提交
4905

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

H
HelloCrease 已提交
4908
**参数:** 
C
cff-gite 已提交
4909

C
cff-gite 已提交
4910 4911 4912 4913
| 参数名   | 类型                                          | 必填 | 说明                                                         |
| -------- | --------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_HALL | 是   | 要订阅的霍尔传感器类型为SENSOR_TYPE_ID_HALL。                |
| callback | Callback&lt;[HallResponse](#hallresponse)&gt; | 是   | 注册霍尔传感器的回调函数,上报的数据类型为&nbsp;HallResponse。 |
L
li-yaoyao777 已提交
4914
| options  | [Options](#options)                           | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
Z
zengyawen 已提交
4915

H
HelloCrease 已提交
4916
**示例:** 
L
li-yaoyao777 已提交
4917 4918

```ts
L
li-yaoyao777 已提交
4919 4920 4921
import sensor from '@ohos.sensor';

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HALL, (data: sensor.HallResponse) => {
L
li-yaoyao777 已提交
4922 4923 4924 4925 4926
  console.info('Succeeded in invoking on. Status: ' + data.status);
},
  { interval: 100000000 }
);
```
C
cff-gite 已提交
4927 4928 4929 4930 4931 4932 4933

### AMBIENT_LIGHT<sup>(deprecated)</sup>

on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback&lt;LightResponse&gt;, options?: Options): void

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

C
cff-gite 已提交
4934
从API version 9 开始不再维护,建议使用[sensor.on.AMBIENT_LIGHT](#ambient_light9)代替。
C
cff-gite 已提交
4935 4936 4937 4938 4939

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

**参数:** 

C
cff-gite 已提交
4940 4941 4942 4943
| 参数名   | 类型                                                   | 必填 | 说明                                                        |
| -------- | ------------------------------------------------------ | ---- | ----------------------------------------------------------- |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_AMBIENT_LIGHT | 是   | 要订阅的环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。    |
| callback | Callback&lt;[LightResponse](#lightresponse)&gt;        | 是   | 注册环境光传感器的回调函数,上报的数据类型为LightResponse。 |
L
li-yaoyao777 已提交
4944
| options  | [Options](#options)                                    | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。 |
C
cff-gite 已提交
4945 4946 4947

**示例:** 

L
li-yaoyao777 已提交
4948
```ts
L
li-yaoyao777 已提交
4949 4950 4951
import sensor from '@ohos.sensor';

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, (data: sensor.LightResponse) => {
L
li-yaoyao777 已提交
4952 4953 4954 4955 4956
  console.info('Succeeded in invoking on. Illumination: ' + data.intensity);
},
  { interval: 100000000 }
);
```
C
cff-gite 已提交
4957 4958 4959 4960 4961 4962 4963

### ORIENTATION<sup>(deprecated)</sup>

on(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback&lt;OrientationResponse&gt;, options?: Options): void

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

C
cff-gite 已提交
4964
从API version 9 开始不再维护,建议使用[sensor.on.ORIENTATION](#orientation9)代替。
C
cff-gite 已提交
4965 4966 4967 4968 4969

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

**参数:** 

C
cff-gite 已提交
4970 4971 4972 4973
| 参数名   | 类型                                                        | 必填 | 说明                                                         |
| -------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_ORIENTATION        | 是   | 要订阅的方向传感器类型为SENSOR_TYPE_ID_ORIENTATION           |
| callback | Callback&lt;[OrientationResponse](#orientationresponse)&gt; | 是   | 注册方向传感器的回调函数,上报的数据类型为OrientationResponse。 |
L
li-yaoyao777 已提交
4974
| options  | [Options](#options)                                         | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
C
cff-gite 已提交
4975 4976

**示例:** 
L
li-yaoyao777 已提交
4977 4978

```ts
L
li-yaoyao777 已提交
4979 4980 4981
import sensor from '@ohos.sensor';

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, (data: sensor.OrientationResponse) => {
L
li-yaoyao777 已提交
4982 4983 4984 4985 4986 4987 4988
  console.info('Succeeded in the device rotating at an angle around the X axis: ' + data.beta);
  console.info('Succeeded in the device rotating at an angle around the Y axis: ' + data.gamma);
  console.info('Succeeded in the device rotating at an angle around the Z axis: ' + data.alpha);
},
  { interval: 100000000 }
);
```
Z
zengyawen 已提交
4989

C
cff-gite 已提交
4990 4991 4992 4993
### HEART_RATE<sup>(deprecated)</sup>

on(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback&lt;HeartRateResponse&gt;, options?: Options): void

L
li-yaoyao777 已提交
4994
监听心率传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。
C
cff-gite 已提交
4995

C
cff-gite 已提交
4996 4997
从API version 9 开始不再维护,建议使用[sensor.on.HEART_RATE](#heart_rate9)代替。

C
cff-gite 已提交
4998 4999 5000 5001 5002 5003 5004 5005
**需要权限**:ohos.permission.HEALTH_DATA 

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

**参数:** 

| 参数名   | 类型                                                    | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
5006
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_HEART_RATE     | 是   | 要订阅的心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。          |
L
li-yaoyao777 已提交
5007
| callback | Callback&lt;[HeartRateResponse](#heartrateresponse)&gt; | 是   | 注册心率传感器的回调函数,上报的数据类型为HeartRateResponse。 |
L
li-yaoyao777 已提交
5008
| options  | [Options](#options)                                     | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
C
cff-gite 已提交
5009 5010

### ROTATION_VECTOR<sup>(deprecated)</sup>
Z
zengyawen 已提交
5011

C
cff-gite 已提交
5012
on(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,callback: Callback&lt;RotationVectorResponse&gt;,options?: Options): void
Z
zengyawen 已提交
5013

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

C
cff-gite 已提交
5016
从API version 9 开始不再维护,建议使用[sensor.on.ROTATION_VECTOR](#rotation_vector9)代替。
C
cff-gite 已提交
5017

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

H
HelloCrease 已提交
5020
**参数:** 
C
cff-gite 已提交
5021

C
cff-gite 已提交
5022 5023 5024 5025
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_ROTATION_VECTOR     | 是   | 要订阅的旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。 |
| callback | Callback&lt;[RotationVectorResponse](#rotationvectorresponse)&gt; | 是   | 注册旋转矢量传感器的回调函数,上报的数据类型为RotationVectorResponse。 |
L
li-yaoyao777 已提交
5026
| options  | [Options](#options)                                          | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
Z
zengyawen 已提交
5027

H
HelloCrease 已提交
5028
**示例:** 
L
li-yaoyao777 已提交
5029 5030

```ts
L
li-yaoyao777 已提交
5031 5032 5033
import sensor from '@ohos.sensor';

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, (data: sensor.RotationVectorResponse) => {
L
li-yaoyao777 已提交
5034 5035 5036 5037 5038 5039 5040 5041
  console.info('Succeeded in invoking on. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking on. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking on. Z-coordinate component: ' + data.z);
  console.info('Succeeded in invoking on. Scalar quantity: ' + data.w);
},
  { interval: 100000000 }
);
```
Z
zengyawen 已提交
5042

C
cff-gite 已提交
5043
### WEAR_DETECTION<sup>(deprecated)</sup>
Z
zengyawen 已提交
5044

C
cff-gite 已提交
5045
on(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback&lt;WearDetectionResponse&gt;,options?: Options): void
Z
zengyawen 已提交
5046

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

C
cff-gite 已提交
5049
从API version 9 开始不再维护,建议使用[sensor.on.WEAR_DETECTION](#wear_detection9)代替。
C
cff-gite 已提交
5050

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

H
HelloCrease 已提交
5053
**参数:** 
C
cff-gite 已提交
5054

C
cff-gite 已提交
5055 5056 5057 5058
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_WEAR_DETECTION      | 是   | 要订阅的佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。  |
| callback | Callback&lt;[WearDetectionResponse](#weardetectionresponse)&gt; | 是   | 注册佩戴检测传感器的回调函数,上报的数据类型为WearDetectionResponse。 |
L
li-yaoyao777 已提交
5059
| options  | [Options](#options)                                          | 否   | 可选参数列表,用于设置传感器上报频率,默认值为200000000ns。  |
Z
zengyawen 已提交
5060

H
HelloCrease 已提交
5061
**示例:** 
L
li-yaoyao777 已提交
5062 5063

```ts
L
li-yaoyao777 已提交
5064 5065 5066
import sensor from '@ohos.sensor';

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, (data: sensor.WearDetectionResponse) => {
L
li-yaoyao777 已提交
5067 5068 5069 5070 5071
  console.info('Succeeded in invoking on. Wear status: ' + data.value);
},
  { interval: 100000000 }
);
```
Z
zengyawen 已提交
5072

C
cff-gite 已提交
5073
## sensor.once<sup>(deprecated)</sup>
Z
zengyawen 已提交
5074

C
cff-gite 已提交
5075
### ACCELEROMETER<sup>(deprecated)</sup>
Z
zengyawen 已提交
5076

C
cff-gite 已提交
5077
once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback&lt;AccelerometerResponse&gt;): void
Z
zengyawen 已提交
5078

C
cff-gite 已提交
5079 5080
监听加速度传感器的数据变化一次。

C
cff-gite 已提交
5081
从API version 9 开始不再维护,建议使用[sensor.once.ACCELEROMETER](#accelerometer9-1)代替。
C
cff-gite 已提交
5082 5083

**需要权限**:ohos.permission.ACCELEROMETER
C
cff-gite 已提交
5084

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

H
HelloCrease 已提交
5087
**参数:** 
C
cff-gite 已提交
5088

C
cff-gite 已提交
5089 5090 5091 5092
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_ACCELEROMETER       | 是   | 加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。             |
| callback | Callback&lt;[AccelerometerResponse](#accelerometerresponse)&gt; | 是   | 注册一次加速度传感器的回调函数,上报的数据类型为AccelerometerResponse。 |
Z
zengyawen 已提交
5093

H
HelloCrease 已提交
5094
**示例:** 
L
li-yaoyao777 已提交
5095 5096

```ts
L
li-yaoyao777 已提交
5097 5098 5099
import sensor from '@ohos.sensor';

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, (data: sensor.AccelerometerResponse) => {
L
li-yaoyao777 已提交
5100 5101 5102 5103 5104
  console.info('Succeeded in invoking once. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z);
});
```
Z
zengyawen 已提交
5105

C
cff-gite 已提交
5106
### LINEAR_ACCELERATION<sup>(deprecated)</sup>
Z
zengyawen 已提交
5107

C
cff-gite 已提交
5108
once(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback&lt;LinearAccelerometerResponse&gt;): void
Z
zengyawen 已提交
5109

C
cff-gite 已提交
5110
监听线性加速度传感器数据变化一次。
Z
zengyawen 已提交
5111

C
cff-gite 已提交
5112
从API version 9 开始不再维护,建议使用[sensor.once.LINEAR_ACCELEROMETER](#linear_accelerometer9-1)代替。
C
cff-gite 已提交
5113

C
cff-gite 已提交
5114
**需要权限**:ohos.permission.ACCELERATION
C
cff-gite 已提交
5115 5116 5117

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

H
HelloCrease 已提交
5118
**参数:** 
C
cff-gite 已提交
5119

C
cff-gite 已提交
5120 5121 5122 5123
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_LINEAR_ACCELERATION | 是   | 线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。   |
| callback | Callback&lt;[LinearAccelerometerResponse](#linearaccelerometerresponse)&gt; | 是   | 注册一次线性加速度传感器的回调函数,上报的数据类型为LinearAccelerometerResponse。 |
Z
zengyawen 已提交
5124

C
cff-gite 已提交
5125
### ACCELEROMETER_UNCALIBRATED<sup>(deprecated)</sup>
Z
zengyawen 已提交
5126

C
cff-gite 已提交
5127
once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback&lt;AccelerometerUncalibratedResponse&gt;): void
Z
zengyawen 已提交
5128

C
cff-gite 已提交
5129
监听未校准加速度传感器的数据变化一次。
Z
zengyawen 已提交
5130

C
cff-gite 已提交
5131
从API version 9 开始不再维护,建议使用[sensor.once.ACCELEROMETER_UNCALIBRATED](#accelerometer_uncalibrated9-1)代替。
C
cff-gite 已提交
5132 5133

**需要权限**:ohos.permission.ACCELEROMETER
C
cff-gite 已提交
5134

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

H
HelloCrease 已提交
5137
**参数:** 
C
cff-gite 已提交
5138

C
cff-gite 已提交
5139 5140 5141 5142
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED | 是   | 未校准加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 |
| callback | Callback&lt;[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)&gt; | 是   | 注册一次未校准加速度传感器的回调函数,上报的数据类型为AccelerometerUncalibratedResponse。 |
Z
zengyawen 已提交
5143

H
HelloCrease 已提交
5144
**示例:** 
L
li-yaoyao777 已提交
5145 5146

```ts
L
li-yaoyao777 已提交
5147 5148 5149
import sensor from '@ohos.sensor';

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, (data: sensor.AccelerometerUncalibratedResponse) => {
L
li-yaoyao777 已提交
5150 5151 5152 5153 5154 5155 5156 5157
  console.info('Succeeded in invoking once. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z);
  console.info('Succeeded in invoking once. X-coordinate bias: ' + data.biasX);
  console.info('Succeeded in invoking once. Y-coordinate bias: ' + data.biasY);
  console.info('Succeeded in invoking once. Z-coordinate bias: ' + data.biasZ);
});
```
Z
zengyawen 已提交
5158

C
cff-gite 已提交
5159
### GRAVITY<sup>(deprecated)</sup>
Z
zengyawen 已提交
5160

C
cff-gite 已提交
5161
once(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback&lt;GravityResponse&gt;): void
Z
zengyawen 已提交
5162

C
cff-gite 已提交
5163
监听重力传感器的数据变化一次。
C
cff-gite 已提交
5164

C
cff-gite 已提交
5165
从API version 9 开始不再维护,建议使用[sensor.once.GRAVITY](#gravity9-1)代替。
C
cff-gite 已提交
5166

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

H
HelloCrease 已提交
5169
**参数:** 
C
cff-gite 已提交
5170

C
cff-gite 已提交
5171 5172 5173 5174
| 参数名   | 类型                                                | 必填 | 说明                                                         |
| -------- | --------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_GRAVITY    | 是   | 重力传感器类型为SENSOR_TYPE_ID_GRAVITY。                     |
| callback | Callback&lt;[GravityResponse](#gravityresponse)&gt; | 是   | 注册一次重力传感器的回调函数,上报的数据类型为GravityResponse。 |
Z
zengyawen 已提交
5175

H
HelloCrease 已提交
5176
**示例:** 
L
li-yaoyao777 已提交
5177 5178

```ts
L
li-yaoyao777 已提交
5179 5180 5181
import sensor from '@ohos.sensor';

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, (data: sensor.GravityResponse) => {
L
li-yaoyao777 已提交
5182 5183 5184 5185 5186
  console.info('Succeeded in invoking once. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z);
  });
```
C
cff-gite 已提交
5187

C
cff-gite 已提交
5188
### GYROSCOPE<sup>(deprecated)</sup>
C
cff-gite 已提交
5189

C
cff-gite 已提交
5190
once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback&lt;GyroscopeResponse&gt;): void
C
cff-gite 已提交
5191

C
cff-gite 已提交
5192
监听陀螺仪传感器的数据变化一次。
C
cff-gite 已提交
5193

C
cff-gite 已提交
5194
从API version 9 开始不再维护,建议使用[sensor.once.GYROSCOPE](#gyroscope9-1)代替。
C
cff-gite 已提交
5195

C
cff-gite 已提交
5196
**需要权限**:ohos.permission.GYROSCOPE
C
cff-gite 已提交
5197

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

H
HelloCrease 已提交
5200
**参数:** 
C
cff-gite 已提交
5201

C
cff-gite 已提交
5202 5203 5204 5205
| 参数名   | 类型                                                    | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_GYROSCOPE      | 是   | 陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。                 |
| callback | Callback&lt;[GyroscopeResponse](#gyroscoperesponse)&gt; | 是   | 注册一次陀螺仪传感器的回调函数,上报的数据类型为GyroscopeResponse。 |
C
cff-gite 已提交
5206

H
HelloCrease 已提交
5207
**示例:** 
L
li-yaoyao777 已提交
5208 5209

```ts
L
li-yaoyao777 已提交
5210 5211 5212
import sensor from '@ohos.sensor';

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, (data: sensor.GyroscopeResponse) => {
L
li-yaoyao777 已提交
5213 5214 5215 5216 5217
  console.info('Succeeded in invoking once. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z);
});
```
C
cff-gite 已提交
5218

C
cff-gite 已提交
5219
### GYROSCOPE_UNCALIBRATED<sup>(deprecated)</sup>
C
cff-gite 已提交
5220

C
cff-gite 已提交
5221
once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback: Callback&lt;GyroscopeUncalibratedResponse&gt;): void
C
cff-gite 已提交
5222

C
cff-gite 已提交
5223
监听未校准陀螺仪传感器的数据变化一次。
C
cff-gite 已提交
5224

C
cff-gite 已提交
5225
从API version 9 开始不再维护,建议使用[sensor.once.GYROSCOPE_UNCALIBRATED](#gyroscope_uncalibrated9-1)代替。
C
cff-gite 已提交
5226

C
cff-gite 已提交
5227
**需要权限**:ohos.permission.GYROSCOPE
C
cff-gite 已提交
5228

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

H
HelloCrease 已提交
5231
**参数:** 
C
cff-gite 已提交
5232

C
cff-gite 已提交
5233 5234 5235 5236
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED | 是   | 未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 |
| callback | Callback&lt;[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)&gt; | 是   | 注册一次未校准陀螺仪传感器的回调函数,上报的数据类型为GyroscopeUncalibratedResponse。 |
C
cff-gite 已提交
5237

H
HelloCrease 已提交
5238
**示例:** 
L
li-yaoyao777 已提交
5239
```ts
L
li-yaoyao777 已提交
5240 5241 5242
import sensor from '@ohos.sensor';

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, (data: sensor.GyroscopeUncalibratedResponse) => {
L
li-yaoyao777 已提交
5243 5244 5245 5246 5247 5248 5249 5250
    console.info('Succeeded in invoking once. X-coordinate component: ' + data.x);
    console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y);
    console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z);
    console.info('Succeeded in invoking once. X-coordinate bias: ' + data.biasX);
    console.info('Succeeded in invoking once. Y-coordinate bias: ' + data.biasY);
    console.info('Succeeded in invoking once. Z-coordinate bias: ' + data.biasZ);
});
```
C
cff-gite 已提交
5251

C
cff-gite 已提交
5252
### SIGNIFICANT_MOTION<sup>(deprecated)</sup>
C
cff-gite 已提交
5253

C
cff-gite 已提交
5254
once(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,callback: Callback&lt;SignificantMotionResponse&gt;): void
C
cff-gite 已提交
5255

C
cff-gite 已提交
5256
监听有效运动传感器的数据变化一次。
C
cff-gite 已提交
5257

C
cff-gite 已提交
5258
从API version 9 开始不再维护,建议使用[sensor.once.SIGNIFICANT_MOTION](#significant_motion9-1)代替。
C
cff-gite 已提交
5259

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

H
HelloCrease 已提交
5262
**参数:** 
C
cff-gite 已提交
5263

C
cff-gite 已提交
5264 5265 5266 5267
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_SIGNIFICANT_MOTION  | 是   | 有效运动传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。      |
| callback | Callback&lt;[SignificantMotionResponse](#significantmotionresponse)&gt; | 是   | 注册一次有效运动传感器的回调函数,上报的数据类型为SignificantMotionResponse。 |
C
cff-gite 已提交
5268

H
HelloCrease 已提交
5269
**示例:** 
L
li-yaoyao777 已提交
5270 5271

```ts
L
li-yaoyao777 已提交
5272 5273 5274
import sensor from '@ohos.sensor';

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, (data: sensor.SignificantMotionResponse) => {
L
li-yaoyao777 已提交
5275 5276 5277
  console.info('Succeeded in invoking once. Scalar data: ' + data.scalar);
});
```
C
cff-gite 已提交
5278

C
cff-gite 已提交
5279
### PEDOMETER_DETECTION<sup>(deprecated)</sup>
C
cff-gite 已提交
5280

C
cff-gite 已提交
5281
once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,callback: Callback&lt;PedometerDetectionResponse&gt;): void
C
cff-gite 已提交
5282

C
cff-gite 已提交
5283
监听计步检测传感器数据变化一次。
C
cff-gite 已提交
5284

C
cff-gite 已提交
5285
从API version 9 开始不再维护,建议使用[sensor.once.PEDOMETER_DETECTION](#pedometer_detection9-1)代替。
C
cff-gite 已提交
5286

C
cff-gite 已提交
5287
**需要权限**:ohos.permission.ACTIVITY_MOTION
C
cff-gite 已提交
5288

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

H
HelloCrease 已提交
5291
**参数:** 
C
cff-gite 已提交
5292

C
cff-gite 已提交
5293 5294 5295 5296
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_PEDOMETER_DETECTION | 是   | 计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。     |
| callback | Callback&lt;[PedometerDetectionResponse](#pedometerdetectionresponse)&gt; | 是   | 注册一次计步检测传感器的回调函数,上报的数据类型为PedometerDetectionResponse。 |
C
cff-gite 已提交
5297

H
HelloCrease 已提交
5298
**示例:** 
L
li-yaoyao777 已提交
5299 5300

```ts
L
li-yaoyao777 已提交
5301 5302 5303
import sensor from '@ohos.sensor';

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, (data: sensor.PedometerDetectionResponse) => {
L
li-yaoyao777 已提交
5304 5305 5306
  console.info('Succeeded in invoking once. Scalar data: ' + data.scalar);
});
```
C
cff-gite 已提交
5307

C
cff-gite 已提交
5308
### PEDOMETER<sup>(deprecated)</sup>
C
cff-gite 已提交
5309

C
cff-gite 已提交
5310
once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback&lt;PedometerResponse&gt;): void
C
cff-gite 已提交
5311

C
cff-gite 已提交
5312
监听计步器传感器数据变化一次。
C
cff-gite 已提交
5313

C
cff-gite 已提交
5314
从API version 9 开始不再维护,建议使用[sensor.once.PEDOMETER](#pedometer9-1)代替。
C
cff-gite 已提交
5315

C
cff-gite 已提交
5316
**需要权限**:ohos.permission.ACTIVITY_MOTION
C
cff-gite 已提交
5317 5318 5319

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

H
HelloCrease 已提交
5320
**参数:** 
C
cff-gite 已提交
5321

C
cff-gite 已提交
5322 5323 5324 5325
| 参数名   | 类型                                                    | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_PEDOMETER      | 是   | 计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。                   |
| callback | Callback&lt;[PedometerResponse](#pedometerresponse)&gt; | 是   | 注册一次计步传感器的回调函数,上报的数据类型为PedometerResponse。 |
C
cff-gite 已提交
5326

H
HelloCrease 已提交
5327
**示例:** 
L
li-yaoyao777 已提交
5328

L
li-yaoyao777 已提交
5329
```ts
L
li-yaoyao777 已提交
5330 5331 5332
import sensor from '@ohos.sensor';

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, (data: sensor.PedometerResponse) => {
L
li-yaoyao777 已提交
5333 5334 5335
  console.info('Succeeded in invoking once. Steps: ' + data.steps);
});
```
C
cff-gite 已提交
5336

C
cff-gite 已提交
5337
### AMBIENT_TEMPERATURE<sup>(deprecated)</sup>
C
cff-gite 已提交
5338

C
cff-gite 已提交
5339
once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback: Callback&lt;AmbientTemperatureResponse&gt;): void
C
cff-gite 已提交
5340

C
cff-gite 已提交
5341
监听环境温度传感器数据变化一次。
C
cff-gite 已提交
5342

C
cff-gite 已提交
5343
从API version 9 开始不再维护,建议使用[sensor.once.AMBIENT_TEMPERATURE](#ambient_temperature9-1)代替。
C
cff-gite 已提交
5344 5345 5346

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

H
HelloCrease 已提交
5347
**参数:** 
C
cff-gite 已提交
5348

C
cff-gite 已提交
5349 5350 5351 5352
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_AMBIENT_TEMPERATURE | 是   | 环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。     |
| callback | Callback&lt;[AmbientTemperatureResponse](#ambienttemperatureresponse)&gt; | 是   | 注册一次环境温度传感器的回调函数,上报的数据类型为AmbientTemperatureResponse。 |
C
cff-gite 已提交
5353

H
HelloCrease 已提交
5354
**示例:** 
L
li-yaoyao777 已提交
5355 5356

```ts
L
li-yaoyao777 已提交
5357 5358 5359
import sensor from '@ohos.sensor';

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, (data: sensor.AmbientTemperatureResponse) => {
L
li-yaoyao777 已提交
5360 5361 5362
  console.info('Succeeded in invoking once. Temperature: ' + data.temperature);
});
```
C
cff-gite 已提交
5363

C
cff-gite 已提交
5364
### MAGNETIC_FIELD<sup>(deprecated)</sup>
C
cff-gite 已提交
5365

C
cff-gite 已提交
5366
once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback&lt;MagneticFieldResponse&gt;): void
C
cff-gite 已提交
5367

C
cff-gite 已提交
5368
监听磁场传感器数据变化一次。
C
cff-gite 已提交
5369

C
cff-gite 已提交
5370
从API version 9 开始不再维护,建议使用[sensor.once.MAGNETIC_FIELD](#magnetic_field9-1)代替。
C
cff-gite 已提交
5371

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

H
HelloCrease 已提交
5374
**参数:** 
C
cff-gite 已提交
5375

C
cff-gite 已提交
5376 5377 5378 5379
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_MAGNETIC_FIELD      | 是   | 磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。              |
| callback | Callback&lt;[MagneticFieldResponse](#magneticfieldresponse)&gt; | 是   | 注册一次磁场传感器的回调函数,上报的数据类型为MagneticFieldResponse。 |
C
cff-gite 已提交
5380

H
HelloCrease 已提交
5381
**示例:** 
L
li-yaoyao777 已提交
5382 5383

```ts
L
li-yaoyao777 已提交
5384 5385 5386
import sensor from '@ohos.sensor';

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, (data: sensor.MagneticFieldResponse) => {
L
li-yaoyao777 已提交
5387 5388 5389 5390 5391
  console.info('Succeeded in invoking once. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z);
});
```
C
cff-gite 已提交
5392

C
cff-gite 已提交
5393
### MAGNETIC_FIELD_UNCALIBRATED<sup>(deprecated)</sup>
C
cff-gite 已提交
5394

C
cff-gite 已提交
5395
once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callback&lt;MagneticFieldUncalibratedResponse&gt;): void
C
cff-gite 已提交
5396

C
cff-gite 已提交
5397
监听未校准磁场传感器数据变化一次。
H
h00514358 已提交
5398

C
cff-gite 已提交
5399
从API version 9 开始不再维护,建议使用[sensor.once.MAGNETIC_FIELD_UNCALIBRATED](#magnetic_field_uncalibrated9-1)代替。
C
cff-gite 已提交
5400 5401 5402

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

H
HelloCrease 已提交
5403
**参数:** 
C
cff-gite 已提交
5404

C
cff-gite 已提交
5405 5406 5407 5408
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED | 是   | 未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 |
| callback | Callback&lt;[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)&gt; | 是   | 注册一次未校准磁场传感器的回调函数,上报的数据类型为MagneticFieldUncalibratedResponse。 |
C
cff-gite 已提交
5409

C
cff-gite 已提交
5410
**示例:** 
L
li-yaoyao777 已提交
5411 5412

```ts
L
li-yaoyao777 已提交
5413 5414 5415
import sensor from '@ohos.sensor';

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, (data: sensor.MagneticFieldUncalibratedResponse) => {
L
li-yaoyao777 已提交
5416 5417 5418 5419 5420 5421 5422 5423
  console.info('Succeeded in invoking once. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z);
  console.info('Succeeded in invoking once. X-coordinate bias: ' + data.biasX);
  console.info('Succeeded in invoking once. Y-coordinate bias: ' + data.biasY);
  console.info('Succeeded in invoking once. Z-coordinate bias: ' + data.biasZ);
});
```
H
h00514358 已提交
5424

C
cff-gite 已提交
5425
### PROXIMITY<sup>(deprecated)</sup>
H
h00514358 已提交
5426

C
cff-gite 已提交
5427
once(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback&lt;ProximityResponse&gt;): void
H
h00514358 已提交
5428

C
cff-gite 已提交
5429
监听接近光传感器数据变化一次。
H
h00514358 已提交
5430

C
cff-gite 已提交
5431
从API version 9 开始不再维护,建议使用[sensor.once.PROXIMITY](#proximity9-1)代替。
H
h00514358 已提交
5432

C
cff-gite 已提交
5433
**系统能力**:SystemCapability.Sensors.Sensor
H
h00514358 已提交
5434

C
cff-gite 已提交
5435
**参数:** 
H
h00514358 已提交
5436

C
cff-gite 已提交
5437 5438 5439 5440
| 参数名   | 类型                                                    | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_PROXIMITY      | 是   | 接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。                 |
| callback | Callback&lt;[ProximityResponse](#proximityresponse)&gt; | 是   | 注册一次接近光传感器的回调函数,上报的数据类型为ProximityResponse。 |
H
h00514358 已提交
5441

C
cff-gite 已提交
5442
**示例:** 
L
li-yaoyao777 已提交
5443 5444

```ts
L
li-yaoyao777 已提交
5445 5446 5447
import sensor from '@ohos.sensor';

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, (data: sensor.ProximityResponse) => {
L
li-yaoyao777 已提交
5448 5449 5450 5451
  console.info('Succeeded in invoking once. Distance: ' + data.distance);
}
);
```
H
h00514358 已提交
5452

C
cff-gite 已提交
5453
### HUMIDITY<sup>(deprecated)</sup>
C
cff-gite 已提交
5454

C
cff-gite 已提交
5455
once(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback&lt;HumidityResponse&gt;): void
C
cff-gite 已提交
5456

C
cff-gite 已提交
5457
监听湿度传感器数据变化一次。
C
cff-gite 已提交
5458

C
cff-gite 已提交
5459
从API version 9 开始不再维护,建议使用[sensor.once.HUMIDITY](#humidity9-1)代替。
C
cff-gite 已提交
5460

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

H
HelloCrease 已提交
5463
**参数:** 
C
cff-gite 已提交
5464

C
cff-gite 已提交
5465 5466 5467 5468
| 参数名   | 类型                                                  | 必填 | 说明                                                         |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_HUMIDITY     | 是   | 湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。                    |
| callback | Callback&lt;[HumidityResponse](#humidityresponse)&gt; | 是   | 注册一次湿度传感器的回调函数,上报的数据类型为HumidityResponse。 |
C
cff-gite 已提交
5469

H
HelloCrease 已提交
5470
**示例:** 
L
li-yaoyao777 已提交
5471 5472

```ts
L
li-yaoyao777 已提交
5473 5474 5475
import sensor from '@ohos.sensor';

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, (data: sensor.HumidityResponse) => {
L
li-yaoyao777 已提交
5476 5477 5478
  console.info('Succeeded in invoking once. Humidity: ' + data.humidity);
});
```
C
cff-gite 已提交
5479

C
cff-gite 已提交
5480
### BAROMETER<sup>(deprecated)</sup>
C
cff-gite 已提交
5481

C
cff-gite 已提交
5482
once(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback&lt;BarometerResponse&gt;): void
C
cff-gite 已提交
5483

C
cff-gite 已提交
5484
监听气压计传感器数据变化一次。
H
h00514358 已提交
5485

C
cff-gite 已提交
5486
从API version 9 开始不再维护,建议使用[sensor.once.BAROMETER](#barometer9-1)代替。
C
cff-gite 已提交
5487 5488 5489

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

H
HelloCrease 已提交
5490
**参数:** 
C
cff-gite 已提交
5491

C
cff-gite 已提交
5492 5493 5494 5495
| 参数名   | 类型                                                    | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_BAROMETER      | 是   | 气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。                 |
| callback | Callback&lt;[BarometerResponse](#barometerresponse)&gt; | 是   | 注册一次气压计传感器的回调函数,上报的数据类型为BarometerResponse。 |
C
cff-gite 已提交
5496

C
cff-gite 已提交
5497
**示例:** 
L
li-yaoyao777 已提交
5498 5499

```ts
L
li-yaoyao777 已提交
5500 5501 5502
import sensor from '@ohos.sensor';

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, (data: sensor.BarometerResponse) => {
L
li-yaoyao777 已提交
5503 5504 5505
  console.info('Succeeded in invoking once. Atmospheric pressure: ' + data.pressure);
});
```
H
h00514358 已提交
5506

C
cff-gite 已提交
5507
### HALL<sup>(deprecated)</sup>
H
h00514358 已提交
5508

C
cff-gite 已提交
5509
once(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback&lt;HallResponse&gt;): void
H
h00514358 已提交
5510

C
cff-gite 已提交
5511 5512
监听霍尔传感器数据变化一次。

C
cff-gite 已提交
5513
从API version 9 开始不再维护,建议使用[sensor.once.HALL](#hall9-1)代替。
H
h00514358 已提交
5514 5515 5516

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

C
cff-gite 已提交
5517
**参数:** 
H
h00514358 已提交
5518

C
cff-gite 已提交
5519 5520 5521 5522
| 参数名   | 类型                                          | 必填 | 说明                                                         |
| -------- | --------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_HALL | 是   | 霍尔传感器类型为SENSOR_TYPE_ID_HALL。                        |
| callback | Callback&lt;[HallResponse](#hallresponse)&gt; | 是   | 注册一次霍尔传感器的回调函数,上报的数据类型为HallResponse。 |
H
h00514358 已提交
5523

C
cff-gite 已提交
5524
**示例:** 
L
li-yaoyao777 已提交
5525 5526

```ts
L
li-yaoyao777 已提交
5527 5528 5529
import sensor from '@ohos.sensor';

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HALL, (data: sensor.HallResponse) => {
L
li-yaoyao777 已提交
5530 5531 5532
  console.info('Succeeded in invoking once. Status: ' + data.status);
});
```
H
h00514358 已提交
5533

C
cff-gite 已提交
5534
### AMBIENT_LIGHT<sup>(deprecated)</sup>
C
cff-gite 已提交
5535

C
cff-gite 已提交
5536
once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback&lt;LightResponse&gt;): void
C
cff-gite 已提交
5537

C
cff-gite 已提交
5538
监听环境光传感器数据变化一次。
C
cff-gite 已提交
5539

C
cff-gite 已提交
5540
从API version 9 开始不再维护,建议使用[sensor.once.AMBIENT_LIGHT](#ambient_light9-1)代替。
C
cff-gite 已提交
5541

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

H
HelloCrease 已提交
5544
**参数:** 
C
cff-gite 已提交
5545

C
cff-gite 已提交
5546 5547 5548 5549
| 参数名   | 类型                                                   | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_AMBIENT_LIGHT | 是   | 环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。             |
| callback | Callback&lt;[LightResponse](#lightresponse)&gt;        | 是   | 注册一次环境光传感器的回调函数,上报的数据类型为LightResponse。 |
C
cff-gite 已提交
5550

H
HelloCrease 已提交
5551
**示例:** 
C
cff-gite 已提交
5552

L
li-yaoyao777 已提交
5553
```ts
L
li-yaoyao777 已提交
5554 5555 5556
import sensor from '@ohos.sensor';

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, (data: sensor.LightResponse) => {
L
li-yaoyao777 已提交
5557 5558 5559
  console.info('Succeeded in invoking once. invoking once. Illumination: ' + data.intensity);
});
```
C
cff-gite 已提交
5560

C
cff-gite 已提交
5561
### ORIENTATION<sup>(deprecated)</sup>
C
cff-gite 已提交
5562

C
cff-gite 已提交
5563
once(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback&lt;OrientationResponse&gt;): void
C
cff-gite 已提交
5564

C
cff-gite 已提交
5565
监听方向传感器数据变化一次。
C
cff-gite 已提交
5566

C
cff-gite 已提交
5567
从API version 9 开始不再维护,建议使用[sensor.once.ORIENTATION](#orientation9-1)代替。 
C
cff-gite 已提交
5568

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

H
HelloCrease 已提交
5571
**参数:** 
C
cff-gite 已提交
5572

C
cff-gite 已提交
5573 5574 5575 5576
| 参数名   | 类型                                                        | 必填 | 说明                                                         |
| -------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_ORIENTATION        | 是   | 方向传感器类型为SENSOR_TYPE_ID_ORIENTATION。                 |
| callback | Callback&lt;[OrientationResponse](#orientationresponse)&gt; | 是   | 注册一次方向传感器的回调函数,上报的数据类型为OrientationResponse。 |
C
cff-gite 已提交
5577

H
HelloCrease 已提交
5578
**示例:** 
L
li-yaoyao777 已提交
5579 5580

```ts
L
li-yaoyao777 已提交
5581 5582 5583
import sensor from '@ohos.sensor';

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, (data: sensor.OrientationResponse) => {
L
li-yaoyao777 已提交
5584 5585 5586 5587 5588
  console.info('Succeeded in invoking the device rotateing at an angle around the X axis: ' + data.beta);
  console.info('Succeeded in invoking the device rotateing at an angle around the Y axis: ' + data.gamma);
  console.info('Succeeded in invoking the device rotateing at an angle around the Z axis: ' + data.alpha);
});
```
C
cff-gite 已提交
5589

C
cff-gite 已提交
5590
### ROTATION_VECTOR<sup>(deprecated)</sup>
C
cff-gite 已提交
5591

C
cff-gite 已提交
5592
once(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback: Callback&lt;RotationVectorResponse&gt;): void
C
cff-gite 已提交
5593

C
cff-gite 已提交
5594
监听旋转矢量传感器数据变化一次。
C
cff-gite 已提交
5595

C
cff-gite 已提交
5596
从API version 9 开始不再维护,建议使用[sensor.once.ROTATION_VECTOR](#rotation_vector9-1)代替。  
C
cff-gite 已提交
5597

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

H
HelloCrease 已提交
5600
**参数:** 
C
cff-gite 已提交
5601

C
cff-gite 已提交
5602 5603 5604 5605
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_ROTATION_VECTOR     | 是   | 旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。         |
| callback | Callback&lt;[RotationVectorResponse](#rotationvectorresponse)&gt; | 是   | 注册一次旋转矢量传感器的回调函数,上报的数据类型为RotationVectorResponse。 |
C
cff-gite 已提交
5606

H
HelloCrease 已提交
5607
**示例:** 
L
li-yaoyao777 已提交
5608 5609

```ts
L
li-yaoyao777 已提交
5610 5611 5612
import sensor from '@ohos.sensor';

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, (data: sensor.RotationVectorResponse) => {
L
li-yaoyao777 已提交
5613 5614 5615 5616 5617 5618
  console.info('Succeeded in invoking once. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking once. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking once. Z-coordinate component: ' + data.z);
  console.info('Succeeded in invoking once. Scalar quantity: ' + data.w);
});
```
C
cff-gite 已提交
5619

C
cff-gite 已提交
5620
### HEART_RATE<sup>(deprecated)</sup>
C
cff-gite 已提交
5621

C
cff-gite 已提交
5622
once(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback&lt;HeartRateResponse&gt;): void
C
cff-gite 已提交
5623

C
cff-gite 已提交
5624
监听心率传感器数据变化一次。
C
cff-gite 已提交
5625

C
cff-gite 已提交
5626
从API version 9 开始不再维护,建议使用[sensor.once.HEART_RATE](#heart_rate9-1)代替。
C
cff-gite 已提交
5627

C
cff-gite 已提交
5628
**需要权限**:ohos.permission.HEART_RATE  
C
cff-gite 已提交
5629

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

H
HelloCrease 已提交
5632
**参数:** 
C
cff-gite 已提交
5633

C
cff-gite 已提交
5634 5635 5636 5637
| 参数名   | 类型                                                    | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_HEART_RATE     | 是   | 心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。                  |
| callback | Callback&lt;[HeartRateResponse](#heartrateresponse)&gt; | 是   | 注册一次心率传感器的回调函数,上报的数据类型为HeartRateResponse。 |
C
cff-gite 已提交
5638

C
cff-gite 已提交
5639
### WEAR_DETECTION<sup>(deprecated)</sup>
C
cff-gite 已提交
5640

C
cff-gite 已提交
5641
once(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback&lt;WearDetectionResponse&gt;): void
C
cff-gite 已提交
5642

L
li-yaoyao777 已提交
5643
监听所佩戴的检测传感器的数据变化一次。
C
cff-gite 已提交
5644

C
cff-gite 已提交
5645
从API version 9 开始不再维护,建议使用[sensor.once.WEAR_DETECTION](#wear_detection9-1)代替。  
C
cff-gite 已提交
5646

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

H
HelloCrease 已提交
5649
**参数:** 
C
cff-gite 已提交
5650

C
cff-gite 已提交
5651 5652 5653 5654
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_WEAR_DETECTION      | 是   | 佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。          |
| callback | Callback&lt;[WearDetectionResponse](#weardetectionresponse)&gt; | 是   | 注册一次穿戴检测传感器的回调函数,上报的数据类型为WearDetectionResponse。 |
C
cff-gite 已提交
5655

H
HelloCrease 已提交
5656
**示例:** 
L
li-yaoyao777 已提交
5657
```ts
L
li-yaoyao777 已提交
5658 5659 5660
import sensor from '@ohos.sensor';

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, (data: sensor.WearDetectionResponse) => {
L
li-yaoyao777 已提交
5661 5662 5663
  console.info("Succeeded in invoking once. Wear status: " + data.value);
});
```
C
cff-gite 已提交
5664

C
cff-gite 已提交
5665
## sensor.off<sup>(deprecated)</sup>
C
cff-gite 已提交
5666

C
cff-gite 已提交
5667
### ACCELEROMETER<sup>(deprecated)</sup>
C
cff-gite 已提交
5668

C
cff-gite 已提交
5669
off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback?: Callback&lt;AccelerometerResponse&gt;): void
C
cff-gite 已提交
5670 5671 5672

取消订阅传感器数据。

C
cff-gite 已提交
5673
从API version 9 开始不再维护,建议使用[sensor.off.ACCELEROMETER](#accelerometer9-2)代替。  
C
cff-gite 已提交
5674 5675

**需要权限**:ohos.permission.ACCELEROMETER
C
cff-gite 已提交
5676

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

H
HelloCrease 已提交
5679
**参数:** 
C
cff-gite 已提交
5680

C
cff-gite 已提交
5681 5682 5683
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_ACCELEROMETER       | 是   | 要取消订阅的加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。 |
L
li-yaoyao777 已提交
5684
| callback | Callback&lt;[AccelerometerResponse](#accelerometerresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
5685

H
HelloCrease 已提交
5686
**示例:** 
C
cff-gite 已提交
5687

L
li-yaoyao777 已提交
5688
```ts
L
li-yaoyao777 已提交
5689 5690 5691
import sensor from '@ohos.sensor';

function callback(data: sensor.AccelerometerResponse) {
L
li-yaoyao777 已提交
5692 5693 5694
  console.info('Succeeded in invoking off. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking off. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking off. Z-coordinate component: ' + data.z);
C
cff-gite 已提交
5695
}
L
li-yaoyao777 已提交
5696

C
cff-gite 已提交
5697
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback);
C
cff-gite 已提交
5698 5699
```

C
cff-gite 已提交
5700
### ACCELEROMETER_UNCALIBRATED<sup>(deprecated)</sup>
C
cff-gite 已提交
5701

C
cff-gite 已提交
5702
off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, callback?: Callback&lt;AccelerometerUncalibratedResponse&gt;): void
C
cff-gite 已提交
5703 5704 5705

取消订阅传感器数据。

C
cff-gite 已提交
5706
从API version 9 开始不再维护,建议使用[sensor.off.ACCELEROMETER_UNCALIBRATED](#accelerometer_uncalibrated9-2)代替。 
C
cff-gite 已提交
5707 5708

**需要权限**:ohos.permission.ACCELEROMETER
C
cff-gite 已提交
5709

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

H
HelloCrease 已提交
5712
**参数:** 
C
cff-gite 已提交
5713

C
cff-gite 已提交
5714 5715 5716
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED | 是   | 要取消订阅的未校准加速度计传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 |
L
li-yaoyao777 已提交
5717
| callback | Callback&lt;[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
5718

H
HelloCrease 已提交
5719
**示例:** 
C
cff-gite 已提交
5720

L
li-yaoyao777 已提交
5721
```ts
L
li-yaoyao777 已提交
5722 5723 5724
import sensor from '@ohos.sensor';

function callback(data: sensor.AccelerometerUncalibratedResponse) {
L
li-yaoyao777 已提交
5725 5726 5727 5728 5729 5730
  console.info('Succeeded in invoking off. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking off. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking off. Z-coordinate component: ' + data.z);
  console.info('Succeeded in invoking off. X-coordinate bias: ' + data.biasX);
  console.info('Succeeded in invoking off. Y-coordinate bias: ' + data.biasY);
  console.info('Succeeded in invoking off. Z-coordinate bias: ' + data.biasZ);
C
cff-gite 已提交
5731
}
L
li-yaoyao777 已提交
5732

C
cff-gite 已提交
5733
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, callback);
C
cff-gite 已提交
5734 5735
```

C
cff-gite 已提交
5736
### AMBIENT_LIGHT<sup>(deprecated)</sup>
C
cff-gite 已提交
5737

C
cff-gite 已提交
5738
off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback?: Callback&lt;LightResponse&gt;): void
C
cff-gite 已提交
5739 5740 5741

取消订阅传感器数据。

C
cff-gite 已提交
5742
从API version 9 开始不再维护,建议使用[sensor.off.AMBIENT_LIGHT](#ambient_light9-2)代替。 
C
cff-gite 已提交
5743

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

H
HelloCrease 已提交
5746
**参数:** 
C
cff-gite 已提交
5747

C
cff-gite 已提交
5748 5749 5750
| 参数名   | 类型                                                   | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_AMBIENT_LIGHT | 是   | 要取消订阅的环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。 |
L
li-yaoyao777 已提交
5751
| callback | Callback&lt;[LightResponse](#lightresponse)&gt;        | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
5752

H
HelloCrease 已提交
5753
**示例:** 
C
cff-gite 已提交
5754

L
li-yaoyao777 已提交
5755
```ts
L
li-yaoyao777 已提交
5756 5757 5758
import sensor from '@ohos.sensor';

function callback(data: sensor.LightResponse) {
L
li-yaoyao777 已提交
5759
  console.info('Succeeded in invoking off. Illumination: ' + data.intensity);
C
cff-gite 已提交
5760
}
L
li-yaoyao777 已提交
5761

C
cff-gite 已提交
5762
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback);
C
cff-gite 已提交
5763
```
Z
zengyawen 已提交
5764

C
cff-gite 已提交
5765
### AMBIENT_TEMPERATURE<sup>(deprecated)</sup>
Z
zengyawen 已提交
5766

C
cff-gite 已提交
5767
off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback?: Callback&lt;AmbientTemperatureResponse&gt;): void
Z
zengyawen 已提交
5768

C
cff-gite 已提交
5769
取消订阅传感器数据。
Z
zengyawen 已提交
5770

C
cff-gite 已提交
5771
从API version 9 开始不再维护,建议使用[sensor.off.AMBIENT_TEMPERATURE](#ambient_temperature9-2)代替。 
C
cff-gite 已提交
5772

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

H
HelloCrease 已提交
5775
**参数:** 
Z
zengyawen 已提交
5776

C
cff-gite 已提交
5777 5778 5779
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_AMBIENT_TEMPERATURE | 是   | 要取消订阅的环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 |
L
li-yaoyao777 已提交
5780
| callback | Callback&lt;[AmbientTemperatureResponse](#ambienttemperatureresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
Z
zengyawen 已提交
5781

H
HelloCrease 已提交
5782
**示例:** 
Z
zengyawen 已提交
5783

L
li-yaoyao777 已提交
5784
```ts
L
li-yaoyao777 已提交
5785 5786 5787
import sensor from '@ohos.sensor';

function callback(data: sensor.AmbientTemperatureResponse) {
L
li-yaoyao777 已提交
5788
  console.info('Succeeded in invoking off. Temperature: ' + data.temperature);
C
cff-gite 已提交
5789
}
L
li-yaoyao777 已提交
5790

C
cff-gite 已提交
5791
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback);
H
HelloCrease 已提交
5792
```
Z
zengyawen 已提交
5793

C
cff-gite 已提交
5794
### BAROMETER<sup>(deprecated)</sup>
Z
zengyawen 已提交
5795

C
cff-gite 已提交
5796
off(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback?: Callback&lt;BarometerResponse&gt;): void
Z
zengyawen 已提交
5797

C
cff-gite 已提交
5798 5799
取消订阅传感器数据。

C
cff-gite 已提交
5800
从API version 9 开始不再维护,建议使用[sensor.off.BAROMETER](#barometer9-2)代替。 
C
cff-gite 已提交
5801

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

H
HelloCrease 已提交
5804
**参数:** 
Z
zengyawen 已提交
5805

C
cff-gite 已提交
5806 5807 5808
| 参数名   | 类型                                                    | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_BAROMETER      | 是   | 要取消订阅的气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。     |
L
li-yaoyao777 已提交
5809
| callback | Callback&lt;[BarometerResponse](#barometerresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
Z
zengyawen 已提交
5810

H
HelloCrease 已提交
5811
**示例:** 
Z
zengyawen 已提交
5812

L
li-yaoyao777 已提交
5813
```ts
L
li-yaoyao777 已提交
5814 5815 5816
import sensor from '@ohos.sensor';

function callback(data: sensor.BarometerResponse) {
L
li-yaoyao777 已提交
5817
  console.info('Succeeded in invoking off. Atmospheric pressure: ' + data.pressure);
C
cff-gite 已提交
5818
}
L
li-yaoyao777 已提交
5819

C
cff-gite 已提交
5820
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, callback);
H
HelloCrease 已提交
5821
```
Z
zengyawen 已提交
5822

C
cff-gite 已提交
5823
### GRAVITY<sup>(deprecated)</sup>
Z
zengyawen 已提交
5824

C
cff-gite 已提交
5825
off(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback?: Callback&lt;GravityResponse&gt;): void
Z
zengyawen 已提交
5826

C
cff-gite 已提交
5827
取消订阅传感器数据。
Z
zengyawen 已提交
5828

C
cff-gite 已提交
5829
从API version 9 开始不再维护,建议使用[sensor.off.GRAVITY](#gravity9-2)代替。  
C
cff-gite 已提交
5830

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

H
HelloCrease 已提交
5833
**参数:** 
C
cff-gite 已提交
5834

C
cff-gite 已提交
5835 5836 5837
| 参数名   | 类型                                                | 必填 | 说明                                                         |
| -------- | --------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_GRAVITY    | 是   | 要取消订阅的重力传感器类型为SENSOR_TYPE_ID_GRAVITY。         |
L
li-yaoyao777 已提交
5838
| callback | Callback&lt;[GravityResponse](#gravityresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
Z
zengyawen 已提交
5839

H
HelloCrease 已提交
5840
**示例:** 
C
cff-gite 已提交
5841

L
li-yaoyao777 已提交
5842
```ts
L
li-yaoyao777 已提交
5843 5844 5845
import sensor from '@ohos.sensor';

function callback(data: sensor.GravityResponse) {
L
li-yaoyao777 已提交
5846 5847 5848
  console.info('Succeeded in invoking off. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking off. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking off. Z-coordinate component: ' + data.z);
C
cff-gite 已提交
5849
}
L
li-yaoyao777 已提交
5850 5851

sensor.off(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, callback);
H
HelloCrease 已提交
5852
```
Z
zengyawen 已提交
5853

C
cff-gite 已提交
5854
### GYROSCOPE<sup>(deprecated)</sup>
Z
zengyawen 已提交
5855

C
cff-gite 已提交
5856
off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback?: Callback&lt;GyroscopeResponse&gt;): void
Z
zengyawen 已提交
5857

C
cff-gite 已提交
5858 5859
取消订阅传感器数据。

C
cff-gite 已提交
5860
从API version 9 开始不再维护,建议使用[sensor.off.GYROSCOPE](#gyroscope9-2)代替。 
C
cff-gite 已提交
5861 5862

**需要权限**:ohos.permission.GYROSCOPE
C
cff-gite 已提交
5863

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

H
HelloCrease 已提交
5866
**参数:** 
C
cff-gite 已提交
5867

C
cff-gite 已提交
5868 5869 5870
| 参数名   | 类型                                                    | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_GYROSCOPE      | 是   | 要取消订阅的陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。     |
L
li-yaoyao777 已提交
5871
| callback | Callback&lt;[GyroscopeResponse](#gyroscoperesponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
Z
zengyawen 已提交
5872

H
HelloCrease 已提交
5873
**示例:** 
Z
zengyawen 已提交
5874

L
li-yaoyao777 已提交
5875
```ts
L
li-yaoyao777 已提交
5876 5877 5878
import sensor from '@ohos.sensor';

function callback(data: sensor.GyroscopeResponse) {
L
li-yaoyao777 已提交
5879 5880 5881
  console.info('Succeeded in invoking off. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking off. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking off. Z-coordinate component: ' + data.z);
C
cff-gite 已提交
5882
}
L
li-yaoyao777 已提交
5883

C
cff-gite 已提交
5884 5885 5886 5887
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback);
```

### GYROSCOPE_UNCALIBRATED<sup>(deprecated)</sup>
Z
zengyawen 已提交
5888

C
cff-gite 已提交
5889
off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback?: Callback&lt;GyroscopeUncalibratedResponse&gt;): void
Z
zengyawen 已提交
5890

C
cff-gite 已提交
5891
取消订阅传感器数据。
Z
zengyawen 已提交
5892

C
cff-gite 已提交
5893
从API version 9 开始不再维护,建议使用[sensor.off.GYROSCOPE_UNCALIBRATED](#gyroscope_uncalibrated9-2)代替。  
C
cff-gite 已提交
5894 5895

**需要权限**:ohos.permission.GYROSCOPE
C
cff-gite 已提交
5896

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

H
HelloCrease 已提交
5899
**参数:** 
Z
zengyawen 已提交
5900

C
cff-gite 已提交
5901 5902 5903
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED | 是   | 要取消订阅的未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 |
L
li-yaoyao777 已提交
5904
| callback | Callback&lt;[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
Z
zengyawen 已提交
5905

H
HelloCrease 已提交
5906
**示例:** 
Z
zengyawen 已提交
5907

L
li-yaoyao777 已提交
5908
```ts
L
li-yaoyao777 已提交
5909 5910 5911
import sensor from '@ohos.sensor';

function callback(data: sensor.GyroscopeUncalibratedResponse) {
L
li-yaoyao777 已提交
5912 5913 5914
  console.info('Succeeded in invoking off. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking off. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking off. Z-coordinate component: ' + data.z);
C
cff-gite 已提交
5915
}
L
li-yaoyao777 已提交
5916

C
cff-gite 已提交
5917 5918
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback);
```
Z
zengyawen 已提交
5919

C
cff-gite 已提交
5920
### HALL<sup>(deprecated)</sup>
Z
zengyawen 已提交
5921

C
cff-gite 已提交
5922
off(type: SensorType.SENSOR_TYPE_ID_HALL, callback?: Callback&lt;HallResponse&gt;): void
Z
zengyawen 已提交
5923

C
cff-gite 已提交
5924
取消订阅传感器数据。
Z
zengyawen 已提交
5925

C
cff-gite 已提交
5926
从API version 9 开始不再维护,建议使用[sensor.off.HALL](#hall9-2)代替。 
C
cff-gite 已提交
5927

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

H
HelloCrease 已提交
5930
**参数:** 
Z
zengyawen 已提交
5931

C
cff-gite 已提交
5932 5933 5934
| 参数名   | 类型                                          | 必填 | 说明                                                         |
| -------- | --------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_HALL | 是   | 要取消订阅的霍尔传感器类型为SENSOR_TYPE_ID_HALL。            |
L
li-yaoyao777 已提交
5935
| callback | Callback&lt;[HallResponse](#hallresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
Z
zengyawen 已提交
5936

H
HelloCrease 已提交
5937
**示例:** 
Z
zengyawen 已提交
5938

L
li-yaoyao777 已提交
5939
```ts
L
li-yaoyao777 已提交
5940 5941 5942
import sensor from '@ohos.sensor';

function callback(data: sensor.HallResponse) {
L
li-yaoyao777 已提交
5943
  console.info('Succeeded in invoking off. Status: ' + data.status);
C
cff-gite 已提交
5944
}
L
li-yaoyao777 已提交
5945

C
cff-gite 已提交
5946 5947
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_HALL, callback);
```
Z
zengyawen 已提交
5948

C
cff-gite 已提交
5949
### HEART_RATE<sup>(deprecated)</sup>
Z
zengyawen 已提交
5950

C
cff-gite 已提交
5951
off(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback?: Callback&lt;HeartRateResponse&gt;): void
Z
zengyawen 已提交
5952

C
cff-gite 已提交
5953
取消订阅传感器数据。
Z
zengyawen 已提交
5954

C
cff-gite 已提交
5955
从API version 9 开始不再维护,建议使用[sensor.off.HEART_RATE](#heart_rate9-2)代替。
C
cff-gite 已提交
5956

C
cff-gite 已提交
5957
**需要权限**:ohos.permission.HEALTH_DATA 
C
cff-gite 已提交
5958

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

H
HelloCrease 已提交
5961
**参数:** 
Z
zengyawen 已提交
5962

C
cff-gite 已提交
5963 5964
| 参数名   | 类型                                                    | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
C
cff-gite 已提交
5965
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_HEART_RATE     | 是   | 要取消订阅的心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。      |
L
li-yaoyao777 已提交
5966
| callback | Callback&lt;[HeartRateResponse](#heartrateresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
Z
zengyawen 已提交
5967

C
cff-gite 已提交
5968
### HUMIDITY<sup>(deprecated)</sup>
Z
zengyawen 已提交
5969

C
cff-gite 已提交
5970
off(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback?: Callback&lt;HumidityResponse&gt;): void
Z
zengyawen 已提交
5971

C
cff-gite 已提交
5972
取消订阅传感器数据。
Z
zengyawen 已提交
5973

C
cff-gite 已提交
5974
从API version 9 开始不再维护,建议使用[sensor.off.HUMIDITY](#humidity9-2)代替。 
C
cff-gite 已提交
5975

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

H
HelloCrease 已提交
5978
**参数:** 
Z
zengyawen 已提交
5979

C
cff-gite 已提交
5980 5981 5982
| 参数名   | 类型                                                  | 必填 | 说明                                                         |
| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_HUMIDITY     | 是   | 要取消订阅的湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。        |
L
li-yaoyao777 已提交
5983
| callback | Callback&lt;[HumidityResponse](#humidityresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
Z
zengyawen 已提交
5984

H
HelloCrease 已提交
5985
**示例:** 
Z
zengyawen 已提交
5986

L
li-yaoyao777 已提交
5987
```ts
L
li-yaoyao777 已提交
5988 5989 5990
import sensor from '@ohos.sensor';

function callback(data: sensor.HumidityResponse) {
L
li-yaoyao777 已提交
5991
  console.info('Succeeded in invoking off. Humidity: ' + data.humidity);
C
cff-gite 已提交
5992
}
L
li-yaoyao777 已提交
5993

C
cff-gite 已提交
5994 5995
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, callback);
```
Z
zengyawen 已提交
5996

C
cff-gite 已提交
5997
### LINEAR_ACCELERATION<sup>(deprecated)</sup>
Z
zengyawen 已提交
5998

C
cff-gite 已提交
5999
off(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback?: Callback&lt;LinearAccelerometerResponse&gt;): void
Z
zengyawen 已提交
6000

C
cff-gite 已提交
6001
取消订阅传感器数据。
Z
zengyawen 已提交
6002

C
cff-gite 已提交
6003
从API version 9 开始不再维护,建议使用[sensor.off.LINEAR_ACCELEROMETER](#linear_accelerometer9-2)代替。
C
cff-gite 已提交
6004

C
cff-gite 已提交
6005
**需要权限**:ohos.permission.ACCELEROMETER
C
cff-gite 已提交
6006

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

H
HelloCrease 已提交
6009
**参数:** 
Z
zengyawen 已提交
6010

C
cff-gite 已提交
6011 6012 6013
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_LINEAR_ACCELERATION | 是   | 要取消订阅的线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。 |
L
li-yaoyao777 已提交
6014
| callback | Callback&lt;[LinearAccelerometerResponse](#linearaccelerometerresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
Z
zengyawen 已提交
6015

C
cff-gite 已提交
6016 6017 6018 6019 6020 6021
### MAGNETIC_FIELD<sup>(deprecated)</sup>

 off(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback?: Callback&lt;MagneticFieldResponse&gt;): void

取消订阅传感器数据。

C
cff-gite 已提交
6022
从API version 9 开始不再维护,建议使用[sensor.off.MAGNETIC_FIELD](#magnetic_field9-2)代替。 
C
cff-gite 已提交
6023

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

H
HelloCrease 已提交
6026
**参数:** 
Z
zengyawen 已提交
6027

C
cff-gite 已提交
6028 6029 6030
| 参数名           | 类型                                                         | 必填 | 说明                                                         |
| ---------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type             | [SensorType](#sensortype).SENSOR_TYPE_ID_MAGNETIC_FIELD      | 是   | 要取消订阅的磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。  |
L
li-yaoyao777 已提交
6031
| callbackcallback | Callback&lt;[MagneticFieldResponse](#magneticfieldresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
Z
zengyawen 已提交
6032

H
HelloCrease 已提交
6033
**示例:** 
Z
zengyawen 已提交
6034

L
li-yaoyao777 已提交
6035
```ts
L
li-yaoyao777 已提交
6036 6037 6038
import sensor from '@ohos.sensor';

function callback(data: sensor.MagneticFieldResponse) {
L
li-yaoyao777 已提交
6039 6040 6041
  console.info('Succeeded in invoking off. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking off. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking off. Z-coordinate component: ' + data.z);
C
cff-gite 已提交
6042
}
L
li-yaoyao777 已提交
6043

C
cff-gite 已提交
6044 6045
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback);
```
Z
zengyawen 已提交
6046

C
cff-gite 已提交
6047
### MAGNETIC_FIELD_UNCALIBRATED<sup>(deprecated)</sup>
Z
zengyawen 已提交
6048

C
cff-gite 已提交
6049
 off(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, callback?: Callback&lt;MagneticFieldUncalibratedResponse&gt;): void
Z
zengyawen 已提交
6050

C
cff-gite 已提交
6051
取消订阅传感器数据。
Z
zengyawen 已提交
6052

C
cff-gite 已提交
6053
从API version 9 开始不再维护,建议使用[sensor.off.MAGNETIC_FIELD_UNCALIBRATED](#magnetic_field_uncalibrated9-2)代替。
C
cff-gite 已提交
6054

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

H
HelloCrease 已提交
6057
**参数:** 
Z
zengyawen 已提交
6058

C
cff-gite 已提交
6059 6060 6061
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED | 是   | 要取消订阅的未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 |
L
li-yaoyao777 已提交
6062
| callback | Callback&lt;[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
Z
zengyawen 已提交
6063

H
HelloCrease 已提交
6064
**示例:** 
Z
zengyawen 已提交
6065

L
li-yaoyao777 已提交
6066
```ts
L
li-yaoyao777 已提交
6067 6068 6069
import sensor from '@ohos.sensor';

function callback(data: sensor.MagneticFieldUncalibratedResponse) {
L
li-yaoyao777 已提交
6070 6071 6072 6073 6074 6075
  console.info('Succeeded in invoking off. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking off. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking off. Z-coordinate component: ' + data.z);
  console.info('Succeeded in invoking off. X-coordinate bias: ' + data.biasX);
  console.info('Succeeded in invoking off. Y-coordinate bias: ' + data.biasY);
  console.info('Succeeded in invoking off. Z-coordinate bias: ' + data.biasZ);
C
cff-gite 已提交
6076
}
L
li-yaoyao777 已提交
6077

C
cff-gite 已提交
6078 6079
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, callback);
```
Z
zengyawen 已提交
6080

C
cff-gite 已提交
6081
### ORIENTATION<sup>(deprecated)</sup>
Z
zengyawen 已提交
6082

C
cff-gite 已提交
6083
 off(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback?: Callback&lt;OrientationResponse&gt;): void
Z
zengyawen 已提交
6084

C
cff-gite 已提交
6085
取消订阅传感器数据。
Z
zengyawen 已提交
6086

C
cff-gite 已提交
6087
从API version 9 开始不再维护,建议使用[sensor.off.ORIENTATION](#orientation9-2)代替。 
C
cff-gite 已提交
6088

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

H
HelloCrease 已提交
6091
**参数:** 
Z
zengyawen 已提交
6092

C
cff-gite 已提交
6093 6094 6095
| 参数名   | 类型                                                        | 必填 | 说明                                                         |
| -------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_ORIENTATION        | 是   | 要取消订阅的方向传感器类型为SENSOR_TYPE_ID_ORIENTATION       |
L
li-yaoyao777 已提交
6096
| callback | Callback&lt;[OrientationResponse](#orientationresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
Z
zengyawen 已提交
6097

H
HelloCrease 已提交
6098
**示例:** 
Z
zengyawen 已提交
6099

L
li-yaoyao777 已提交
6100
```ts
L
li-yaoyao777 已提交
6101 6102 6103
import sensor from '@ohos.sensor';

function callback(data: sensor.OrientationResponse) {
L
li-yaoyao777 已提交
6104 6105 6106
  console.info('Succeeded in invoking off. The device rotates at an angle around the X axis: ' + data.beta);
  console.info('Succeeded in invoking off. The device rotates at an angle around the Y axis: ' + data.gamma);
  console.info('Succeeded in invoking off. The device rotates at an angle around the Z axis: ' + data.alpha);
C
cff-gite 已提交
6107
}
L
li-yaoyao777 已提交
6108

C
cff-gite 已提交
6109 6110
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, callback);
```
Z
zengyawen 已提交
6111

C
cff-gite 已提交
6112
### PEDOMETER<sup>(deprecated)</sup>
Z
zengyawen 已提交
6113

C
cff-gite 已提交
6114
off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback?: Callback&lt;PedometerResponse&gt;): void
Z
zengyawen 已提交
6115

C
cff-gite 已提交
6116
取消订阅传感器数据。
Z
zengyawen 已提交
6117

C
cff-gite 已提交
6118
从API version 9 开始不再维护,建议使用[sensor.off.PEDOMETER](#pedometer9-2)代替。 
Z
zengyawen 已提交
6119

C
cff-gite 已提交
6120
**需要权限**:ohos.permission.ACTIVITY_MOTION
C
cff-gite 已提交
6121

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

H
HelloCrease 已提交
6124
**参数:** 
Z
zengyawen 已提交
6125

C
cff-gite 已提交
6126 6127 6128
| 参数名   | 类型                                                    | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_PEDOMETER      | 是   | 要取消订阅的计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。       |
L
li-yaoyao777 已提交
6129
| callback | Callback&lt;[PedometerResponse](#pedometerresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
6130 6131

**示例:** 
Z
zengyawen 已提交
6132

L
li-yaoyao777 已提交
6133
```ts
L
li-yaoyao777 已提交
6134 6135 6136
import sensor from '@ohos.sensor';

function callback(data: sensor.PedometerResponse) {
L
li-yaoyao777 已提交
6137
  console.info('Succeeded in invoking off. Steps: ' + data.steps);
C
cff-gite 已提交
6138
}
L
li-yaoyao777 已提交
6139

C
cff-gite 已提交
6140 6141
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, callback);
```
Z
zengyawen 已提交
6142

C
cff-gite 已提交
6143
### PEDOMETER_DETECTION<sup>(deprecated)</sup>
Z
zengyawen 已提交
6144

C
cff-gite 已提交
6145
off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback?: Callback&lt;PedometerDetectionResponse&gt;): void
Z
zengyawen 已提交
6146

C
cff-gite 已提交
6147
取消订阅传感器数据。
Z
zengyawen 已提交
6148

C
cff-gite 已提交
6149
从API version 9 开始不再维护,建议使用[sensor.off.PEDOMETER_DETECTION](#pedometer_detection9-2)代替。 
C
cff-gite 已提交
6150 6151

**需要权限**:ohos.permission.ACTIVITY_MOTION
C
cff-gite 已提交
6152

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

H
HelloCrease 已提交
6155
**参数:** 
Z
zengyawen 已提交
6156

C
cff-gite 已提交
6157 6158 6159
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_PEDOMETER_DETECTION | 是   | 要取消订阅的计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。 |
L
li-yaoyao777 已提交
6160
| callback | Callback&lt;[PedometerDetectionResponse](#pedometerdetectionresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
Z
zengyawen 已提交
6161

H
HelloCrease 已提交
6162
**示例:** 
Z
zengyawen 已提交
6163

L
li-yaoyao777 已提交
6164
```ts
L
li-yaoyao777 已提交
6165 6166 6167
import sensor from '@ohos.sensor';

function callback(data: sensor.PedometerDetectionResponse) {
L
li-yaoyao777 已提交
6168
  console.info('Succeeded in invoking off. Scalar data: ' + data.scalar);
C
cff-gite 已提交
6169
}
L
li-yaoyao777 已提交
6170

C
cff-gite 已提交
6171 6172
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback);
```
Z
zengyawen 已提交
6173

C
cff-gite 已提交
6174
### PROXIMITY<sup>(deprecated)</sup>
Z
zengyawen 已提交
6175

C
cff-gite 已提交
6176
off(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback?: Callback&lt;ProximityResponse&gt;): void
Z
zengyawen 已提交
6177

C
cff-gite 已提交
6178
取消订阅传感器数据。
Z
zengyawen 已提交
6179

C
cff-gite 已提交
6180
从API version 9 开始不再维护,建议使用[sensor.off.PROXIMITY](#proximity9-2)代替。 
C
cff-gite 已提交
6181

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

H
HelloCrease 已提交
6184
**参数:** 
Z
zengyawen 已提交
6185

C
cff-gite 已提交
6186 6187 6188
| 参数名   | 类型                                                    | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_PROXIMITY      | 是   | 要取消订阅的接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。     |
L
li-yaoyao777 已提交
6189
| callback | Callback&lt;[ProximityResponse](#proximityresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
Z
zengyawen 已提交
6190

H
HelloCrease 已提交
6191
**示例:** 
Z
zengyawen 已提交
6192

L
li-yaoyao777 已提交
6193
```ts
L
li-yaoyao777 已提交
6194 6195 6196
import sensor from '@ohos.sensor';

function callback(data: sensor.ProximityResponse) {
L
li-yaoyao777 已提交
6197
  console.info('Succeeded in invoking off. Distance: ' + data.distance);
C
cff-gite 已提交
6198
}
L
li-yaoyao777 已提交
6199

C
cff-gite 已提交
6200 6201
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, callback);
```
Z
zengyawen 已提交
6202

C
cff-gite 已提交
6203
### ROTATION_VECTOR<sup>(deprecated)</sup>
Z
zengyawen 已提交
6204

C
cff-gite 已提交
6205
off(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback?: Callback&lt;RotationVectorResponse&gt;): void
Z
zengyawen 已提交
6206

C
cff-gite 已提交
6207
取消订阅传感器数据。
Z
zengyawen 已提交
6208

C
cff-gite 已提交
6209
从API version 9 开始不再维护,建议使用[sensor.off.ROTATION_VECTOR](#rotation_vector9-2)代替。 
C
cff-gite 已提交
6210

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

H
HelloCrease 已提交
6213
**参数:** 
Z
zengyawen 已提交
6214

C
cff-gite 已提交
6215 6216 6217
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_ROTATION_VECTOR     | 是   | 要取消订阅的旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。 |
L
li-yaoyao777 已提交
6218
| callback | Callback&lt;[RotationVectorResponse](#rotationvectorresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
Z
zengyawen 已提交
6219

H
HelloCrease 已提交
6220
**示例:** 
Z
zengyawen 已提交
6221

L
li-yaoyao777 已提交
6222
```ts
L
li-yaoyao777 已提交
6223 6224 6225
import sensor from '@ohos.sensor';

function callback(data: sensor.RotationVectorResponse) {
L
li-yaoyao777 已提交
6226 6227 6228 6229
  console.info('Succeeded in invoking off. X-coordinate component: ' + data.x);
  console.info('Succeeded in invoking off. Y-coordinate component: ' + data.y);
  console.info('Succeeded in invoking off. Z-coordinate component: ' + data.z);
  console.info('Succeeded in invoking off. Scalar quantity: ' + data.w);
C
cff-gite 已提交
6230
}
L
li-yaoyao777 已提交
6231

C
cff-gite 已提交
6232 6233
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback);
```
Z
zengyawen 已提交
6234

C
cff-gite 已提交
6235
### SIGNIFICANT_MOTION<sup>(deprecated)</sup>
Z
zengyawen 已提交
6236

C
cff-gite 已提交
6237
off(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback?: Callback&lt;SignificantMotionResponse&gt;): void
Z
zengyawen 已提交
6238

C
cff-gite 已提交
6239
取消订阅传感器数据。
Z
zengyawen 已提交
6240

C
cff-gite 已提交
6241
从API version 9 开始不再维护,建议使用[sensor.off.SIGNIFICANT_MOTION](#significant_motion9-2)代替。
C
cff-gite 已提交
6242

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

H
HelloCrease 已提交
6245
**参数:** 
Z
zengyawen 已提交
6246

C
cff-gite 已提交
6247 6248 6249
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_SIGNIFICANT_MOTION  | 是   | 要取消订阅的大幅动作传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。 |
L
li-yaoyao777 已提交
6250
| callback | Callback&lt;[SignificantMotionResponse](#significantmotionresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
Z
zengyawen 已提交
6251

H
HelloCrease 已提交
6252
**示例:** 
Z
zengyawen 已提交
6253

L
li-yaoyao777 已提交
6254
```ts
L
li-yaoyao777 已提交
6255 6256 6257
import sensor from '@ohos.sensor';

function callback(data: sensor.SignificantMotionResponse) {
L
li-yaoyao777 已提交
6258
  console.info('Succeeded in invoking off. Scalar data: ' + data.scalar);
C
cff-gite 已提交
6259
}
L
li-yaoyao777 已提交
6260

C
cff-gite 已提交
6261 6262
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback);
```
Z
zengyawen 已提交
6263

C
cff-gite 已提交
6264
### WEAR_DETECTION<sup>(deprecated)</sup>
C
cff-gite 已提交
6265

C
cff-gite 已提交
6266
off(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback?: Callback&lt;WearDetectionResponse&gt;): void
C
cff-gite 已提交
6267

C
cff-gite 已提交
6268 6269
取消订阅传感器数据。

C
cff-gite 已提交
6270
从API version 9 开始不再维护,建议使用[sensor.off.WEAR_DETECTION](#wear_detection9-2)代替。 
C
cff-gite 已提交
6271 6272 6273 6274 6275

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

**参数:** 

C
cff-gite 已提交
6276 6277 6278
| 参数名   | 类型                                                         | 必填 | 说明                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type     | [SensorType](#sensortype).SENSOR_TYPE_ID_WEAR_DETECTION      | 是   | 要取消订阅的佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。 |
L
li-yaoyao777 已提交
6279
| callback | Callback&lt;[WearDetectionResponse](#weardetectionresponse)&gt; | 否   | 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。 |
C
cff-gite 已提交
6280 6281 6282

**示例:** 

L
li-yaoyao777 已提交
6283
```ts
L
li-yaoyao777 已提交
6284 6285 6286
import sensor from '@ohos.sensor';

function accCallback(data: sensor.WearDetectionResponse) {
L
li-yaoyao777 已提交
6287
  console.info('Succeeded in invoking off. Wear status: ' + data.value);
C
cff-gite 已提交
6288
}
L
li-yaoyao777 已提交
6289

C
cff-gite 已提交
6290
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, accCallback);
C
cff-gite 已提交
6291 6292
```

C
cff-gite 已提交
6293
## sensor.transformCoordinateSystem<sup>(deprecated)</sup>
C
cff-gite 已提交
6294

C
cff-gite 已提交
6295
transformCoordinateSystem(inRotationVector: Array&lt;number&gt;, coordinates: CoordinatesOptions, callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void
C
cff-gite 已提交
6296

C
cff-gite 已提交
6297 6298
旋转提供的旋转矩阵,使其可以以不同的方式表示坐标系。

C
cff-gite 已提交
6299
从API version 9 开始不再维护,建议使用[sensor.transformRotationMatrix](#sensortransformrotationmatrix9)代替。
C
cff-gite 已提交
6300 6301 6302

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

C
cff-gite 已提交
6303
**参数:** 
C
cff-gite 已提交
6304

C
cff-gite 已提交
6305 6306 6307 6308 6309
| 参数名              | 类型                                       | 必填   | 说明          |
| ---------------- | ---------------------------------------- | ---- | ----------- |
| inRotationVector | Array&lt;number&gt;                      | 是    | 表示旋转矩阵。     |
| coordinates      | [CoordinatesOptions](#coordinatesoptions) | 是    | 表示坐标系方向。    |
| callback         | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是    | 返回转换后的旋转矩阵。 |
C
cff-gite 已提交
6310 6311 6312

**示例:** 

L
li-yaoyao777 已提交
6313
```ts
L
li-yaoyao777 已提交
6314 6315 6316 6317 6318
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], { x: 2, y: 3 }, 
                                 (err: BusinessError.BusinessError, data: Array<number>) => {
L
li-yaoyao777 已提交
6319 6320 6321 6322 6323
  if (err) {
    console.error(`Failed to operate. Code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info("Succeeded in starting Operation. Data obtained: " + data);
L
li-yaoyao777 已提交
6324
  for (let i = 0; i < data.length; i++) {
L
li-yaoyao777 已提交
6325 6326 6327
    console.info("Succeeded in getting transformCoordinateSystem data[ " + i + "] = " + data[i]);
  }
})
C
cff-gite 已提交
6328
```
C
cff-gite 已提交
6329
## sensor.transformCoordinateSystem<sup>(deprecated)</sup>
C
cff-gite 已提交
6330

C
cff-gite 已提交
6331
transformCoordinateSystem(inRotationVector: Array&lt;number&gt;, coordinates: CoordinatesOptions): Promise&lt;Array&lt;number&gt;&gt;
C
cff-gite 已提交
6332

C
cff-gite 已提交
6333
旋转提供的旋转矩阵,使其可以以不同的方式表示坐标系。
C
cff-gite 已提交
6334

C
cff-gite 已提交
6335
从API version 9 开始不再维护,建议使用[sensor.transformRotationMatrix](#sensortransformrotationmatrix9-1)代替。
C
cff-gite 已提交
6336 6337 6338 6339 6340

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

**参数:** 

C
cff-gite 已提交
6341 6342 6343 6344
| 参数名              | 类型                                       | 必填   | 说明       |
| ---------------- | ---------------------------------------- | ---- | -------- |
| inRotationVector | Array&lt;number&gt;                      | 是    | 表示旋转矩阵。  |
| coordinates      | [CoordinatesOptions](#coordinatesoptions) | 是    | 表示坐标系方向。 |
C
cff-gite 已提交
6345

C
cff-gite 已提交
6346 6347 6348 6349 6350 6351 6352
**返回值:** 

| 类型                                 | 说明          |
| ---------------------------------- | ----------- |
| Promise&lt;Array&lt;number&gt;&gt; | 返回转换后的旋转矩阵。 |

**示例:** 
C
cff-gite 已提交
6353

L
li-yaoyao777 已提交
6354
```ts
L
li-yaoyao777 已提交
6355 6356 6357
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

L
li-yaoyao777 已提交
6358
const promise = sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], { x: 2, y: 3 });
L
li-yaoyao777 已提交
6359
promise.then((data: Array<number>) => {
L
li-yaoyao777 已提交
6360
  console.info("Succeeded in starting Operation");
L
li-yaoyao777 已提交
6361
  for (let i = 0; i < data.length; i++) {
L
li-yaoyao777 已提交
6362 6363
    console.info("Succeeded in getting transformCoordinateSystem data[ " + i + "] = " + data[i]);
  }
L
li-yaoyao777 已提交
6364
}).catch((err: BusinessError.BusinessError) => {
L
li-yaoyao777 已提交
6365
  console.error(`Failed to operate.`);
C
cff-gite 已提交
6366
})
C
cff-gite 已提交
6367 6368
```

C
cff-gite 已提交
6369
## sensor.getGeomagneticField<sup>(deprecated)</sup>
C
cff-gite 已提交
6370

C
cff-gite 已提交
6371
getGeomagneticField(locationOptions: LocationOptions, timeMillis: number, callback: AsyncCallback&lt;GeomagneticResponse&gt;): void
C
cff-gite 已提交
6372

C
cff-gite 已提交
6373 6374
获取地球上特定位置的地磁场。

C
cff-gite 已提交
6375
从API version 9 开始不再维护,建议使用[sensor.getGeomagneticInfo](#sensorgetgeomagneticinfo9)代替。
C
cff-gite 已提交
6376 6377 6378 6379 6380

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

**参数:** 

C
cff-gite 已提交
6381 6382 6383 6384 6385
| 参数名          | 类型                                                         | 必填 | 说明                               |
| --------------- | ------------------------------------------------------------ | ---- | ---------------------------------- |
| locationOptions | [LocationOptions](#locationoptions)                          | 是   | 地理位置。                         |
| timeMillis      | number                                                       | 是   | 表示获取磁偏角的时间,单位为毫秒。 |
| callback        | AsyncCallback&lt;[GeomagneticResponse](#geomagneticresponse)&gt; | 是   | 返回磁场信息。                     |
C
cff-gite 已提交
6386

C
cff-gite 已提交
6387
**示例:** 
L
li-yaoyao777 已提交
6388 6389

```ts
L
li-yaoyao777 已提交
6390 6391 6392 6393 6394
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

sensor.getGeomagneticField({ latitude: 80, longitude: 0, altitude: 0 }, 1580486400000, 
                           (err: BusinessError.BusinessError, data: sensor.GeomagneticResponse) => {
L
li-yaoyao777 已提交
6395 6396 6397 6398 6399 6400 6401
  if (err) {
    console.error(`Failed to operate. Code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info('Succeeded in getting sensor_getGeomagneticField_callback x: ' + data.x + ',y: ' + data.y + ',z: ' +
  data.z + ',geomagneticDip: ' + data.geomagneticDip + ',deflectionAngle: ' + data.deflectionAngle +
  ',levelIntensity: ' + data.levelIntensity + ',totalIntensity: ' + data.totalIntensity);
C
cff-gite 已提交
6402
});
C
cff-gite 已提交
6403
```
C
cff-gite 已提交
6404
## sensor.getGeomagneticField<sup>(deprecated)</sup>
C
cff-gite 已提交
6405

C
cff-gite 已提交
6406
getGeomagneticField(locationOptions: LocationOptions, timeMillis: number): Promise&lt;GeomagneticResponse&gt;
Z
zengyawen 已提交
6407

C
cff-gite 已提交
6408
获取地球上特定位置的地磁场。
Z
zengyawen 已提交
6409

C
cff-gite 已提交
6410
从API version 9 开始不再维护,建议使用[sensor.getGeomagneticInfo](#sensorgetgeomagneticinfo9-1)代替。
Z
zengyawen 已提交
6411

C
cff-gite 已提交
6412
**系统能力**:SystemCapability.Sensors.Sensor
Z
zengyawen 已提交
6413

C
cff-gite 已提交
6414
**参数:** 
C
cff-gite 已提交
6415

C
cff-gite 已提交
6416 6417 6418 6419
| 参数名             | 类型                                  | 必填   | 说明                |
| --------------- | ----------------------------------- | ---- | ----------------- |
| locationOptions | [LocationOptions](#locationoptions) | 是    | 地理位置。             |
| timeMillis      | number                              | 是    | 表示获取磁偏角的时间,单位为毫秒。 |
C
cff-gite 已提交
6420

C
cff-gite 已提交
6421 6422 6423 6424
**返回值:** 
| 类型                                       | 说明      |
| ---------------------------------------- | ------- |
| Promise&lt;[GeomagneticResponse](#geomagneticresponse)&gt; | 返回磁场信息。 |
C
cff-gite 已提交
6425

C
cff-gite 已提交
6426
**示例:** 
L
li-yaoyao777 已提交
6427 6428

```ts
L
li-yaoyao777 已提交
6429 6430 6431
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

L
li-yaoyao777 已提交
6432
const promise = sensor.getGeomagneticField({ latitude: 80, longitude: 0, altitude: 0 }, 1580486400000);
L
li-yaoyao777 已提交
6433
promise.then((data: sensor.GeomagneticResponse) => {
L
li-yaoyao777 已提交
6434 6435 6436
  console.info('Succeeded in getting sensor_getGeomagneticField_promise x: ' + data.x + ',y: ' + data.y + ',z: ' +
  data.z + ',geomagneticDip: ' + data.geomagneticDip + ',deflectionAngle: ' + data.deflectionAngle +
  ',levelIntensity: ' + data.levelIntensity + ',totalIntensity: ' + data.totalIntensity);
L
li-yaoyao777 已提交
6437
}).catch((reason: BusinessError.BusinessError) => {
L
li-yaoyao777 已提交
6438 6439 6440
  console.error(`Failed to operate.`);
})
```
C
cff-gite 已提交
6441

C
cff-gite 已提交
6442
## sensor.getAltitude<sup>(deprecated)</sup>
C
cff-gite 已提交
6443

C
cff-gite 已提交
6444
getAltitude(seaPressure: number, currentPressure: number, callback: AsyncCallback&lt;number&gt;): void
C
cff-gite 已提交
6445

C
cff-gite 已提交
6446
根据气压值获取设备所在的海拔高度。
Z
zengyawen 已提交
6447

C
cff-gite 已提交
6448
从API version 9 开始不再维护,建议使用[sensor.getDeviceAltitude](#sensorgetdevicealtitude9)代替。
Z
zengyawen 已提交
6449

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

C
cff-gite 已提交
6452
**参数:** 
Z
zengyawen 已提交
6453

C
cff-gite 已提交
6454 6455 6456 6457 6458
| 参数名             | 类型                          | 必填   | 说明                   |
| --------------- | --------------------------- | ---- | -------------------- |
| seaPressure     | number                      | 是    | 表示海平面气压值,单位为hPa。     |
| currentPressure | number                      | 是    | 表示设备所在高度的气压值,单位为hPa。 |
| callback        | AsyncCallback&lt;number&gt; | 是    | 返回设备所在的海拔高度,单位为米。    |
Z
zengyawen 已提交
6459

C
cff-gite 已提交
6460
**示例:** 
Z
zengyawen 已提交
6461

L
li-yaoyao777 已提交
6462
```ts
L
li-yaoyao777 已提交
6463 6464 6465 6466
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

sensor.getAltitude(0, 200, (err: BusinessError.BusinessError, data: number) => {
L
li-yaoyao777 已提交
6467 6468 6469 6470 6471 6472 6473
  if (err) {
    console.error(`Failed to operate. Code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info("Succeeded in getting getAltitude interface get data: " + data);
});
```
Z
zengyawen 已提交
6474

C
cff-gite 已提交
6475
## sensor.getAltitude<sup>(deprecated)</sup>
Z
zengyawen 已提交
6476

C
cff-gite 已提交
6477
getAltitude(seaPressure: number, currentPressure: number): Promise&lt;number&gt;
C
cff-gite 已提交
6478

C
cff-gite 已提交
6479
根据气压值获取设备所在的海拔高度。
Z
zengyawen 已提交
6480

C
cff-gite 已提交
6481
从API version 9 开始不再维护,建议使用[sensor.getDeviceAltitude](#sensorgetdevicealtitude9-1)代替。
Z
zengyawen 已提交
6482

C
cff-gite 已提交
6483
**系统能力**:SystemCapability.Sensors.Sensor
Z
zengyawen 已提交
6484

C
cff-gite 已提交
6485
**参数:** 
Z
zengyawen 已提交
6486

C
cff-gite 已提交
6487 6488 6489 6490
| 参数名             | 类型     | 必填   | 说明                   |
| --------------- | ------ | ---- | -------------------- |
| seaPressure     | number | 是    | 表示海平面气压值,单位为hPa。     |
| currentPressure | number | 是    | 表示设备所在高度的气压值,单位为hPa。 |
Z
zengyawen 已提交
6491

C
cff-gite 已提交
6492
**返回值:** 
C
cff-gite 已提交
6493

C
cff-gite 已提交
6494 6495 6496
| 类型                    | 说明                 |
| --------------------- | ------------------ |
| Promise&lt;number&gt; | 返回设备所在的海拔高度(单位:米)。 |
Z
zengyawen 已提交
6497

C
cff-gite 已提交
6498
**示例:** 
Z
zengyawen 已提交
6499

L
li-yaoyao777 已提交
6500
```ts
L
li-yaoyao777 已提交
6501 6502 6503
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

L
li-yaoyao777 已提交
6504
const promise = sensor.getAltitude(0, 200);
L
li-yaoyao777 已提交
6505
promise.then((data: number) => {
L
li-yaoyao777 已提交
6506
  console.info('Succeeded in getting sensor_getAltitude_Promise success', data);
L
li-yaoyao777 已提交
6507
}).catch((err: BusinessError.BusinessError) => {
L
li-yaoyao777 已提交
6508 6509 6510
  console.error(`Failed to operate.`);
})
```
Z
zengyawen 已提交
6511

Z
zengyawen 已提交
6512

C
cff-gite 已提交
6513
## sensor.getGeomagneticDip<sup>(deprecated)</sup>
Z
zengyawen 已提交
6514

C
cff-gite 已提交
6515
getGeomagneticDip(inclinationMatrix: Array&lt;number&gt;, callback: AsyncCallback&lt;number&gt;): void
C
cff-gite 已提交
6516

C
cff-gite 已提交
6517
根据倾斜矩阵计算地磁倾斜角。
Z
zengyawen 已提交
6518

C
cff-gite 已提交
6519
从API version 9 开始不再维护,建议使用[sensor.getInclination](#sensorgetinclination9)代替。
Z
zengyawen 已提交
6520

C
cff-gite 已提交
6521
**系统能力**:SystemCapability.Sensors.Sensor
Z
zengyawen 已提交
6522

C
cff-gite 已提交
6523
**参数:** 
Z
zengyawen 已提交
6524

C
cff-gite 已提交
6525 6526 6527 6528
| 参数名               | 类型                          | 必填   | 说明             |
| ----------------- | --------------------------- | ---- | -------------- |
| inclinationMatrix | Array&lt;number&gt;         | 是    | 表示倾斜矩阵。        |
| callback          | AsyncCallback&lt;number&gt; | 是    | 返回地磁倾斜角,单位为弧度。 |
Z
zengyawen 已提交
6529

C
cff-gite 已提交
6530
**示例:** 
C
cff-gite 已提交
6531

L
li-yaoyao777 已提交
6532
```ts
L
li-yaoyao777 已提交
6533 6534 6535 6536
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1], (err: BusinessError.BusinessError, data: number) => {
L
li-yaoyao777 已提交
6537 6538 6539 6540 6541 6542 6543
  if (err) {
    console.error(`Failed to register data. Code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info("Succeeded in getting getGeomagneticDip interface get data: " + data);
})
```
Z
zengyawen 已提交
6544

C
cff-gite 已提交
6545
## sensor.getGeomagneticDip<sup>(deprecated)</sup>
Z
zengyawen 已提交
6546

C
cff-gite 已提交
6547
getGeomagneticDip(inclinationMatrix: Array&lt;number&gt;): Promise&lt;number&gt;
Z
zengyawen 已提交
6548

C
cff-gite 已提交
6549
根据倾斜矩阵计算地磁倾斜角。
Z
zengyawen 已提交
6550

C
cff-gite 已提交
6551
从API version 9 开始不再维护,建议使用[sensor.getInclination](#sensorgetinclination9-1)代替。
Z
zengyawen 已提交
6552

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

C
cff-gite 已提交
6555
**参数:** 
Z
zengyawen 已提交
6556

C
cff-gite 已提交
6557 6558 6559
| 参数名               | 类型                  | 必填   | 说明      |
| ----------------- | ------------------- | ---- | ------- |
| inclinationMatrix | Array&lt;number&gt; | 是    | 表示倾斜矩阵。 |
Z
zengyawen 已提交
6560

C
cff-gite 已提交
6561
**返回值:** 
Z
zengyawen 已提交
6562

C
cff-gite 已提交
6563 6564 6565
| 类型                    | 说明             |
| --------------------- | -------------- |
| Promise&lt;number&gt; | 返回地磁倾斜角,单位为弧度。 |
Z
zengyawen 已提交
6566

C
cff-gite 已提交
6567
**示例:** 
Z
zengyawen 已提交
6568

L
li-yaoyao777 已提交
6569
```ts
L
li-yaoyao777 已提交
6570 6571 6572
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

L
li-yaoyao777 已提交
6573
const promise = sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1]);
L
li-yaoyao777 已提交
6574
promise.then((data: number) => {
L
li-yaoyao777 已提交
6575
  console.info('Succeeded in get GeomagneticDip_promise', data);
L
li-yaoyao777 已提交
6576
}).catch((err: BusinessError.BusinessError) => {
L
li-yaoyao777 已提交
6577 6578 6579
  console.error(`Failed to operate.`);
})
```
C
cff-gite 已提交
6580

C
cff-gite 已提交
6581
## sensor. getAngleModify<sup>(deprecated)</sup>
Z
zengyawen 已提交
6582

C
cff-gite 已提交
6583
getAngleModify(currentRotationMatrix: Array&lt;number&gt;, preRotationMatrix: Array&lt;number&gt;, callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void
Z
zengyawen 已提交
6584

C
cff-gite 已提交
6585
获取两个旋转矩阵之间的角度变化。
Z
zengyawen 已提交
6586

C
cff-gite 已提交
6587
从API version 9 开始不再维护,建议使用[sensor.getAngleVariation](#sensorgetanglevariation9)代替。
Z
zengyawen 已提交
6588

C
cff-gite 已提交
6589
**系统能力**:SystemCapability.Sensors.Sensor
Z
zengyawen 已提交
6590

C
cff-gite 已提交
6591
**参数:** 
C
cff-gite 已提交
6592

C
cff-gite 已提交
6593 6594 6595 6596 6597
| 参数名                   | 类型                                       | 必填   | 说明                 |
| --------------------- | ---------------------------------------- | ---- | ------------------ |
| currentRotationMatrix | Array&lt;number&gt;                      | 是    | 表示当前旋转矩阵。          |
| preRotationMatrix     | Array&lt;number&gt;                      | 是    | 表示旋转矩阵。            |
| callback              | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是    | 返回z、x、y轴方向的旋转角度变化。 |
Z
zengyawen 已提交
6598

C
cff-gite 已提交
6599
**示例:** 
Z
zengyawen 已提交
6600

L
li-yaoyao777 已提交
6601
```ts
L
li-yaoyao777 已提交
6602 6603 6604 6605 6606
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

sensor.getAngleModify([1, 0, 0, 0, 1, 0, 0, 0, 1], [1, 0, 0, 0, 0.87, -0.50, 0, 0.50, 0.87],
                      (err: BusinessError.BusinessError, data: Array<number>) => {
L
li-yaoyao777 已提交
6607 6608 6609 6610
  if (err) {
    console.error(`Failed to register data. Code: ${err.code}, message: ${err.message}`);
    return;
  }
L
li-yaoyao777 已提交
6611
  for (let i = 0; i < data.length; i++) {
L
li-yaoyao777 已提交
6612 6613 6614 6615
    console.info("data[" + i + "]: " + data[i]);
  }
})
```
Z
zengyawen 已提交
6616

C
cff-gite 已提交
6617
## sensor. getAngleModify<sup>(deprecated)</sup>
Z
zengyawen 已提交
6618

C
cff-gite 已提交
6619
getAngleModify(currentRotationMatrix: Array&lt;number&gt;, preRotationMatrix: Array&lt;number&gt;): Promise&lt;Array&lt;number&gt;&gt;
C
cff-gite 已提交
6620

C
cff-gite 已提交
6621
获取两个旋转矩阵之间的角度变化。
Z
zengyawen 已提交
6622

C
cff-gite 已提交
6623
从API version 9 开始不再维护,建议使用[sensor.getAngleVariation](#sensorgetanglevariation9-1)代替。
Z
zengyawen 已提交
6624

C
cff-gite 已提交
6625
**系统能力**:SystemCapability.Sensors.Sensor
Z
zengyawen 已提交
6626

C
cff-gite 已提交
6627
**参数:** 
Z
zengyawen 已提交
6628

C
cff-gite 已提交
6629 6630 6631 6632
| 参数名                   | 类型                  | 必填   | 说明        |
| --------------------- | ------------------- | ---- | --------- |
| currentRotationMatrix | Array&lt;number&gt; | 是    | 表示当前旋转矩阵。 |
| preRotationMatrix     | Array&lt;number&gt; | 是    | 表示旋转矩阵。   |
Z
zengyawen 已提交
6633

C
cff-gite 已提交
6634
**返回值:** 
C
cff-gite 已提交
6635

C
cff-gite 已提交
6636 6637 6638
| 类型                                 | 说明                 |
| ---------------------------------- | ------------------ |
| Promise&lt;Array&lt;number&gt;&gt; | 返回z、x、y轴方向的旋转角度变化。 |
Z
zengyawen 已提交
6639

C
cff-gite 已提交
6640
**示例:** 
Z
zengyawen 已提交
6641

L
li-yaoyao777 已提交
6642
```ts
L
li-yaoyao777 已提交
6643 6644 6645
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

L
li-yaoyao777 已提交
6646
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]);
L
li-yaoyao777 已提交
6647
promise.then((data: Array<number>) => {
L
li-yaoyao777 已提交
6648
  console.info('Succeeded in getting AngleModify_promise.');
L
li-yaoyao777 已提交
6649
  for (let i = 0; i < data.length; i++) {
L
li-yaoyao777 已提交
6650 6651
    console.info("Succeeded in getting data[" + i + "]: " + data[i]);
  }
L
li-yaoyao777 已提交
6652 6653 6654
}).catch((reason: BusinessError.BusinessError) => {
  let e: BusinessError.BusinessError = reason as BusinessError.BusinessError;
  console.info("Succeeded in getting promise::catch", e);
L
li-yaoyao777 已提交
6655 6656
})
```
Z
zengyawen 已提交
6657

C
cff-gite 已提交
6658
## sensor.createRotationMatrix<sup>(deprecated)</sup>
Z
zengyawen 已提交
6659

C
cff-gite 已提交
6660
createRotationMatrix(rotationVector: Array&lt;number&gt;, callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void
C
cff-gite 已提交
6661

C
cff-gite 已提交
6662
将旋转矢量转换为旋转矩阵。
Z
zengyawen 已提交
6663

C
cff-gite 已提交
6664
从API version 9 开始不再维护,建议使用[sensor.getRotationMatrix](#sensorgetrotationmatrix9)代替。
Z
zengyawen 已提交
6665

C
cff-gite 已提交
6666
**系统能力**:SystemCapability.Sensors.Sensor
Z
zengyawen 已提交
6667

C
cff-gite 已提交
6668
**参数:** 
Z
zengyawen 已提交
6669

C
cff-gite 已提交
6670 6671 6672 6673
| 参数名            | 类型                                       | 必填   | 说明      |
| -------------- | ---------------------------------------- | ---- | ------- |
| rotationVector | Array&lt;number&gt;                      | 是    | 表示旋转矢量。 |
| callback       | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是    | 返回旋转矩阵。 |
Z
zengyawen 已提交
6674

C
cff-gite 已提交
6675
**示例:** 
C
cff-gite 已提交
6676

L
li-yaoyao777 已提交
6677
```ts
L
li-yaoyao777 已提交
6678 6679 6680 6681 6682
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877],
                            (err: BusinessError.BusinessError, data: Array<number>) => {
L
li-yaoyao777 已提交
6683 6684 6685 6686
  if (err) {
    console.error(`Failed to register data. Code: ${err.code}, message: ${err.message}`);
    return;
  }
L
li-yaoyao777 已提交
6687
  for (let i = 0; i < data.length; i++) {
L
li-yaoyao777 已提交
6688 6689 6690 6691
    console.info("Succeeded in getting data[" + i + "]: " + data[i]);
  }
})
```
Z
zengyawen 已提交
6692

C
cff-gite 已提交
6693
## sensor.createRotationMatrix<sup>(deprecated)</sup>
Z
zengyawen 已提交
6694

C
cff-gite 已提交
6695
createRotationMatrix(rotationVector: Array&lt;number&gt;): Promise&lt;Array&lt;number&gt;&gt;
Z
zengyawen 已提交
6696

C
cff-gite 已提交
6697
将旋转矢量转换为旋转矩阵。
Z
zengyawen 已提交
6698

C
cff-gite 已提交
6699
从API version 9 开始不再维护,建议使用[sensor.getRotationMatrix](#sensorgetrotationmatrix9-1)代替。
C
cff-gite 已提交
6700

C
cff-gite 已提交
6701
**系统能力**:SystemCapability.Sensors.Sensor
Z
zengyawen 已提交
6702

C
cff-gite 已提交
6703
**参数:** 
Z
zengyawen 已提交
6704

C
cff-gite 已提交
6705 6706 6707
| 参数名            | 类型                  | 必填   | 说明      |
| -------------- | ------------------- | ---- | ------- |
| rotationVector | Array&lt;number&gt; | 是    | 表示旋转矢量。 |
Z
zengyawen 已提交
6708

C
cff-gite 已提交
6709
**返回值:** 
Z
zengyawen 已提交
6710

C
cff-gite 已提交
6711 6712 6713
| 类型                                 | 说明      |
| ---------------------------------- | ------- |
| Promise&lt;Array&lt;number&gt;&gt; | 返回旋转矩阵。 |
Z
zengyawen 已提交
6714

C
cff-gite 已提交
6715
**示例:** 
C
cff-gite 已提交
6716

L
li-yaoyao777 已提交
6717
 ```ts
L
li-yaoyao777 已提交
6718 6719 6720
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

L
li-yaoyao777 已提交
6721
const promise = sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877]);
L
li-yaoyao777 已提交
6722
promise.then((data: Array<number>) => {
L
li-yaoyao777 已提交
6723
  console.info('Succeeded in getting createRotationMatrix_promise');
L
li-yaoyao777 已提交
6724
  for (let i = 0; i < data.length; i++) {
L
li-yaoyao777 已提交
6725 6726
    console.info("data[" + i + "]: " + data[i]);
  }
L
li-yaoyao777 已提交
6727
}).catch((reason: BusinessError.BusinessError) => {
L
li-yaoyao777 已提交
6728 6729
  console.info("Succeeded in getting promise::catch", reason);
})
L
li-yaoyao777 已提交
6730
 ```
Z
zengyawen 已提交
6731

C
cff-gite 已提交
6732
## sensor.createQuaternion<sup>(deprecated)</sup>
Z
zengyawen 已提交
6733

C
cff-gite 已提交
6734
createQuaternion(rotationVector: Array&lt;number&gt;, callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void
Z
zengyawen 已提交
6735

C
cff-gite 已提交
6736
将旋转矢量转换为四元数。
Z
zengyawen 已提交
6737

C
cff-gite 已提交
6738
从API version 9 开始不再维护,建议使用[sensor.getQuaternion](#sensorgetquaternion9)代替。
C
cff-gite 已提交
6739

C
cff-gite 已提交
6740
**系统能力**:SystemCapability.Sensors.Sensor
Z
zengyawen 已提交
6741

C
cff-gite 已提交
6742
**参数:** 
Z
zengyawen 已提交
6743

C
cff-gite 已提交
6744 6745 6746 6747
| 参数名            | 类型                                       | 必填   | 说明      |
| -------------- | ---------------------------------------- | ---- | ------- |
| rotationVector | Array&lt;number&gt;                      | 是    | 表示旋转矢量。 |
| callback       | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是    | 返回四元数。  |
Z
zengyawen 已提交
6748

C
cff-gite 已提交
6749
**示例:** 
Z
zengyawen 已提交
6750

L
li-yaoyao777 已提交
6751
```ts
L
li-yaoyao777 已提交
6752 6753 6754 6755 6756
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877],
                        (err: BusinessError.BusinessError, data: Array<number>) => {
L
li-yaoyao777 已提交
6757 6758 6759 6760
  if (err) {
    console.error(`Failed to register data. Code: ${err.code}, message: ${err.message}`);
    return;
  }
L
li-yaoyao777 已提交
6761
  for (let i = 0; i < data.length; i++) {
L
li-yaoyao777 已提交
6762 6763 6764 6765
    console.info("Succeeded in getting data[" + i + "]: " + data[i]);
  }
})
```
C
cff-gite 已提交
6766

C
cff-gite 已提交
6767
## sensor.createQuaternion<sup>(deprecated)</sup>
Z
zengyawen 已提交
6768

C
cff-gite 已提交
6769
createQuaternion(rotationVector: Array&lt;number&gt;): Promise&lt;Array&lt;number&gt;&gt;
Z
zengyawen 已提交
6770

C
cff-gite 已提交
6771
将旋转矢量转换为四元数。
Z
zengyawen 已提交
6772

C
cff-gite 已提交
6773
从API version 9 开始不再维护,建议使用[sensor.getQuaternion](#sensorgetquaternion9-1)代替。
Z
zengyawen 已提交
6774

C
cff-gite 已提交
6775
**系统能力**:SystemCapability.Sensors.Sensor
Z
zengyawen 已提交
6776

C
cff-gite 已提交
6777
**参数:** 
C
cff-gite 已提交
6778

C
cff-gite 已提交
6779 6780 6781
| 参数名            | 类型                  | 必填   | 说明      |
| -------------- | ------------------- | ---- | ------- |
| rotationVector | Array&lt;number&gt; | 是    | 表示旋转矢量。 |
Z
zengyawen 已提交
6782

C
cff-gite 已提交
6783
**返回值:** 
Z
zengyawen 已提交
6784

C
cff-gite 已提交
6785 6786 6787
| 类型                                 | 说明     |
| ---------------------------------- | ------ |
| Promise&lt;Array&lt;number&gt;&gt; | 返回四元数。 |
Z
zengyawen 已提交
6788

C
cff-gite 已提交
6789
**示例:** 
Z
zengyawen 已提交
6790

L
li-yaoyao777 已提交
6791
```ts
L
li-yaoyao777 已提交
6792 6793 6794
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

L
li-yaoyao777 已提交
6795
const promise = sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877]);
L
li-yaoyao777 已提交
6796
promise.then((data: Array<number>) => {
L
li-yaoyao777 已提交
6797
  console.info('Succeeded in getting createQuaternion_promise');
L
li-yaoyao777 已提交
6798
  for (let i = 0; i < data.length; i++) {
L
li-yaoyao777 已提交
6799 6800
    console.info("data[" + i + "]: " + data[i]);
  }
L
li-yaoyao777 已提交
6801
}).catch((err: BusinessError.BusinessError) => {
L
li-yaoyao777 已提交
6802 6803 6804
  console.info(`Failed to get promise.`);
})
```
C
cff-gite 已提交
6805

C
cff-gite 已提交
6806
## sensor.getDirection<sup>(deprecated)</sup>
Z
zengyawen 已提交
6807

C
cff-gite 已提交
6808
getDirection(rotationMatrix: Array&lt;number&gt;, callback: AsyncCallback&lt;Array&lt;number&gt;&gt;): void
Z
zengyawen 已提交
6809

C
cff-gite 已提交
6810
根据旋转矩阵计算设备的方向。
Z
zengyawen 已提交
6811

C
cff-gite 已提交
6812
从API version 9 开始不再维护,建议使用[sensor.getOrientation](#sensorgetorientation9)代替。
Z
zengyawen 已提交
6813

C
cff-gite 已提交
6814
**系统能力**:SystemCapability.Sensors.Sensor
Z
zengyawen 已提交
6815

C
cff-gite 已提交
6816
**参数:** 
C
cff-gite 已提交
6817

C
cff-gite 已提交
6818 6819 6820 6821
| 参数名            | 类型                                       | 必填   | 说明                 |
| -------------- | ---------------------------------------- | ---- | ------------------ |
| rotationMatrix | Array&lt;number&gt;                      | 是    | 表示旋转矩阵。            |
| callback       | AsyncCallback&lt;Array&lt;number&gt;&gt; | 是    | 返回围绕z、x、y轴方向的旋转角度。 |
Z
zengyawen 已提交
6822

C
cff-gite 已提交
6823
**示例:** 
Z
zengyawen 已提交
6824

L
li-yaoyao777 已提交
6825
```ts
L
li-yaoyao777 已提交
6826 6827 6828 6829
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1], (err: BusinessError.BusinessError, data: Array<number>) => {
L
li-yaoyao777 已提交
6830 6831 6832 6833 6834
  if (err) {
    console.error(`Failed to register data. Code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info("Succeeded in getting getDirection interface get data: " + data);
L
li-yaoyao777 已提交
6835
  for (let i = 1; i < data.length; i++) {
L
li-yaoyao777 已提交
6836 6837 6838 6839
    console.info("Succeeded in getting sensor_getDirection_callback" + data[i]);
  }
})
```
Z
zengyawen 已提交
6840

C
cff-gite 已提交
6841
## sensor.getDirection<sup>(deprecated)</sup>
Z
zengyawen 已提交
6842

C
cff-gite 已提交
6843
getDirection(rotationMatrix: Array&lt;number&gt;): Promise&lt;Array&lt;number&gt;&gt;
C
cff-gite 已提交
6844

C
cff-gite 已提交
6845
根据旋转矩阵计算设备的方向。
Z
zengyawen 已提交
6846

C
cff-gite 已提交
6847
从API version 9 开始不再维护,建议使用[sensor.getOrientation](#sensorgetorientation9-1)代替。
Z
zengyawen 已提交
6848

C
cff-gite 已提交
6849
**系统能力**:SystemCapability.Sensors.Sensor
Z
zengyawen 已提交
6850

C
cff-gite 已提交
6851
**参数:** 
Z
zengyawen 已提交
6852

C
cff-gite 已提交
6853 6854 6855
| 参数名            | 类型                  | 必填   | 说明      |
| -------------- | ------------------- | ---- | ------- |
| rotationMatrix | Array&lt;number&gt; | 是    | 表示旋转矩阵。 |
Z
zengyawen 已提交
6856

C
cff-gite 已提交
6857
**返回值:** 
C
cff-gite 已提交
6858

C
cff-gite 已提交
6859 6860 6861
| 类型                                 | 说明                 |
| ---------------------------------- | ------------------ |
| Promise&lt;Array&lt;number&gt;&gt; | 返回围绕z、x、y轴方向的旋转角度。 |
Z
zengyawen 已提交
6862

C
cff-gite 已提交
6863
**示例:** 
Z
zengyawen 已提交
6864

L
li-yaoyao777 已提交
6865
```ts
L
li-yaoyao777 已提交
6866 6867 6868
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

L
li-yaoyao777 已提交
6869
const promise = sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1]);
L
li-yaoyao777 已提交
6870
promise.then((data: Array<number>) => {
L
li-yaoyao777 已提交
6871
  console.info('Succeeded in getting sensor_getAltitude_Promise', data);
L
li-yaoyao777 已提交
6872
  for (let i = 1; i < data.length; i++) {
L
li-yaoyao777 已提交
6873 6874
    console.info("Succeeded in getting sensor_getDirection_promise" + data[i]);
  }
L
li-yaoyao777 已提交
6875
}).catch((err: BusinessError.BusinessError) => {
L
li-yaoyao777 已提交
6876 6877 6878
  console.info(`Failed to get promise.`);
})
```
Z
zengyawen 已提交
6879

C
cff-gite 已提交
6880
## sensor.createRotationMatrix<sup>(deprecated)</sup>
Z
zengyawen 已提交
6881

C
cff-gite 已提交
6882
createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&gt;, callback: AsyncCallback&lt;RotationMatrixResponse&gt;): void
C
cff-gite 已提交
6883

C
cff-gite 已提交
6884
根据重力矢量和地磁矢量计算旋转矩阵。
Z
zengyawen 已提交
6885

C
cff-gite 已提交
6886
从API version 9 开始不再维护,建议使用[sensor.getRotationMatrix](#sensorgetrotationmatrix9-2)代替。
Z
zengyawen 已提交
6887

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

C
cff-gite 已提交
6890
**参数:** 
Z
zengyawen 已提交
6891

C
cff-gite 已提交
6892 6893 6894 6895 6896
| 参数名         | 类型                                       | 必填   | 说明      |
| ----------- | ---------------------------------------- | ---- | ------- |
| gravity     | Array&lt;number&gt;                      | 是    | 表示重力向量。 |
| geomagnetic | Array&lt;number&gt;                      | 是    | 表示地磁矢量。 |
| callback    | AsyncCallback&lt;[RotationMatrixResponse](#rotationmatrixresponse)&gt; | 是    | 返回旋转矩阵。 |
Z
zengyawen 已提交
6897

C
cff-gite 已提交
6898
**示例:** 
Z
zengyawen 已提交
6899

L
li-yaoyao777 已提交
6900
```ts
L
li-yaoyao777 已提交
6901 6902 6903 6904 6905
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444], 
                            (err: BusinessError.BusinessError, data: sensor.RotationMatrixResponse) => {
L
li-yaoyao777 已提交
6906 6907 6908 6909 6910 6911 6912
  if (err) {
    console.error(`Failed to get create rotationMatrix. Code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info(JSON.stringify(data));
})
```
C
cff-gite 已提交
6913

C
cff-gite 已提交
6914
## sensor.createRotationMatrix<sup>(deprecated)</sup>
Z
zengyawen 已提交
6915

C
cff-gite 已提交
6916
createRotationMatrix(gravity: Array&lt;number&gt;, geomagnetic: Array&lt;number&gt;,): Promise&lt;RotationMatrixResponse&gt;
Z
zengyawen 已提交
6917

C
cff-gite 已提交
6918
根据重力矢量和地磁矢量计算旋转矩阵。
Z
zengyawen 已提交
6919

C
cff-gite 已提交
6920
从API version 9 开始不再维护,建议使用[sensor.getRotationMatrix](#sensorgetrotationmatrix9-3)代替。
Z
zengyawen 已提交
6921

C
cff-gite 已提交
6922
**系统能力**:SystemCapability.Sensors.Sensor
Z
zengyawen 已提交
6923

C
cff-gite 已提交
6924
**参数:** 
C
cff-gite 已提交
6925

C
cff-gite 已提交
6926 6927 6928 6929
| 参数名         | 类型                  | 必填   | 说明      |
| ----------- | ------------------- | ---- | ------- |
| gravity     | Array&lt;number&gt; | 是    | 表示重力向量。 |
| geomagnetic | Array&lt;number&gt; | 是    | 表示地磁矢量。 |
Z
zengyawen 已提交
6930

C
cff-gite 已提交
6931
**返回值:** 
Z
zengyawen 已提交
6932

C
cff-gite 已提交
6933 6934 6935
| 类型                                       | 说明      |
| ---------------------------------------- | ------- |
| Promise&lt;[RotationMatrixResponse](#rotationmatrixresponse)&gt; | 返回旋转矩阵。 |
C
cff-gite 已提交
6936

C
cff-gite 已提交
6937
**示例:** 
C
cff-gite 已提交
6938

L
li-yaoyao777 已提交
6939
```ts
L
li-yaoyao777 已提交
6940 6941 6942
import sensor from '@ohos.sensor';
import BusinessError from '@ohos.base';

L
li-yaoyao777 已提交
6943
const promise = sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444]);
L
li-yaoyao777 已提交
6944
promise.then((data: sensor.RotationMatrixResponse) => {
L
li-yaoyao777 已提交
6945
  console.info(JSON.stringify(data));
L
li-yaoyao777 已提交
6946
}).catch((err: BusinessError.BusinessError) => {
L
li-yaoyao777 已提交
6947 6948
  console.info(`Failed to get promise.`);
})
L
li-yaoyao777 已提交
6949
```