Skip to content

D
Docs

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

通知 159
Star 292
Fork 28
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

提交 5beae124 编写于 作者: W wusongqing
浏览文件
操作

updated docs against 5150 

Signed-off-by: Nwusongqing <wusongqing@huawei.com>
上级 9024154a
显示空白变更内容
内联 并排
Showing with 208 addition and 203 deletion
en/application-dev/reference/apis/js-apis-config-policy.md
浏览文件 @ 5beae124
# Configuration Policy # Configuration Policy
> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** > **NOTE**
> - The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. >
> - The APIs of this module are system APIs and cannot be called by third-party applications. > The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
>
> The APIs of this module are system APIs and cannot be called by third-party applications.
The configuration policy provides the capability of obtaining the custom configuration directory and file path based on the predefined custom configuration level. The configuration policy provides the capability of obtaining the custom configuration directory and file path based on the predefined custom configuration level.
## Modules to Import ## Modules to Import
``` ```js
import configPolicy from '@ohos.configPolicy'; import configPolicy from '@ohos.configPolicy';
``` ```
...@@ -22,18 +24,18 @@ For example, if the **config.xml** file is stored in **/system/etc/config.xml** ...@@ -22,18 +24,18 @@ For example, if the **config.xml** file is stored in **/system/etc/config.xml**
**System capability**: SystemCapability.Customization.ConfigPolicy **System capability**: SystemCapability.Customization.ConfigPolicy
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| relPath | string | Yes| Name of the configuration file.| | relPath | string | Yes| Name of the configuration file.|
| callback | AsyncCallback&lt;string&gt; | Yes| Callback used to return the path of the configuration file.| | callback | AsyncCallback&lt;string&gt; | Yes| Callback used to return the path of the configuration file.|
**Example** **Example**
``` ```js
configPolicy.getOneCfgFile('config.xml', (error, value) => { configPolicy.getOneCfgFile('config.xml', (error, value) => {
if (error == undefined) { if (error == undefined) {
console.log(value); console.log("value is " + value);
} else { } else {
console.log(error); console.log("error occurs "+ error);
} }
}); });
``` ```
...@@ -48,19 +50,19 @@ Obtains the path of a configuration file with the specified name and highest pri ...@@ -48,19 +50,19 @@ Obtains the path of a configuration file with the specified name and highest pri
**System capability**: SystemCapability.Customization.ConfigPolicy **System capability**: SystemCapability.Customization.ConfigPolicy
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| relPath | string | Yes| Name of the configuration file.| | relPath | string | Yes| Name of the configuration file.|
**Return value** **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise&lt;string&gt; | Promise used to return the path of the configuration file.| | Promise&lt;string&gt; | Promise used to return the path of the configuration file.|
**Example** **Example**
``` ```js
configPolicy.getOneCfgFile('config.xml').then(value => { configPolicy.getOneCfgFile('config.xml').then(value => {
console.log(value); console.log("value is " + value);
}).catch(error => { }).catch(error => {
console.log("getOneCfgFile promise " + error); console.log("getOneCfgFile promise " + error);
}); });
...@@ -77,18 +79,18 @@ and **/sys-pod/etc/config.xml**, then **/system/etc/config.xml, /sys-pod/etc/con ...@@ -77,18 +79,18 @@ and **/sys-pod/etc/config.xml**, then **/system/etc/config.xml, /sys-pod/etc/con
**System capability**: SystemCapability.Customization.ConfigPolicy **System capability**: SystemCapability.Customization.ConfigPolicy
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| relPath | string | Yes| Name of the configuration file.| | relPath | string | Yes| Name of the configuration file.|
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | Yes| Callback used to return the file list.| | callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | Yes| Callback used to return the file list.|
**Example** **Example**
``` ```js
configPolicy.getCfgFiles('config.xml', (error, value) => { configPolicy.getCfgFiles('config.xml', (error, value) => {
if (error == undefined) { if (error == undefined) {
console.log(value); console.log("value is " + value);
} else { } else {
console.log(error); console.log("error occurs "+ error);
} }
}); });
``` ```
...@@ -103,19 +105,19 @@ Obtains all configuration files with the specified name and lists them in ascend ...@@ -103,19 +105,19 @@ Obtains all configuration files with the specified name and lists them in ascend
**System capability**: SystemCapability.Customization.ConfigPolicy **System capability**: SystemCapability.Customization.ConfigPolicy
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| relPath | string | Yes| Name of the configuration file.| | relPath | string | Yes| Name of the configuration file.|
**Return value** **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise&lt;Array&lt;string&gt;&gt; | Promise used to return the file list.| | Promise&lt;Array&lt;string&gt;&gt; | Promise used to return the file list.|
**Example** **Example**
``` ```js
configPolicy.getCfgFiles('config.xml').then(value => { configPolicy.getCfgFiles('config.xml').then(value => {
console.log(value); console.log("value is " + value);
}).catch(error => { }).catch(error => {
console.log("getCfgFiles promise " + error); console.log("getCfgFiles promise " + error);
}); });
...@@ -131,17 +133,17 @@ Obtains the configuration level directory list. This API uses an asynchronous ca ...@@ -131,17 +133,17 @@ Obtains the configuration level directory list. This API uses an asynchronous ca
**System capability**: SystemCapability.Customization.ConfigPolicy **System capability**: SystemCapability.Customization.ConfigPolicy
**Parameters** **Parameters**
| Name| Type| Mandatory| Description| | Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | Yes| Callback used to return the configuration level directory list.| | callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | Yes| Callback used to return the configuration level directory list.|
**Example** **Example**
``` ```js
configPolicy.getCfgDirList((error, value) => { configPolicy.getCfgDirList((error, value) => {
if (error == undefined) { if (error == undefined) {
console.log(value); console.log("value is " + value);
} else { } else {
console.log(error); console.log("error occurs "+ error);
} }
}); });
``` ```
...@@ -156,14 +158,14 @@ Obtains the configuration level directory list. This API uses a promise to retur ...@@ -156,14 +158,14 @@ Obtains the configuration level directory list. This API uses a promise to retur
**System capability**: SystemCapability.Customization.ConfigPolicy **System capability**: SystemCapability.Customization.ConfigPolicy
**Return value** **Return value**
| Type| Description| | Type| Description|
| -------- | -------- | | -------- | -------- |
| Promise&lt;Array&lt;string&gt;&gt; | Promise used to return the configuration level directory list.| | Promise&lt;Array&lt;string&gt;&gt; | Promise used to return the configuration level directory list.|
**Example** **Example**
``` ```js
configPolicy.getCfgDirList().then(value => { configPolicy.getCfgDirList().then(value => {
console.log(value); console.log("value is " + value);
}).catch(error => { }).catch(error => {
console.log("getCfgDirList promise " + error); console.log("getCfgDirList promise " + error);
}); });
......
en/application-dev/reference/apis/js-apis-sensor.md
浏览文件 @ 5beae124
# Sensor # Sensor
> **NOTE**<br/> > **NOTE**
>
> The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. > The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
## Modules to Import ## Modules to Import
``` ```js
import sensor from '@ohos.sensor'; import sensor from '@ohos.sensor';
``` ```
...@@ -30,7 +31,7 @@ Subscribes to data changes of the acceleration sensor. If this API is called mul ...@@ -30,7 +31,7 @@ Subscribes to data changes of the acceleration sensor. If this API is called mul
| options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. | | options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. |
**Example** **Example**
``` ```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER,function(data){
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -59,7 +60,7 @@ Subscribes to data changes of the linear acceleration sensor. If this API is cal ...@@ -59,7 +60,7 @@ Subscribes to data changes of the linear acceleration sensor. If this API is cal
| options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. | | options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. |
**Example** **Example**
``` ```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,function(data){
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -88,7 +89,7 @@ Subscribes to data changes of the uncalibrated acceleration sensor. If this API ...@@ -88,7 +89,7 @@ Subscribes to data changes of the uncalibrated acceleration sensor. If this API
| options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. | | options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. |
**Example** **Example**
``` ```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,function(data){
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -118,7 +119,7 @@ Subscribes to data changes of the gravity sensor. If this API is called multiple ...@@ -118,7 +119,7 @@ Subscribes to data changes of the gravity sensor. If this API is called multiple
| options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. | | options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. |
**Example** **Example**
``` ```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY,function(data){
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -147,7 +148,7 @@ Subscribes to data changes of the gyroscope sensor. If this API is called multip ...@@ -147,7 +148,7 @@ Subscribes to data changes of the gyroscope sensor. If this API is called multip
| options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. | | options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. |
**Example** **Example**
``` ```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE,function(data){
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -176,7 +177,7 @@ Subscribes to data changes of the uncalibrated gyroscope sensor. If this API is ...@@ -176,7 +177,7 @@ Subscribes to data changes of the uncalibrated gyroscope sensor. If this API is
| options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. | | options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. |
**Example** **Example**
``` ```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,function(data){
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -206,7 +207,7 @@ Subscribes to data changes of the significant motion sensor. If this API is call ...@@ -206,7 +207,7 @@ Subscribes to data changes of the significant motion sensor. If this API is call
| options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. | | options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. |
**Example** **Example**
``` ```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,function(data){
console.info('Scalar data: ' + data.scalar); console.info('Scalar data: ' + data.scalar);
}, },
...@@ -233,7 +234,7 @@ Subscribes to data changes of the pedometer detection sensor. If this API is cal ...@@ -233,7 +234,7 @@ Subscribes to data changes of the pedometer detection sensor. If this API is cal
| options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. | | options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. |
**Example** **Example**
``` ```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,function(data){
console.info('Scalar data: ' + data.scalar); console.info('Scalar data: ' + data.scalar);
}, },
...@@ -260,7 +261,7 @@ Subscribes to data changes of the pedometer sensor. If this API is called multip ...@@ -260,7 +261,7 @@ Subscribes to data changes of the pedometer sensor. If this API is called multip
| options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. | | options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. |
**Example** **Example**
``` ```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER,function(data){
console.info('Steps: ' + data.steps); console.info('Steps: ' + data.steps);
}, },
...@@ -285,7 +286,7 @@ Subscribes to data changes of the ambient temperature sensor. If this API is cal ...@@ -285,7 +286,7 @@ Subscribes to data changes of the ambient temperature sensor. If this API is cal
| options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. | | options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. |
**Example** **Example**
``` ```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,function(data){
console.info('Temperature: ' + data.temperature); console.info('Temperature: ' + data.temperature);
}, },
...@@ -310,7 +311,7 @@ Subscribes to data changes of the magnetic field sensor. If this API is called m ...@@ -310,7 +311,7 @@ Subscribes to data changes of the magnetic field sensor. If this API is called m
| options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. | | options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. |
**Example** **Example**
``` ```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD,function(data){
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -337,7 +338,7 @@ Subscribes to data changes of the uncalibrated magnetic field sensor. If this AP ...@@ -337,7 +338,7 @@ Subscribes to data changes of the uncalibrated magnetic field sensor. If this AP
| options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. | | options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. |
**Example** **Example**
``` ```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,function(data){
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -367,7 +368,7 @@ Subscribes to data changes of the proximity sensor. If this API is called multip ...@@ -367,7 +368,7 @@ Subscribes to data changes of the proximity sensor. If this API is called multip
| options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. | | options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. |
**Example** **Example**
``` ```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY,function(data){
console.info('Distance: ' + data.distance); console.info('Distance: ' + data.distance);
}, },
...@@ -392,7 +393,7 @@ Subscribes to data changes of the humidity sensor. If this API is called multipl ...@@ -392,7 +393,7 @@ Subscribes to data changes of the humidity sensor. If this API is called multipl
| options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. | | options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. |
**Example** **Example**
``` ```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY,function(data){
console.info('Humidity: ' + data.humidity); console.info('Humidity: ' + data.humidity);
}, },
...@@ -417,7 +418,7 @@ Subscribes to data changes of the barometer sensor. If this API is called multip ...@@ -417,7 +418,7 @@ Subscribes to data changes of the barometer sensor. If this API is called multip
| options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. | | options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. |
**Example** **Example**
``` ```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER,function(data){
console.info('Atmospheric pressure: ' + data.pressure); console.info('Atmospheric pressure: ' + data.pressure);
}, },
...@@ -442,7 +443,7 @@ Subscribes to data changes of the Hall effect sensor. If this API is called mult ...@@ -442,7 +443,7 @@ Subscribes to data changes of the Hall effect sensor. If this API is called mult
| options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. | | options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. |
**Example** **Example**
``` ```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HALL,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HALL,function(data){
console.info('Status: ' + data.status); console.info('Status: ' + data.status);
}, },
...@@ -467,7 +468,7 @@ Subscribes to data changes of the ambient light sensor. If this API is called mu ...@@ -467,7 +468,7 @@ Subscribes to data changes of the ambient light sensor. If this API is called mu
| options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. | | options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. |
**Example** **Example**
``` ```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT,function(data){
console.info(' Illumination: ' + data.intensity); console.info(' Illumination: ' + data.intensity);
}, },
...@@ -492,7 +493,7 @@ Subscribes to data changes of the orientation sensor. If this API is called mult ...@@ -492,7 +493,7 @@ Subscribes to data changes of the orientation sensor. If this API is called mult
| options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. | | options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. |
**Example** **Example**
``` ```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION,function(data){
console.info('The device rotates at an angle around the X axis: ' + data.beta); console.info('The device rotates at an angle around the X axis: ' + data.beta);
console.info('The device rotates at an angle around the Y axis: ' + data.gamma); console.info('The device rotates at an angle around the Y axis: ' + data.gamma);
...@@ -521,7 +522,7 @@ Subscribes to only one data change of the heart rate sensor. ...@@ -521,7 +522,7 @@ Subscribes to only one data change of the heart rate sensor.
**Example** **Example**
``` ```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE,function(data){
console.info("Heart rate: " + data.heartRate); console.info("Heart rate: " + data.heartRate);
}, },
...@@ -545,7 +546,7 @@ Subscribes to data changes of the rotation vector sensor. If this API is called ...@@ -545,7 +546,7 @@ Subscribes to data changes of the rotation vector sensor. If this API is called
| options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. | | options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. |
**Example** **Example**
``` ```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,function(data){
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -573,7 +574,7 @@ Subscribes to data changes of the wear detection sensor. If this API is called m ...@@ -573,7 +574,7 @@ Subscribes to data changes of the wear detection sensor. If this API is called m
| options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. | | options | [Options](#options) | No | Interval at which the callback is invoked to return the sensor data. The default value is 200,000,000 ns. |
**Example** **Example**
``` ```js
sensor.on(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION,function(data){ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION,function(data){
console.info('Wear status: ' + data.value); console.info('Wear status: ' + data.value);
}, },
...@@ -599,7 +600,7 @@ Subscribes to only one data change of the acceleration sensor. ...@@ -599,7 +600,7 @@ Subscribes to only one data change of the acceleration sensor.
| callback | Callback&lt;[AccelerometerResponse](#accelerometerresponse)&gt; | Yes | One-shot callback used to return the acceleration sensor data. The reported data type in the callback is **AccelerometerResponse**.| | callback | Callback&lt;[AccelerometerResponse](#accelerometerresponse)&gt; | Yes | One-shot callback used to return the acceleration sensor data. The reported data type in the callback is **AccelerometerResponse**.|
**Example** **Example**
``` ```js
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER,function(data){ sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER,function(data){
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -626,7 +627,7 @@ Subscribes to only one data change of the linear acceleration sensor. ...@@ -626,7 +627,7 @@ Subscribes to only one data change of the linear acceleration sensor.
| callback | Callback&lt;[LinearAccelerometerResponse](#linearaccelerometerresponse)&gt; | Yes | One-shot callback used to return the linear acceleration sensor data. The reported data type in the callback is **LinearAccelerometerResponse**.| | callback | Callback&lt;[LinearAccelerometerResponse](#linearaccelerometerresponse)&gt; | Yes | One-shot callback used to return the linear acceleration sensor data. The reported data type in the callback is **LinearAccelerometerResponse**.|
**Example** **Example**
``` ```js
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, function(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -681,7 +682,7 @@ Subscribes to only one data change of the gravity sensor. ...@@ -681,7 +682,7 @@ Subscribes to only one data change of the gravity sensor.
| callback | Callback&lt;[GravityResponse](#gravityresponse)&gt; | Yes | One-shot callback used to return the gravity sensor data. The reported data type in the callback is **GravityResponse**.| | callback | Callback&lt;[GravityResponse](#gravityresponse)&gt; | Yes | One-shot callback used to return the gravity sensor data. The reported data type in the callback is **GravityResponse**.|
**Example** **Example**
``` ```js
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, function(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -708,7 +709,7 @@ Subscribes to only one data change of the gyroscope sensor. ...@@ -708,7 +709,7 @@ Subscribes to only one data change of the gyroscope sensor.
| callback | Callback&lt;[GyroscopeResponse](#gyroscoperesponse)&gt; | Yes | One-shot callback used to return the gyroscope sensor data. The reported data type in the callback is **GyroscopeResponse**.| | callback | Callback&lt;[GyroscopeResponse](#gyroscoperesponse)&gt; | Yes | One-shot callback used to return the gyroscope sensor data. The reported data type in the callback is **GyroscopeResponse**.|
**Example** **Example**
``` ```js
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, function(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -735,7 +736,7 @@ Subscribes to only one data change of the uncalibrated gyroscope sensor. ...@@ -735,7 +736,7 @@ Subscribes to only one data change of the uncalibrated gyroscope sensor.
| callback | Callback&lt;[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)&gt; | Yes | One-shot callback used to return the uncalibrated gyroscope sensor data. The reported data type in the callback is **GyroscopeUncalibratedResponse**.| | callback | Callback&lt;[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)&gt; | Yes | One-shot callback used to return the uncalibrated gyroscope sensor data. The reported data type in the callback is **GyroscopeUncalibratedResponse**.|
**Example** **Example**
``` ```js
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, function(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -763,7 +764,7 @@ Subscribes to only one data change of the significant motion sensor. ...@@ -763,7 +764,7 @@ Subscribes to only one data change of the significant motion sensor.
| callback | Callback&lt;[SignificantMotionResponse](#significantmotionresponse)&gt; | Yes | One-shot callback used to return the significant motion sensor data. The reported data type in the callback is **SignificantMotionResponse**.| | callback | Callback&lt;[SignificantMotionResponse](#significantmotionresponse)&gt; | Yes | One-shot callback used to return the significant motion sensor data. The reported data type in the callback is **SignificantMotionResponse**.|
**Example** **Example**
``` ```js
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, function(data) {
console.info('Scalar data: ' + data.scalar); console.info('Scalar data: ' + data.scalar);
} }
...@@ -788,7 +789,7 @@ Subscribes to only one data change of the pedometer detection sensor. ...@@ -788,7 +789,7 @@ Subscribes to only one data change of the pedometer detection sensor.
| callback | Callback&lt;[PedometerDetectionResponse](#pedometerdetectionresponse)&gt; | Yes | One-shot callback used to return the pedometer detection sensor data. The reported data type in the callback is **PedometerDetectionResponse**.| | callback | Callback&lt;[PedometerDetectionResponse](#pedometerdetectionresponse)&gt; | Yes | One-shot callback used to return the pedometer detection sensor data. The reported data type in the callback is **PedometerDetectionResponse**.|
**Example** **Example**
``` ```js
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, function(data) {
console.info('Scalar data: ' + data.scalar); console.info('Scalar data: ' + data.scalar);
} }
...@@ -813,7 +814,7 @@ Subscribes to only one data change of the pedometer sensor. ...@@ -813,7 +814,7 @@ Subscribes to only one data change of the pedometer sensor.
| callback | Callback&lt;[PedometerResponse](#pedometerresponse)&gt; | Yes | One-shot callback used to return the pedometer sensor data. The reported data type in the callback is **PedometerResponse**.| | callback | Callback&lt;[PedometerResponse](#pedometerresponse)&gt; | Yes | One-shot callback used to return the pedometer sensor data. The reported data type in the callback is **PedometerResponse**.|
**Example** **Example**
``` ```js
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, function(data) {
console.info('Steps: ' + data.steps); console.info('Steps: ' + data.steps);
} }
...@@ -836,7 +837,7 @@ Subscribes to only one data change of the ambient temperature sensor. ...@@ -836,7 +837,7 @@ Subscribes to only one data change of the ambient temperature sensor.
| callback | Callback&lt;[AmbientTemperatureResponse](#ambienttemperatureresponse)&gt; | Yes | One-shot callback used to return the ambient temperature sensor data. The reported data type in the callback is **AmbientTemperatureResponse**.| | callback | Callback&lt;[AmbientTemperatureResponse](#ambienttemperatureresponse)&gt; | Yes | One-shot callback used to return the ambient temperature sensor data. The reported data type in the callback is **AmbientTemperatureResponse**.|
**Example** **Example**
``` ```js
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, function(data) {
console.info('Temperature: ' + data.temperature); console.info('Temperature: ' + data.temperature);
} }
...@@ -859,7 +860,7 @@ Subscribes to only one data change of the magnetic field sensor. ...@@ -859,7 +860,7 @@ Subscribes to only one data change of the magnetic field sensor.
| callback | Callback&lt;[MagneticFieldResponse](#magneticfieldresponse)&gt; | Yes | One-shot callback used to return the magnetic field sensor data. The reported data type in the callback is **MagneticFieldResponse**.| | callback | Callback&lt;[MagneticFieldResponse](#magneticfieldresponse)&gt; | Yes | One-shot callback used to return the magnetic field sensor data. The reported data type in the callback is **MagneticFieldResponse**.|
**Example** **Example**
``` ```js
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, function(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -884,7 +885,7 @@ Subscribes to only one data change of the uncalibrated magnetic field sensor. ...@@ -884,7 +885,7 @@ Subscribes to only one data change of the uncalibrated magnetic field sensor.
| callback | Callback&lt;[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)&gt; | Yes | One-shot callback used to return the uncalibrated magnetic field sensor data. The reported data type in the callback is **MagneticFieldUncalibratedResponse**.| | callback | Callback&lt;[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)&gt; | Yes | One-shot callback used to return the uncalibrated magnetic field sensor data. The reported data type in the callback is **MagneticFieldUncalibratedResponse**.|
**Example** **Example**
``` ```js
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, function(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -912,7 +913,7 @@ Subscribes to only one data change of the proximity sensor. ...@@ -912,7 +913,7 @@ Subscribes to only one data change of the proximity sensor.
| callback | Callback&lt;[ProximityResponse](#proximityresponse)&gt; | Yes | One-shot callback used to return the proximity sensor data. The reported data type in the callback is **ProximityResponse**.| | callback | Callback&lt;[ProximityResponse](#proximityresponse)&gt; | Yes | One-shot callback used to return the proximity sensor data. The reported data type in the callback is **ProximityResponse**.|
**Example** **Example**
``` ```js
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, function(error, data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, function(error, data) {
if (error) { if (error) {
console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message); console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message);
...@@ -939,7 +940,7 @@ Subscribes to only one data change of the humidity sensor. ...@@ -939,7 +940,7 @@ Subscribes to only one data change of the humidity sensor.
| callback | Callback&lt;[HumidityResponse](#humidityresponse)&gt; | Yes | One-shot callback used to return the humidity sensor data. The reported data type in the callback is **HumidityResponse**.| | callback | Callback&lt;[HumidityResponse](#humidityresponse)&gt; | Yes | One-shot callback used to return the humidity sensor data. The reported data type in the callback is **HumidityResponse**.|
**Example** **Example**
``` ```js
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, function(data) {
console.info('Humidity: ' + data.humidity); console.info('Humidity: ' + data.humidity);
} }
...@@ -962,7 +963,7 @@ Subscribes to only one data change of the barometer sensor. ...@@ -962,7 +963,7 @@ Subscribes to only one data change of the barometer sensor.
| callback | Callback&lt;[BarometerResponse](#barometerresponse)&gt; | Yes | One-shot callback used to return the barometer sensor data. The reported data type in the callback is **BarometerResponse**.| | callback | Callback&lt;[BarometerResponse](#barometerresponse)&gt; | Yes | One-shot callback used to return the barometer sensor data. The reported data type in the callback is **BarometerResponse**.|
**Example** **Example**
``` ```js
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, function(data) {
console.info('Atmospheric pressure: ' + data.pressure); console.info('Atmospheric pressure: ' + data.pressure);
} }
...@@ -985,7 +986,7 @@ Subscribes to only one data change of the Hall effect sensor. ...@@ -985,7 +986,7 @@ Subscribes to only one data change of the Hall effect sensor.
| callback | Callback&lt;[HallResponse](#hallresponse)&gt; | Yes | One-shot callback used to return the Hall effect sensor data. The reported data type in the callback is **HallResponse**.| | callback | Callback&lt;[HallResponse](#hallresponse)&gt; | Yes | One-shot callback used to return the Hall effect sensor data. The reported data type in the callback is **HallResponse**.|
**Example** **Example**
``` ```js
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HALL, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HALL, function(data) {
console.info('Status: ' + data.status); console.info('Status: ' + data.status);
} }
...@@ -1008,7 +1009,7 @@ Subscribes to only one data change of the ambient light sensor. ...@@ -1008,7 +1009,7 @@ Subscribes to only one data change of the ambient light sensor.
| callback | Callback&lt;[LightResponse](#lightresponse)&gt; | Yes | One-shot callback used to return the ambient light sensor data. The reported data type in the callback is **LightResponse**.| | callback | Callback&lt;[LightResponse](#lightresponse)&gt; | Yes | One-shot callback used to return the ambient light sensor data. The reported data type in the callback is **LightResponse**.|
**Example** **Example**
``` ```js
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, function(data) {
console.info(' Illumination: ' + data.intensity); console.info(' Illumination: ' + data.intensity);
} }
...@@ -1031,7 +1032,7 @@ Subscribes to only one data change of the orientation sensor. ...@@ -1031,7 +1032,7 @@ Subscribes to only one data change of the orientation sensor.
| callback | Callback&lt;[OrientationResponse](#orientationresponse)&gt; | Yes | One-shot callback used to return the orientation sensor data. The reported data type in the callback is **OrientationResponse**.| | callback | Callback&lt;[OrientationResponse](#orientationresponse)&gt; | Yes | One-shot callback used to return the orientation sensor data. The reported data type in the callback is **OrientationResponse**.|
**Example** **Example**
``` ```js
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, function(data) {
console.info('The device rotates at an angle around the X axis: ' + data.beta); console.info('The device rotates at an angle around the X axis: ' + data.beta);
console.info('The device rotates at an angle around the Y axis: ' + data.gamma); console.info('The device rotates at an angle around the Y axis: ' + data.gamma);
...@@ -1056,7 +1057,7 @@ Subscribes to only one data change of the rotation vector sensor. ...@@ -1056,7 +1057,7 @@ Subscribes to only one data change of the rotation vector sensor.
| callback | Callback&lt;[RotationVectorResponse](#rotationvectorresponse)&gt; | Yes | One-shot callback used to return the rotation vector sensor data. The reported data type in the callback is **RotationVectorResponse**.| | callback | Callback&lt;[RotationVectorResponse](#rotationvectorresponse)&gt; | Yes | One-shot callback used to return the rotation vector sensor data. The reported data type in the callback is **RotationVectorResponse**.|
**Example** **Example**
``` ```js
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, function(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -1084,7 +1085,7 @@ Subscribes to only one data change of the heart rate sensor. ...@@ -1084,7 +1085,7 @@ Subscribes to only one data change of the heart rate sensor.
| callback | Callback&lt;[HeartRateResponse](#heartrateresponse)&gt; | Yes | One-shot callback used to return the heart rate sensor data. The reported data type in the callback is **HeartRateResponse**.| | callback | Callback&lt;[HeartRateResponse](#heartrateresponse)&gt; | Yes | One-shot callback used to return the heart rate sensor data. The reported data type in the callback is **HeartRateResponse**.|
**Example** **Example**
``` ```js
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE, function(data) {
console.info("Heart rate: " + data.heartRate); console.info("Heart rate: " + data.heartRate);
} }
...@@ -1107,7 +1108,7 @@ Subscribes to only one data change of the wear detection sensor. ...@@ -1107,7 +1108,7 @@ Subscribes to only one data change of the wear detection sensor.
| callback | Callback&lt;[WearDetectionResponse](#weardetectionresponse)&gt; | Yes | One-shot callback used to return the wear detection sensor data. The reported data type in the callback is **WearDetectionResponse**.| | callback | Callback&lt;[WearDetectionResponse](#weardetectionresponse)&gt; | Yes | One-shot callback used to return the wear detection sensor data. The reported data type in the callback is **WearDetectionResponse**.|
**Example** **Example**
``` ```js
sensor.once(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, function(data) { sensor.once(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, function(data) {
console.info("Wear status: "+ data.value); console.info("Wear status: "+ data.value);
} }
...@@ -1133,7 +1134,7 @@ Unsubscribes from sensor data changes. ...@@ -1133,7 +1134,7 @@ Unsubscribes from sensor data changes.
**Example** **Example**
``` ```js
function callback(data) { function callback(data) {
console.info('x-coordinate component: ' + data.x); console.info('x-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -1161,7 +1162,7 @@ Unsubscribes from sensor data changes. ...@@ -1161,7 +1162,7 @@ Unsubscribes from sensor data changes.
**Example** **Example**
``` ```js
function callback(data) { function callback(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -1190,7 +1191,7 @@ Unsubscribes from sensor data changes. ...@@ -1190,7 +1191,7 @@ Unsubscribes from sensor data changes.
**Example** **Example**
``` ```js
function callback(data) { function callback(data) {
console.info(' Illumination: ' + data.intensity); console.info(' Illumination: ' + data.intensity);
} }
...@@ -1214,7 +1215,7 @@ Unsubscribes from sensor data changes. ...@@ -1214,7 +1215,7 @@ Unsubscribes from sensor data changes.
**Example** **Example**
``` ```js
function callback(data) { function callback(data) {
console.info('Temperature: ' + data.temperature); console.info('Temperature: ' + data.temperature);
} }
...@@ -1238,7 +1239,7 @@ Unsubscribes from sensor data changes. ...@@ -1238,7 +1239,7 @@ Unsubscribes from sensor data changes.
**Example** **Example**
``` ```js
function callback(data) { function callback(data) {
console.info('Atmospheric pressure: ' + data.pressure); console.info('Atmospheric pressure: ' + data.pressure);
} }
...@@ -1262,7 +1263,7 @@ Unsubscribes from sensor data changes. ...@@ -1262,7 +1263,7 @@ Unsubscribes from sensor data changes.
**Example** **Example**
``` ```js
function callback(data) { function callback(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -1290,7 +1291,7 @@ Unsubscribes from sensor data changes. ...@@ -1290,7 +1291,7 @@ Unsubscribes from sensor data changes.
**Example** **Example**
``` ```js
function callback(data) { function callback(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -1318,7 +1319,7 @@ Unsubscribes from sensor data changes. ...@@ -1318,7 +1319,7 @@ Unsubscribes from sensor data changes.
**Example** **Example**
``` ```js
function callback(data) { function callback(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -1344,7 +1345,7 @@ Unsubscribes from sensor data changes. ...@@ -1344,7 +1345,7 @@ Unsubscribes from sensor data changes.
**Example** **Example**
``` ```js
function callback(data) { function callback(data) {
console.info('Status: ' + data.status); console.info('Status: ' + data.status);
} }
...@@ -1370,7 +1371,7 @@ Unsubscribes from sensor data changes. ...@@ -1370,7 +1371,7 @@ Unsubscribes from sensor data changes.
**Example** **Example**
``` ```js
function callback(data) { function callback(data) {
console.info("Heart rate: " + data.heartRate); console.info("Heart rate: " + data.heartRate);
} }
...@@ -1396,7 +1397,7 @@ Unsubscribes from sensor data changes. ...@@ -1396,7 +1397,7 @@ Unsubscribes from sensor data changes.
**Example** **Example**
``` ```js
function callback(data) { function callback(data) {
console.info('Humidity: ' + data.humidity); console.info('Humidity: ' + data.humidity);
} }
...@@ -1422,7 +1423,7 @@ Unsubscribes from sensor data changes. ...@@ -1422,7 +1423,7 @@ Unsubscribes from sensor data changes.
**Example** **Example**
``` ```js
function callback(data) { function callback(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -1450,7 +1451,7 @@ Unsubscribes from sensor data changes. ...@@ -1450,7 +1451,7 @@ Unsubscribes from sensor data changes.
**Example** **Example**
``` ```js
function callback(data) { function callback(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -1476,7 +1477,7 @@ Unsubscribes from sensor data changes. ...@@ -1476,7 +1477,7 @@ Unsubscribes from sensor data changes.
**Example** **Example**
``` ```js
function callback(data) { function callback(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -1505,7 +1506,7 @@ Unsubscribes from sensor data changes. ...@@ -1505,7 +1506,7 @@ Unsubscribes from sensor data changes.
**Example** **Example**
``` ```js
function callback(data) { function callback(data) {
console.info('The device rotates at an angle around the X axis: ' + data.beta); console.info('The device rotates at an angle around the X axis: ' + data.beta);
console.info('The device rotates at an angle around the Y axis: ' + data.gamma); console.info('The device rotates at an angle around the Y axis: ' + data.gamma);
...@@ -1529,9 +1530,9 @@ Unsubscribes from sensor data changes. ...@@ -1529,9 +1530,9 @@ Unsubscribes from sensor data changes.
| type | [SensorType](#sensortype) | Yes | Type of the sensor to unsubscribe from, which is **SENSOR_TYPE_ID_PEDOMETER**. | | type | [SensorType](#sensortype) | Yes | Type of the sensor to unsubscribe from, which is **SENSOR_TYPE_ID_PEDOMETER**. |
| callback | Callback&lt;[PedometerResponse](#pedometerresponse)&gt; | Yes | Callback used to return the pedometer sensor data. The reported data type in the callback is **PedometerResponse**.| | callback | Callback&lt;[PedometerResponse](#pedometerresponse)&gt; | Yes | Callback used to return the pedometer sensor data. The reported data type in the callback is **PedometerResponse**.|
**Return value** **Example**
``` ```js
function callback(data) { function callback(data) {
console.info('Steps: ' + data.steps); console.info('Steps: ' + data.steps);
} }
...@@ -1557,7 +1558,7 @@ Unsubscribes from sensor data changes. ...@@ -1557,7 +1558,7 @@ Unsubscribes from sensor data changes.
**Example** **Example**
``` ```js
function callback(data) { function callback(data) {
console.info('Scalar data: ' + data.scalar); console.info('Scalar data: ' + data.scalar);
} }
...@@ -1581,7 +1582,7 @@ Unsubscribes from sensor data changes. ...@@ -1581,7 +1582,7 @@ Unsubscribes from sensor data changes.
**Example** **Example**
``` ```js
function callback(data) { function callback(data) {
console.info('Distance: ' + data.distance); console.info('Distance: ' + data.distance);
} }
...@@ -1605,7 +1606,7 @@ Unsubscribes from sensor data changes. ...@@ -1605,7 +1606,7 @@ Unsubscribes from sensor data changes.
**Example** **Example**
``` ```js
function callback(data) { function callback(data) {
console.info('X-coordinate component: ' + data.x); console.info('X-coordinate component: ' + data.x);
console.info('Y-coordinate component: ' + data.y); console.info('Y-coordinate component: ' + data.y);
...@@ -1632,7 +1633,7 @@ Unsubscribes from sensor data changes. ...@@ -1632,7 +1633,7 @@ Unsubscribes from sensor data changes.
**Example** **Example**
``` ```js
function callback(data) { function callback(data) {
console.info('Scalar data: ' + data.scalar); console.info('Scalar data: ' + data.scalar);
} }
...@@ -1656,7 +1657,7 @@ Unsubscribes from sensor data changes. ...@@ -1656,7 +1657,7 @@ Unsubscribes from sensor data changes.
**Example** **Example**
``` ```js
function accCallback(data) { function accCallback(data) {
console.info('Wear status: ' + data.value); console.info('Wear status: ' + data.value);
} }
...@@ -1681,13 +1682,13 @@ Rotates a rotation vector so that it can represent the coordinate system in diff ...@@ -1681,13 +1682,13 @@ Rotates a rotation vector so that it can represent the coordinate system in diff
**Example** **Example**
``` ```js
sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], {'axisX':2, 'axisY':3}, function(err, data) { sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], {x:2, y:3}, function(err, data) {
if (err) { if (err) {
console.error("Operation failed. Error code: " + err.code + ", message: " + err.message); console.error("Operation failed. Error code: " + err.code + ", message: " + err.message);
return; return;
} }
console.info("Operation successed. Data obtained: " + data.x); console.info("Operation successed. Data obtained: " + data);
for (var i=0; i < data.length; i++) { for (var i=0; i < data.length; i++) {
console.info("transformCoordinateSystem data[ " + i + "] = " + data[i]); console.info("transformCoordinateSystem data[ " + i + "] = " + data[i]);
} }
...@@ -1716,8 +1717,8 @@ Rotates a rotation vector so that it can represent the coordinate system in diff ...@@ -1716,8 +1717,8 @@ Rotates a rotation vector so that it can represent the coordinate system in diff
**Example** **Example**
``` ```js
const promise = sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], {'axisX':2, 'axisY':3}); const promise = sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], {x:2, y:3});
promise.then((data) => { promise.then((data) => {
console.info("Operation successed."); console.info("Operation successed.");
for (var i=0; i < data.length; i++) { for (var i=0; i < data.length; i++) {
...@@ -1744,8 +1745,8 @@ Obtains the geomagnetic field of a geographic location. This API uses a callback ...@@ -1744,8 +1745,8 @@ Obtains the geomagnetic field of a geographic location. This API uses a callback
| callback | AsyncCallback&lt;[GeomagneticResponse](#geomagneticresponse)&gt; | Yes | Callback used to return the geomagnetic field. | | callback | AsyncCallback&lt;[GeomagneticResponse](#geomagneticresponse)&gt; | Yes | Callback used to return the geomagnetic field. |
**Example** **Example**
``` ```js
sensor.getGeomagneticField([80, 0, 0], 1580486400000, function(err, data) { sensor.getGeomagneticField({latitude:80, longitude:0, altitude:0}, 1580486400000, function(err, data) {
if (err) { if (err) {
console.error('Operation failed. Error code: ' + err.code + '; message: ' + err.message); console.error('Operation failed. Error code: ' + err.code + '; message: ' + err.message);
return; return;
...@@ -1774,9 +1775,10 @@ Obtains the geomagnetic field of a geographic location. This API uses a promise ...@@ -1774,9 +1775,10 @@ Obtains the geomagnetic field of a geographic location. This API uses a promise
| ---------------------------------------- | ------- | | ---------------------------------------- | ------- |
| Promise&lt;[GeomagneticResponse](#geomagneticresponse)&gt; | Promise used to return the geomagnetic field.| | Promise&lt;[GeomagneticResponse](#geomagneticresponse)&gt; | Promise used to return the geomagnetic field.|
**Return value** **Example**
```
const promise = sensor.getGeomagneticField([80, 0, 0], 1580486400000); ```js
const promise = sensor.getGeomagneticField({latitude:80, longitude:0, altitude:0}, 1580486400000);
promise.then((data) => { promise.then((data) => {
console.info('sensor_getGeomagneticField_promise x: ' + data.x + ',y: ' + data.y + ',z: ' + console.info('sensor_getGeomagneticField_promise x: ' + data.x + ',y: ' + data.y + ',z: ' +
data.z + ',geomagneticDip: ' + data.geomagneticDip + ',deflectionAngle: ' + data.deflectionAngle + data.z + ',geomagneticDip: ' + data.geomagneticDip + ',deflectionAngle: ' + data.deflectionAngle +
...@@ -1802,9 +1804,9 @@ Obtains the altitude at which the device is located based on the sea-level atmos ...@@ -1802,9 +1804,9 @@ Obtains the altitude at which the device is located based on the sea-level atmos
| currentPressure | number | Yes | Atmospheric pressure at the altitude where the device is located, in hPa.| | currentPressure | number | Yes | Atmospheric pressure at the altitude where the device is located, in hPa.|
| callback | AsyncCallback&lt;number&gt; | Yes | Callback used to return the altitude, in meters. | | callback | AsyncCallback&lt;number&gt; | Yes | Callback used to return the altitude, in meters. |
**Return value** **Example**
``` ```js
sensor.getAltitude(0, 200, function(err, data) { sensor.getAltitude(0, 200, function(err, data) {
if (err) { if (err) {
console.error( console.error(
...@@ -1836,9 +1838,9 @@ Obtains the altitude at which the device is located based on the sea-level atmos ...@@ -1836,9 +1838,9 @@ Obtains the altitude at which the device is located based on the sea-level atmos
| --------------------- | ------------------ | | --------------------- | ------------------ |
| Promise&lt;number&gt; | Promise used to return the altitude, in meters.| | Promise&lt;number&gt; | Promise used to return the altitude, in meters.|
**Return value** **Example**
``` ```js
const promise = sensor.getAltitude(0, 200); const promise = sensor.getAltitude(0, 200);
promise.then((data) => { promise.then((data) => {
console.info(' sensor_getAltitude_Promise success', data); console.info(' sensor_getAltitude_Promise success', data);
...@@ -1863,12 +1865,12 @@ Obtains the magnetic dip based on the inclination matrix. This API uses a callba ...@@ -1863,12 +1865,12 @@ Obtains the magnetic dip based on the inclination matrix. This API uses a callba
| inclinationMatrix | Array&lt;number&gt; | Yes | Inclination matrix. | | inclinationMatrix | Array&lt;number&gt; | Yes | Inclination matrix. |
| callback | AsyncCallback&lt;number&gt; | Yes | Callback used to return the magnetic dip, in radians.| | callback | AsyncCallback&lt;number&gt; | Yes | Callback used to return the magnetic dip, in radians.|
**Return value** **Example**
``` ```js
sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1], function(err, data) { sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1], function(err, data) {
if (err) { if (err) {
console.error(LABEL + 'SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' + console.error('SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' +
err.message); err.message);
return; return;
} }
...@@ -1896,9 +1898,9 @@ Obtains the magnetic dip based on the inclination matrix. This API uses a promis ...@@ -1896,9 +1898,9 @@ Obtains the magnetic dip based on the inclination matrix. This API uses a promis
| --------------------- | -------------- | | --------------------- | -------------- |
| Promise&lt;number&gt; | Promise used to return the magnetic dip, in radians.| | Promise&lt;number&gt; | Promise used to return the magnetic dip, in radians.|
**Return value** **Example**
``` ```js
const promise = sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1]); const promise = sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1]);
promise.then((data) => { promise.then((data) => {
console.info(' getGeomagneticDip_promise successed', data); console.info(' getGeomagneticDip_promise successed', data);
...@@ -1923,12 +1925,12 @@ Obtains the angle change between two rotation matrices. This API uses a callback ...@@ -1923,12 +1925,12 @@ Obtains the angle change between two rotation matrices. This API uses a callback
| preRotationMatrix | Array&lt;number&gt; | Yes | The other rotation matrix. | | preRotationMatrix | Array&lt;number&gt; | Yes | The other rotation matrix. |
| callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | Yes | Callback used to return the angle change around the z, x, and y axes.| | callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | Yes | Callback used to return the angle change around the z, x, and y axes.|
**Return value** **Example**
``` ```js
sensor. getAngleModify([1,0,0,0,1,0,0,0,1], [1, 0, 0, 0, 0.87, -0.50, 0, 0.50, 0.87], function(err, data) { sensor. getAngleModify([1,0,0,0,1,0,0,0,1], [1, 0, 0, 0, 0.87, -0.50, 0, 0.50, 0.87], function(err, data) {
if (err) { if (err) {
console.error(LABEL + 'Failed to register data, error code is: ' + err.code + ', message: ' + console.error('Failed to register data, error code is: ' + err.code + ', message: ' +
err.message); err.message);
return; return;
} }
...@@ -1961,12 +1963,12 @@ Obtains the angle change between two rotation matrices. This API uses a promise ...@@ -1961,12 +1963,12 @@ Obtains the angle change between two rotation matrices. This API uses a promise
| ---------------------------------- | ------------------ | | ---------------------------------- | ------------------ |
| Promise&lt;Array&lt;number&gt;&gt; | Promise used to return the angle change around the z, x, and y axes.| | Promise&lt;Array&lt;number&gt;&gt; | Promise used to return the angle change around the z, x, and y axes.|
**Return value** **Example**
``` ```js
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]); const promise = sensor.getAngleModify([1,0,0,0,1,0,0,0,1], [1,0,0,0,0.87,-0.50,0,0.50,0.87]);
promise.then((data) => { promise.then((data) => {
console.info(LABEL + 'getAngleModifiy_promise success'); console.info('getAngleModifiy_promise success');
for (var i=0; i < data.length; i++) { for (var i=0; i < data.length; i++) {
console.info(LABEL + "data[" + i + "]: " + data[i]); console.info(LABEL + "data[" + i + "]: " + data[i]);
} }
...@@ -1991,12 +1993,12 @@ Converts a rotation vector into a rotation matrix. This API uses a callback to r ...@@ -1991,12 +1993,12 @@ Converts a rotation vector into a rotation matrix. This API uses a callback to r
| rotationVector | Array&lt;number&gt; | Yes | Rotation vector to convert.| | rotationVector | Array&lt;number&gt; | Yes | Rotation vector to convert.|
| callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | Yes | Callback used to return the rotation matrix.| | callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | Yes | Callback used to return the rotation matrix.|
**Return value** **Example**
``` ```js
sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877], function(err, data) { sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877], function(err, data) {
if (err) { if (err) {
console.error(LABEL + 'SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' + console.error('SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' +
err.message); err.message);
return; return;
} }
...@@ -2028,12 +2030,12 @@ Converts a rotation vector into a rotation matrix. This API uses a promise to re ...@@ -2028,12 +2030,12 @@ Converts a rotation vector into a rotation matrix. This API uses a promise to re
| ---------------------------------- | ------- | | ---------------------------------- | ------- |
| Promise&lt;Array&lt;number&gt;&gt; | Promise used to return the rotation matrix.| | Promise&lt;Array&lt;number&gt;&gt; | Promise used to return the rotation matrix.|
**Return value** **Example**
``` ```js
const promise = sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877]); const promise = sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877]);
promise.then((data) => { promise.then((data) => {
console.info(LABEL + 'createRotationMatrix_promise success'); console.info('createRotationMatrix_promise success');
for (var i=0; i < data.length; i++) { for (var i=0; i < data.length; i++) {
console.info(LABEL + "data[" + i + "]: " + data[i]); console.info(LABEL + "data[" + i + "]: " + data[i]);
} }
...@@ -2058,12 +2060,12 @@ Converts a rotation vector into a quaternion. This API uses a callback to return ...@@ -2058,12 +2060,12 @@ Converts a rotation vector into a quaternion. This API uses a callback to return
| rotationVector | Array&lt;number&gt; | Yes | Rotation vector to convert.| | rotationVector | Array&lt;number&gt; | Yes | Rotation vector to convert.|
| callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | Yes | Callback used to return the quaternion. | | callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | Yes | Callback used to return the quaternion. |
**Return value** **Example**
``` ```js
sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877], function(err, data) { sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877], function(err, data) {
if (err) { if (err) {
console.error(LABEL + 'SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' + console.error('SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' +
err.message); err.message);
return; return;
} }
...@@ -2095,14 +2097,14 @@ Converts a rotation vector into a quaternion. This API uses a promise to return ...@@ -2095,14 +2097,14 @@ Converts a rotation vector into a quaternion. This API uses a promise to return
| ---------------------------------- | ------ | | ---------------------------------- | ------ |
| Promise&lt;Array&lt;number&gt;&gt; | Promise used to return the quaternion.| | Promise&lt;Array&lt;number&gt;&gt; | Promise used to return the quaternion.|
**Return value** **Example**
``` ```js
const promise = sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877]); const promise = sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877]);
promise.then((data) => { promise.then((data) => {
console.info('createQuaternion_promise successed'); console.info('createQuaternion_promise successed');
for (var i=0; i < data.length; i++) { for (var i=0; i < data.length; i++) {
console.info(LABEL + "data[" + i + "]: " + data[i]); console.info("data[" + i + "]: " + data[i]);
} }
}).catch((err) => { }).catch((err) => {
console.info('promise failed'); console.info('promise failed');
...@@ -2125,18 +2127,18 @@ Obtains the device direction based on the rotation matrix. This API uses a callb ...@@ -2125,18 +2127,18 @@ Obtains the device direction based on the rotation matrix. This API uses a callb
| rotationMatrix | Array&lt;number&gt; | Yes | Rotation matrix. | | rotationMatrix | Array&lt;number&gt; | Yes | Rotation matrix. |
| callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | Yes | Callback used to return the rotation angle around the z, x, and y axes.| | callback | AsyncCallback&lt;Array&lt;number&gt;&gt; | Yes | Callback used to return the rotation angle around the z, x, and y axes.|
**Return value** **Example**
``` ```js
sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1], function(err, data) { sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1], function(err, data) {
if (err) { if (err) {
console.error(LABEL + 'SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' + console.error('SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' +
err.message); err.message);
return; return;
} }
console.info(LABEL + "SensorJsAPI--->Successed to get getDirection interface get data: " + data.x); console.info("SensorJsAPI--->Successed to get getDirection interface get data: " + data.x);
for (var i = 1; i < data.length; i++) { for (var i = 1; i < data.length; i++) {
console.info(TAG +"sensor_getDirection_callback" + data[i]); console.info("sensor_getDirection_callback" + data[i]);
} }
}) })
``` ```
...@@ -2162,14 +2164,14 @@ Obtains the device direction based on the rotation matrix. This API uses a promi ...@@ -2162,14 +2164,14 @@ Obtains the device direction based on the rotation matrix. This API uses a promi
| ---------------------------------- | ------------------ | | ---------------------------------- | ------------------ |
| Promise&lt;Array&lt;number&gt;&gt; | Promise used to return the rotation angle around the z, x, and y axes.| | Promise&lt;Array&lt;number&gt;&gt; | Promise used to return the rotation angle around the z, x, and y axes.|
**Return value** **Example**
``` ```js
const promise = sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1]); const promise = sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1]);
promise.then((data) => { promise.then((data) => {
console.info(' sensor_getAltitude_Promise success', data.x); console.info('sensor_getAltitude_Promise success', data.x);
for (var i = 1; i < data.length; i++) { for (var i = 1; i < data.length; i++) {
console.info(TAG +"sensor_getDirection_promise" + data[i]); console.info("sensor_getDirection_promise" + data[i]);
} }
}).catch((err) => { }).catch((err) => {
console.info('promise failed'); console.info('promise failed');
...@@ -2193,18 +2195,18 @@ Creates a rotation matrix based on the gravity vector and geomagnetic vector. Th ...@@ -2193,18 +2195,18 @@ Creates a rotation matrix based on the gravity vector and geomagnetic vector. Th
| geomagnetic | Array&lt;number&gt; | Yes | Geomagnetic vector.| | geomagnetic | Array&lt;number&gt; | Yes | Geomagnetic vector.|
| callback | AsyncCallback&lt;[RotationMatrixResponse](#rotationmatrixresponse)&gt; | Yes | Callback used to return the rotation matrix.| | callback | AsyncCallback&lt;[RotationMatrixResponse](#rotationmatrixresponse)&gt; | Yes | Callback used to return the rotation matrix.|
**Return value** **Example**
``` ```js
sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444], function(err, data) { sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444], function(err, data) {
if (err) { if (err) {
console.error(LABEL + 'SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' + console.error('SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' +
err.message); err.message);
return; return;
} }
console.info("SensorJsAPI--->Successed to get createRotationMatrix interface get data: " + data.x); console.info("SensorJsAPI--->Successed to get createRotationMatrix interface get data: " + data.x);
for (var i=0; i < data.length; i++) { for (var i=0; i < data.length; i++) {
console.info(LABEL + "data[" + i + "]: " + data[i]) console.info("data[" + i + "]: " + data[i])
} }
}) })
``` ```
...@@ -2231,17 +2233,17 @@ Creates a rotation matrix based on the gravity vector and geomagnetic vector. Th ...@@ -2231,17 +2233,17 @@ Creates a rotation matrix based on the gravity vector and geomagnetic vector. Th
| ---------------------------------------- | ------- | | ---------------------------------------- | ------- |
| Promise&lt;[RotationMatrixResponse](#rotationmatrixresponse)&gt; | Promise used to return the rotation matrix.| | Promise&lt;[RotationMatrixResponse](#rotationmatrixresponse)&gt; | Promise used to return the rotation matrix.|
**Return value** **Example**
``` ```js
const promise = sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444]); const promise = sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444]);
promise.then((data) => { promise.then((data) => {
console.info(LABEL + 'createRotationMatrix_promise successed'); console.info('createRotationMatrix_promise successed');
for (var i=0; i < data.length; i++) { for (var i=0; i < data.length; i++) {
console.info(LABEL + "data[" + i + "]: " + data[i]); console.info(LABEL + "data[" + i + "]: " + data[i]);
} }
}).catch((err) => { }).catch((err) => {
console.info(LABEL + 'promise failed'); console.info('promise failed');
}) })
``` ```
...@@ -2357,9 +2359,9 @@ Describes the orientation sensor data. It extends from [Response](#response). ...@@ -2357,9 +2359,9 @@ Describes the orientation sensor data. It extends from [Response](#response).
| Name | Type | Readable | Writable | Description | | Name | Type | Readable | Writable | Description |
| ----- | ------ | ---- | ---- | ------------------------ | | ----- | ------ | ---- | ---- | ------------------------ |
| alpha | number | Yes | Yes | Rotation angle of the device around the z-axis, in degrees.| | alpha | number | Yes | Yes | Rotation angle of the device around the z-axis, in rad.|
| beta | number | Yes | Yes | Rotation angle of the device around the x-axis, in degrees. | | beta | number | Yes | Yes | Rotation angle of the device around the x-axis, in rad. |
| gamma | number | Yes | Yes | Rotation angle of the device around the y-axis, in degrees. | | gamma | number | Yes | Yes | Rotation angle of the device around the y-axis, in rad. |
## RotationVectorResponse ## RotationVectorResponse
......
en/application-dev/reference/apis/js-apis-vibrator.md
浏览文件 @ 5beae124
# Vibrator # Vibrator
> ![icon-note.gif](public_sys-resources/icon-note.gif) **Note:** > **NOTE**
>
> The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. > The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
## Modules to Import ## Modules to Import
``` ```js
import vibrator from '@ohos.vibrator'; import vibrator from '@ohos.vibrator';
``` ```
...@@ -25,16 +26,16 @@ Triggers vibration with a specific duration. This API uses a promise to return t ...@@ -25,16 +26,16 @@ Triggers vibration with a specific duration. This API uses a promise to return t
**Parameters** **Parameters**
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | ------ | ---- | ------------ | | -------- | ------ | ---- | ------------ |
| duration | number | Yes | Vibration duration.| | duration | number | Yes | Vibration duration. |
**Return value** **Return value**
| Type | Description | | Type | Description |
| ------------------- | ----------- | | ------------------- | ----------- |
| Promise&lt;void&gt; | Promise used to indicate whether the vibration is triggered successfully.| | Promise&lt;void&gt; | Promise used to indicate whether the vibration is triggered successfully. |
**Example** **Example**
``` ```js
vibrator.vibrate(1000).then(()=>{ vibrator.vibrate(1000).then(()=>{
console.log("Promise returned to indicate a successful vibration."); console.log("Promise returned to indicate a successful vibration.");
}, (error)=>{ }, (error)=>{
...@@ -57,10 +58,10 @@ Triggers vibration with a specific duration. This API uses an asynchronous callb ...@@ -57,10 +58,10 @@ Triggers vibration with a specific duration. This API uses an asynchronous callb
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | ------------------------- | ---- | ----------------------- | | -------- | ------------------------- | ---- | ----------------------- |
| duration | number | Yes | Vibration duration. | | duration | number | Yes | Vibration duration. |
| callback | AsyncCallback&lt;void&gt; | No | Callback used to indicate whether the vibration is triggered successfully.| | callback | AsyncCallback&lt;void&gt; | No | Callback used to indicate whether the vibration is triggered successfully. |
**Example** **Example**
``` ```js
vibrator.vibrate(1000,function(error){ vibrator.vibrate(1000,function(error){
if(error){ if(error){
console.log("error.code"+error.code+"error.message"+error.message); console.log("error.code"+error.code+"error.message"+error.message);
...@@ -84,15 +85,15 @@ Triggers vibration with a specific effect. This API uses a promise to return the ...@@ -84,15 +85,15 @@ Triggers vibration with a specific effect. This API uses a promise to return the
**Parameters** **Parameters**
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | --------------------- | ---- | ------------- | | -------- | --------------------- | ---- | ------------- |
| effectId | [EffectId](#effectid) | Yes | String that indicates the vibration effect.| | effectId | [EffectId](#effectid) | Yes | String that indicates the vibration effect. |
**Return value** **Return value**
| Type | Description | | Type | Description |
| ------------------- | ----------- | | ------------------- | ----------- |
| Promise&lt;void&gt; | Promise used to indicate whether the vibration is triggered successfully.| | Promise&lt;void&gt; | Promise used to indicate whether the vibration is triggered successfully. |
**Example** **Example**
``` ```js
vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER).then(()=>{ vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER).then(()=>{
console.log("Promise returned to indicate a successful vibration."); console.log("Promise returned to indicate a successful vibration.");
}, (error)=>{ }, (error)=>{
...@@ -115,10 +116,10 @@ Triggers vibration with a specific effect. This API uses an asynchronous callbac ...@@ -115,10 +116,10 @@ Triggers vibration with a specific effect. This API uses an asynchronous callbac
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | ------------------------- | ---- | ----------------------- | | -------- | ------------------------- | ---- | ----------------------- |
| effectId | [EffectId](#effectid) | Yes | String that indicates the vibration effect. | | effectId | [EffectId](#effectid) | Yes | String that indicates the vibration effect. |
| callback | AsyncCallback&lt;void&gt; | No | Callback used to indicate whether the vibration is triggered successfully.| | callback | AsyncCallback&lt;void&gt; | No | Callback used to indicate whether the vibration is triggered successfully. |
**Example** **Example**
``` ```js
vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function(error){ vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function(error){
if(error){ if(error){
console.log("error.code"+error.code+"error.message"+error.message); console.log("error.code"+error.code+"error.message"+error.message);
...@@ -142,15 +143,15 @@ Stops the vibration based on the specified **stopMode**. This API uses a promise ...@@ -142,15 +143,15 @@ Stops the vibration based on the specified **stopMode**. This API uses a promise
**Parameters** **Parameters**
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | ------------------------------------- | ---- | --------------- | | -------- | ------------------------------------- | ---- | --------------- |
| stopMode | [VibratorStopMode](#vibratorstopmode) | Yes | Vibration mode to stop.| | stopMode | [VibratorStopMode](#vibratorstopmode) | Yes | Vibration mode to stop. |
**Return value** **Return value**
| Type | Description | | Type | Description |
| ------------------- | ----------- | | ------------------- | ----------- |
| Promise&lt;void&gt; | Promise used to indicate whether the vibration is stopped successfully.| | Promise&lt;void&gt; | Promise used to indicate whether the vibration is stopped successfully. |
**Example** **Example**
``` ```js
vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then(()=>{ vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then(()=>{
console.log("Promise returned to indicate a successful vibration."); console.log("Promise returned to indicate a successful vibration.");
}, (error)=>{ }, (error)=>{
...@@ -173,15 +174,15 @@ Stops the vibration based on the specified **stopMode**. This API uses an asynch ...@@ -173,15 +174,15 @@ Stops the vibration based on the specified **stopMode**. This API uses an asynch
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | ------------------------------------- | ---- | ----------------------- | | -------- | ------------------------------------- | ---- | ----------------------- |
| stopMode | [VibratorStopMode](#vibratorstopmode) | Yes | Vibration mode to stop. | | stopMode | [VibratorStopMode](#vibratorstopmode) | Yes | Vibration mode to stop. |
| callback | AsyncCallback&lt;void&gt; | No | Callback used to indicate whether the vibration is stopped successfully.| | callback | AsyncCallback&lt;void&gt; | No | Callback used to indicate whether the vibration is stopped successfully. |
**Example** **Example**
``` ```js
vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET, function(error){ vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET, function(error){
if(error){ if(error){
console.log("error.code"+error.code+"error.message"+error.message); console.log("error.code"+error.code+"error.message"+error.message);
}else{ }else{
console.log("Callback returned to indicate a successful stop."); console.log("Callback returned to indicate successful.");
} }
}) })
``` ```
...@@ -194,8 +195,8 @@ Describes the vibration effect. ...@@ -194,8 +195,8 @@ Describes the vibration effect.
**System capability**: SystemCapability.Sensors.MiscDevice **System capability**: SystemCapability.Sensors.MiscDevice
| Name | Default Value | Description | | Name | Default Value | Description |
| ------------------ | -------------------- | --------------- | | ------------------ | -------------------- | --------------------------------------------------------------- |
| EFFECT_CLOCK_TIMER | "haptic.clock.timer" | Vibration effect of the vibrator when a user adjusts the timer.| | EFFECT_CLOCK_TIMER | "haptic.clock.timer" | Vibration effect of the vibrator when a user adjusts the timer. |
## VibratorStopMode ## VibratorStopMode
...@@ -206,5 +207,5 @@ Describes the vibration mode to stop. ...@@ -206,5 +207,5 @@ Describes the vibration mode to stop.
| Name | Default Value | Description | | Name | Default Value | Description |
| ------------------------- | -------- | ---------------------------------------- | | ------------------------- | -------- | ---------------------------------------- |
| VIBRATOR_STOP_MODE_TIME | "time" | The vibration to stop is in **duration** mode. This vibration is triggered with the parameter **duration** of the **number** type.| | VIBRATOR_STOP_MODE_TIME | "time" | The vibration to stop is in **duration** mode. This vibration is triggered with the parameter **duration** of the **number** type. |
| VIBRATOR_STOP_MODE_PRESET | "preset" | The vibration to stop is in **EffectId** mode. This vibration is triggered with the parameter **effectId** of the **EffectId** type.| | VIBRATOR_STOP_MODE_PRESET | "preset" | The vibration to stop is in **EffectId** mode. This vibration is triggered with the parameter **effectId** of the **EffectId** type. |
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或