From de485d6547bcc8c7baea734102fa548ae641c2dd Mon Sep 17 00:00:00 2001 From: cff-gite Date: Wed, 7 Sep 2022 17:54:16 +0800 Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0sensor=E6=8E=A5=E5=8F=A3?= 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 | 152 +++++++++++++++++- 1 file changed, 144 insertions(+), 8 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 329ac88df2..309f9fa09e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-sensor.md +++ b/zh-cn/application-dev/reference/apis/js-apis-sensor.md @@ -1880,11 +1880,11 @@ getGeomagneticField(locationOptions: LocationOptions, timeMillis: number, callba **系统能力**：SystemCapability.Sensors.Sensor **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| --------------- | ---------------------------------------- | ---- | ----------------- | -| locationOptions | [LocationOptions](#locationoptions) | 是 | 地理位置。 | -| timeMillis | number | 是 | 表示获取磁偏角的时间，单位为毫秒。 | -| callback | AsyncCallback<[GeomagneticResponse](#geomagneticresponse)> | 是 | 返回磁场信息。 | +| 说明 | 参数名 | 类型 | 必填 | +| ---------------------------------- | --------------- | ------------------------------------------------------------ | ---- | +| 地理位置。 | locationOptions | [LocationOptions](#locationoptions) | 是 | +| 表示获取磁偏角的时间，单位为毫秒。 | timeMillis | number | 是 | +| 返回磁场信息。 | callback | AsyncCallback<[GeomagneticResponse](#geomagneticresponse)> | 是 | **示例：** ```js @@ -2384,6 +2384,124 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number& }) ``` +## sensor.getSensorLists + + getSensorLists(callback: AsyncCallback<sensor>): void + +获取设备上的所有传感器信息。 + +**系统能力**：SystemCapability.Sensors.Sensor + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------- | ---- | ---------------- | +| callback | AsyncCallback<[Sensor](#sensor)> | 是 | 返回传感器链表。 | + +**示例：** + +``` +sensor.getSensorList(function(err, data) { + if (err) { + console.error('getSensorList failed, : code' + err.code + ', message: ' + + err.message); + return; + } + for (var i=0; i < data.length; i++) { + console.info("data[" + i + "]: " + data[i]); + } + }) +``` + +## sensor.getSensorLists + + getSensorLists(): Promise< Array<Sensor>> + +获取设备上的所有传感器信息。 + +**系统能力**：SystemCapability.Sensors.Sensor + +**返回值：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | -------------------------------- | ---- | ---------------- | +| promise | Promise<[Sensor](#sensor)> | 是 | 返回传感器链表。 | + +**示例：** + +``` + const promise = sensor.getSensorList(); + promise.then((data) => { + console.info('getSensorList successed'); + for (var i=0; i < data.length; i++) { + console.info("data[" + i + "]: " + data[i]); + } + }).catch((err) => { + console.info('promise failed'); + }) +``` + +## sensor. getSingleSensor + +getSingleSensor(type：SensorType, callback: AsyncCallback<sensor>): void + +获取指定类型的传感器信息。 + +**系统能力**：SystemCapability.Sensors.Sensor + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------- | ---- | ------------------------ | +| type | SensorType | 是 | 指示传感器类型。 | +| callback | AsyncCallback<[Sensor](#sensor)> | 是 | 返回获取到的单个传感器。 | + +**示例：** + +``` +sensor.getSingleSensor(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, function(err, data) { + if (err) { + console.error('getSingleSensor failed, code: ' + err.code + ', message: ' + + err.message); + return; + } + console.info("data: " + data) + }) +``` + +## sensor. getSingleSensor + + getSingleSensor(type: SensorType,): Promise<Sensor> + +获取指定类型的传感器信息。 + +**系统能力**：SystemCapability.Sensors.Sensor + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ---------- | ---- | ---------------- | +| type | SensorType | 是 | 指示传感器类型。 | + +**返回值：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | -------------------------------- | ---- | ------------------------ | +| promise | Promise<[Sensor](#sensor)> | 是 | 返回获取到的单个传感器。 | + +**示例：** + +``` + const promise = sensor.getSingleSensor(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER); + promise.then((data) => { + console.info('getSingleSensor successed'); + console.info("data: " + data) + }).catch((err) => { + console.info('promise failed'); + }) +``` + + ## SensorType @@ -2425,9 +2543,27 @@ createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number& **系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor -| 名称 | 参数类型 | 可读 | 可写 | 说明 | -| --------- | ------ | ---- | ---- | ------------ | -| timestamp | number | 是 | 是 | 传感器数据上报的时间戳。 | +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| --------- | -------- | ---- | ---- | ------------------------ | +| timestamp | number | 是 | 是 | 传感器数据上报的时间戳。 | + +## Sensor + +指示传感器信息。 + +**系统能力**：以下各项对应的系统能力均为SystemCapability.Sensors.Sensor + +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| --------------- | -------- | ---- | ---- | ---------------------- | +| sensorName | string | 是 | 是 | 传感器名称。 | +| venderName | string | 是 | 是 | 传感器供应商。 | +| firmwareVersion | string | 是 | 是 | 传感器固件版本。 | +| hardwareVersion | string | 是 | 是 | 传感器硬件版本。 | +| sensorTypeId | number | 是 | 是 | 传感器类型 Id。 | +| maxRange | number | 是 | 是 | 传感器的最大测量范围。 | +| precision | number | 是 | 是 | 传感器精度。 | +| power | number | 是 | 是 | 传感器电源。 | + ## AccelerometerResponse -- GitLab