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 5a1c82a1ef495fc852a605e0bc135f19d9a04047..739c2e99d2390413ee84ee90445dc4447e57fa8f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-sensor.md +++ b/zh-cn/application-dev/reference/apis/js-apis-sensor.md @@ -12,8 +12,84 @@ sensor模块提供了获取传感器数据的能力，包括获取传感器属 ```js import sensor from '@ohos.sensor'; ``` +## sensor.on -## sensor.on9+ +### COLOR10+ + +on(type: SensorId.COLOR, callback: Callback\,options?: Options): void + +订阅颜色传感器数据。 + +**系统能力**：SystemCapability.Sensors.Sensor + +**系统API**：此接口为系统接口 + +**错误码**： + +以下错误码的详细介绍请参见 [ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------ | +| 14500101 | Service exception. | + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------------- | ---- | ----------------------------------------------------------- | +| type | [SensorId](#sensorid9).COLOR | 是 | 传感器类型，该值固定为SensorId.COLOR。 | +| callback | Callback<[ColorResponse](#colorresponse)> | 是 | 回调函数，异步上报的传感器数据固定为ColorResponse。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | + +**示例：** + +```js +try { + sensor.on(sensor.SensorId.COLOR, function (data) { + console.info('The intensity of light: ' + data.lightIntensity); + console.info('The color temperature: ' + data.colorTemperature); + }, { interval: 100000000 }); +} catch (err) { + console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message); +} +``` + +### SAR10+ + +on(type: SensorId.SAR, callback: Callback\,options?: Options): void + +订阅吸收比率传感器数据。 + +**系统能力**：SystemCapability.Sensors.Sensor + +**系统API**：此接口为系统接口 + +**错误码**： + +以下错误码的详细介绍请参见[ohos.sensor(传感器)错误码](../errorcodes/errorcode-sensor.md)。 + +| 错误码ID | 错误信息 | +| -------- | ------------------ | +| 14500101 | Service exception. | + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ----------------------------------------------------------- | +| type | [SensorId](#sensorid9).SAR | 是 | 传感器类型，该值固定为SensorId.SAR。 | +| callback | Callback<[SarResponse](#sarresponse)> | 是 | 回调函数，异步上报的传感器数据固定为SarResponse。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | + +**示例：** + +```js +try { + sensor.on(sensor.SensorId.SAR, function (data) { + console.info('Specific absorption rate : ' + data.absorptionRatio); + }, { interval: 100000000 }); +} catch (err) { + console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message); +} +``` ### ACCELEROMETER9+ @@ -31,7 +107,7 @@ on(type: SensorId.ACCELEROMETER, callback: Callback<AccelerometerResponse> | -------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- | | type | [SensorId](#sensorid9).ACCELEROMETER | 是 | 传感器类型，该值固定为SensorId.ACCELEROMETER。 | | callback | Callback<[AccelerometerResponse](#accelerometerresponse)> | 是 | 回调函数，异步上报的传感器数据固定为AccelerometerResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **错误码**： @@ -71,7 +147,7 @@ on(type: SensorId.ACCELEROMETER_UNCALIBRATED, callback: Callback<Acceleromete | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | type | [SensorId](#sensorid9).ACCELEROMETER_UNCALIBRATED | 是 | 传感器类型，该值固定为SensorId.ACCELEROMETER_UNCALIBRATED。 | | callback | Callback<[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)> | 是 | 回调函数，异步上报的传感器数据固定为AccelerometerUncalibratedResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **错误码**： @@ -108,11 +184,11 @@ on(type: SensorId.AMBIENT_LIGHT, callback: Callback<LightResponse>, option **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------------------- | ---- | --------------------------------------------------- | -| type | [SensorId](#sensorid9).AMBIENT_LIGHT | 是 | 传感器类型，该值固定为SensorId.AMBIENT_LIGHT。 | -| callback | Callback<[LightResponse](#lightresponse)> | 是 | 回调函数，异步上报的传感器数据固定为LightResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------------- | ---- | ----------------------------------------------------------- | +| type | [SensorId](#sensorid9).AMBIENT_LIGHT | 是 | 传感器类型，该值固定为SensorId.AMBIENT_LIGHT。 | +| callback | Callback<[LightResponse](#lightresponse)> | 是 | 回调函数，异步上报的传感器数据固定为LightResponse。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **错误码**： @@ -148,7 +224,7 @@ on(type: SensorId.AMBIENT_TEMPERATURE, callback: Callback<AmbientTemperatureR | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | type | [SensorId](#sensorid9).AMBIENT_TEMPERATURE | 是 | 传感器类型，该值固定为SensorId.AMBIENT_TEMPERATURE。 | | callback | Callback<[AmbientTemperatureResponse](#ambienttemperatureresponse)> | 是 | 回调函数，异步上报的传感器数据固定为AmbientTemperatureResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **错误码**： @@ -180,11 +256,11 @@ on(type: SensorId.BAROMETER, callback: Callback<BarometerResponse>, option **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------- | -| type | [SensorId](#sensorid9).BAROMETER | 是 | 传感器类型，该值固定为SensorId.BAROMETER。 | -| callback | Callback<[BarometerResponse](#barometerresponse)> | 是 | 回调函数，异步上报的传感器数据固定为BarometerResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------- | ---- | ----------------------------------------------------------- | +| type | [SensorId](#sensorid9).BAROMETER | 是 | 传感器类型，该值固定为SensorId.BAROMETER。 | +| callback | Callback<[BarometerResponse](#barometerresponse)> | 是 | 回调函数，异步上报的传感器数据固定为BarometerResponse。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **错误码**： @@ -216,11 +292,11 @@ on(type: SensorId.GRAVITY, callback: Callback<GravityResponse>,options?: O **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------------------- | ---- | ----------------------------------------------------- | -| type | [SensorId](#sensorid9).GRAVITY | 是 | 传感器类型，该值固定为SensorId.GRAVITY。 | -| callback | Callback<[GravityResponse](#gravityresponse)> | 是 | 回调函数，异步上报的传感器数据固定为GravityResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------------------- | ---- | ----------------------------------------------------------- | +| type | [SensorId](#sensorid9).GRAVITY | 是 | 传感器类型，该值固定为SensorId.GRAVITY。 | +| callback | Callback<[GravityResponse](#gravityresponse)> | 是 | 回调函数，异步上报的传感器数据固定为GravityResponse。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **错误码**： @@ -256,11 +332,11 @@ on(type: SensorId.GYROSCOPE, callback: Callback<GyroscopeResponse>,options **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------- | -| type | [SensorId](#sensorid9).GYROSCOPE | 是 | 传感器类型，该值固定为SensorId.GYROSCOPE。 | -| callback | Callback<[GyroscopeResponse](#gyroscoperesponse)> | 是 | 回调函数，异步上报的传感器数据固定为GyroscopeResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------- | ---- | ----------------------------------------------------------- | +| type | [SensorId](#sensorid9).GYROSCOPE | 是 | 传感器类型，该值固定为SensorId.GYROSCOPE。 | +| callback | Callback<[GyroscopeResponse](#gyroscoperesponse)> | 是 | 回调函数，异步上报的传感器数据固定为GyroscopeResponse。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **错误码**： @@ -301,7 +377,7 @@ on(type: SensorId.GYROSCOPE_UNCALIBRATED, callback: Callback<GyroscopeUncalib | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | type | [SensorId](#sensorid9).GYROSCOPE_UNCALIBRATED | 是 | 传感器类型，该值固定为SensorId.GYROSCOPE_UNCALIBRATED。 | | callback | Callback<[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)> | 是 | 回调函数，异步上报的传感器数据固定为GyroscopeUncalibratedResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **错误码**： @@ -338,11 +414,11 @@ on(type: SensorId.HALL, callback: Callback<HallResponse>, options?: Option **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------------- | ---- | -------------------------------------------------- | -| type | [SensorId](#sensorid9).HALL | 是 | 传感器类型，该值固定为SensorId.HALL。 | -| callback | Callback<[HallResponse](#hallresponse)> | 是 | 回调函数，异步上报的传感器数据固定为HallResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------------- | ---- | ----------------------------------------------------------- | +| type | [SensorId](#sensorid9).HALL | 是 | 传感器类型，该值固定为SensorId.HALL。 | +| callback | Callback<[HallResponse](#hallresponse)> | 是 | 回调函数，异步上报的传感器数据固定为HallResponse。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **错误码**： @@ -376,11 +452,11 @@ on(type: SensorId.HEART_RATE, callback: Callback<HeartRateResponse>,option **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------- | -| type | [SensorId](#sensorid9).HEART_RATE | 是 | 传感器类型，该值固定为SensorId.HEART_RATE。 | -| callback | Callback<[HeartRateResponse](#heartrateresponse)> | 是 | 回调函数，异步上报的传感器数据固定为HeartRateResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------- | ---- | ----------------------------------------------------------- | +| type | [SensorId](#sensorid9).HEART_RATE | 是 | 传感器类型，该值固定为SensorId.HEART_RATE。 | +| callback | Callback<[HeartRateResponse](#heartrateresponse)> | 是 | 回调函数，异步上报的传感器数据固定为HeartRateResponse。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **错误码**： @@ -412,11 +488,11 @@ on(type: SensorId.HUMIDITY, callback: Callback<HumidityResponse>,options?: **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------ | -| type | [SensorId](#sensorid9).HUMIDITY | 是 | 传感器类型，该值固定为SensorId.HUMIDITY。 | -| callback | Callback<[HumidityResponse](#humidityresponse)> | 是 | 回调函数，异步上报的传感器数据固定为HumidityResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------------------- | ---- | ----------------------------------------------------------- | +| type | [SensorId](#sensorid9).HUMIDITY | 是 | 传感器类型，该值固定为SensorId.HUMIDITY。 | +| callback | Callback<[HumidityResponse](#humidityresponse)> | 是 | 回调函数，异步上报的传感器数据固定为HumidityResponse。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **错误码**： @@ -455,7 +531,7 @@ on(type: SensorId.LINEAR_ACCELEROMETER, callback: Callback<LinearAcceleromete | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | type | [SensorId](#sensorid9).LINEAR_ACCELEROMETER | 是 | 传感器类型，该值固定为SensorId.LINEAR_ACCELEROMETER。 | | callback | Callback<[LinearAccelerometerResponse](#linearaccelerometerresponse)> | 是 | 回调函数，异步上报的传感器数据固定为LinearAccelerometerResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **错误码**： @@ -493,7 +569,7 @@ on(type: SensorId.MAGNETIC_FIELD, callback: Callback<MagneticFieldResponse> | -------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- | | type | [SensorId](#sensorid9).MAGNETIC_FIELD | 是 | 传感器类型，该值固定为SensorId.MAGNETIC_FIELD。 | | callback | Callback<[MagneticFieldResponse](#magneticfieldresponse)> | 是 | 回调函数，异步上报的传感器数据固定为MagneticFieldResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **错误码**： @@ -531,7 +607,7 @@ on(type: SensorId.MAGNETIC_FIELD_UNCALIBRATED, callback: Callback<MagneticFie | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | type | [SensorId](#sensorid9).MAGNETIC_FIELD_UNCALIBRATED | 是 | 传感器类型，该值固定为SensorId.MAGNETIC_FIELD_UNCALIBRATED。 | | callback | Callback<[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)> | 是 | 回调函数，异步上报的传感器数据固定为MagneticFieldUncalibratedResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **错误码**： @@ -576,11 +652,11 @@ on(type: SensorId.ORIENTATION, callback: Callback<OrientationResponse>,opt **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------------------------------- | ---- | --------------------------------------------------------- | -| type | [SensorId](#sensorid9).ORIENTATION | 是 | 传感器类型，该值固定为SensorId.ORIENTATION。 | -| callback | Callback<[OrientationResponse](#orientationresponse)> | 是 | 回调函数，异步上报的传感器数据固定为OrientationResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------------------------- | ---- | ----------------------------------------------------------- | +| type | [SensorId](#sensorid9).ORIENTATION | 是 | 传感器类型，该值固定为SensorId.ORIENTATION。 | +| callback | Callback<[OrientationResponse](#orientationresponse)> | 是 | 回调函数，异步上报的传感器数据固定为OrientationResponse。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **示例：** @@ -616,11 +692,11 @@ on(type: SensorId.PEDOMETER, callback: Callback<PedometerResponse>, option **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------- | -| type | [SensorId](#sensorid9).PEDOMETER | 是 | 传感器类型，该值固定为SensorId.PEDOMETER。 | -| callback | Callback<[PedometerResponse](#pedometerresponse)> | 是 | 回调函数，异步上报的传感器数据固定为PedometerResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------- | ---- | ----------------------------------------------------------- | +| type | [SensorId](#sensorid9).PEDOMETER | 是 | 传感器类型，该值固定为SensorId.PEDOMETER。 | +| callback | Callback<[PedometerResponse](#pedometerresponse)> | 是 | 回调函数，异步上报的传感器数据固定为PedometerResponse。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **示例：** @@ -651,7 +727,7 @@ on(type: SensorId.PEDOMETER_DETECTION, callback: Callback<PedometerDetectionR | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | type | [SensorId](#sensorid9).PEDOMETER_DETECTION | 是 | 传感器类型，该值固定为SensorId.PEDOMETER_DETECTION。 | | callback | Callback<[PedometerDetectionResponse](#pedometerdetectionresponse)> | 是 | 回调函数，异步上报的传感器数据固定为PedometerDetectionResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **错误码**： @@ -683,11 +759,11 @@ on(type: SensorId.PROXIMITY, callback: Callback<ProximityResponse>, option **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------- | -| type | [SensorId](#sensorid9).PROXIMITY | 是 | 传感器类型，该值固定为SensorId.PROXIMITY。 | -| callback | Callback<[ProximityResponse](#proximityresponse)> | 是 | 回调函数，异步上报的传感器数据固定为ProximityResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------- | ---- | ----------------------------------------------------------- | +| type | [SensorId](#sensorid9).PROXIMITY | 是 | 传感器类型，该值固定为SensorId.PROXIMITY。 | +| callback | Callback<[ProximityResponse](#proximityresponse)> | 是 | 回调函数，异步上报的传感器数据固定为ProximityResponse。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **错误码**： @@ -724,7 +800,7 @@ on(type: SensorId.ROTATION_VECTOR, callback: Callback<RotationVectorResponse& | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | type | [SensorId](#sensorid9).ROTATION_VECTOR | 是 | 传感器类型，该值固定为SensorId.ROTATION_VECTOR。 | | callback | Callback<[RotationVectorResponse](#rotationvectorresponse)> | 是 | 回调函数，异步上报的传感器数据固定为RotationVectorResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **错误码**： @@ -764,7 +840,7 @@ on(type: SensorId.SIGNIFICANT_MOTION, callback: Callback<SignificantMotionRes | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | type | [SensorId](#sensorid9).SIGNIFICANT_MOTION | 是 | 传感器类型，该值固定为SensorId.SIGNIFICANT_MOTION。 | | callback | Callback<[SignificantMotionResponse](#significantmotionresponse)> | 是 | 回调函数，异步上报的传感器数据固定为SignificantMotionResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **错误码**： @@ -801,7 +877,7 @@ on(type: SensorId.WEAR_DETECTION, callback: Callback<WearDetectionResponse> | -------- | ------------------------------------------------------------ | ---- | ----------------------------------------------------------- | | type | [SensorId](#sensorid9).WEAR_DETECTION | 是 | 传感器类型，该值固定为SensorId.WEAR_DETECTION。 | | callback | Callback<[WearDetectionResponse](#weardetectionresponse)> | 是 | 回调函数，异步上报的传感器数据固定为WearDetectionResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **错误码**： @@ -1606,7 +1682,83 @@ try { } ``` -## sensor.off9+ +## sensor.off + +### COLOR10+ + +off(type: SensorId.COLOR, callback?: Callback\): void + +取消订阅颜色传感器数据。 + +**系统能力**：SystemCapability.Sensors.Sensor + +**系统API**：此接口为系统接口 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ | +| type | [SensorId](#sensorid9).COLOR | 是 | 传感器类型，该值固定为SensorId.COLOR。 | +| callback | Callback<[ColorResponse](#colorresponse)> | 否 | 需要取消订阅的回调函数，若无此参数，则取消订阅当前类型的所有回调函数。 | + +**示例：** + +```js +function callback1(data) { + console.info('Callback1 data: ' + JSON.stringify(data)); +} +function callback2(data) { + console.info('Callback2 data: ' + JSON.stringify(data)); +} +try { + sensor.on(sensor.SensorId.COLOR, callback1); + sensor.on(sensor.SensorId.COLOR, callback2); + // 仅取消callback1的注册 + sensor.off(sensor.SensorId.COLOR, callback1); + // 取消注册SensorId.COLOR的所有回调 + sensor.off(sensor.SensorId.COLOR); +} catch (err) { + console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message); +} +``` + +### SAR10+ + +off(type: SensorId.SAR, callback?: Callback\): void + +取消订阅吸收比率传感器数据。 + +**系统能力**：SystemCapability.Sensors.Sensor + +**系统API**：此接口为系统接口 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | ------------------------------------------------------------ | +| type | [SensorId](#sensorid9).SAR | 是 | 传感器类型，该值固定为SensorId.SAR。 | +| callback | Callback<[SarResponse](#sarresponse)> | 否 | 需要取消订阅的回调函数，若无此参数，则取消订阅当前类型的所有回调函数。 | + +**示例：** + +```js +function callback1(data) { + console.info('Callback1 data: ' + JSON.stringify(data)); +} +function callback2(data) { + console.info('Callback2 data: ' + JSON.stringify(data)); +} +try { + sensor.on(sensor.SensorId.SAR, callback1); + sensor.on(sensor.SensorId.SAR, callback2); + // 仅取消callback1的注册 + sensor.off(sensor.SensorId.SAR, callback1); + // 取消注册SensorId.SAR的所有回调 + sensor.off(sensor.SensorId.SAR); +} catch (err) { + console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message); +} +``` ### ACCELEROMETER9+ @@ -3457,7 +3609,6 @@ try { | SENSOR_TYPE_ID_WEAR_DETECTION | 280 | 佩戴检测传感器。 | | SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED | 281 | 未校准加速度计传感器。 | - ## Response 传感器数据的时间戳。 @@ -3487,6 +3638,33 @@ try { | precision | number | 是 | 是 | 传感器精度。 | | power | number | 是 | 是 | 传感器功率。 | +## ColorResponse10+ + +颜色传感器数据，继承于[Response](#response)。 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor + +**系统API**：此接口为系统接口 + + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ---------------- | ------ | ---- | ---- | ----------------------------- | +| lightIntensity | number | 是 | 是 | 表示光的强度，单位 : 勒克斯。 | +| colorTemperature | number | 是 | 是 | 表示色温，单位 : 开尔文。 | + +## SarResponse10+ + +吸收比率传感器数据，继承于[Response](#response)。 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor + +**系统API**：此接口为系统接口 + + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| --------------- | ------ | ---- | ---- | ------------------------------- | +| absorptionRatio | number | 是 | 是 | 表示具体的吸收率，单位 : W/kg。 | + ## AccelerometerResponse 加速度传感器数据，继承于[Response](#response)。 @@ -3883,7 +4061,7 @@ on(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<Line | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | type | [SensorType](#sensortype).SENSOR_TYPE_ID_LINEAR_ACCELERATION | 是 | 要订阅的线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。 | | callback | Callback<[LinearAccelerometerResponse](#linearaccelerometerresponse)> | 是 | 注册线性加速度传感器的回调函数，上报的数据类型为LinearAccelerometerResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | ### ACCELEROMETER_UNCALIBRATED(deprecated) @@ -3903,7 +4081,7 @@ on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | type | [SensorType](#sensortype).SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED | 是 | 要订阅的未校准加速度计传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。 | | callback | Callback<[AccelerometerUncalibratedResponse](#accelerometeruncalibratedresponse)> | 是 | 注册未校准加速度计传感器的回调函数，上报的数据类型为AccelerometerUncalibratedResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **示例：** ```js @@ -3935,7 +4113,7 @@ on(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback<GravityRespons | -------- | --------------------------------------------------- | ---- | ----------------------------------------------------------- | | type | [SensorType](#sensortype).SENSOR_TYPE_ID_GRAVITY | 是 | 要订阅的重力传感器类型为SENSOR_TYPE_ID_GRAVITY。 | | callback | Callback<[GravityResponse](#gravityresponse)> | 是 | 注册重力传感器的回调函数，上报的数据类型为GravityResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **示例：** @@ -3967,7 +4145,7 @@ on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback<GyroscopeRes | -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ | | type | [SensorType](#sensortype).SENSOR_TYPE_ID_GYROSCOPE | 是 | 要订阅的陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。 | | callback | Callback<[GyroscopeResponse](#gyroscoperesponse)> | 是 | 注册陀螺仪传感器的回调函数，上报的数据类型为GyroscopeResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **示例：** ```js @@ -3998,7 +4176,7 @@ on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback:Callback<G | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | type | [SensorType](#sensortype).SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED | 是 | 要订阅的未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。 | | callback | Callback<[GyroscopeUncalibratedResponse](#gyroscopeuncalibratedresponse)> | 是 | 注册未校准陀螺仪传感器的回调函数，上报的数据类型为GyroscopeUncalibratedResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **示例：** ```js @@ -4030,7 +4208,7 @@ on(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback: Callback<Sig | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | type | [SensorType](#sensortype).SENSOR_TYPE_ID_SIGNIFICANT_MOTION | 是 | 要订阅的大幅动作传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。 | | callback | Callback<[SignificantMotionResponse](#significantmotionresponse)> | 是 | 注册有效运动传感器的回调函数，上报的数据类型为SignificantMotionResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **示例：** ```js @@ -4059,7 +4237,7 @@ on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback: Callback<Pe | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | type | [SensorType](#sensortype).SENSOR_TYPE_ID_PEDOMETER_DETECTION | 是 | 要订阅的计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。 | | callback | Callback<[PedometerDetectionResponse](#pedometerdetectionresponse)> | 是 | 注册计步检测传感器的回调函数，上报的数据类型为PedometerDetectionResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **示例：** ```js @@ -4088,7 +4266,7 @@ on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback<PedometerRes | -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ | | type | [SensorType](#sensortype).SENSOR_TYPE_ID_PEDOMETER | 是 | 要订阅的计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。 | | callback | Callback<[PedometerResponse](#pedometerresponse)> | 是 | 注册计步传感器的回调函数，上报的数据类型为PedometerResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **示例：** ```js @@ -4115,7 +4293,7 @@ on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback:Callback<Ambi | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | type | [SensorType](#sensortype).SENSOR_TYPE_ID_AMBIENT_TEMPERATURE | 是 | 要订阅的环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。 | | callback | Callback<[AmbientTemperatureResponse](#ambienttemperatureresponse)> | 是 | 注册环境温度传感器的回调函数，上报的数据类型为AmbientTemperatureResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **示例：** @@ -4143,7 +4321,7 @@ on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback<Magneti | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | type | [SensorType](#sensortype).SENSOR_TYPE_ID_MAGNETIC_FIELD | 是 | 要订阅的磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。 | | callback | Callback<[MagneticFieldResponse](#magneticfieldresponse)> | 是 | 注册磁场传感器的回调函数，上报的数据类型为MagneticFieldResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **示例：** @@ -4173,7 +4351,7 @@ on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callbac | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | type | [SensorType](#sensortype).SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED | 是 | 要订阅的未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。 | | callback | Callback<[MagneticFieldUncalibratedResponse](#magneticfielduncalibratedresponse)> | 是 | 注册未校准磁场传感器的回调函数，上报的数据类型为MagneticFieldUncalibratedResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **示例：** ```js @@ -4205,7 +4383,7 @@ on(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback<ProximityRes | -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ | | type | [SensorType](#sensortype).SENSOR_TYPE_ID_PROXIMITY | 是 | 要订阅的接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。 | | callback | Callback<[ProximityResponse](#proximityresponse)> | 是 | 注册接近光传感器的回调函数，上报的数据类型为ProximityResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **示例：** ```js @@ -4232,7 +4410,7 @@ on(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback<HumidityRespo | -------- | ----------------------------------------------------- | ---- | ------------------------------------------------------------ | | type | [SensorType](#sensortype).SENSOR_TYPE_ID_HUMIDITY | 是 | 要订阅的湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。 | | callback | Callback<[HumidityResponse](#humidityresponse)> | 是 | 注册湿度传感器的回调函数，上报的数据类型为HumidityResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **示例：** @@ -4260,7 +4438,7 @@ on(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback<BarometerRes | -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ | | type | [SensorType](#sensortype).SENSOR_TYPE_ID_BAROMETER | 是 | 要订阅的气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。 | | callback | Callback<[BarometerResponse](#barometerresponse)> | 是 | 注册气压计传感器的回调函数，上报的数据类型为BarometerResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **示例：** @@ -4288,7 +4466,7 @@ on(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback<HallResponse>, | -------- | --------------------------------------------- | ---- | ------------------------------------------------------------ | | type | [SensorType](#sensortype).SENSOR_TYPE_ID_HALL | 是 | 要订阅的霍尔传感器类型为SENSOR_TYPE_ID_HALL。 | | callback | Callback<[HallResponse](#hallresponse)> | 是 | 注册霍尔传感器的回调函数，上报的数据类型为 HallResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **示例：** ```js @@ -4315,7 +4493,7 @@ on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback<LightRes | -------- | ------------------------------------------------------ | ---- | ----------------------------------------------------------- | | type | [SensorType](#sensortype).SENSOR_TYPE_ID_AMBIENT_LIGHT | 是 | 要订阅的环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。 | | callback | Callback<[LightResponse](#lightresponse)> | 是 | 注册环境光传感器的回调函数，上报的数据类型为LightResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **示例：** @@ -4343,7 +4521,7 @@ on(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<Orientatio | -------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------------ | | type | [SensorType](#sensortype).SENSOR_TYPE_ID_ORIENTATION | 是 | 要订阅的方向传感器类型为SENSOR_TYPE_ID_ORIENTATION | | callback | Callback<[OrientationResponse](#orientationresponse)> | 是 | 注册方向传感器的回调函数，上报的数据类型为OrientationResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **示例：** ```js @@ -4374,7 +4552,7 @@ on(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback<HeartRateRe | -------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ | | type | [SensorType](#sensortype).SENSOR_TYPE_ID_HEART_RATE | 是 | 要订阅的心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。 | | callback | Callback<[HeartRateResponse](#heartrateresponse)> | 是 | 注册心率传感器的回调函数，上报的数据类型为HeartRateResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | ### ROTATION_VECTOR(deprecated) @@ -4392,7 +4570,7 @@ on(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,callback: Callback<Rotatio | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | type | [SensorType](#sensortype).SENSOR_TYPE_ID_ROTATION_VECTOR | 是 | 要订阅的旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。 | | callback | Callback<[RotationVectorResponse](#rotationvectorresponse)> | 是 | 注册旋转矢量传感器的回调函数，上报的数据类型为RotationVectorResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **示例：** ```js @@ -4422,7 +4600,7 @@ on(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback<WearDet | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | type | [SensorType](#sensortype).SENSOR_TYPE_ID_WEAR_DETECTION | 是 | 要订阅的佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。 | | callback | Callback<[WearDetectionResponse](#weardetectionresponse)> | 是 | 注册佩戴检测传感器的回调函数，上报的数据类型为WearDetectionResponse。 | -| options | [Options](#options) | 否 | 可选参数列表，当前可用于设置传感器上报频率，默认值为200000000ns。 | +| options | [Options](#options) | 否 | 可选参数列表，用于设置传感器上报频率，默认值为200000000ns。 | **示例：** ```js