提交 650c7b38 编写于 作者: C cff-gite

修改docs资料

Signed-off-by: Ncff-gite <chenfeifei8@huawei.com>
上级 65649aaf
...@@ -24,9 +24,9 @@ ...@@ -24,9 +24,9 @@
| 模块 | 接口名 | 描述 | | 模块 | 接口名 | 描述 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| ohos.sensor | sensor.on(sensorType, callback:AsyncCallback&lt;Response&gt;): void | 持续监听传感器数据变化 | | ohos.sensor | sensor.on(sensorId, callback:AsyncCallback&lt;Response&gt;): void | 持续监听传感器数据变化 |
| ohos.sensor | sensor.once(sensorType, callback:AsyncCallback&lt;Response&gt;): void | 获取一次传感器数据变化 | | ohos.sensor | sensor.once(sensorId, callback:AsyncCallback&lt;Response&gt;): void | 获取一次传感器数据变化 |
| ohos.sensor | sensor.off(sensorType, callback?:AsyncCallback&lt;void&gt;): void | 注销传感器数据的监听 | | ohos.sensor | sensor.off(sensorId, callback?:AsyncCallback&lt;void&gt;): void | 注销传感器数据的监听 |
## 开发步骤 ## 开发步骤
...@@ -45,47 +45,47 @@ ...@@ -45,47 +45,47 @@
2. 持续监听传感器数据变化。 2. 持续监听传感器数据变化。
``` ```js
import sensor from "@ohos.sensor"; import sensor from "@ohos.sensor";
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, function(data){ sensor.on(sensor.SensorId.ACCELEROMETER, function(data){
console.info("Data obtained successfully. x: " + data.x + "y: " + data.y + "z: " + data.z);// 获取数据成功 console.info("Data obtained successfully. x: " + data.x + "y: " + data.y + "z: " + data.z);// 获取数据成功
}); });
``` ```
以SensorType为SENSOR_TYPE_ID_ACCELEROMETER为例展示运行结果,持续监听传感器接口的结果如下图所示: 以SensorId为ACCELEROMETER为例展示运行结果,持续监听传感器接口的结果如下图所示:
![zh-cn_image_0000001241693881](figures/zh-cn_image_0000001241693881.png) ![171e6f30-a8d9-414c-bafa-b430340305f](D:\docs\docs\zh-cn\figures\171e6f30-a8d9-414c-bafa-b430340305fb.png)
3. 注销传感器数据监听。 3. 注销传感器数据监听。
``` ```js
import sensor from "@ohos.sensor"; import sensor from "@ohos.sensor";
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER); sensor.off(sensor.SensorId.ACCELEROMETER);
``` ```
以SensorType为SENSOR_TYPE_ID_ACCELEROMETER为例展示运行结果,注销传感器成功结果如下图所示: 以SensorId为ACCELEROMETER为例展示运行结果,注销传感器成功结果如下图所示:
![zh-cn_image_0000001196654004](figures/zh-cn_image_0000001196654004.png) ![65d69983-29f6-4381-80a3-f9ef2ec19e53](D:\docs\docs\zh-cn\figures\65d69983-29f6-4381-80a3-f9ef2ec19e53.png)
4. 获取一次传感器数据变化。 4. 获取一次传感器数据变化。
``` ```js
import sensor from "@ohos.sensor"; import sensor from "@ohos.sensor";
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, function(data) { sensor.once(sensor.SensorId.ACCELEROMETER, function(data) {
console.info("Data obtained successfully. x: " + data.x + "y: " + data.y + "z: " + data.z);// 获取数据成功 console.info("Data obtained successfully. x: " + data.x + "y: " + data.y + "z: " + data.z);// 获取数据成功
}); });
``` ```
以SensorType为SENSOR_TYPE_ID_ACCELEROMETER为例展示运行结果,获取数据成功日志如下图所示: 以SensorId为ACCELEROMETER为例展示运行结果,获取数据成功日志如下图所示:
![zh-cn_image_0000001241733907](figures/zh-cn_image_0000001241733907.png) ![db5d017d-6c1c-4a71-a2dd-f74b7f23239e](D:\docs\docs\zh-cn\figures\db5d017d-6c1c-4a71-a2dd-f74b7f23239e.png)
若接口调用不成功,建议使用try/catch语句捕获代码中可能出现的错误信息。例如: 若接口调用不成功,建议使用try/catch语句捕获代码中可能出现的错误信息。例如:
``` ```js
import sensor from "@ohos.sensor"; import sensor from "@ohos.sensor";
try { try {
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, function(data) { sensor.once(sensor.SensorId.ACCELEROMETER, function(data) {
console.info("Data obtained successfully. x: " + data.x + "y: " + data.y + "z: " + data.z);// 获取数据成功 console.info("Data obtained successfully. x: " + data.x + "y: " + data.y + "z: " + data.z);// 获取数据成功
}); });
} catch (error) { } catch (error) {
......
...@@ -10,14 +10,18 @@ ...@@ -10,14 +10,18 @@
## 接口说明 ## 接口说明
| 模块 | 接口名 | 描述 | | 模块 | 接口名 | 描述 |
| ------------- | ---------------------------------------- | ------------------------------- | | ------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| ohos.vibrator | vibrate(duration:&nbsp;number):&nbsp;Promise&lt;void&gt; | 触发马达按照时长振动,使用Promise异步回调。 | | ohos.vibrator | vibrate(duration:&nbsp;number):&nbsp;Promise&lt;void&gt; | 触发马达按照时长振动,使用Promise异步回调。 |
| ohos.vibrator | vibrate(duration:&nbsp;number,&nbsp;callback?:&nbsp;AsyncCallback&lt;void&gt;):&nbsp;void | 触发马达按照时长振动,使用Callback异步回调。 | | ohos.vibrator | vibrate(duration:&nbsp;number,&nbsp;callback?:&nbsp;AsyncCallback&lt;void&gt;):&nbsp;void | 触发马达按照时长振动,使用Callback异步回调。 |
| ohos.vibrator | vibrate(effectId:&nbsp;EffectId):&nbsp;Promise&lt;void&gt; | 触发马达按照开发者传递效果振动,使用Promise异步回调。 | | ohos.vibrator | vibrate(effectId:&nbsp;EffectId):&nbsp;Promise&lt;void&gt; | 触发马达按照开发者传递效果振动,使用Promise异步回调。 |
| ohos.vibrator | vibrate(effectId:&nbsp;EffectId,&nbsp;callback?:&nbsp;AsyncCallback&lt;void&gt;):&nbsp;void | 触发马达按照开发者传递效果振动,使用Callback异步回调。 | | ohos.vibrator | vibrate(effectId:&nbsp;EffectId,&nbsp;callback?:&nbsp;AsyncCallback&lt;void&gt;):&nbsp;void | 触发马达按照开发者传递效果振动,使用Callback异步回调。 |
| ohos.vibrator | stop(stopMode:&nbsp;VibratorStopMode):&nbsp;Promise&lt;void&gt; | 停止振动。 | | ohos.vibrator | startVibration(effect: VibrateEffect, attribute: VibrateAttribute): Promise&lt;void&gt; | 根据指定振动效果和振动属性触发马达振动,使用Promise异步回调。 |
| ohos.vibrator | stop(stopMode:&nbsp;VibratorStopMode,&nbsp;callback?:&nbsp;AsyncCallback&lt;void&gt;):&nbsp;void | 停止振动。 | | ohos.vibrator | startVibration(effect: VibrateEffect, attribute: VibrateAttribute, callback: AsyncCallback&lt;void&gt;): void | 根据指定振动效果和振动属性触发马达振动,使用Callback异步回调。 |
| ohos.vibrator | stop(stopMode:&nbsp;VibratorStopMode):&nbsp;Promise&lt;void&gt; | 停止振动。 |
| ohos.vibrator | stop(stopMode:&nbsp;VibratorStopMode,&nbsp;callback?:&nbsp;AsyncCallback&lt;void&gt;):&nbsp;void | 停止振动。 |
| ohos.vibrator | stopVibration(stopMode: VibratorStopMode): Promise&lt;void&gt; | 按照指定模式停止马达的振动。 |
| ohos.vibrator | stopVibration(stopMode: VibratorStopMode, callback: AsyncCallback&lt;void&gt;): void | 按照指定模式停止马达的振动。 |
## 开发步骤 ## 开发步骤
...@@ -26,7 +30,7 @@ ...@@ -26,7 +30,7 @@
2. 触发设备振动。 2. 触发设备振动。
``` ```js
import vibrator from "@ohos.vibrator" import vibrator from "@ohos.vibrator"
vibrator.vibrate(1000).then((error) => { vibrator.vibrate(1000).then((error) => {
if (error) { //调用失败,打印error.code和error.message if (error) { //调用失败,打印error.code和error.message
...@@ -39,7 +43,7 @@ ...@@ -39,7 +43,7 @@
3. 停止设备振动。 3. 停止设备振动。
``` ```js
import vibrator from "@ohos.vibrator" import vibrator from "@ohos.vibrator"
vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then((error) => { vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then((error) => {
if (error) { //调用失败,打印error.code和error.message if (error) { //调用失败,打印error.code和error.message
...@@ -50,6 +54,47 @@ ...@@ -50,6 +54,47 @@
}) })
``` ```
4. 根据指定振动效果和振动属性触发马达振动 。
```js
try {
vibrator.startVibration({
type: 'time',
duration: 1000,
}, {
id: 0,
usage: 'alarm'
}, (error) => {
if (error) {
console.error('vibrate fail, error.code: ' + error.code + 'error.message: ', + error.message);
return;
}
console.log('Callback returned to indicate a successful vibration.');
});
} catch (err) {
console.error('errCode: ' + err.code + ' ,msg: ' + err.message);
}
```
5. 按照指定模式停止马达的振动。
```js
try {
// 按照VIBRATOR_STOP_MODE_TIME模式停止振动
vibrator.stopVibration(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_TIME, function (error) {
if (error) {
console.log('error.code' + error.code + 'error.message' + error.message);
return;
}
console.log('Callback returned to indicate successful.');
})
} catch (err) {
console.info('errCode: ' + err.code + ' ,msg: ' + err.message);
}
```
## 相关实例 ## 相关实例
针对振动开发,有以下相关实例可供参考: 针对振动开发,有以下相关实例可供参考:
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册