• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @system.sensor (传感器)
2
3sensor模块提供订阅传感器数据基本能力,主要包含查询传感器的列表、订阅/取消传感器的数据、执行控制命令等。
4
5根据传感器的用途,可以将传感器分为六大类:运动类传感器、环境类传感器、方向类传感器、光线类传感器、健康类传感器、其他类传感器(如霍尔传感器),每一大类传感器包含不同类型的传感器,某种类型的传感器可能是单一的物理传感器,也可能是由多个物理传感器复合而成。
6
7
8> **说明:**
9>
10> - 从API Version 8开始,该接口不再维护,推荐使用新接口[`@ohos.sensor`](js-apis-sensor.md)。
11> - 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
12> - 该功能使用需要对应硬件支持,仅支持真机调试。
13
14
15## 导入模块
16
17
18```
19import sensor from '@system.sensor';
20```
21
22## sensor.subscribeAccelerometer
23
24 subscribeAccelerometer(options: subscribeAccelerometerOptions): void
25
26观察加速度数据变化。针对同一个应用,多次点击调用时,会覆盖前面的调用效果,即仅最后一次调用生效。
27
28**系统能力**:SystemCapability.Sensors.Sensor
29
30**需要权限**:ohos.permission.ACCELEROMETER,该权限为系统权限
31
32**参数:**
33
34| 参数名  | 类型                                                         | 必填 | 说明                                       |
35| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------ |
36| options | [subscribeAccelerometerOptions](#subscribeaccelerometeroptions) | 是   | 监听加速度传感器数据的回调函数的执行频率。 |
37
38**示例:**
39
40```js
41sensor.subscribeAccelerometer({
42  interval: 'normal',
43  success: function(ret) {
44    console.log('X-axis data: ' + ret.x);
45    console.log('Y-axis data: ' + ret.y);
46    console.log('Z-axis data: ' + ret.z);
47  },
48  fail: function(data, code) {
49    console.error('Subscription failed. Code: ' + code + '; Data: ' + data);
50  },
51});
52```
53
54> **说明:**
55> 建议在页面销毁时,即onDestory回调中,取消数据订阅,避免不必要的性能开销。
56
57## sensor.unsubscribeAccelerometer
58
59unsubscribeAccelerometer(): void
60
61取消订阅加速度数据。
62
63**系统能力**:SystemCapability.Sensors.Sensor
64
65**需要权限**:ohos.permission.ACCELEROMETER,该权限为系统权限
66
67**示例:**
68
69```js
70sensor.unsubscribeAccelerometer();
71```
72
73## sensor.subscribeCompass
74
75 subscribeCompass(options: SubscribeCompassOptions): void
76
77订阅罗盘数据变化。针对同一个应用,多次点击调用时,会覆盖前面的调用效果,即仅最后一次调用生效。
78
79**系统能力**:SystemCapability.Sensors.Sensor
80
81**参数:**
82
83| 参数名  | 类型                                                | 必填 | 说明                             |
84| ------- | --------------------------------------------------- | ---- | -------------------------------- |
85| options | [SubscribeCompassOptions](#subscribecompassoptions) | 是   | 当罗盘传感器数据发生变化时调用。 |
86
87**示例:**
88
89```js
90sensor.subscribeCompass({
91  success: function(ret) {
92    console.log('Get data direction:' + ret.direction);
93  },
94  fail: function(data, code) {
95    console.error('Subscription failed. Code: ' + code + '; Data: ' + data);
96  },
97});
98```
99
100> **说明:**
101> 建议在页面销毁时,即onDestory回调中,取消数据订阅,避免不必要的性能开销。
102
103## sensor.unsubscribeCompass
104
105unsubscribeCompass(): void
106
107取消订阅罗盘。
108
109**系统能力**:SystemCapability.Sensors.Sensor
110
111**示例:**
112
113```js
114sensor.unsubscribeCompass();
115```
116
117## sensor.subscribeProximity
118
119 subscribeProximity(options: SubscribeProximityOptions): void
120
121订阅距离感应数据变化。针对同一个应用,多次点击调用时,会覆盖前面的调用效果,即仅最后一次调用生效。
122
123**系统能力**:SystemCapability.Sensors.Sensor
124
125**参数:**
126
127| 参数名  | 类型                                                    | 必填 | 说明                             |
128| ------- | ------------------------------------------------------- | ---- | -------------------------------- |
129| options | [SubscribeProximityOptions](#subscribeproximityoptions) | 是   | 当距离传感器数据发生变化时调用。 |
130
131**示例:**
132
133```js
134sensor.subscribeProximity({
135  success: function(ret) {
136    console.log('Get data distance:' + ret.distance);
137  },
138  fail: function(data, code) {
139    console.error('Subscription failed. Code: ' + code + '; Data: ' + data);
140  },
141});
142```
143
144> **说明:**
145> 建议在页面销毁时,即onDestory回调中,取消数据订阅,避免不必要的性能开销。
146
147## sensor.unsubscribeProximity
148
149unsubscribeProximity(): void
150
151取消订阅距离感应。
152
153**系统能力**:SystemCapability.Sensors.Sensor
154
155**示例:**
156
157```js
158sensor.unsubscribeProximity();
159```
160
161## sensor.subscribeLight
162
163 subscribeLight(options: SubscribeLightOptions): void
164
165订阅环境光线感应数据变化。再次调用时,会覆盖前一次调用效果,即仅最后一次调用生效。
166
167**系统能力**:SystemCapability.Sensors.Sensor
168
169**参数:**
170
171| 参数名  | 类型                                            | 必填 | 说明                               |
172| ------- | ----------------------------------------------- | ---- | ---------------------------------- |
173| options | [SubscribeLightOptions](#subscribelightoptions) | 是   | 当环境光传感器数据发生变化时调用。 |
174
175**示例:**
176
177```js
178sensor.subscribeLight({
179  success: function(ret) {
180    console.log('Get data intensity:' + ret.intensity);
181  },
182  fail: function(data, code) {
183    console.error('Subscription failed. Code: ' + code + '; Data: ' + data);
184  },
185});
186```
187
188> **说明:**
189> 建议在页面销毁时,即onDestory回调中,取消数据订阅,避免不必要的性能开销。
190
191## sensor.unsubscribeLight
192
193unsubscribeLight(): void
194
195取消订阅环境光线感应。
196
197**系统能力**:SystemCapability.Sensors.Sensor
198
199**示例:**
200
201```js
202sensor.unsubscribeLight();
203```
204
205## sensor.subscribeStepCounter
206
207 subscribeStepCounter(options: SubscribeStepCounterOptions): void
208
209订阅计步传感器数据变化。针对同一个应用,多次点击调用时,会覆盖前面的调用效果,即仅最后一次调用生效。
210
211**系统能力**:SystemCapability.Sensors.Sensor
212
213**需要权限**:ohos.permission.ACTIVITY_MOTION
214
215**参数:**
216
217| 参数名  | 类型                                                        | 必填 | 说明                                   |
218| ------- | ----------------------------------------------------------- | ---- | -------------------------------------- |
219| options | [SubscribeStepCounterOptions](#subscribestepcounteroptions) | 是   | 当步进计数器传感器数据发生变化时调用。 |
220
221**示例:**
222
223```js
224sensor.subscribeStepCounter({
225  success: function(ret) {
226    console.log('Get step value:' + ret.steps);
227  },
228  fail: function(data, code) {
229    console.log('Subscription failed. Code: ' + code + '; Data: ' + data);
230  },
231});
232```
233
234> **说明:**
235> 建议在页面销毁时,即onDestory回调中,取消数据订阅,避免不必要的性能开销。
236
237## sensor.unsubscribeStepCounter
238
239unsubscribeStepCounter(): void
240
241取消订阅计步传感器。
242
243**系统能力**:SystemCapability.Sensors.Sensor
244
245**需要权限**:ohos.permission.ACTIVITY_MOTION
246
247**示例:**
248
249```js
250sensor.unsubscribeStepCounter();
251```
252
253
254## sensor.subscribeBarometer
255
256subscribeBarometer(options: SubscribeBarometerOptions): void
257
258订阅气压计传感器数据变化。针对同一个应用,多次点击调用时,会覆盖前面的调用效果,即仅最后一次调用生效。
259
260**系统能力**:SystemCapability.Sensors.Sensor
261
262**参数:**
263
264| 参数名  | 类型                                                    | 必填 | 说明                               |
265| ------- | ------------------------------------------------------- | ---- | ---------------------------------- |
266| options | [SubscribeBarometerOptions](#subscribebarometeroptions) | 是   | 当气压计传感器数据发生变化时调用。 |
267
268**示例:**
269
270```js
271sensor.subscribeBarometer({
272  success: function(ret) {
273    console.log('Get data value:' + ret.pressure);
274  },
275  fail: function(data, code) {
276    console.log('Subscription failed. Code: ' + code + '; Data: ' + data);
277  },
278});
279```
280
281> **说明:**
282> 建议在页面销毁时,即onDestory回调中,取消数据订阅,避免不必要的性能开销。
283
284
285## sensor.unsubscribeBarometer
286
287unsubscribeBarometer(): void
288
289取消订阅气压计传感器。
290
291**系统能力**:SystemCapability.Sensors.Sensor
292
293**示例:**
294
295```js
296sensor.unsubscribeBarometer();
297```
298
299
300## sensor.subscribeHeartRate
301
302 subscribeHeartRate(options: SubscribeHeartRateOptions): void
303
304订阅心率传感器数据变化。针对同一个应用,多次点击调用时,会覆盖前面的调用效果,即仅最后一次调用生效。
305
306**系统能力**:SystemCapability.Sensors.Sensor
307
308**需要权限**:ohos.permission.READ_HEALTH_DATA
309
310**参数:**
311
312| 参数名  | 类型                                                    | 必填 | 说明                             |
313| ------- | ------------------------------------------------------- | ---- | -------------------------------- |
314| options | [SubscribeHeartRateOptions](#subscribeheartrateoptions) | 是   | 当心率传感器数据发生变化时调用。 |
315
316**示例:**
317
318```js
319sensor.subscribeHeartRate({
320  success: function(ret) {
321    console.log('Get heartrate value:' + ret.heartRate);
322  },
323  fail: function(data, code) {
324    console.log('Subscription failed. Code: ' + code + '; Data: ' + data);
325  },
326});
327```
328
329> **说明:**
330> 建议在页面销毁时,即onDestory回调中,取消数据订阅,避免不必要的性能开销。
331
332
333## sensor.unsubscribeHeartRate
334
335unsubscribeHeartRate(): void
336
337取消订阅心率传感器。
338
339**系统能力**:SystemCapability.Sensors.Sensor
340
341**需要权限**:ohos.permission.READ_HEALTH_DATA
342
343**示例:**
344
345```js
346sensor.unsubscribeHeartRate();
347```
348
349## sensor.subscribeOnBodyState
350
351 subscribeOnBodyState(options: SubscribeOnBodyStateOptions): void
352
353订阅设备佩戴状态。针对同一个应用,多次点击调用时,会覆盖前面的调用效果,即仅最后一次调用生效。
354
355**系统能力**:SystemCapability.Sensors.Sensor
356
357**参数:**
358
359| 参数名  | 类型                                                        | 必填 | 说明                   |
360| ------- | ----------------------------------------------------------- | ---- | ---------------------- |
361| options | [SubscribeOnBodyStateOptions](#subscribeonbodystateoptions) | 是   | 当穿着状态改变时调用。 |
362
363**示例:**
364
365```js
366sensor.subscribeOnBodyState({
367  success: function(ret) {
368    console.log('Get on-body state value:' + ret.value);
369  },
370  fail: function(data, code) {
371    console.log('Subscription failed. Code: ' + code + '; Data: ' + data);
372  },
373});
374```
375
376> **说明:**
377> 建议在页面销毁时,即onDestory回调中,取消数据订阅,避免不必要的性能开销。
378
379## sensor.unsubscribeOnBodyState
380
381unsubscribeOnBodyState(): void
382
383取消订阅设备佩戴状态。
384
385**系统能力**:SystemCapability.Sensors.Sensor
386
387**示例:**
388
389```js
390sensor.unsubscribeOnBodyState();
391```
392
393## sensor.getOnBodyState
394
395 getOnBodyState(options: GetOnBodyStateOptions): void
396
397获取设备佩戴状态。
398
399**系统能力**:SystemCapability.Sensors.Sensor
400
401**参数:**
402
403| 参数名  | 类型                                            | 必填 | 说明                       |
404| ------- | ----------------------------------------------- | ---- | -------------------------- |
405| options | [GetOnBodyStateOptions](#getonbodystateoptions) | 是   | 获取传感器磨损状态时调用。 |
406
407**示例:**
408
409```js
410sensor.getOnBodyState({
411  success: function(ret) {
412    console.log('On body state: ' + ret.value);
413  },
414  fail: function(data, code) {
415    console.log('Subscription failed. Code: ' + code + '; Data: ' + data);
416  },
417});
418```
419
420## sensor.subscribeDeviceOrientation<sup>6+</sup>
421
422 subscribeDeviceOrientation(options: SubscribeDeviceOrientationOptions): void
423
424观察设备方向传感器数据变化。
425
426针对同一个应用,多次点击调用时,会覆盖前面的调用效果,即仅最后一次调用生效;针对同一个方法内,不支持多次调用。
427
428**系统能力**:SystemCapability.Sensors.Sensor
429
430**参数:**
431
432| 参数名  | 类型                                                         | 必填 | 说明                                             |
433| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------ |
434| options | [SubscribeDeviceOrientationOptions](#subscribedeviceorientationoptions) | 是   | 用于监听设备方向传感器数据的回调函数的执行频率。 |
435
436**示例:**
437
438```js
439sensor.subscribeDeviceOrientation({
440  interval: 'normal',
441  success: function(ret) {
442    console.log('Alpha data: ' + ret.alpha);
443    console.log('Beta data: ' + ret.beta);
444    console.log('Gamma data: ' + ret.gamma);
445  },
446  fail: function(data, code) {
447    console.error('Subscription failed. Code: ' + code + '; Data: ' + data);
448  }
449});
450```
451
452> **说明:**
453> 建议在页面销毁时,即onDestory回调中,取消数据订阅,避免不必要的性能开销。
454
455## sensor.unsubscribeDeviceOrientation<sup>6+</sup>
456
457unsubscribeDeviceOrientation(): void
458
459取消订阅设备方向传感器数据。
460
461**系统能力**:SystemCapability.Sensors.Sensor
462
463**示例:**
464
465```js
466sensor.unsubscribeDeviceOrientation();
467```
468
469## sensor.subscribeGyroscope<sup>6+</sup>
470
471 subscribeGyroscope(options: SubscribeGyroscopeOptions): void
472
473观察陀螺仪传感器数据变化。
474
475针对同一个应用,多次点击调用时,会覆盖前面的调用效果,即仅最后一次调用生效;针对同一个方法内,不支持多次调用。
476
477**系统能力**:SystemCapability.Sensors.Sensor
478
479**需要权限**:ohos.permission.GYROSCOPE,该权限为系统权限
480
481**参数:**
482
483| 参数名  | 类型                                                    | 必填 | 说明                                           |
484| ------- | ------------------------------------------------------- | ---- | ---------------------------------------------- |
485| options | [SubscribeGyroscopeOptions](#subscribegyroscopeoptions) | 是   | 用于侦听陀螺仪传感器数据的回调函数的执行频率。 |
486
487**示例:**
488
489```js
490sensor.subscribeGyroscope({
491  interval: 'normal',
492  success: function(ret) {
493    console.log('X-axis data: ' + ret.x);
494    console.log('Y-axis data: ' + ret.y);
495    console.log('Z-axis data: ' + ret.z);
496  },
497  fail: function(data, code) {
498    console.error('Subscription failed. Code: ' + code + '; data: ' + data);
499  }
500});
501```
502
503> **说明:**
504> 建议在页面销毁时,即onDestory回调中,取消数据订阅,避免不必要的性能开销。
505
506## sensor.unsubscribeGyroscope<sup>6+</sup>
507
508unsubscribeGyroscope(): void
509
510取消订阅陀螺仪传感器数据。
511
512**系统能力**:SystemCapability.Sensors.Sensor
513
514**需要权限**:ohos.permission.GYROSCOPE,该权限为系统权限
515
516**示例:**
517
518```js
519sensor.unsubscribeGyroscope();
520```
521
522## subscribeAccelerometerOptions
523
524用于监听加速度传感器数据的回调函数的执行频率。
525
526**需要权限**:ohos.permission.ACCELEROMETER
527
528**系统能力**:SystemCapability.Sensors.Sensor
529
530| 名称     | 类型                                            | 必填 | 说明                                                         |
531| -------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ |
532| interval | string                                          | 是   | 频率参数,加速度的回调函数执行频率。 默认为normal,可选值有: - game:极高的回调频率,20ms/次,适用于游戏。 - ui:较高的回调频率,60ms/次,适用于UI更新。 - normal:普通的回调频率,200ms/次,低功耗。 |
533| success  | [AccelerometerResponse](#accelerometerresponse) | 是   | 感应到加速度数据变化后的回调函数。                           |
534| fail     | Function                                        | 否   | 接口调用失败的回调函数。                                     |
535
536## AccelerometerResponse
537
538感应到加速度数据变化后的回调函数。
539
540**需要权限**:ohos.permission.ACCELEROMETER
541
542**系统能力**:SystemCapability.Sensors.Sensor
543
544| 名称 | 类型   | 必填 | 说明          |
545| ---- | ------ | ---- | ------------- |
546| x    | number | 是   | x轴的加速度。 |
547| y    | number | 是   | y轴的加速度。 |
548| z    | number | 是   | z轴的加速度。 |
549
550## SubscribeCompassOptions
551
552当罗盘传感器数据发生变化时调用。
553
554**系统能力**:SystemCapability.Sensors.Sensor
555
556| 名称    | 类型                                | 必填 | 说明                           |
557| ------- | ----------------------------------- | ---- | ------------------------------ |
558| success | [CompassResponse](#compassresponse) | 是   | 罗盘数据改变后触发的回调函数。 |
559| fail    | Function                            | 否   | 接口调用失败的回调函数。       |
560
561## CompassResponse
562
563罗盘数据改变后触发的回调函数。
564
565**系统能力**:SystemCapability.Sensors.Sensor
566
567| 名称      | 类型   | 必填 | 说明                 |
568| --------- | ------ | ---- | -------------------- |
569| direction | number | 是   | 设备面对的方向度数。 |
570
571## SubscribeProximityOptions
572
573当距离传感器数据发生变化时调用。
574
575**系统能力**:SystemCapability.Sensors.Sensor
576
577| 名称    | 类型                                    | 必填 | 说明                               |
578| ------- | --------------------------------------- | ---- | ---------------------------------- |
579| success | [ProximityResponse](#proximityresponse) | 是   | 距离感应数据改变后调用的回调函数。 |
580| fail    | Function                                | 否   | 接口调用失败的回调函数。           |
581
582## ProximityResponse
583
584距离感应数据改变后调用的回调函数。
585
586**系统能力**:SystemCapability.Sensors.Sensor
587
588| 名称     | 类型   | 必填 | 说明                                       |
589| -------- | ------ | ---- | ------------------------------------------ |
590| distance | number | 是   | 可见物体相对于设备显示屏的接近或远离状态。 |
591
592## SubscribeLightOptions
593
594当环境光传感器数据发生变化时调用。
595
596**系统能力**:SystemCapability.Sensors.Sensor
597
598| 名称    | 类型                            | 必填 | 说明                           |
599| ------- | ------------------------------- | ---- | ------------------------------ |
600| success | [LightResponse](#lightresponse) | 是   | 光线感应数据改变后的回调函数。 |
601| fail    | Function                        | 否   | 接口调用失败的回调函数。       |
602
603## LightResponse
604
605光线感应数据改变后的回调函数。
606
607**系统能力**:SystemCapability.Sensors.Sensor
608
609| 名称      | 类型   | 必填 | 说明                  |
610| --------- | ------ | ---- | --------------------- |
611| intensity | number | 是   | 光线强度,单位为lux。 |
612
613## SubscribeStepCounterOptions
614
615当步进计数器传感器数据发生变化时调用。
616
617**需要权限**:ohos.permission.ACTIVITY_MOTION
618
619**系统能力**:SystemCapability.Sensors.Sensor
620
621| 名称    | 类型                                        | 必填 | 说明                             |
622| ------- | ------------------------------------------- | ---- | -------------------------------- |
623| success | [StepCounterResponse](#stepcounterresponse) | 是   | 计步传感器数据改变后的回调函数。 |
624| fail    | Function                                    | 否   | 接口调用失败的回调函数。         |
625
626## StepCounterResponse
627
628计步传感器数据改变后的回调函数。
629
630**需要权限**:ohos.permission.ACTIVITY_MOTION
631
632**系统能力**:SystemCapability.Sensors.Sensor
633
634| 名称  | 类型   | 必填 | 说明                             |
635| ----- | ------ | ---- | -------------------------------- |
636| steps | number | 是   | 计步传感器重启后累计记录的步数。 |
637
638## SubscribeBarometerOptions
639
640当气压计传感器数据发生变化时调用。
641
642**系统能力**:SystemCapability.Sensors.Sensor
643
644| 名称    | 类型                                    | 必填 | 说明                             |
645| ------- | --------------------------------------- | ---- | -------------------------------- |
646| success | [BarometerResponse](#barometerresponse) | 是   | 气压计传感器数据改变后的回调函数。 |
647| fail    | Function                                | 否   | 接口调用失败的回调函数。         |
648
649## BarometerResponse
650
651气压计传感器数据改变后的回调函数。
652
653**系统能力**:SystemCapability.Sensors.Sensor
654
655| 名称     | 类型   | 必填 | 说明                   |
656| -------- | ------ | ---- | ---------------------- |
657| pressure | number | 是   | 气压值,单位:帕斯卡。 |
658
659## SubscribeHeartRateOptions
660
661当心率传感器数据发生变化时调用。
662
663**需要权限**:ohos.permission.READ_HEALTH_DATA
664
665**系统能力**:SystemCapability.Sensors.Sensor
666
667| 名称    | 类型                                    | 必填 | 说明                                            |
668| ------- | --------------------------------------- | ---- | ----------------------------------------------- |
669| success | [HeartRateResponse](#heartrateresponse) | 是   | 心率传感器数据改变后的回调函数,默认频率5s/次。 |
670| fail    | Function                                | 否   | 接口调用失败的回调函数。                        |
671
672## HeartRateResponse
673
674心率传感器数据改变后的回调函数,默认频率5s/次。
675
676**需要权限**:ohos.permission.READ_HEALTH_DATA
677
678**系统能力**:SystemCapability.Sensors.Sensor
679
680| 名称      | 类型   | 必填 | 说明     |
681| --------- | ------ | ---- | -------- |
682| heartRate | number | 是   | 心率值。 |
683
684## SubscribeOnBodyStateOptions
685
686当穿着状态改变时调用。
687
688**系统能力**:SystemCapability.Sensors.Sensor
689
690| 名称    | 类型                                        | 必填 | 说明                       |
691| ------- | ------------------------------------------- | ---- | -------------------------- |
692| success | [OnBodyStateResponse](#onbodystateresponse) | 是   | 穿戴状态改变后的回调函数。 |
693| fail    | Function                                    | 否   | 接口调用失败的回调函数。   |
694
695## OnBodyStateResponse
696
697传感器是否磨损。
698
699**系统能力**:SystemCapability.Sensors.Sensor
700
701| 名称  | 类型    | 必填 | 说明         |
702| ----- | ------- | ---- | ------------ |
703| value | boolean | 是   | 是否已佩戴。 |
704
705## GetOnBodyStateOptions
706
707 获取传感器磨损状态时调用。
708
709**系统能力**:SystemCapability.Sensors.Sensor
710
711| 名称     | 类型                                        | 必填 | 说明                     |
712| -------- | ------------------------------------------- | ---- | ------------------------ |
713| success  | [OnBodyStateResponse](#onbodystateresponse) | 是   | 接口调用成功的回调函数。 |
714| fail     | Function                                    | 否   | 接口调用失败的回调函数。 |
715| complete | Function                                    | 否   | 接口调用结束的回调函数。 |
716
717## SubscribeDeviceOrientationOptions<sup>6+</sup>
718
719用于监听设备方向传感器数据的回调函数的执行频率。
720
721**系统能力**:SystemCapability.Sensors.Sensor
722
723| 名称     | 类型                                                    | 必填 | 说明                                                         |
724| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
725| interval | string                                                  | 是   | 频率参数,设备方向传感器的回调函数执行频率。<br/>默认为normal,可选值有:<br/>-&nbsp;game:极高的回调频率,20ms/次,适用于游戏。<br/>-&nbsp;ui:较高的回调频率,60ms/次,适用于UI更新。<br/>-&nbsp;normal:普通的回调频率,200ms/次,低功耗。 |
726| success  | [DeviceOrientationResponse](#deviceorientationresponse) | 是   | 感应到设备方向传感器数据变化后的回调函数。                   |
727| fail     | Function                                                | 否   | 接口调用失败的回调函数。                                     |
728
729## DeviceOrientationResponse<sup>6+</sup>
730
731感应到设备方向传感器数据变化后的回调函数。
732
733**系统能力**:SystemCapability.Sensors.Sensor
734
735| 名称  | 类型   | 必填 | 说明                                                         |
736| ----- | ------ | ---- | ------------------------------------------------------------ |
737| alpha | number | 是   | 当设备坐标&nbsp;X/Y&nbsp;和地球&nbsp;X/Y&nbsp;重合时,绕着&nbsp;Z&nbsp;轴转动的夹角为&nbsp;alpha。 |
738| beta  | number | 是   | 当设备坐标&nbsp;Y/Z&nbsp;和地球&nbsp;Y/Z&nbsp;重合时,绕着&nbsp;X&nbsp;轴转动的夹角为&nbsp;beta。 |
739| gamma | number | 是   | 当设备&nbsp;X/Z&nbsp;和地球&nbsp;X/Z&nbsp;重合时,绕着&nbsp;Y&nbsp;轴转动的夹角为&nbsp;gamma。 |
740
741## SubscribeGyroscopeOptions<sup>6+</sup>
742
743用于侦听陀螺仪传感器数据的回调函数的执行频率。
744
745**需要权限**:ohos.permission.GYROSCOPE
746
747**系统能力**:SystemCapability.Sensors.Sensor
748
749| 名称     | 类型                                    | 必填 | 说明                                                         |
750| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
751| interval | string                                  | 是   | 频率参数,陀螺仪的回调函数执行频率。<br/>默认为normal,可选值有:<br/>-&nbsp;game:极高的回调频率,20ms/次,适用于游戏。<br/>-&nbsp;ui:较高的回调频率,60ms/次,适用于UI更新。<br/>-&nbsp;normal:普通的回调频率,200ms/次,低功耗。 |
752| success  | [GyroscopeResponse](#gyroscoperesponse) | 是   | 感应到陀螺仪数据变化后的回调函数。                           |
753| fail     | Function                                | 否   | 接口调用失败的回调函数。                                     |
754
755## GyroscopeResponse<sup>6+</sup>
756
757感应到陀螺仪传感器数据变化后的回调函数。
758
759**需要权限**:ohos.permission.GYROSCOPE
760
761**系统能力**:SystemCapability.Sensors.Sensor
762
763| 名称 | 类型   | 必填 | 说明              |
764| ---- | ------ | ---- | ----------------- |
765| x    | number | 是   | x轴的旋转角速度。 |
766| y    | number | 是   | y轴的旋转角速度。 |
767| z    | number | 是   | z轴的旋转角速度。 |