Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 f453a735 编写于 作者: C cff-gite
浏览文件
操作

修改废弃接口 

Signed-off-by: Ncff-gite <chenfeifei8@huawei.com>
上级 5eb5458c
显示空白变更内容
内联 并排
Showing with 347 addition and 185 deletion
zh-cn/application-dev/reference/apis/js-apis-system-sensor.md
浏览文件 @ f453a735
# @system.sensor (传感器) # @system.sensor (传感器)
## 模块说明
sensor模块提供订阅传感器数据基本能力，主要包含查询传感器的列表、订阅/取消传感器的数据、执行控制命令等。 sensor模块提供订阅传感器数据基本能力，主要包含查询传感器的列表、订阅/取消传感器的数据、执行控制命令等。
根据传感器的用途，可以将传感器分为六大类：运动类传感器、环境类传感器、方向类传感器、光线类传感器、健康类传感器、其他类传感器（如霍尔传感器），每一大类传感器包含不同类型的传感器，某种类型的传感器可能是单一的物理传感器，也可能是由多个物理传感器复合而成。 根据传感器的用途，可以将传感器分为六大类：运动类传感器、环境类传感器、方向类传感器、光线类传感器、健康类传感器、其他类传感器（如霍尔传感器），每一大类传感器包含不同类型的传感器，某种类型的传感器可能是单一的物理传感器，也可能是由多个物理传感器复合而成。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > **说明：**
> >
> - 从API Version 8开始，该接口不再维护，推荐使用新接口[`@ohos.sensor`](js-apis-sensor.md)。 > - 从API Version 8开始，该接口不再维护，推荐使用新接口[`@ohos.sensor`](js-apis-sensor.md)。
> - 本模块首批接口从API version 4开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - 该功能使用需要对应硬件支持，仅支持真机调试。 > - 该功能使用需要对应硬件支持，仅支持真机调试。
...@@ -21,15 +19,9 @@ sensor模块提供订阅传感器数据基本能力，主要包含查询传感 ...@@ -21,15 +19,9 @@ sensor模块提供订阅传感器数据基本能力，主要包含查询传感
import sensor from '@system.sensor'; import sensor from '@system.sensor';
``` ```
## 传感器错误码列表
| 错误码 | 说明 |
| ---- | -------------- |
| 900 | 当前设备不支持相应的传感器。 |
## sensor.subscribeAccelerometer ## sensor.subscribeAccelerometer
subscribeAccelerometer(Object): void subscribeAccelerometer(options: subscribeAccelerometerOptions): void
观察加速度数据变化。针对同一个应用，多次点击调用时，会覆盖前面的调用效果，即仅最后一次调用生效。 观察加速度数据变化。针对同一个应用，多次点击调用时，会覆盖前面的调用效果，即仅最后一次调用生效。
...@@ -40,22 +32,12 @@ subscribeAccelerometer(Object): void ...@@ -40,22 +32,12 @@ subscribeAccelerometer(Object): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ---------------------------------------- | | ------- | ------------------------------------------------------------ | ---- | ------------------------------------------ |
| interval | string | 是 | 频率参数，加速度的回调函数执行频率。<br/>默认为normal，可选值有：<br/>-&nbsp;game：极高的回调频率，20ms/次，适用于游戏。<br/>-&nbsp;ui：较高的回调频率，60ms/次，适用于UI更新。<br/>-&nbsp;normal：普通的回调频率，200ms/次，低功耗。 | | options | [subscribeAccelerometerOptions](#subscribeaccelerometeroptions) | 是 | 监听加速度传感器数据的回调函数的执行频率。 |
| success | Function | 是 | 感应到加速度数据变化后的回调函数。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
success返回值：
| 参数名 | 类型 | 说明 |
| ---- | ------ | ------- |
| x | number | x轴的加速度。 |
| y | number | y轴的加速度。 |
| z | number | z轴的加速度。 |
**示例：** **示例：**
``` ```js
sensor.subscribeAccelerometer({ sensor.subscribeAccelerometer({
interval: 'normal', interval: 'normal',
success: function(ret) { success: function(ret) {
...@@ -69,7 +51,7 @@ sensor.subscribeAccelerometer({ ...@@ -69,7 +51,7 @@ sensor.subscribeAccelerometer({
}); });
``` ```
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > **说明：**
> 建议在页面销毁时，即onDestory回调中，取消数据订阅，避免不必要的性能开销。 > 建议在页面销毁时，即onDestory回调中，取消数据订阅，避免不必要的性能开销。
## sensor.unsubscribeAccelerometer ## sensor.unsubscribeAccelerometer
...@@ -84,13 +66,13 @@ unsubscribeAccelerometer(): void ...@@ -84,13 +66,13 @@ unsubscribeAccelerometer(): void
**示例：** **示例：**
``` ```js
sensor.unsubscribeAccelerometer(); sensor.unsubscribeAccelerometer();
``` ```
## sensor.subscribeCompass ## sensor.subscribeCompass
subscribeCompass(Object): void subscribeCompass(options: SubscribeCompassOptions): void
订阅罗盘数据变化。针对同一个应用，多次点击调用时，会覆盖前面的调用效果，即仅最后一次调用生效。 订阅罗盘数据变化。针对同一个应用，多次点击调用时，会覆盖前面的调用效果，即仅最后一次调用生效。
...@@ -99,19 +81,12 @@ subscribeCompass(Object): void ...@@ -99,19 +81,12 @@ subscribeCompass(Object): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | -------- | ---- | --------------- | | ------- | --------------------------------------------------- | ---- | -------------------------------- |
| success | Function | 是 | 罗盘数据改变后触发的回调函数。 | | options | [SubscribeCompassOptions](#subscribecompassoptions) | 是 | 当罗盘传感器数据发生变化时调用。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
success返回值：
| 参数名 | 类型 | 说明 |
| --------- | ------ | ---------- |
| direction | number | 设备面对的方向度数。 |
**示例：** **示例：**
``` ```js
sensor.subscribeCompass({ sensor.subscribeCompass({
success: function(ret) { success: function(ret) {
console.log('get data direction:' + ret.direction); console.log('get data direction:' + ret.direction);
...@@ -122,7 +97,7 @@ sensor.subscribeCompass({ ...@@ -122,7 +97,7 @@ sensor.subscribeCompass({
}); });
``` ```
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > **说明：**
> 建议在页面销毁时，即onDestory回调中，取消数据订阅，避免不必要的性能开销。 > 建议在页面销毁时，即onDestory回调中，取消数据订阅，避免不必要的性能开销。
## sensor.unsubscribeCompass ## sensor.unsubscribeCompass
...@@ -135,13 +110,13 @@ unsubscribeCompass(): void ...@@ -135,13 +110,13 @@ unsubscribeCompass(): void
**示例：** **示例：**
``` ```js
sensor.unsubscribeCompass(); sensor.unsubscribeCompass();
``` ```
## sensor.subscribeProximity ## sensor.subscribeProximity
subscribeProximity(Object): void subscribeProximity(options: SubscribeProximityOptions): void
订阅距离感应数据变化。针对同一个应用，多次点击调用时，会覆盖前面的调用效果，即仅最后一次调用生效。 订阅距离感应数据变化。针对同一个应用，多次点击调用时，会覆盖前面的调用效果，即仅最后一次调用生效。
...@@ -150,19 +125,12 @@ subscribeProximity(Object): void ...@@ -150,19 +125,12 @@ subscribeProximity(Object): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | -------- | ---- | ----------------- | | ------- | ------------------------------------------------------- | ---- | -------------------------------- |
| success | Function | 是 | 距离感应数据改变后调用的回调函数。 | | options | [SubscribeProximityOptions](#subscribeproximityoptions) | 是 | 当距离传感器数据发生变化时调用。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
success返回值：
| 参数名 | 类型 | 说明 |
| -------- | ------ | --------------------- |
| distance | number | 可见物体相对于设备显示屏的接近或远离状态。 |
**示例：** **示例：**
``` ```js
sensor.subscribeProximity({ sensor.subscribeProximity({
success: function(ret) { success: function(ret) {
console.log('get data distance:' + ret.distance); console.log('get data distance:' + ret.distance);
...@@ -173,7 +141,7 @@ sensor.subscribeProximity({ ...@@ -173,7 +141,7 @@ sensor.subscribeProximity({
}); });
``` ```
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > **说明：**
> 建议在页面销毁时，即onDestory回调中，取消数据订阅，避免不必要的性能开销。 > 建议在页面销毁时，即onDestory回调中，取消数据订阅，避免不必要的性能开销。
## sensor.unsubscribeProximity ## sensor.unsubscribeProximity
...@@ -186,13 +154,13 @@ unsubscribeProximity(): void ...@@ -186,13 +154,13 @@ unsubscribeProximity(): void
**示例：** **示例：**
``` ```js
sensor.unsubscribeProximity(); sensor.unsubscribeProximity();
``` ```
## sensor.subscribeLight ## sensor.subscribeLight
sensor.subscribeLight(Object): void subscribeLight(options: SubscribeLightOptions): void
订阅环境光线感应数据变化。再次调用时，会覆盖前一次调用效果，即仅最后一次调用生效。 订阅环境光线感应数据变化。再次调用时，会覆盖前一次调用效果，即仅最后一次调用生效。
...@@ -201,19 +169,12 @@ sensor.subscribeLight(Object): void ...@@ -201,19 +169,12 @@ sensor.subscribeLight(Object): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | -------- | ---- | --------------- | | ------- | ----------------------------------------------- | ---- | ---------------------------------- |
| success | Function | 是 | 光线感应数据改变后的回调函数。 | | options | [SubscribeLightOptions](#subscribelightoptions) | 是 | 当环境光传感器数据发生变化时调用。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
success返回值：
| 参数名 | 类型 | 说明 |
| --------- | ------ | ------------ |
| intensity | number | 光线强度，单位为lux。 |
**示例：** **示例：**
``` ```js
sensor.subscribeLight({ sensor.subscribeLight({
success: function(ret) { success: function(ret) {
console.log('get data intensity:' + ret.intensity); console.log('get data intensity:' + ret.intensity);
...@@ -224,7 +185,7 @@ sensor.subscribeLight({ ...@@ -224,7 +185,7 @@ sensor.subscribeLight({
}); });
``` ```
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > **说明：**
> 建议在页面销毁时，即onDestory回调中，取消数据订阅，避免不必要的性能开销。 > 建议在页面销毁时，即onDestory回调中，取消数据订阅，避免不必要的性能开销。
## sensor.unsubscribeLight ## sensor.unsubscribeLight
...@@ -237,13 +198,13 @@ unsubscribeLight(): void ...@@ -237,13 +198,13 @@ unsubscribeLight(): void
**示例：** **示例：**
``` ```js
sensor.unsubscribeLight(); sensor.unsubscribeLight();
``` ```
## sensor.subscribeStepCounter ## sensor.subscribeStepCounter
subscribeStepCounter(Object): void subscribeStepCounter(options: SubscribeStepCounterOptions): void
订阅计步传感器数据变化。针对同一个应用，多次点击调用时，会覆盖前面的调用效果，即仅最后一次调用生效。 订阅计步传感器数据变化。针对同一个应用，多次点击调用时，会覆盖前面的调用效果，即仅最后一次调用生效。
...@@ -254,19 +215,12 @@ subscribeStepCounter(Object): void ...@@ -254,19 +215,12 @@ subscribeStepCounter(Object): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | -------- | ---- | ---------------- | | ------- | ----------------------------------------------------------- | ---- | -------------------------------------- |
| success | Function | 是 | 计步传感器数据改变后的回调函数。 | | options | [SubscribeStepCounterOptions](#subscribestepcounteroptions) | 是 | 当步进计数器传感器数据发生变化时调用。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
success返回值：
| 参数名 | 类型 | 说明 |
| ----- | ------ | --------------------- |
| steps | number | 计步传感器重启后累计记录的步数。<br/> |
**示例：** **示例：**
``` ```js
sensor.subscribeStepCounter({ sensor.subscribeStepCounter({
success: function(ret) { success: function(ret) {
console.log('get step value:' + ret.steps); console.log('get step value:' + ret.steps);
...@@ -277,7 +231,7 @@ sensor.subscribeStepCounter({ ...@@ -277,7 +231,7 @@ sensor.subscribeStepCounter({
}); });
``` ```
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > **说明：**
> 建议在页面销毁时，即onDestory回调中，取消数据订阅，避免不必要的性能开销。 > 建议在页面销毁时，即onDestory回调中，取消数据订阅，避免不必要的性能开销。
## sensor.unsubscribeStepCounter ## sensor.unsubscribeStepCounter
...@@ -292,14 +246,14 @@ unsubscribeStepCounter(): void ...@@ -292,14 +246,14 @@ unsubscribeStepCounter(): void
**示例：** **示例：**
``` ```js
sensor.unsubscribeStepCounter(); sensor.unsubscribeStepCounter();
``` ```
## sensor.subscribeBarometer ## sensor.subscribeBarometer
subscribeBarometer(Object): void subscribeBarometer(options: SubscribeBarometerOptions): void
订阅气压传感器数据变化。针对同一个应用，多次点击调用时，会覆盖前面的调用效果，即仅最后一次调用生效。 订阅气压传感器数据变化。针对同一个应用，多次点击调用时，会覆盖前面的调用效果，即仅最后一次调用生效。
...@@ -308,19 +262,12 @@ subscribeBarometer(Object): void ...@@ -308,19 +262,12 @@ subscribeBarometer(Object): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | -------- | ---- | ---------------- | | ------- | ------------------------------------------------------- | ---- | ---------------------------------- |
| success | Function | 是 | 气压传感器数据改变后的回调函数。 | | options | [SubscribeBarometerOptions](#subscribebarometeroptions) | 是 | 当气压计传感器数据发生变化时调用。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
success返回值：
| 参数名 | 类型 | 说明 |
| -------- | ------ | ----------- |
| pressure | number | 气压值，单位：帕斯卡。 |
**示例：** **示例：**
``` ```js
sensor.subscribeBarometer({ sensor.subscribeBarometer({
success: function(ret) { success: function(ret) {
console.log('get data value:' + ret.pressure); console.log('get data value:' + ret.pressure);
...@@ -331,7 +278,7 @@ sensor.subscribeBarometer({ ...@@ -331,7 +278,7 @@ sensor.subscribeBarometer({
}); });
``` ```
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > **说明：**
> 建议在页面销毁时，即onDestory回调中，取消数据订阅，避免不必要的性能开销。 > 建议在页面销毁时，即onDestory回调中，取消数据订阅，避免不必要的性能开销。
...@@ -345,14 +292,14 @@ unsubscribeBarometer(): void ...@@ -345,14 +292,14 @@ unsubscribeBarometer(): void
**示例：** **示例：**
``` ```js
sensor.unsubscribeBarometer(); sensor.unsubscribeBarometer();
``` ```
## sensor.subscribeHeartRate ## sensor.subscribeHeartRate
subscribeHeartRate(Object): void subscribeHeartRate(options: SubscribeHeartRateOptions): void
订阅心率传感器数据变化。针对同一个应用，多次点击调用时，会覆盖前面的调用效果，即仅最后一次调用生效。 订阅心率传感器数据变化。针对同一个应用，多次点击调用时，会覆盖前面的调用效果，即仅最后一次调用生效。
...@@ -363,19 +310,12 @@ subscribeHeartRate(Object): void ...@@ -363,19 +310,12 @@ subscribeHeartRate(Object): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | -------- | ---- | ------------------------- | | ------- | ------------------------------------------------------- | ---- | -------------------------------- |
| success | Function | 是 | 心率传感器数据改变后的回调函数，默认频率5s/次。 | | options | [SubscribeHeartRateOptions](#subscribeheartrateoptions) | 是 | 当心率传感器数据发生变化时调用。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
success返回值：
| 参数名 | 类型 | 说明 |
| --------- | ------ | ---- |
| heartRate | number | 心率值。 |
**示例：** **示例：**
``` ```js
sensor.subscribeHeartRate({ sensor.subscribeHeartRate({
success: function(ret) { success: function(ret) {
console.log('get heartrate value:' + ret.heartRate); console.log('get heartrate value:' + ret.heartRate);
...@@ -386,7 +326,7 @@ sensor.subscribeHeartRate({ ...@@ -386,7 +326,7 @@ sensor.subscribeHeartRate({
}); });
``` ```
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > **说明：**
> 建议在页面销毁时，即onDestory回调中，取消数据订阅，避免不必要的性能开销。 > 建议在页面销毁时，即onDestory回调中，取消数据订阅，避免不必要的性能开销。
...@@ -402,13 +342,13 @@ unsubscribeHeartRate(): void ...@@ -402,13 +342,13 @@ unsubscribeHeartRate(): void
**示例：** **示例：**
``` ```js
sensor.unsubscribeHeartRate(); sensor.unsubscribeHeartRate();
``` ```
## sensor.subscribeOnBodyState ## sensor.subscribeOnBodyState
subscribeOnBodyState(Object): void subscribeOnBodyState(options: SubscribeOnBodyStateOptions): void
订阅设备佩戴状态。针对同一个应用，多次点击调用时，会覆盖前面的调用效果，即仅最后一次调用生效。 订阅设备佩戴状态。针对同一个应用，多次点击调用时，会覆盖前面的调用效果，即仅最后一次调用生效。
...@@ -417,19 +357,12 @@ subscribeOnBodyState(Object): void ...@@ -417,19 +357,12 @@ subscribeOnBodyState(Object): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | -------- | ---- | ------------- | | ------- | ----------------------------------------------------------- | ---- | ---------------------- |
| success | Function | 是 | 穿戴状态改变后的回调函数。 | | options | [SubscribeOnBodyStateOptions](#subscribeonbodystateoptions) | 是 | 当穿着状态改变时调用。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
success返回值：
| 参数名 | 类型 | 说明 |
| ----- | ------- | ------ |
| value | boolean | 是否已佩戴。 |
**示例：** **示例：**
``` ```js
sensor.subscribeOnBodyState({ sensor.subscribeOnBodyState({
success: function(ret) { success: function(ret) {
console.log('get on-body state value:' + ret.value); console.log('get on-body state value:' + ret.value);
...@@ -440,7 +373,7 @@ sensor.subscribeOnBodyState({ ...@@ -440,7 +373,7 @@ sensor.subscribeOnBodyState({
}); });
``` ```
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > **说明：**
> 建议在页面销毁时，即onDestory回调中，取消数据订阅，避免不必要的性能开销。 > 建议在页面销毁时，即onDestory回调中，取消数据订阅，避免不必要的性能开销。
## sensor.unsubscribeOnBodyState ## sensor.unsubscribeOnBodyState
...@@ -453,13 +386,13 @@ unsubscribeOnBodyState(): void ...@@ -453,13 +386,13 @@ unsubscribeOnBodyState(): void
**示例：** **示例：**
``` ```js
sensor.unsubscribeOnBodyState(); sensor.unsubscribeOnBodyState();
``` ```
## sensor.getOnBodyState ## sensor.getOnBodyState
getOnBodyState(Object): void getOnBodyState(options: GetOnBodyStateOptions): void
获取设备佩戴状态。 获取设备佩戴状态。
...@@ -468,20 +401,12 @@ getOnBodyState(Object): void ...@@ -468,20 +401,12 @@ getOnBodyState(Object): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------ | | ------- | ----------------------------------------------- | ---- | -------------------------- |
| success | Function | 否 | 接口调用成功的回调函数。 | | options | [GetOnBodyStateOptions](#getonbodystateoptions) | 是 | 获取传感器磨损状态时调用。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
| complete | Function | 否 | 接口调用结束的回调函数。 |
success返回值：
| 参数名 | 类型 | 说明 |
| ----- | ------- | ------ |
| value | boolean | 是否已佩戴。 |
**示例：** **示例：**
``` ```js
sensor.getOnBodyState({ sensor.getOnBodyState({
success: function(ret) { success: function(ret) {
console.log('on body state: ' + ret.value); console.log('on body state: ' + ret.value);
...@@ -494,7 +419,7 @@ sensor.getOnBodyState({ ...@@ -494,7 +419,7 @@ sensor.getOnBodyState({
## sensor.subscribeDeviceOrientation<sup>6+</sup> ## sensor.subscribeDeviceOrientation<sup>6+</sup>
subscribeDeviceOrientation(interval: string, success: (data: DeviceOrientationResponse), fail?: (data: string, code: number)): void subscribeDeviceOrientation(options: SubscribeDeviceOrientationOptions): void
观察设备方向传感器数据变化。 观察设备方向传感器数据变化。
...@@ -505,21 +430,12 @@ subscribeDeviceOrientation(interval: string, success: (data: DeviceOrientationRe ...@@ -505,21 +430,12 @@ subscribeDeviceOrientation(interval: string, success: (data: DeviceOrientationRe
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ---------------------------------------- | | ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------ |
| interval | string | 是 | 频率参数，设备方向传感器的回调函数执行频率。<br/>默认为normal，可选值有：<br/>-&nbsp;game：极高的回调频率，20ms/次，适用于游戏。<br/>-&nbsp;ui：较高的回调频率，60ms/次，适用于UI更新。<br/>-&nbsp;normal：普通的回调频率，200ms/次，低功耗。 | | options | [SubscribeDeviceOrientationOptions](#subscribedeviceorientationoptions) | 是 | 用于监听设备方向传感器数据的回调函数的执行频率。 |
| success | Function | 是 | 感应到设备方向传感器数据变化后的回调函数。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
success返回值：
| 参数名 | 类型 | 说明 |
| ----- | ------ | ---------------------------------------- |
| alpha | number | 当设备坐标&nbsp;X/Y&nbsp;和地球&nbsp;X/Y&nbsp;重合时，绕着&nbsp;Z&nbsp;轴转动的夹角为&nbsp;alpha。 |
| beta | number | 当设备坐标&nbsp;Y/Z&nbsp;和地球&nbsp;Y/Z&nbsp;重合时，绕着&nbsp;X&nbsp;轴转动的夹角为&nbsp;beta。 |
| gamma | number | 当设备&nbsp;X/Z&nbsp;和地球&nbsp;X/Z&nbsp;重合时，绕着&nbsp;Y&nbsp;轴转动的夹角为&nbsp;gamma。 |
**示例：** **示例：**
``` ```js
sensor.subscribeDeviceOrientation({ sensor.subscribeDeviceOrientation({
interval: 'normal', interval: 'normal',
success: function(ret) { success: function(ret) {
...@@ -533,7 +449,7 @@ sensor.subscribeDeviceOrientation({ ...@@ -533,7 +449,7 @@ sensor.subscribeDeviceOrientation({
}); });
``` ```
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > **说明：**
> 建议在页面销毁时，即onDestory回调中，取消数据订阅，避免不必要的性能开销。 > 建议在页面销毁时，即onDestory回调中，取消数据订阅，避免不必要的性能开销。
## sensor.unsubscribeDeviceOrientation<sup>6+</sup> ## sensor.unsubscribeDeviceOrientation<sup>6+</sup>
...@@ -546,13 +462,13 @@ unsubscribeDeviceOrientation(): void ...@@ -546,13 +462,13 @@ unsubscribeDeviceOrientation(): void
**示例：** **示例：**
``` ```js
sensor.unsubscribeDeviceOrientation(); sensor.unsubscribeDeviceOrientation();
``` ```
## sensor.subscribeGyroscope<sup>6+</sup> ## sensor.subscribeGyroscope<sup>6+</sup>
subscribeGyroscope(interval: string, success: (data: GyroscopeResponse), fail?: (data: string, code: number)): void subscribeGyroscope(options: SubscribeGyroscopeOptions): void
观察陀螺仪数据变化。 观察陀螺仪数据变化。
...@@ -565,22 +481,12 @@ subscribeGyroscope(interval: string, success: (data: GyroscopeResponse), fail?: ...@@ -565,22 +481,12 @@ subscribeGyroscope(interval: string, success: (data: GyroscopeResponse), fail?:
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ---------------------------------------- | | ------- | ------------------------------------------------------- | ---- | ---------------------------------------------- |
| interval | string | 是 | 频率参数，陀螺仪的回调函数执行频率。<br/>默认为normal，可选值有：<br/>-&nbsp;game：极高的回调频率，20ms/次，适用于游戏。<br/>-&nbsp;ui：较高的回调频率，60ms/次，适用于UI更新。<br/>-&nbsp;normal：普通的回调频率，200ms/次，低功耗。 | | options | [SubscribeGyroscopeOptions](#subscribegyroscopeoptions) | 是 | 用于侦听陀螺仪传感器数据的回调函数的执行频率。 |
| success | Function | 是 | 感应到陀螺仪数据变化后的回调函数。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
success返回值：
| 参数名 | 类型 | 说明 |
| ---- | ------ | --------- |
| x | number | x轴的旋转角速度。 |
| y | number | y轴的旋转角速度。 |
| z | number | z轴的旋转角速度。 |
**示例：** **示例：**
``` ```js
sensor.subscribeGyroscope({ sensor.subscribeGyroscope({
interval: 'normal', interval: 'normal',
success: function(ret) { success: function(ret) {
...@@ -594,7 +500,7 @@ sensor.subscribeGyroscope({ ...@@ -594,7 +500,7 @@ sensor.subscribeGyroscope({
}); });
``` ```
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > **说明：**
> 建议在页面销毁时，即onDestory回调中，取消数据订阅，避免不必要的性能开销。 > 建议在页面销毁时，即onDestory回调中，取消数据订阅，避免不必要的性能开销。
## sensor.unsubscribeGyroscope<sup>6+</sup> ## sensor.unsubscribeGyroscope<sup>6+</sup>
...@@ -609,6 +515,253 @@ unsubscribeGyroscope(): void ...@@ -609,6 +515,253 @@ unsubscribeGyroscope(): void
**示例：** **示例：**
``` ```js
sensor.unsubscribeGyroscope(); sensor.unsubscribeGyroscope();
``` ```
## subscribeAccelerometerOptions
用于监听加速度传感器数据的回调函数的执行频率。
**需要权限**：ohos.permission.ACCELEROMETER
**系统能力**：SystemCapability.Sensors.Sensor
| 名称 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ |
| interval | string | 是 | 频率参数，加速度的回调函数执行频率。 默认为normal，可选值有： - game：极高的回调频率，20ms/次，适用于游戏。 - ui：较高的回调频率，60ms/次，适用于UI更新。 - normal：普通的回调频率，200ms/次，低功耗。 |
| success | [AccelerometerResponse](#accelerometerresponse) | 是 | 感应到加速度数据变化后的回调函数。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
## AccelerometerResponse
感应到加速度数据变化后的回调函数。
**需要权限**：ohos.permission.ACCELEROMETER
**系统能力**：SystemCapability.Sensors.Sensor
| 名称 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------- |
| x | number | 是 | x轴的加速度。 |
| y | number | 是 | y轴的加速度。 |
| z | number | 是 | z轴的加速度。 |
## SubscribeCompassOptions
当罗盘传感器数据发生变化时调用。
**系统能力**：SystemCapability.Sensors.Sensor
| 名称 | 类型 | 必填 | 说明 |
| ------- | ----------------------------------- | ---- | ------------------------------ |
| success | [CompassResponse](#compassresponse) | 是 | 罗盘数据改变后触发的回调函数。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
## CompassResponse
罗盘数据改变后触发的回调函数。
**系统能力**：SystemCapability.Sensors.Sensor
| 名称 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | -------------------- |
| direction | number | 是 | 设备面对的方向度数。 |
## SubscribeProximityOptions
当距离传感器数据发生变化时调用。
**系统能力**：SystemCapability.Sensors.Sensor
| 名称 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ---------------------------------- |
| success | [ProximityResponse](#proximityresponse) | 是 | 距离感应数据改变后调用的回调函数。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
## ProximityResponse
距离感应数据改变后调用的回调函数。
**系统能力**：SystemCapability.Sensors.Sensor
| 名称 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------------------------ |
| distance | number | 是 | 可见物体相对于设备显示屏的接近或远离状态。 |
## SubscribeLightOptions
当环境光传感器数据发生变化时调用。
**系统能力**：SystemCapability.Sensors.Sensor
| 名称 | 类型 | 必填 | 说明 |
| ------- | ------------------------------- | ---- | ------------------------------ |
| success | [LightResponse](#lightresponse) | 是 | 光线感应数据改变后的回调函数。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
## LightResponse
光线感应数据改变后的回调函数。
**系统能力**：SystemCapability.Sensors.Sensor
| 名称 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | --------------------- |
| intensity | number | 是 | 光线强度，单位为lux。 |
## SubscribeStepCounterOptions
当步进计数器传感器数据发生变化时调用。
**需要权限**：ohos.permission.ACTIVITY_MOTION
**系统能力**：SystemCapability.Sensors.Sensor
| 名称 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------------- | ---- | -------------------------------- |
| success | [StepCounterResponse](#stepcounterresponse) | 是 | 计步传感器数据改变后的回调函数。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
## StepCounterResponse
计步传感器数据改变后的回调函数。
**需要权限**：ohos.permission.ACTIVITY_MOTION
**系统能力**：SystemCapability.Sensors.Sensor
| 名称 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | -------------------------------- |
| steps | number | 是 | 计步传感器重启后累计记录的步数。 |
## SubscribeBarometerOptions
当气压计传感器数据发生变化时调用。
**系统能力**：SystemCapability.Sensors.Sensor
| 名称 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | -------------------------------- |
| success | [BarometerResponse](#barometerresponse) | 是 | 气压传感器数据改变后的回调函数。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
## BarometerResponse
气压传感器数据改变后的回调函数。
**系统能力**：SystemCapability.Sensors.Sensor
| 名称 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------------------- |
| pressure | number | 是 | 气压值，单位：帕斯卡。 |
## SubscribeHeartRateOptions
当心率传感器数据发生变化时调用。
**需要权限**：ohos.permission.READ_HEALTH_DATA
**系统能力**：SystemCapability.Sensors.Sensor
| 名称 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ----------------------------------------------- |
| success | [HeartRateResponse](#heartrateresponse) | 是 | 心率传感器数据改变后的回调函数，默认频率5s/次。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
## HeartRateResponse
心率传感器数据改变后的回调函数，默认频率5s/次。
**需要权限**：ohos.permission.READ_HEALTH_DATA
**系统能力**：SystemCapability.Sensors.Sensor
| 名称 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | -------- |
| heartRate | number | 是 | 心率值。 |
## SubscribeOnBodyStateOptions
当穿着状态改变时调用。
**系统能力**：SystemCapability.Sensors.Sensor
| 名称 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------------- | ---- | -------------------------- |
| success | [OnBodyStateResponse](#onbodystateresponse) | 是 | 穿戴状态改变后的回调函数。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
## OnBodyStateResponse
传感器是否磨损。
**系统能力**：SystemCapability.Sensors.Sensor
| 名称 | 类型 | 必填 | 说明 |
| ----- | ------- | ---- | ------------ |
| value | boolean | 是 | 是否已佩戴。 |
## GetOnBodyStateOptions
获取传感器磨损状态时调用。
**系统能力**：SystemCapability.Sensors.Sensor
| 名称 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------- | ---- | ------------------------ |
| success | [OnBodyStateResponse](#onbodystateresponse) | 否 | 接口调用成功的回调函数。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
| complete | Function | 否 | 接口调用结束的回调函数。 |
## SubscribeDeviceOrientationOptions<sup>6+</sup>
用于监听设备方向传感器数据的回调函数的执行频率。
**系统能力**：SystemCapability.Sensors.Sensor
| 名称 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| interval | string | 是 | 频率参数，设备方向传感器的回调函数执行频率。<br/>默认为normal，可选值有：<br/>-&nbsp;game：极高的回调频率，20ms/次，适用于游戏。<br/>-&nbsp;ui：较高的回调频率，60ms/次，适用于UI更新。<br/>-&nbsp;normal：普通的回调频率，200ms/次，低功耗。 |
| success | [DeviceOrientationResponse](#deviceorientationresponse) | 是 | 感应到设备方向传感器数据变化后的回调函数。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
## DeviceOrientationResponse<sup>6+</sup>
感应到设备方向传感器数据变化后的回调函数。
**系统能力**：SystemCapability.Sensors.Sensor
| 名称 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ------------------------------------------------------------ |
| alpha | number | 是 | 当设备坐标&nbsp;X/Y&nbsp;和地球&nbsp;X/Y&nbsp;重合时，绕着&nbsp;Z&nbsp;轴转动的夹角为&nbsp;alpha。 |
| beta | number | 是 | 当设备坐标&nbsp;Y/Z&nbsp;和地球&nbsp;Y/Z&nbsp;重合时，绕着&nbsp;X&nbsp;轴转动的夹角为&nbsp;beta。 |
| gamma | number | 是 | 当设备&nbsp;X/Z&nbsp;和地球&nbsp;X/Z&nbsp;重合时，绕着&nbsp;Y&nbsp;轴转动的夹角为&nbsp;gamma。 |
## SubscribeGyroscopeOptions<sup>6+</sup>
用于侦听陀螺仪传感器数据的回调函数的执行频率。
**需要权限**：ohos.permission.GYROSCOPE
**系统能力**：SystemCapability.Sensors.Sensor
| 名称 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ |
| interval | string | 是 | 频率参数，陀螺仪的回调函数执行频率。<br/>默认为normal，可选值有：<br/>-&nbsp;game：极高的回调频率，20ms/次，适用于游戏。<br/>-&nbsp;ui：较高的回调频率，60ms/次，适用于UI更新。<br/>-&nbsp;normal：普通的回调频率，200ms/次，低功耗。 |
| success | [GyroscopeResponse](#gyroscoperesponse) | 是 | 感应到陀螺仪数据变化后的回调函数。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
## GyroscopeResponse<sup>6+</sup>
感应到陀螺仪数据变化后的回调函数。
**需要权限**：ohos.permission.GYROSCOPE
**系统能力**：SystemCapability.Sensors.Sensor
| 名称 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----------------- |
| x | number | 是 | x轴的旋转角速度。 |
| y | number | 是 | y轴的旋转角速度。 |
| z | number | 是 | z轴的旋转角速度。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-system-vibrate.md
浏览文件 @ f453a735
# @system.vibrator (振动) # @system.vibrator (振动)
## 模块说明
vibrator模块提供控制马达振动的能力，主要包含灯的列表查询、打开灯、关闭灯等接口，振动器的列表查询、振动器的振动器效果查询、触发/关闭振动器等接口。 vibrator模块提供控制马达振动的能力，主要包含灯的列表查询、打开灯、关闭灯等接口，振动器的列表查询、振动器的振动器效果查询、触发/关闭振动器等接口。
控制类小器件指的是设备上的LED灯和振动器。其中，LED灯主要用作指示（如充电状态）、闪烁功能（如三色灯）等；振动器主要用于闹钟、开关机振动、来电振动等场景。 控制类小器件指的是设备上的LED灯和振动器。其中，LED灯主要用作指示（如充电状态）、闪烁功能（如三色灯）等；振动器主要用于闹钟、开关机振动、来电振动等场景。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > **说明：**
> - 本模块首批接口从API version 4开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > - 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - 从API Version 8开始，该接口不再维护，推荐使用新接口[`@ohos.vibrator`](js-apis-vibrator.md)。 > - 从API Version 8开始，该接口不再维护，推荐使用新接口[`@ohos.vibrator`](js-apis-vibrator.md)。
> - 该功能使用需要对应硬件支持，仅支持真机调试。 > - 该功能使用需要对应硬件支持，仅支持真机调试。
...@@ -22,26 +20,23 @@ import vibrator from '@system.vibrator'; ...@@ -22,26 +20,23 @@ import vibrator from '@system.vibrator';
## vibrator.vibrate ## vibrator.vibrate
vibrate(Object): void vibrate(options?: VibrateOptions): void
触发设备振动。 触发设备振动。
**系统能力**：SystemCapability.Sensors.MiscDevice **需要权限**：ohos.permission.VIBRATE
**需要权限**：ohos.permission.VIBRATE，该权限为系统权限 **系统能力**：SystemCapability.Sensors.MiscDevice
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | --------------------------------- | ---- | ---------- |
| mode | string | 否 | 振动的模式，其中long表示长振动，short表示短振动，默认值为long。 | | options | [VibrateOptions](#vibrateoptions) | 否 | 振动模式。 |
| success | Function | 是 | 感应到振动数据变化后的回调函数。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
| complete | Function | 否 | 接口调用结束的回调函数。 |
**示例：** **示例：**
``` ```js
vibrator.vibrate({ vibrator.vibrate({
mode: 'short', mode: 'short',
success: function() { success: function() {
...@@ -56,3 +51,17 @@ vibrator.vibrate({ ...@@ -56,3 +51,17 @@ vibrator.vibrate({
}); });
``` ```
## VibrateOptions
振动模式。
**需要权限**：ohos.permission.VIBRATE
**系统能力**：SystemCapability.Sensors.MiscDevice
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------------------------------------------------ |
| mode | string | 否 | 振动的模式，其中long表示长振动，short表示短振动，默认值为long。 |
| success | Function | 否 | 感应到振动数据变化后的回调函数。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
| complete | Function | 否 | 接口调用结束的回调函数。 |
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或