From de332005b6191f145c90bc3b05160c1fd2a90ccf Mon Sep 17 00:00:00 2001 From: cff-gite Date: Tue, 28 Jun 2022 14:53:12 +0800 Subject: [PATCH] =?UTF-8?q?docs=E6=96=87=E4=BB=B6=E4=BF=AE=E6=94=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: cff-gite --- .../reference/apis/js-apis-sensor.md | 472 ++++++++++-------- 1 file changed, 266 insertions(+), 206 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-sensor.md b/zh-cn/application-dev/reference/apis/js-apis-sensor.md index ad3a72baee..084e24ea3f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-sensor.md +++ b/zh-cn/application-dev/reference/apis/js-apis-sensor.md @@ -1,18 +1,17 @@ # 传感器 -> **说明：** +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 -```js +``` import sensor from '@ohos.sensor'; ``` -## sensor.on -### ACCELEROMETER +## sensor.on(SensorType.SENSOR_TYPE_ID_ACCELEROMETER) on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<AccelerometerResponse>,options?: Options): void @@ -31,7 +30,7 @@ on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<Acceler | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 | **示例：** - ```js + ``` sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER,function(data){ console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -41,7 +40,8 @@ on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<Acceler ); ``` -### LINEAR_ACCELERATION + +## sensor.on(SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION) on(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<LinearAccelerometerResponse>, options?: Options): void @@ -59,7 +59,7 @@ on(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<Line | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 | **示例：** - ```js + ``` sensor.on(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,function(data){ console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -69,7 +69,8 @@ on(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<Line ); ``` -### ACCELEROMETER_UNCALIBRATED + +## sensor.on(SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED) on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback<AccelerometerUncalibratedResponse>, options?: Options): void @@ -80,6 +81,7 @@ on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback **系统能力**：SystemCapability.Sensors.Sensor **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ---------------------------------------- | | type | [SensorType](#sensortype) | 是 | 要订阅的未校准加速度计传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 | @@ -87,7 +89,7 @@ on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 | **示例：** - ```js + ``` sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,function(data){ console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -100,7 +102,8 @@ on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback ); ``` -### GRAVITY + +## sensor.on(SensorType.SENSOR_TYPE_ID_GRAVITY) on(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback<GravityResponse>,options?: Options): void @@ -116,7 +119,7 @@ on(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback<GravityRespons | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 | **示例：** - ```js + ``` sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY,function(data){ console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -126,7 +129,8 @@ on(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback<GravityRespons ); ``` -### GYROSCOPE + +## sensor.on(SensorType.SENSOR_TYPE_ID_GYROSCOPE) on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback<GyroscopeResponse>, options?: Options): void @@ -144,7 +148,7 @@ on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback<GyroscopeRes | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 | **示例：** - ```js + ``` sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE,function(data){ console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -154,7 +158,8 @@ on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback<GyroscopeRes ); ``` -### GYROSCOPE_UNCALIBRATED + +## sensor.on(SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED) on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback:Callback<GyroscopeUncalibratedResponse>, options?: Options): void @@ -172,7 +177,7 @@ on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback:Callback<G | options | [Options](#options) | 否 | 可选参数列表，设置上报频率。 | **示例：** - ```js + ``` sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,function(data){ console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -185,7 +190,8 @@ on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback:Callback<G ); ``` -### SIGNIFICANT_MOTION + +## sensor.on(SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION) on(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback: Callback<SignificantMotionResponse>, options?: Options): void @@ -201,7 +207,7 @@ on(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback: Callback<Sig | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 | **示例：** - ```js + ``` sensor.on(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,function(data){ console.info('Scalar data: ' + data.scalar); }, @@ -209,7 +215,8 @@ on(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback: Callback<Sig ); ``` -### PEDOMETER_DETECTION + +## sensor.on(SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION) on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback: Callback<PedometerDetectionResponse>, options?: Options): void @@ -227,7 +234,7 @@ on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback: Callback<Pe | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 | **示例：** - ```js + ``` sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,function(data){ console.info('Scalar data: ' + data.scalar); }, @@ -235,7 +242,8 @@ on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback: Callback<Pe ); ``` -### PEDOMETER + +## sensor.on(SensorType.SENSOR_TYPE_ID_PEDOMETER) on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback<PedometerResponse>, options?: Options): void @@ -253,7 +261,7 @@ on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback<PedometerRes | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 | **示例：** - ```js + ``` sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER,function(data){ console.info('Steps: ' + data.steps); }, @@ -261,7 +269,8 @@ on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback<PedometerRes ); ``` -### AMBIENT_TEMPERATURE + +## sensor.on(SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE) on(type:SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback:Callback<AmbientTemperatureResponse>, options?: Options): void @@ -277,7 +286,7 @@ on(type:SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback:Callback<Ambie | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 | **示例：** - ```js + ``` sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,function(data){ console.info('Temperature: ' + data.temperature); }, @@ -285,7 +294,8 @@ on(type:SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback:Callback<Ambie ); ``` -### MAGNETIC_FIELD + +## sensor.on(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD) on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback<MagneticFieldResponse>,options?: Options): void @@ -301,7 +311,7 @@ on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback<Magneti | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 | **示例：** - ```js + ``` sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD,function(data){ console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -311,7 +321,8 @@ on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback<Magneti ); ``` -### MAGNETIC_FIELD_UNCALIBRATED + +## sensor.on(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED) on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callback<MagneticFieldUncalibratedResponse>, options?: Options): void @@ -327,7 +338,7 @@ on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callbac | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 | **示例：** - ```js + ``` sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,function(data){ console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -340,7 +351,8 @@ on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callbac ); ``` -### PROXIMITY + +## sensor.on(SensorType.SENSOR_TYPE_ID_PROXIMITY) on(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback<ProximityResponse>,options?: Options): void @@ -356,7 +368,7 @@ on(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback<ProximityRes | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 | **示例：** - ```js + ``` sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY,function(data){ console.info('Distance: ' + data.distance); }, @@ -364,7 +376,8 @@ on(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback<ProximityRes ); ``` -### HUMIDITY + +## sensor.on(SensorType.SENSOR_TYPE_ID_HUMIDITY) on(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback<HumidityResponse>,options?: Options): void @@ -380,7 +393,7 @@ on(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback<HumidityRespo | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 | **示例：** - ```js + ``` sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY,function(data){ console.info('Humidity: ' + data.humidity); }, @@ -388,7 +401,8 @@ on(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback<HumidityRespo ); ``` -### BAROMETER + +## sensor.on(SensorType.SENSOR_TYPE_ID_BAROMETER) on(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback<BarometerResponse>,options?: Options): void @@ -404,7 +418,7 @@ on(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback<BarometerRes | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 | **示例：** - ```js + ``` sensor.on(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER,function(data){ console.info('Atmospheric pressure: ' + data.pressure); }, @@ -412,7 +426,8 @@ on(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback<BarometerRes ); ``` -### HALL + +## sensor.on(SensorType.SENSOR_TYPE_ID_HALL) on(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback<HallResponse>, options?: Options): void @@ -428,7 +443,8 @@ on(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback<HallResponse>, | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 | **示例：** - ```js + + ``` sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HALL,function(data){ console.info('Status: ' + data.status); }, @@ -436,7 +452,8 @@ on(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback<HallResponse>, ); ``` -### AMBIENT_LIGHT + +## sensor.on(SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT) on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback<LightResponse>, options?: Options): void @@ -452,7 +469,7 @@ on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback<LightRes | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 | **示例：** - ```js + ``` sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT,function(data){ console.info(' Illumination: ' + data.intensity); }, @@ -460,7 +477,32 @@ on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback<LightRes ); ``` -### ORIENTATION +## sensor.on(SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE) + +on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback: Callback<AmbientTemperatureResponse>, options?: Options): void + +订阅传感器数据，如果 API 被多次调用，则最后一次调用生效 + +**系统能力**：SystemCapability.Sensors.Sensor + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| type | [SensorType](#sensortype) | 是 | 环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 | +| callback | Callback<[AmbientTemperatureResponse](#ambienttemperatureresponse)> | 是 | 注册一次环境温度传感器的回调函数，上报的数据类型为AmbientTemperatureResponse。 | + +**示例：** + +``` +sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, function(data) { + console.info('Temperature: ' + data.temperature); + } + {interval: 10000000} +); +``` + +## sensor.on(SensorType.SENSOR_TYPE_ID_ORIENTATION) on(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<OrientationResponse>, options?: Options): void @@ -469,6 +511,7 @@ on(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<Orientatio **系统能力**：SystemCapability.Sensors.Sensor **参数：** + | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ---------------------------------------- | | type | [SensorType](#sensortype) | 是 | 要订阅的方向传感器类型为SENSOR_TYPE_ID_ORIENTATION | @@ -476,7 +519,8 @@ on(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<Orientatio | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 | **示例：** - ```js + + ``` 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 Y axis: ' + data.gamma); @@ -486,7 +530,7 @@ on(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<Orientatio ); ``` -### HEART_RATE +## sensor.on(SensorType.SENSOR_TYPE_ID_HEART_RATE) on(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback<HeartRateResponse>, options?: Options): void @@ -505,7 +549,7 @@ on(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback<HeartRateRe **示例：** -```js +``` sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE,function(data){ console.info("Heart rate: " + data.heartRate); }, @@ -513,7 +557,7 @@ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE,function(data){ ); ``` -### ROTATION_VECTOR +## sensor.on(SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR) on(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,callback: Callback<RotationVectorResponse>,options?: Options): void @@ -529,7 +573,7 @@ on(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,callback: Callback<Rotatio | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 | **示例：** - ```js + ``` sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,function(data){ console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -540,7 +584,8 @@ on(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,callback: Callback<Rotatio ); ``` -### WEAR_DETECTION + +## sensor.on(SensorType.SENSOR_TYPE_ID_WEAR_DETECTION) on(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback<WearDetectionResponse>,options?: Options): void @@ -556,7 +601,7 @@ on(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback<WearDet | options | [Options](#options) | 否 | 可选参数列表，设置上报频率，默认值为200000000ns。 | **示例：** - ```js + ``` sensor.on(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION,function(data){ console.info('Wear status: ' + data.value); }, @@ -564,9 +609,8 @@ on(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback<WearDet ); ``` -## sensor.once -### ACCELEROMETER +## sensor.once(SensorType.SENSOR_TYPE_ID_ACCELEROMETER) once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<AccelerometerResponse>): void @@ -583,7 +627,7 @@ once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<Accele | callback | Callback<[AccelerometerResponse](#accelerometerresponse)> | 是 | 注册一次加速度传感器的回调函数，上报的数据类型为AccelerometerResponse。 | **示例：** - ```js + ``` sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER,function(data){ console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -592,7 +636,8 @@ once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<Accele ); ``` -### LINEAR_ACCELERATION + +## sensor.once(SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION) once(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<LinearAccelerometerResponse>): void @@ -609,7 +654,7 @@ once(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<Li | callback | Callback<[LinearAccelerometerResponse](#linearaccelerometerresponse)> | 是 | 注册一次线性加速度传感器的回调函数，上报的数据类型为LinearAccelerometerResponse。 | **示例：** - ```js + ``` sensor.once(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, function(data) { console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -618,7 +663,8 @@ once(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<Li ); ``` -### ACCELEROMETER_UNCALIBRATED + +## sensor.once(SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED) once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback<AccelerometerUncalibratedResponse>): void @@ -647,7 +693,8 @@ once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callba ); ``` -### GRAVITY + +## sensor.once(SensorType.SENSOR_TYPE_ID_GRAVITY) once(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback<GravityResponse>): void @@ -662,7 +709,7 @@ once(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback<GravityRespo | callback | Callback<[GravityResponse](#gravityresponse)> | 是 | 注册一次重力传感器的回调函数，上报的数据类型为GravityResponse。 | **示例：** - ```js + ``` sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, function(data) { console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -671,7 +718,8 @@ once(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback<GravityRespo ); ``` -### GYROSCOPE + +## sensor.once(SensorType.SENSOR_TYPE_ID_GYROSCOPE) once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback<GyroscopeResponse>): void @@ -688,7 +736,7 @@ once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback<GyroscopeR | callback | Callback<[GyroscopeResponse](#gyroscoperesponse)> | 是 | 注册一次陀螺仪传感器的回调函数，上报的数据类型为GyroscopeResponse。 | **示例：** - ```js + ``` sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, function(data) { console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -697,7 +745,8 @@ once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback<GyroscopeR ); ``` -### GYROSCOPE_UNCALIBRATED + +## sensor.once(SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED) once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback: Callback<GyroscopeUncalibratedResponse>): void @@ -714,7 +763,7 @@ once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback: Callback&l | callback | Callback<[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)> | 是 | 注册一次未校准陀螺仪传感器的回调函数，上报的数据类型为GyroscopeUncalibratedResponse。 | **示例：** - ```js + ``` sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, function(data) { console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -726,7 +775,8 @@ once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback: Callback&l ); ``` -### SIGNIFICANT_MOTION + +## sensor.once(SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION) once(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,callback: Callback<SignificantMotionResponse>): void @@ -741,14 +791,15 @@ once(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,callback: Callback<Si | callback | Callback<[SignificantMotionResponse](#significantmotionresponse)> | 是 | 注册一次有效运动传感器的回调函数，上报的数据类型为SignificantMotionResponse。 | **示例：** - ```js + ``` sensor.once(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, function(data) { console.info('Scalar data: ' + data.scalar); } ); ``` -### PEDOMETER_DETECTION + +## sensor.once(SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION) once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,callback: Callback<PedometerDetectionResponse>): void @@ -765,14 +816,15 @@ once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,callback: Callback<P | callback | Callback<[PedometerDetectionResponse](#pedometerdetectionresponse)> | 是 | 注册一次计步检测传感器的回调函数，上报的数据类型为PedometerDetectionResponse。 | **示例：** - ```js + ``` sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, function(data) { console.info('Scalar data: ' + data.scalar); } ); ``` -### PEDOMETER + +## sensor.once(SensorType.SENSOR_TYPE_ID_PEDOMETER) once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback<PedometerResponse>): void @@ -789,14 +841,15 @@ once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback<PedometerR | callback | Callback<[PedometerResponse](#pedometerresponse)> | 是 | 注册一次计步传感器的回调函数，上报的数据类型为PedometerResponse。 | **示例：** - ```js + ``` sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, function(data) { console.info('Steps: ' + data.steps); } ); ``` -### AMBIENT_TEMPERATURE + +## sensor.once(SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE) once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback: Callback<AmbientTemperatureResponse>): void @@ -811,14 +864,15 @@ once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback: Callback<A | callback | Callback<[AmbientTemperatureResponse](#ambienttemperatureresponse)> | 是 | 注册一次环境温度传感器的回调函数，上报的数据类型为AmbientTemperatureResponse。 | **示例：** - ```js + ``` sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, function(data) { console.info('Temperature: ' + data.temperature); } ); ``` -### MAGNETIC_FIELD + +## sensor.once(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD) once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback<MagneticFieldResponse>): void @@ -833,7 +887,7 @@ once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback<Magne | callback | Callback<[MagneticFieldResponse](#magneticfieldresponse)> | 是 | 注册一次磁场传感器的回调函数，上报的数据类型为MagneticFieldResponse。 | **示例：** - ```js + ``` sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, function(data) { console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -842,7 +896,8 @@ once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback<Magne ); ``` -### MAGNETIC_FIELD_UNCALIBRATED + +## sensor.once(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED) once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callback<MagneticFieldUncalibratedResponse>): void @@ -857,7 +912,7 @@ once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callb | callback | Callback<[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)> | 是 | 注册一次未校准磁场传感器的回调函数，上报的数据类型为MagneticFieldUncalibratedResponse。 | **示例：** - ```js + ``` sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, function(data) { console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -869,7 +924,8 @@ once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callb ); ``` -### PROXIMITY + +## sensor.once(SensorType.SENSOR_TYPE_ID_PROXIMITY) once(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback<ProximityResponse>): void @@ -884,7 +940,7 @@ once(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback<ProximityR | callback | Callback<[ProximityResponse](#proximityresponse)> | 是 | 注册一次接近光传感器的回调函数，上报的数据类型为ProximityResponse。 | **示例：** - ```js + ``` sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, function(error, data) { if (error) { console.error("Subscription failed. Error code: " + error.code + "; message: " + error.message); @@ -895,7 +951,8 @@ once(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback<ProximityR ); ``` -### HUMIDITY + +## sensor.once(SensorType.SENSOR_TYPE_ID_HUMIDITY) once(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback<HumidityResponse>): void @@ -910,14 +967,15 @@ once(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback<HumidityRes | callback | Callback<[HumidityResponse](#humidityresponse)> | 是 | 注册一次湿度传感器的回调函数，上报的数据类型为HumidityResponse。 | **示例：** - ```js + ``` sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, function(data) { console.info('Humidity: ' + data.humidity); } ); ``` -### BAROMETER + +## sensor.once(SensorType.SENSOR_TYPE_ID_BAROMETER) once(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback<BarometerResponse>): void @@ -932,14 +990,15 @@ once(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback<BarometerR | callback | Callback<[BarometerResponse](#barometerresponse)> | 是 | 注册一次气压计传感器的回调函数，上报的数据类型为BarometerResponse。 | **示例：** - ```js + ``` sensor.once(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, function(data) { console.info('Atmospheric pressure: ' + data.pressure); } ); ``` -### HALL + +## sensor.once(SensorType.SENSOR_TYPE_ID_HALL) once(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback<HallResponse>): void @@ -954,14 +1013,15 @@ once(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback<HallResponse> | callback | Callback<[HallResponse](#hallresponse)> | 是 | 注册一次霍尔传感器的回调函数，上报的数据类型为HallResponse。 | **示例：** - ```js + ``` sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HALL, function(data) { console.info('Status: ' + data.status); } ); ``` -### AMBIENT_LIGHT + +## sensor.once(SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT) once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback<LightResponse>): void @@ -976,14 +1036,15 @@ once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback<LightR | callback | Callback<[LightResponse](#lightresponse)> | 是 | 注册一次环境光传感器的回调函数，上报的数据类型为LightResponse。 | **示例：** - ```js + ``` sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, function(data) { console.info(' Illumination: ' + data.intensity); } ); ``` -### ORIENTATION + +## sensor.once(SensorType.SENSOR_TYPE_ID_ORIENTATION) once(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<OrientationResponse>): void @@ -998,7 +1059,7 @@ once(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<Orientat | callback | Callback<[OrientationResponse](#orientationresponse)> | 是 | 注册一次方向传感器的回调函数，上报的数据类型为OrientationResponse。 | **示例：** - ```js + ``` 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 Y axis: ' + data.gamma); @@ -1007,7 +1068,8 @@ once(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<Orientat ); ``` -### ROTATION_VECTOR + +## sensor.once(SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR) once(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback: Callback<RotationVectorResponse>): void @@ -1022,7 +1084,7 @@ once(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback: Callback<Rota | callback | Callback<[RotationVectorResponse](#rotationvectorresponse)> | 是 | 注册一次旋转矢量传感器的回调函数，上报的数据类型为RotationVectorResponse。 | **示例：** - ```js + ``` sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, function(data) { console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -1032,7 +1094,8 @@ once(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback: Callback<Rota ); ``` -### HEART_RATE + +## sensor.once(SensorType.SENSOR_TYPE_ID_HEART_RATE) once(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback<HeartRateResponse>): void @@ -1049,14 +1112,15 @@ once(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback<HeartRate | callback | Callback<[HeartRateResponse](#heartrateresponse)> | 是 | 注册一次心率传感器的回调函数，上报的数据类型为HeartRateResponse。 | **示例：** - ```js + ``` sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE, function(data) { console.info("Heart rate: " + data.heartRate); } ); ``` -### WEAR_DETECTION + +## sensor.once(SensorType.SENSOR_TYPE_ID_WEAR_DETECTION) once(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback<WearDetectionResponse>): void @@ -1071,16 +1135,14 @@ once(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback<WearD | callback | Callback<[WearDetectionResponse](#weardetectionresponse)> | 是 | 注册一次穿戴检测传感器的回调函数，上报的数据类型为WearDetectionResponse。 | **示例：** - ```js + ``` sensor.once(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, function(data) { console.info("Wear status: "+ data.value); } ); ``` -## sensor.off - -### ACCELEROMETER +## sensor.off(SensorType.SENSOR_TYPE_ID_ACCELEROMETER) off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback?: Callback<AccelerometerResponse>): void @@ -1099,7 +1161,7 @@ off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback?: Callback<Accele **示例：** -```js +``` function callback(data) { console.info('x-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -1108,7 +1170,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback); ``` -### ACCELEROMETER_UNCALIBRATED +## sensor.off(SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED) off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, callback?: Callback<AccelerometerUncalibratedResponse>): void @@ -1127,7 +1189,7 @@ off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, callback?: Callb **示例：** -```js +``` function callback(data) { console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -1139,7 +1201,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, callback); ``` -### AMBIENT_LIGHT +## sensor.off(SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT) off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback?: Callback<LightResponse>): void @@ -1156,14 +1218,14 @@ off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback?: Callback<LightR **示例：** -```js +``` function callback(data) { console.info(' Illumination: ' + data.intensity); } sensor.off(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback); ``` -### AMBIENT_TEMPERATURE +## sensor.off(SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE) off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback?: Callback<AmbientTemperatureResponse>): void @@ -1180,14 +1242,14 @@ off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback?: Callback< **示例：** -```js +``` function callback(data) { console.info('Temperature: ' + data.temperature); } sensor.off( sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback); ``` -### AMBIENT_TEMPERATURE +## sensor.off(SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE) off(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback?: Callback<BarometerResponse>): void @@ -1204,14 +1266,14 @@ off(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback?: Callback<BarometerR **示例：** -```js +``` function callback(data) { console.info('Atmospheric pressure: ' + data.pressure); } sensor.off(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, callback); ``` -### GRAVITY +## sensor.off(SensorType.SENSOR_TYPE_ID_GRAVITY) off(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback?: Callback<GravityResponse>): void @@ -1228,7 +1290,7 @@ off(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback?: Callback<GravityRespo **示例：** -```js +``` function callback(data) { console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -1237,7 +1299,7 @@ function callback(data) { sensor.off( sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, callback); ``` -### GYROSCOPE +## sensor.off(SensorType.SENSOR_TYPE_ID_GYROSCOPE) off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback?: Callback<GyroscopeResponse>): void @@ -1256,7 +1318,7 @@ off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback?: Callback<GyroscopeR **示例：** -```js +``` function callback(data) { console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -1265,7 +1327,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback); ``` -### GYROSCOPE_UNCALIBRATED +## sensor.off(SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED) off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback?: Callback<GyroscopeUncalibratedResponse>): void @@ -1284,7 +1346,7 @@ off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback?: Callback& **示例：** -```js +``` function callback(data) { console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -1293,7 +1355,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback); ``` -### HALL +## sensor.off(SensorType.SENSOR_TYPE_ID_HALL) off(type: SensorType.SENSOR_TYPE_ID_HALL, callback?: Callback<HallResponse>): void @@ -1310,14 +1372,14 @@ off(type: SensorType.SENSOR_TYPE_ID_HALL, callback?: Callback<HallResponse> **示例：** -```js +``` function callback(data) { console.info('Status: ' + data.status); } sensor.off(sensor.SensorType.SENSOR_TYPE_ID_HALL, callback); ``` -### HEART_RATE +## sensor.off(SensorType.SENSOR_TYPE_ID_HEART_RATE) off(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback?: Callback<HeartRateResponse>): void @@ -1336,21 +1398,19 @@ off(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback?: Callback<HeartRate **示例：** -```js +``` function callback(data) { console.info("Heart rate: " + data.heartRate); } sensor.off(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE, callback); ``` -### HUMIDITY +## sensor.off(SensorType.SENSOR_TYPE_ID_HUMIDITY) off(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback?: Callback<HumidityResponse>): void 取消订阅传感器数据。 -**需要权限**：ohos.permission.READ_HEALTH_DATA，该权限为系统权限 - **系统能力**：SystemCapability.Sensors.Sensor **参数：** @@ -1362,14 +1422,14 @@ off(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback?: Callback<HumidityRes **示例：** -```js +``` function callback(data) { console.info('Humidity: ' + data.humidity); } sensor.off(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, callback); ``` -### LINEAR_ACCELERATION +## sensor.off(SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION) off(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback?: Callback<LinearAccelerometerResponse>): void @@ -1388,7 +1448,7 @@ off(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback?: Callback< **示例：** -```js +``` function callback(data) { console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -1397,14 +1457,12 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback); ``` -### MAGNETIC_FIELD +## sensor.off(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD) off(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback?: Callback<MagneticFieldResponse>): void 取消订阅传感器数据。 -**需要权限**：ohos.permission.ACCELEROMETER，该权限为系统权限 - **系统能力**：SystemCapability.Sensors.Sensor **参数：** @@ -1416,7 +1474,7 @@ sensor.off(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback); **示例：** -```js +``` function callback(data) { console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -1425,7 +1483,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback); ``` -### MAGNETIC_FIELD_UNCALIBRATED +## sensor.off(SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED) off(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, callback?: Callback<MagneticFieldUncalibratedResponse>): void @@ -1442,7 +1500,7 @@ sensor.off(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback); **示例：** -```js +``` function callback(data) { console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -1454,7 +1512,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, callback); ``` -### ORIENTATION +## sensor.off(SensorType.SENSOR_TYPE_ID_ORIENTATION) off(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback?: Callback<OrientationResponse>): void @@ -1464,14 +1522,14 @@ sensor.off(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, callbac **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | ---------------------------------------- | -| type | [SensorType](#sensortype) | 是 | 要取消订阅的方向传感器类型为SENSOR_TYPE_ID_ORIENTATION | -| callback | Callback<[OrientationResponse](#orientationresponse)> | 是 | 取消注册方向传感器的回调函数，上报的数据类型为OrientationResponse。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------------ | +| type | [SensorType](#sensortype) | 是 | 要取消订阅的方向传感器类型为SENSOR_TYPE_ID_ORIENTATION。 | +| callback | Callback<[OrientationResponse](#orientationresponse)> | 是 | 取消注册方向传感器的回调函数，上报的数据类型为OrientationResponse。 | **示例：** -```js +``` 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 Y axis: ' + data.gamma); @@ -1480,12 +1538,14 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, callback); ``` -### PEDOMETER +## sensor.off(SensorType.SENSOR_TYPE_ID_PEDOMETER) off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback?: Callback<PedometerResponse>): void 取消订阅传感器数据。 +**需要权限**：ohos.permission.ACTIVITY_MOTION，该权限为系统权限 + **系统能力**：SystemCapability.Sensors.Sensor **参数：** @@ -1495,16 +1555,16 @@ off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback?: Callback<PedometerR | type | [SensorType](#sensortype) | 是 | 要取消订阅的计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。 | | callback | Callback<[PedometerResponse](#pedometerresponse)> | 是 | 取消注册计步传感器的回调函数，上报的数据类型为PedometerResponse。 | -**示例：** +**返回值：** ; -```js +``` function callback(data) { console.info('Steps: ' + data.steps); } sensor.off(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, callback); ``` -### PEDOMETER_DETECTION +## sensor.off(SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION) off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback?: Callback<PedometerDetectionResponse>): void @@ -1523,14 +1583,14 @@ off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback?: Callback< **示例：** -```js +``` function callback(data) { console.info('Scalar data: ' + data.scalar); } sensor.off(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback); ``` -### PROXIMITY +## sensor.off(SensorType.SENSOR_TYPE_ID_PROXIMITY) off(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback?: Callback<ProximityResponse>): void @@ -1547,14 +1607,14 @@ off(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback?: Callback<ProximityR **示例：** -```js +``` function callback(data) { console.info('Distance: ' + data.distance); } sensor.off(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, callback); ``` -### ROTATION_VECTOR +## sensor.off(SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR) off(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback?: Callback<RotationVectorResponse>): void @@ -1571,7 +1631,7 @@ off(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback?: Callback<Rota **示例：** -```js +``` function callback(data) { console.info('X-coordinate component: ' + data.x); console.info('Y-coordinate component: ' + data.y); @@ -1581,7 +1641,7 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback); ``` -### SIGNIFICANT_MOTION +## sensor.off(SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION) off(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback?: Callback<SignificantMotionResponse>): void @@ -1598,14 +1658,14 @@ off(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback?: Callback<S **示例：** -```js +``` function callback(data) { console.info('Scalar data: ' + data.scalar); } sensor.off(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback); ``` -### WEAR_DETECTION +## sensor.off(SensorType.SENSOR_TYPE_ID_WEAR_DETECTION) off(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback?: Callback<WearDetectionResponse>): void @@ -1622,7 +1682,7 @@ off(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback?: Callback<WearD **示例：** -```js +``` function accCallback(data) { console.info('Wear status: ' + data.value); } @@ -1647,13 +1707,13 @@ transformCoordinateSystem(inRotationVector: Array<number>, coordinates: Co **示例：** -```js -sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], {x:2, y:3}, function(err, data) { +``` +sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], {'axisX':2, 'axisY':3}, function(err, data) { if (err) { console.error("Operation failed. Error code: " + err.code + ", message: " + err.message); return; } - console.info("Operation successed. Data obtained: " + data); + console.info("Operation successed. Data obtained: " + data.x); for (var i=0; i < data.length; i++) { console.info("transformCoordinateSystem data[ " + i + "] = " + data[i]); } @@ -1682,8 +1742,8 @@ transformCoordinateSystem(inRotationVector: Array<number>, coordinates: Co **示例：** -```js -const promise = sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], {x:2, y:3}); +``` +const promise = sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], {'axisX':2, 'axisY':3}); promise.then((data) => { console.info("Operation successed."); for (var i=0; i < data.length; i++) { @@ -1710,8 +1770,8 @@ getGeomagneticField(locationOptions: LocationOptions, timeMillis: number, callba | callback | AsyncCallback<[GeomagneticResponse](#geomagneticresponse)> | 是 | 返回磁场信息。 | **示例：** -```js -sensor.getGeomagneticField({latitude:80, longitude:0, altitude:0}, 1580486400000, function(err, data) { +``` +sensor.getGeomagneticField([80, 0, 0], 1580486400000, function(err, data) { if (err) { console.error('Operation failed. Error code: ' + err.code + '; message: ' + err.message); return; @@ -1740,9 +1800,9 @@ getGeomagneticField(locationOptions: LocationOptions, timeMillis: number): Promi | ---------------------------------------- | ------- | | Promise<[GeomagneticResponse](#geomagneticresponse)> | 返回磁场信息。 | -**示例：** - ```js - const promise = sensor.getGeomagneticField({latitude:80, longitude:0, altitude:0}, 1580486400000); +**返回值：** + ``` + const promise = sensor.getGeomagneticField([80, 0, 0], 1580486400000); promise.then((data) => { console.info('sensor_getGeomagneticField_promise x: ' + data.x + ',y: ' + data.y + ',z: ' + data.z + ',geomagneticDip: ' + data.geomagneticDip + ',deflectionAngle: ' + data.deflectionAngle + @@ -1768,9 +1828,9 @@ getAltitude(seaPressure: number, currentPressure: number, callback: AsyncCallbac | currentPressure | number | 是 | 表示设备所在高度的气压值，单位为hPa。 | | callback | AsyncCallback<number> | 是 | 返回设备所在的海拔高度，单位为米。 | -**示例：** +**返回值：** - ```js + ``` sensor.getAltitude(0, 200, function(err, data) { if (err) { console.error( @@ -1802,9 +1862,9 @@ getAltitude(seaPressure: number, currentPressure: number): Promise<number> | --------------------- | ------------------ | | Promise<number> | 返回设备所在的海拔高度（单位：米）。 | -**示例：** +**返回值：** - ```js + ``` const promise = sensor.getAltitude(0, 200); promise.then((data) => { console.info(' sensor_getAltitude_Promise success', data); @@ -1829,12 +1889,12 @@ getGeomagneticDip(inclinationMatrix: Array<number>, callback: AsyncCallbac | inclinationMatrix | Array<number> | 是 | 表示倾斜矩阵。 | | callback | AsyncCallback<number> | 是 | 返回地磁倾斜角，单位为弧度。 | -**示例：** +**返回值：** - ```js + ``` sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1], function(err, data) { if (err) { - console.error('SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' + + console.error(LABEL + 'SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' + err.message); return; } @@ -1862,9 +1922,9 @@ getGeomagneticDip(inclinationMatrix: Array<number>): Promise<number> | --------------------- | -------------- | | Promise<number> | 返回地磁倾斜角，单位为弧度。 | -**示例：** +**返回值：** - ```js + ``` const promise = sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1]); promise.then((data) => { console.info(' getGeomagneticDip_promise successed', data); @@ -1889,18 +1949,18 @@ getAngleModify(currentRotationMatrix: Array<number>, preRotationMatrix: Ar | preRotationMatrix | Array<number> | 是 | 表示旋转矩阵。 | | callback | AsyncCallback<Array<number>> | 是 | 返回z、x、y轴方向的旋转角度变化。 | -**示例：** +**返回值：** - ```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) { if (err) { - console.error('Failed to register data, error code is: ' + err.code + ', message: ' + + console.error(LABEL + 'Failed to register data, error code is: ' + err.code + ', message: ' + err.message); return; } console.info("SensorJsAPI--->Successed to get getAngleModifiy interface get data: " + data.x); for (var i=0; i < data.length; i++) { - console.info("data[" + i + "]: " + data[i]); + console.info(LABEL + "data[" + i + "]: " + data[i]); } }) ``` @@ -1927,17 +1987,17 @@ getAngleModify(currentRotationMatrix: Array<number>, preRotationMatrix: Ar | ---------------------------------- | ------------------ | | Promise<Array<number>> | 返回z、x、y轴方向的旋转角度变化。 | -**示例：** +**返回值：** - ```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]); promise.then((data) => { - console.info('getAngleModifiy_promise success'); + console.info(LABEL + 'getAngleModifiy_promise success'); for (var i=0; i < data.length; i++) { - console.info("data[" + i + "]: " + data[i]); + console.info(LABEL + "data[" + i + "]: " + data[i]); } }).catch((reason) => { - console.info("promise::catch", reason); + console.info(LABEL + "promise::catch", reason); }) ``` @@ -1957,18 +2017,18 @@ createRotationMatrix(rotationVector: Array<number>, callback: AsyncCallbac | rotationVector | Array<number> | 是 | 表示旋转矢量。 | | callback | AsyncCallback<Array<number>> | 是 | 返回旋转矩阵。 | -**示例：** +**返回值：** - ```js + ``` sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877], function(err, data) { if (err) { - console.error('SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' + + console.error(LABEL + 'SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' + err.message); return; } console.info("SensorJsAPI--->Successed to get createRotationMatrix interface get data: " + data.x); for (var i=0; i < data.length; i++) { - console.info("data[" + i + "]: " + data[i]); + console.info(LABEL + "data[" + i + "]: " + data[i]); } }) ``` @@ -1994,17 +2054,17 @@ createRotationMatrix(rotationVector: Array<number>): Promise<Array<n | ---------------------------------- | ------- | | Promise<Array<number>> | 返回旋转矩阵。 | -**示例：** +**返回值：** - ```js + ``` const promise = sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877]); promise.then((data) => { - console.info('createRotationMatrix_promise success'); + console.info(LABEL + 'createRotationMatrix_promise success'); for (var i=0; i < data.length; i++) { - console.info("data[" + i + "]: " + data[i]); + console.info(LABEL + "data[" + i + "]: " + data[i]); } }).catch((reason) => { - console.info("promise::catch", reason); + console.info(LABEL + "promise::catch", reason); }) ``` @@ -2024,18 +2084,18 @@ createQuaternion(rotationVector: Array<number>, callback: AsyncCallback< | rotationVector | Array<number> | 是 | 表示旋转矢量。 | | callback | AsyncCallback<Array<number>> | 是 | 返回四元数。 | -**示例：** +**返回值：** - ```js + ``` sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877], function(err, data) { if (err) { - console.error('SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' + + console.error(LABEL + 'SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' + err.message); return; } console.info("SensorJsAPI--->Successed to get createQuaternion interface get data: " + data.x); for (var i=0; i < data.length; i++) { - console.info("data[" + i + "]: " + data[i]); + console.info(LABEL + "data[" + i + "]: " + data[i]); } }) ``` @@ -2061,14 +2121,14 @@ createQuaternion(rotationVector: Array<number>): Promise<Array<numbe | ---------------------------------- | ------ | | Promise<Array<number>> | 返回四元数。 | -**示例：** +**返回值：** - ```js + ``` const promise = sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877]); promise.then((data) => { console.info('createQuaternion_promise successed'); for (var i=0; i < data.length; i++) { - console.info("data[" + i + "]: " + data[i]); + console.info(LABEL + "data[" + i + "]: " + data[i]); } }).catch((err) => { console.info('promise failed'); @@ -2091,18 +2151,18 @@ getDirection(rotationMatrix: Array<number>, callback: AsyncCallback<Arr | rotationMatrix | Array<number> | 是 | 表示旋转矩阵。 | | callback | AsyncCallback<Array<number>> | 是 | 返回围绕z、x、y轴方向的旋转角度。 | -**示例：** +**返回值：** - ```js + ``` sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1], function(err, data) { if (err) { - console.error('SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' + + console.error(LABEL + 'SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' + err.message); return; } - console.info("SensorJsAPI--->Successed to get getDirection interface get data: " + data); + console.info(LABEL + "SensorJsAPI--->Successed to get getDirection interface get data: " + data.x); for (var i = 1; i < data.length; i++) { - console.info("sensor_getDirection_callback" + data[i]); + console.info(TAG +"sensor_getDirection_callback" + data[i]); } }) ``` @@ -2128,14 +2188,14 @@ getDirection(rotationMatrix: Array<number>): Promise<Array<number> | ---------------------------------- | ------------------ | | Promise<Array<number>> | 返回围绕z、x、y轴方向的旋转角度。 | -**示例：** +**返回值：** - ```js + ``` const promise = sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1]); promise.then((data) => { - console.info('sensor_getAltitude_Promise success', data); + console.info(' sensor_getAltitude_Promise success', data.x); for (var i = 1; i < data.length; i++) { - console.info("sensor_getDirection_promise" + data[i]); + console.info(TAG +"sensor_getDirection_promise" + data[i]); } }).catch((err) => { console.info('promise failed'); @@ -2159,18 +2219,18 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number& | geomagnetic | Array<number> | 是 | 表示地磁矢量。 | | callback | AsyncCallback<[RotationMatrixResponse](#rotationmatrixresponse)> | 是 | 返回旋转矩阵。 | -**示例：** +**返回值：** - ```js + ``` sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444], function(err, data) { if (err) { - console.error('SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' + + console.error(LABEL + 'SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' + err.message); return; } console.info("SensorJsAPI--->Successed to get createRotationMatrix interface get data: " + data.x); for (var i=0; i < data.length; i++) { - console.info("data[" + i + "]: " + data[i]) + console.info(LABEL + "data[" + i + "]: " + data[i]) } }) ``` @@ -2197,17 +2257,17 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number& | ---------------------------------------- | ------- | | Promise<[RotationMatrixResponse](#rotationmatrixresponse)> | 返回旋转矩阵。 | -**示例：** +**返回值：** - ```js + ``` const promise = sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444]); promise.then((data) => { - console.info('createRotationMatrix_promise successed'); + console.info(LABEL + 'createRotationMatrix_promise successed'); for (var i=0; i < data.length; i++) { - console.info("data[" + i + "]: " + data[i]); + console.info(LABEL + "data[" + i + "]: " + data[i]); } }).catch((err) => { - console.info('promise failed'); + console.info(LABEL + 'promise failed'); }) ``` @@ -2321,11 +2381,11 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number& **系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor -| 名称 | 参数类型 | 可读 | 可写 | 说明 | -| ----- | ------ | ---- | ---- | ----------------- | +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| ----- | ------ | ---- | ---- | ------------------------ | | alpha | number | 是 | 是 | 设备围绕Z轴的旋转角度，单位：度。 | -| beta | number | 是 | 是 | 设备围绕X轴的旋转角度，单位：度。 | -| gamma | number | 是 | 是 | 设备围绕Y轴的旋转角度，单位：度。 | +| beta | number | 是 | 是 | 设备围绕X轴的旋转角度，单位：度。 | +| gamma | number | 是 | 是 | 设备围绕Y轴的旋转角度，单位：度。 | ## RotationVectorResponse -- GitLab