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 d22706b127d02eca6495ee5b5a8b792be6c3700b..e0c09e2c461c4cb98974a705a933f282b4852393 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-sensor.md +++ b/zh-cn/application-dev/reference/apis/js-apis-sensor.md @@ -54,12 +54,14 @@ on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<Acceler ); ``` -### LINEAR_ACCELERATION +### LINEAR_ACCELERATIONdeprecated on(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<LinearAccelerometerResponse>, options?: Options): void 监听线性加速度传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。 +从API Version9开始该接口不再维护,推荐使用[LINEAR_ACCELEROMETER](#sensor.on.LINEAR_ACCELEROMETER) + **需要权限**:ohos.permission.ACCELEROMETER ,该权限为系统权限 **系统能力**:SystemCapability.Sensors.Sensor @@ -82,6 +84,36 @@ on(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<Line ); ``` +### LINEAR_ACCELEROMETER + +on(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELEROMETER,callback:Callback<LinearAccelerometerResponse>, options?: Options): void + +监听线性加速度传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。 + +从API Version9开始支持。 + +**需要权限**:ohos.permission.ACCELEROMETER,该权限为系统权限 + +**系统能力**:SystemCapability.Sensors.Sensor + +**参数:** +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ---------------------------------------- | +| type | [SensorType](#sensortype) | 是 | 要订阅的线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELEROMETER。 | +| callback | Callback<[LinearAccelerometerResponse](#linearaccelerometerresponse)> | 是 | 注册线性加速度传感器的回调函数,上报的数据类型为LinearAccelerometerResponse。 | +| options | [Options](#options) | 否 | 可选参数列表,设置上报频率,默认值为200000000ns。 | + +**示例:** + ```js + sensor.on(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELEROMETER,function(data){ + console.info('X-coordinate component: ' + data.x); + console.info('Y-coordinate component: ' + data.y); + console.info('Z-coordinate component: ' + data.z); + }, + {interval: 10000000} + ); + ``` + ### ACCELEROMETER_UNCALIBRATED on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback<AccelerometerUncalibratedResponse>, options?: Options): void @@ -499,12 +531,14 @@ on(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<Orientatio ); ``` -### HEART_RATE +### HEART_RATEdeprecated on(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback<HeartRateResponse>, options?: Options): void 监听心率传感器数据变化一次。 +从API Version9开始该接口不再维护,推荐使用[HEART_BEAT_RATE](#sensor.on.HEART_BEAT_RATE) + **需要权限**:ohos.permission.READ_HEALTH_DATA **系统能力**:SystemCapability.Sensors.Sensor @@ -526,6 +560,35 @@ sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE,function(data){ ); ``` +### HEART_BEAT_RATE + +on(type: SensorType.SENSOR_TYPE_ID_HEART_BEAT_RATE, callback: Callback<HeartRateResponse>, options?: Options): void + +监听心率传感器数据变化一次。 + +从API Version9开始支持。 + +**需要权限**:ohos.permission.READ_HEALTH_DATA + +**系统能力**:SystemCapability.Sensors.Sensor + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ---------------------------------------- | +| type | [SensorType](#sensortype) | 是 | 要订阅的心率传感器类型为SENSOR_TYPE_ID_HEART_BEAT_RATE。 | +| callback | Callback<[HeartRateResponse](#heartrateresponse)> | 是 | 注册一次心率传感器的回调函数,上报的数据类型为HeartRateResponse。 | + +**示例:** + +```js +sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HEART_BEAT_RATE,function(data){ + console.info("Heart rate: " + data.heartRate); +}, + {interval: 10000000} +); +``` + ### ROTATION_VECTOR on(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,callback: Callback<RotationVectorResponse>,options?: Options): void @@ -605,12 +668,14 @@ once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<Accele ); ``` -### LINEAR_ACCELERATION +### LINEAR_ACCELERATIONdeprecated once(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<LinearAccelerometerResponse>): void 监听线性加速度传感器数据变化一次。 +从API Version9开始该接口不再维护,推荐使用[LINEAR_ACCELEROMETER](#sensor.once.LINEAR_ACCELEROMETER) + **需要权限**:ohos.permission.ACCELEROMETER ,该权限为系统权限 **系统能力**:SystemCapability.Sensors.Sensor @@ -631,6 +696,34 @@ once(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<Li ); ``` +### LINEAR_ACCELEROMETER + +once(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELEROMETER,callback:Callback<LinearAccelerometerResponse>): void + +监听线性加速度传感器数据变化一次。 + +从API Version9开始支持。 + +**需要权限**:ohos.permission.ACCELEROMETER ,该权限为系统权限 + +**系统能力**:SystemCapability.Sensors.Sensor + +**参数:** +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ---------------------------------------- | +| type | [SensorType](#sensortype) | 是 | 线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELEROMETER。 | +| callback | Callback<[LinearAccelerometerResponse](#linearaccelerometerresponse)> | 是 | 注册一次线性加速度传感器的回调函数,上报的数据类型为LinearAccelerometerResponse。 | + +**示例:** + ```js + sensor.once(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELEROMETER, function(data) { + console.info('X-coordinate component: ' + data.x); + console.info('Y-coordinate component: ' + data.y); + console.info('Z-coordinate component: ' + data.z); + } + ); + ``` + ### ACCELEROMETER_UNCALIBRATED once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback<AccelerometerUncalibratedResponse>): void @@ -1041,12 +1134,14 @@ once(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback: Callback<Rota ); ``` -### HEART_RATE +### HEART_RATEdeprecated once(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback<HeartRateResponse>): void 监听心率传感器数据变化一次。 +从API Version9开始该接口不再维护,推荐使用[HEART_BEAT_RATE](#sensor.once.HEART_BEAT_RATE) + **需要权限**:ohos.permission.READ_HEALTH_DATA **系统能力**:SystemCapability.Sensors.Sensor @@ -1065,6 +1160,32 @@ once(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback<HeartRate ); ``` +### HEART_BEAT_RATE + +once(type: SensorType.SENSOR_TYPE_ID_HEART_BEAT_RATE, callback: Callback<HeartRateResponse>): void + +监听心率传感器数据变化一次。 + +从API Version9开始支持。 + +**需要权限**:ohos.permission.READ_HEALTH_DATA + +**系统能力**:SystemCapability.Sensors.Sensor + +**参数:** +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ---------------------------------------- | +| type | [SensorType](#sensortype) | 是 | 心率传感器类型为SENSOR_TYPE_ID_HEART_BEAT_RATE。 | +| callback | Callback<[HeartRateResponse](#heartrateresponse)> | 是 | 注册一次心率传感器的回调函数,上报的数据类型为HeartRateResponse。 | + +**示例:** + ```js + sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HEART_BEAT_RATE, function(data) { + console.info("Heart rate: " + data.heartRate); + } + ); + ``` + ### WEAR_DETECTION once(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback<WearDetectionResponse>): void @@ -1326,12 +1447,14 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_HALL, callback); ``` -### HEART_RATE +### HEART_RATEdeprecated off(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback?: Callback<HeartRateResponse>): void 取消订阅传感器数据。 +从API Version9开始该接口不再维护,推荐使用[HEART_BEAT_RATE](#sensor.off.HEART_BEAT_RATE) + **需要权限**:ohos.permission.READ_HEALTH_DATA **系统能力**:SystemCapability.Sensors.Sensor @@ -1352,6 +1475,34 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_HEART_RATE, callback); ``` +### HEART_BEAT_RATE + +off(type: SensorType.SENSOR_TYPE_ID_HEART_BEAT_RATE, callback?: Callback<HeartRateResponse>): void + +取消订阅传感器数据。 + +从API Version9开始支持。 + +**需要权限**:ohos.permission.READ_HEALTH_DATA + +**系统能力**:SystemCapability.Sensors.Sensor + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ---------------------------------------- | +| type | [SensorType](#sensortype)[SensorType](#sensortype) | 是 | 要取消订阅的心率传感器类型为SENSOR_TYPE_ID_HEART_BEAT_RATE。 | +| callback | Callback<[HeartRateResponse](#heartrateresponse)> | 是 | 取消注册一次心率传感器的回调函数,上报的数据类型为HeartRateResponse。 | + +**示例:** + +```js +function callback(data) { + console.info("Heart rate: " + data.heartRate); +} +sensor.off(sensor.SensorType.SENSOR_TYPE_ID_HEART_BEAT_RATE, callback); +``` + ### HUMIDITY off(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback?: Callback<HumidityResponse>): void @@ -1376,12 +1527,14 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, callback); ``` -### LINEAR_ACCELERATION +### LINEAR_ACCELERATIONdeprecated off(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback?: Callback<LinearAccelerometerResponse>): void 取消订阅传感器数据。 +从API Version9开始该接口不再维护,推荐使用[LINEAR_ACCELEROMETER](#sensor.off.LINEAR_ACCELEROMETER) + **需要权限**:ohos.permission.ACCELEROMETER,该权限为系统权限 **系统能力**:SystemCapability.Sensors.Sensor @@ -1404,6 +1557,36 @@ function callback(data) { sensor.off(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback); ``` +### LINEAR_ACCELEROMETER + +off(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELEROMETER, callback?: Callback<LinearAccelerometerResponse>): void + +取消订阅传感器数据。 + +从API Version9开始支持。 + +**需要权限**:ohos.permission.ACCELEROMETER,该权限为系统权限 + +**系统能力**:SystemCapability.Sensors.Sensor + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ---------------------------------------- | +| type | [SensorType](#sensortype) | 是 | 要取消订阅的线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELEROMETER。 | +| callback | Callback<[LinearAccelerometerResponse](#linearaccelerometerresponse)> | 是 | 取消注册性加速度传感器的回调函数,上报的数据类型为LinearAccelerometerResponse。 | + +**示例:** + +```js +function callback(data) { + console.info('X-coordinate component: ' + data.x); + console.info('Y-coordinate component: ' + data.y); + console.info('Z-coordinate component: ' + data.z); +} +sensor.off(sensor.SensorType.SENSOR_TYPE_ID_LINEAR_ACCELEROMETER, callback); +``` + ### MAGNETIC_FIELD off(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback?: Callback<MagneticFieldResponse>): void @@ -2234,7 +2417,8 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number& | SENSOR_TYPE_ID_HUMIDITY | 13 | 湿度传感器。 | | SENSOR_TYPE_ID_ORIENTATION | 256 | 方向传感器。 | | SENSOR_TYPE_ID_GRAVITY | 257 | 重力传感器。 | -| SENSOR_TYPE_ID_LINEAR_ACCELERATION | 258 | 线性加速度传感器。 | +| SENSOR_TYPE_ID_LINEAR_ACCELERATIONdeprecated | 258 | 线性加速度传感器。 | +| SENSOR_TYPE_ID_LINEAR_ACCELEROMETER | 258 | 线性加速度传感器。 | | SENSOR_TYPE_ID_ROTATION_VECTOR | 259 | 旋转矢量传感器。 | | SENSOR_TYPE_ID_AMBIENT_TEMPERATURE | 260 | 环境温度传感器。 | | SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED | 261 | 未校准磁场传感器。 | @@ -2242,7 +2426,8 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number& | SENSOR_TYPE_ID_SIGNIFICANT_MOTION | 264 | 有效运动传感器。 | | SENSOR_TYPE_ID_PEDOMETER_DETECTION | 265 | 计步检测传感器。 | | SENSOR_TYPE_ID_PEDOMETER | 266 | 计步传感器。 | -| SENSOR_TYPE_ID_HEART_RATE | 278 | 心率传感器。 | +| SENSOR_TYPE_ID_HEART_RATEdeprecated | 278 | 心率传感器。 | +| SENSOR_TYPE_ID_HEART_BEAT_RATE | 278 | 心率传感器。 | | SENSOR_TYPE_ID_WEAR_DETECTION | 280 | 佩戴检测传感器。 | | SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED | 281 | 未校准加速度计传感器。 |