diff --git a/zh-cn/application-dev/connectivity/bluetooth/gatt-development-guide.md b/zh-cn/application-dev/connectivity/bluetooth/gatt-development-guide.md index de94143949c2827a86e84c6f45011662d5e37309..7c21b8e5a20e0c8c22020a1461769abd51872d92 100644 --- a/zh-cn/application-dev/connectivity/bluetooth/gatt-development-guide.md +++ b/zh-cn/application-dev/connectivity/bluetooth/gatt-development-guide.md @@ -250,9 +250,9 @@ try { // enable入参: true表示启用，false表示禁用 gattClient.setCharacteristicChangeIndication(characteristic, true, (err: BusinessError) => { if (err) { - console.info('setCharacteristicChangeNotification callback failed'); + console.info('setCharacteristicChangeIndication callback failed'); } else { - console.info('setCharacteristicChangeNotification callback successful'); + console.info('setCharacteristicChangeIndication callback successful'); } }); } catch (err) { @@ -875,9 +875,9 @@ export class GattClientManager { // 设置特征值变化指示能力，enable: true表示启用，false表示禁用 this.gattClient.setCharacteristicChangeIndication(this.myCharacteristic, enable, (err: BusinessError) => { if (err) { - console.info('setCharacteristicChangeNotification callback failed'); + console.info('setCharacteristicChangeIndication callback failed'); } else { - console.info('setCharacteristicChangeNotification callback successful'); + console.info('setCharacteristicChangeIndication callback successful'); } }); } catch (err) { diff --git a/zh-cn/application-dev/reference/apis-connectivity-kit/_bluetooth.md b/zh-cn/application-dev/reference/apis-connectivity-kit/_bluetooth.md index 0c6b0f8c293e5de87b6ebf09eeb3aa3799f8f794..5b881b827806beed30b8348211114d72bedbc4f5 100644 --- a/zh-cn/application-dev/reference/apis-connectivity-kit/_bluetooth.md +++ b/zh-cn/application-dev/reference/apis-connectivity-kit/_bluetooth.md @@ -133,8 +133,8 @@ Bluetooth_ResultCode OH_Bluetooth_GetBluetoothSwitchState (Bluetooth_SwitchState | 名称 | 描述 | | -------- | -------- | -| state | 指向接收蓝牙开关状态的枚举值的指针。 需要传入非空指针，否则将返回错误码。 详细定义请参考[Bluetooth_SwitchState](#bluetooth_switchstate)。 | +| state | 指向接收蓝牙开关状态的枚举值的指针。需要传入非空指针，否则将返回错误码。详细定义请参考[Bluetooth_SwitchState](#bluetooth_switchstate)。 | **返回：** -返回蓝牙开关状态函数的错误码。详细定义请参考[Bluetooth_ResultCode](#bluetooth_resultcode)。
BLUETOOTH_SUCCESS 成功获取蓝牙开关状态。 BLUETOOTH_INVALID_PARAM 输入参数为空指针。 +返回蓝牙开关状态函数的错误码。详细定义请参考[Bluetooth_ResultCode](#bluetooth_resultcode)。
BLUETOOTH_SUCCESS 成功获取蓝牙开关状态。 BLUETOOTH_INVALID_PARAM 输入参数为空指针。 diff --git a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-a2dp-sys.md b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-a2dp-sys.md index 1bbeb9148f4e9f488e473656f6727f1d401362b3..7bad0497e203637df4a1050463a4663e7a84fea3 100644 --- a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-a2dp-sys.md +++ b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-a2dp-sys.md @@ -31,7 +31,7 @@ connect(deviceId: string): void | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | **错误码**： @@ -77,7 +77,7 @@ disconnect(deviceId: string): void | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | **错误码**： @@ -123,7 +123,7 @@ isAbsoluteVolumeSupported(deviceId: string, callback: AsyncCallback<boolean&g | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | | callback | AsyncCallback<boolean> | 是 | 回调函数。当接口调用返回成功，err为undefined，data为获取到的设备是否支持绝对音量结果；否则为错误对象。 | @@ -171,7 +171,7 @@ isAbsoluteVolumeSupported(deviceId: string): Promise<boolean> | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | **返回值：** @@ -223,7 +223,7 @@ isAbsoluteVolumeEnabled(deviceId: string, callback: AsyncCallback<boolean> | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | | callback | AsyncCallback<boolean> | 是 | 回调函数。当接口调用返回成功，err为undefined，data为获取到的绝对音量能力开启结果，true表示设备支持绝对音量能力，返回false表示设备不支持绝对音量能力；否则为错误对象。 | @@ -271,7 +271,7 @@ isAbsoluteVolumeEnabled(deviceId: string): Promise<boolean> | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | **返回值：** @@ -323,7 +323,7 @@ enableAbsoluteVolume(deviceId: string, callback: AsyncCallback<void>): voi | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | | callback | AsyncCallback<void> | 是 | 回调函数。如果成功，err为undefined，否则为错误对象。 | @@ -373,7 +373,7 @@ enableAbsoluteVolume(deviceId: string): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | **返回值：** @@ -426,7 +426,7 @@ disableAbsoluteVolume(deviceId: string, callback: AsyncCallback<void>): vo | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | | callback | AsyncCallback<void> | 是 | 回调函数。如果成功，err为undefined，否则为错误对象。 | @@ -476,7 +476,7 @@ disableAbsoluteVolume(deviceId: string): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | **返回值：** @@ -528,7 +528,7 @@ getCurrentCodecInfo(deviceId: string): CodecInfo | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | **返回值：** @@ -578,7 +578,7 @@ setCurrentCodecInfo(deviceId: string, codecInfo: CodecInfo): void | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | | codecInfo | [CodecInfo](js-apis-bluetooth-a2dp.md#codecinfo11) | 是 | 编码器信息。 | **错误码**： @@ -630,8 +630,8 @@ disableAutoPlay(deviceId: string, duration: number): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址，例如："11:22:33:AA:BB:FF"。 | -| duration | number | 是 | 拦截时长，单位：毫秒。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | +| duration | number | 是 | 拦截时长，取值范围：[3000, 20000]，单位：ms。 | **返回值：** @@ -685,7 +685,7 @@ enableAutoPlay(deviceId: string): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址，例如："11:22:33:AA:BB:FF"。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | **返回值：** @@ -738,13 +738,13 @@ getAutoPlayDisabledDuration(deviceId: string): Promise<number> | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址，例如："11:22:33:AA:BB:FF"。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | **返回值：** | 类型 | 说明 | | ----------------------------- | ---------- | -| Promise<number> | 以Promise的形式返回结果。number为返回的拦截时长，单位：毫秒。如果返回-1，则表示允许设备在连接成功后自动播放音乐。 | +| Promise<number> | 以Promise的形式返回结果。number为返回的拦截时长，单位：ms。如果返回-1，则表示允许设备在连接成功后自动播放音乐。 | **错误码**： diff --git a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-a2dp.md b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-a2dp.md index 5e269f018877afa53d2d3e9d305f1f57329d20a5..9406fd3f40f8e4a8d953daacac8d6c451bab8b15 100644 --- a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-a2dp.md +++ b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-a2dp.md @@ -82,7 +82,7 @@ getPlayingState(deviceId: string): PlayingState | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | **返回值：** diff --git a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-access-sys.md b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-access-sys.md index 8fb9086f340cbe2e1f7f9857a4ccf359345dbdba..f4bfdebbb624c3834ffc8f03f1e993c2faf186e7 100644 --- a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-access-sys.md +++ b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-access-sys.md @@ -108,7 +108,7 @@ try { ## access.getLocalAddress11+ -getLocalAddress(): string; +getLocalAddress(): string 获取本端设备的蓝牙地址。 diff --git a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-baseProfile.md b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-baseProfile.md index 7b088559faf9f000c9ac689681f485006311f127..99d5477ad2955150e41b883b450b62980575ba5b 100644 --- a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-baseProfile.md +++ b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-baseProfile.md @@ -36,14 +36,14 @@ type ProfileConnectionState = constant.ProfileConnectionState | 名称 | 类型 | 只读 | 可选 | 说明 | | -------- | ----------------------------- | ---- | ---- | ------------------------------- | -| deviceId | string | 否 | 否 | 表示蓝牙设备地址。 | -| state | [ProfileConnectionState](js-apis-bluetooth-constant.md#profileconnectionstate) | 否 | 否 | 表示蓝牙设备的profile连接状态。 | -| cause12+| [DisconnectCause](#disconnectcause12) | 否 | 否 | 表示连接失败的原因。| +| deviceId | string | 否 | 否 | 蓝牙设备地址，例如："XX:XX:XX:XX:XX:XX"。 | +| state | [ProfileConnectionState](js-apis-bluetooth-constant.md#profileconnectionstate) | 否 | 否 | 蓝牙设备的profile连接状态。 | +| cause12+| [DisconnectCause](#disconnectcause12) | 否 | 否 | 断连的原因。| ## DisconnectCause12+ -枚举，连接失败原因。 +枚举，断连的原因。 **系统能力**：SystemCapability.Communication.Bluetooth.Core @@ -114,7 +114,7 @@ getConnectionState(deviceId: string): ProfileConnectionState | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | **返回值：** @@ -164,8 +164,8 @@ on(type: 'connectionStateChange', callback: Callback<StateChangeParam>): v | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ---------------------------------------- | -| type | string | 是 | 填写"connectionStateChange"字符串，表示连接状态变化事件。 | -| callback | Callback<[StateChangeParam](#statechangeparam)> | 是 | 表示回调函数的入参。 | +| type | string | 是 | 事件回调类型，支持的事件为'connectionStateChange'，表示连接状态变化事件。
当连接状态变化时，触发该事件。 | +| callback | Callback<[StateChangeParam](#statechangeparam)> | 是 | 指定订阅的回调函数，会携带蓝牙profile连接状态。 | **错误码**： @@ -208,8 +208,8 @@ off(type: 'connectionStateChange', callback?: Callback<[StateChangeParam](#st | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ---------------------------------------- | -| type | string | 是 | 填写"connectionStateChange"字符串，表示连接状态变化事件。 | -| callback | Callback<[StateChangeParam](#statechangeparam)> | 否 | 表示回调函数的入参。 | +| type | string | 是 | 事件回调类型，支持的事件为'connectionStateChange'，表示连接状态变化事件。 | +| callback | Callback<[StateChangeParam](#statechangeparam)> | 否 | 指定取消订阅的回调函数通知。
若传参，则需与[BaseProfile.on('connectionStateChange')](#baseprofileonconnectionstatechange)中的回调函数一致；若无传参，则取消订阅该type对应的所有回调函数通知。 | **错误码**： diff --git a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-ble.md b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-ble.md index 132c864d0ee8ccaa899480317addeaec580fbd57..cd61ec9b5584e3ced0ee2a4c79b1123581cb5e3e 100644 --- a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-ble.md +++ b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-ble.md @@ -2230,7 +2230,7 @@ server端订阅MTU（最大传输单元）大小变更事件。使用Callback异 | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ---------------------------------------- | | type | string | 是 | 事件回调类型，支持的事件为'BLEMtuChange'，表示MTU状态变化事件。
当收到了client端发起了MTU协商请求时，触发该事件。 | -| callback | Callback<number> | 是 | 指定订阅的回调函数，会携带协商后的MTU大小。单位是字节。 | +| callback | Callback<number> | 是 | 指定订阅的回调函数，会携带协商后的MTU大小。单位：Byte。 | **错误码**： @@ -3222,7 +3222,7 @@ client端获取GATT连接链路信号强度 (Received Signal Strength Indication | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------- | ---- | ------------------------------ | -| callback | AsyncCallback<number> | 是 | 回调函数。获取链路信号强度成功，err为undefined，data为获取到的信号强度值，单位是dBm；否则为错误对象。 | +| callback | AsyncCallback<number> | 是 | 回调函数。获取链路信号强度成功，err为undefined，data为获取到的信号强度值，单位：dBm；否则为错误对象。 | **错误码**： @@ -3273,7 +3273,7 @@ client端获取GATT连接链路信号强度 (Received Signal Strength Indication | 类型 | 说明 | | --------------------- | --------------------------------- | -| Promise<number> | Promise对象。返回链路的信号强度，单位是dBm。 | +| Promise<number> | Promise对象。返回链路的信号强度，单位：dBm。 | **错误码**： @@ -3322,7 +3322,7 @@ client端同server端协商MTU（最大传输单元）大小。
| 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | -------------- | -| mtu | number | 是 | 需要协商的mtu大小，取值范围是[23, 517]，单位是字节。 | +| mtu | number | 是 | 需要协商的mtu大小，取值范围：[23, 517]，单位：Byte。 | **错误码**： @@ -3834,7 +3834,7 @@ client端订阅MTU（最大传输单元）大小变更事件。使用Callback异 | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ---------------------------------------- | | type | string | 是 | 事件回调类型，支持的事件为'BLEMtuChange'，表示MTU大小变更事件。
当调用[setBLEMtuSize](#setblemtusize)方法，client端发起MTU大小协商后，会触发该事件。 | -| callback | Callback<number> | 是 | 指定订阅的回调函数，会携带协商后的MTU大小。单位是字节。 | +| callback | Callback<number> | 是 | 指定订阅的回调函数，会携带协商后的MTU大小。单位：Byte。 | **错误码**： @@ -4329,7 +4329,7 @@ GATT描述符结构定义，是特征值[BLECharacteristic](#blecharacteristic) | 名称 | 类型 | 只读 | 可选 | 说明 | | -------- | ----------- | ---- | ---- | ---------------------------------- | | deviceId | string | 否 | 否 | 扫描到的蓝牙设备地址。例如："XX:XX:XX:XX:XX:XX"。
基于信息安全考虑，此处获取的设备地址为虚拟MAC地址。
- 若和该设备地址配对成功后，该地址不会变更。
- 若取消配对该设备或蓝牙关闭后，再次重新发起扫描，该虚拟地址会变更。
- 若要持久化保存该地址，可使用[access.addPersistentDeviceId](js-apis-bluetooth-access.md#accessaddpersistentdeviceid16)方法。 | -| rssi | number | 否 | 否 | 扫描到的设备信号强度，单位dBm。 | +| rssi | number | 否 | 否 | 扫描到的设备信号强度，单位：dBm。 | | data | ArrayBuffer | 否 | 否 | 扫描到的设备发送的广播报文内容。 | | deviceName | string | 否 | 否 | 扫描到的设备名称。 | | connectable | boolean | 否 | 否 | 扫描到的设备是否可连接。true表示可连接，false表示不可连接。 | @@ -4345,9 +4345,9 @@ GATT描述符结构定义，是特征值[BLECharacteristic](#blecharacteristic) | 名称 | 类型 | 只读 | 可选 | 说明 | | ----------- | ------- | ---- | ---- | ---------------------------------------- | -| interval | number | 否 | 是 | 广播发送间隔。
取值范围是[32, 16777215]，单位是slot（时间槽），一个slot代表0.625毫秒，默认值为1600。
其中传统广播的最大值是16384。 | -| txPower | number | 否 | 是 | 广播发送功率。取值范围是[-127, 1]，单位是dBm，默认值为-7。
考虑到发送广播的性能和功耗，建议高档取值为1，中档取为-7，低档取值为-15。 | -| connectable | boolean | 否 | 是 | 是否是可连接广播。true表示发送可连接广播，默认值为true。 | +| interval | number | 否 | 是 | 广播发送间隔。
取值范围：[32, 16777215]，单位：slot（时间槽），一个slot代表0.625毫秒，默认值为1600。
其中传统广播的最大值是16384。 | +| txPower | number | 否 | 是 | 广播发送功率。取值范围：[-127, 1]，单位：dBm，默认值为-7。
考虑到发送广播的性能和功耗，建议高档取值为1，中档取为-7，低档取值为-15。 | +| connectable | boolean | 否 | 是 | 是否是可连接广播。true表示发送可连接广播，false表示发送不可连接广播，默认值为true。 | ## AdvertiseData @@ -4376,7 +4376,7 @@ GATT描述符结构定义，是特征值[BLECharacteristic](#blecharacteristic) | advertisingSettings11+ | [AdvertiseSetting](#advertisesetting) | 否 | 否 | 广播的发送参数。 | | advertisingData11+ | [AdvertiseData](#advertisedata) | 否 | 否 | 需要发送的广播报文数据内容。 | | advertisingResponse11+ | [AdvertiseData](#advertisedata) | 否 | 是 | 回复扫描请求的广播报文数据内容。 | -| duration11+ | number | 否 | 是 | 发送广播的持续时间。有效的取值范围为[1, 65535]，单位为10毫秒。
如果未指定此参数或者将其设置为0，则会持续发送广播。 | +| duration11+ | number | 否 | 是 | 发送广播的持续时间。取值范围：[1, 65535]，单位：10ms。
如果未指定此参数或者将其设置为0，则会持续发送广播。 | ## AdvertisingEnableParams11+ @@ -4387,7 +4387,7 @@ GATT描述符结构定义，是特征值[BLECharacteristic](#blecharacteristic) | 名称 | 类型 | 只读 | 可选 | 说明 | | ------------------- | --------------------- | ----- | ----- | ------------------------ | | advertisingId | number | 否 | 否 | 需要启动的广播标识。 | -| duration | number | 否 | 是 | 发送广播的持续时间。有效的取值范围为[1, 65535]，单位为10毫秒。
如果未指定此参数或者将其设置为0，则会持续发送广播。 | +| duration | number | 否 | 是 | 发送广播的持续时间。取值范围：[1, 65535]，单位：10ms。
如果未指定此参数或者将其设置为0，则会持续发送广播。 | ## AdvertisingDisableParams11+ @@ -4469,7 +4469,7 @@ BLE扫描的配置参数。 | 名称 | 类型 | 只读 | 可选 | 说明 | | --------- | ----------------------- | ---- | ---- | -------------------------------------- | -| interval | number | 否 | 是 | 扫描结果上报的延迟时间，单位为ms，默认值为0。搭配 [ScanReportMode](#scanreportmode15)使用。
- 该值在常规或围栏扫描上报模式下不生效，当扫描到符合过滤条件的广播报文后，立刻上报。
- 该值在批量扫描上报模式下生效，当扫描到符合过滤条件的广播报文后，会存入缓存队列，延时上报。若不设置该值或该值在[0,5000)范围内，蓝牙子系统会默认设置延时时间为5000。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | +| interval | number | 否 | 是 | 扫描结果上报的延迟时间，单位：ms，默认值为0。搭配 [ScanReportMode](#scanreportmode15)使用。
- 该值在常规或围栏扫描上报模式下不生效，当扫描到符合过滤条件的广播报文后，立刻上报。
- 该值在批量扫描上报模式下生效，当扫描到符合过滤条件的广播报文后，会存入缓存队列，延时上报。若不设置该值或该值在[0, 5000)范围内，蓝牙子系统会默认设置延时时间为5000。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | | dutyMode | [ScanDuty](#scanduty) | 否 | 是 | 扫描模式，默认值为SCAN_MODE_LOW_POWER。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | | matchMode | [MatchMode](#matchmode) | 否 | 是 | 硬件的过滤匹配模式，默认值为MATCH_MODE_AGGRESSIVE。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | | phyType12+ | [PhyType](#phytype12) | 否 | 是 | 扫描中使用的物理通道类型，默认值为PHY_LE_1M。
**原子化服务API**：从API version 12开始，该接口支持在原子化服务中使用。 | diff --git a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-connection.md b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-connection.md index 051315e7dbaf14cc962a2109ba7bbf5a6e5ee044..41e30377dc6d0152ff41bb40dba14883fd28a477 100644 --- a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-connection.md +++ b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-connection.md @@ -669,7 +669,7 @@ setDevicePinCode(deviceId: string, code: string, callback: AsyncCallback<void | 参数名 | 类型 | 必填 | 说明 | | ------ | ------- | ---- | -------------------------------- | | deviceId | string | 是 | 表示对端设备MAC地址，例如："XX:XX:XX:XX:XX:XX"。 | -| code | string | 是 | 用户输入的PIN码。 | +| code | string | 是 | 用户输入的PIN码，该字符串的字符个数范围为(0, 16]，例如："12345"。 | | callback | AsyncCallback<void> | 是 | 回调函数，当设置PinCode成功，err为undefined，否则为错误对象。 | **错误码**： @@ -715,7 +715,7 @@ setDevicePinCode(deviceId: string, code: string): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | ------ | ------- | ---- | -------------------------------- | | deviceId | string | 是 | 表示对端设备MAC地址，例如："XX:XX:XX:XX:XX:XX"。 | -| code | string | 是 | 用户输入的PIN码。 | +| code | string | 是 | 用户输入的PIN码，该字符串的字符个数范围为(0, 16]，例如："12345"。 | **返回值：** @@ -771,7 +771,7 @@ setLocalName(name: string): void | 参数名 | 类型 | 必填 | 说明 | | ---- | ------ | ---- | --------------------- | -| name | string | 是 | 需要设置的蓝牙名称，名称长度范围为(0,248]，单位是字节。 | +| name | string | 是 | 需要设置的蓝牙名称，名称长度范围：(0, 248]，单位：Byte。 | **错误码**： @@ -813,7 +813,7 @@ setBluetoothScanMode(mode: ScanMode, duration: number): void | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------- | ---- | ---------------------------- | | mode | [ScanMode](#scanmode) | 是 | 蓝牙扫描模式。当扫描模式为SCAN_MODE_GENERAL_DISCOVERABLE时，超出duration持续时间(不为0)，扫描模式会重新设置为SCAN_MODE_CONNECTABLE。 | -| duration | number | 是 | 设备可被发现的持续时间，单位为毫秒。设置为0则持续可发现。 | +| duration | number | 是 | 设备可被发现的持续时间，单位：ms。设置为0则表示持续可发现。 | **错误码**： @@ -1020,7 +1020,7 @@ setRemoteDeviceName(deviceId: string, name: string): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------- | ---- | -------------------------------------- | | deviceId | string | 是 | 表示对端设备MAC地址，例如："XX:XX:XX:XX:XX:XX"。 | -| name | string | 是 | 修改对端设备名称，名称长度范围为(0,64]，单位是字节。 | +| name | string | 是 | 修改对端设备名称，名称长度范围：(0, 64]，单位：Byte。 | **返回值：** @@ -1828,6 +1828,6 @@ try { | 名称 | 类型 | 只读 | 可选 | 说明 | | -------- | ------ | ---- | ---- | ----------- | | deviceId | string | 否 | 否 | 扫描到的设备地址。
基于信息安全考虑，此处获取的设备地址为虚拟MAC地址。
- 若和该设备地址配对成功后，该地址不会变更。
- 若取消配对该设备或蓝牙关闭后，再次重新发起扫描，该虚拟地址会变更。
- 若要持久化保存该地址，可使用[access.addPersistentDeviceId](js-apis-bluetooth-access.md#accessaddpersistentdeviceid16)方法。| -| rssi | number | 否 | 否 | 扫描到的设备信号强度，单位dBm。| +| rssi | number | 否 | 否 | 扫描到的设备信号强度，单位：dBm。| | deviceName | string | 否 | 否 | 扫描到的设备名称。| -| deviceClass | DeviceClass | 否 | 否 | 扫描到的设备的设备类型。| \ No newline at end of file +| deviceClass | [DeviceClass](#deviceclass) | 否 | 否 | 扫描到的设备类型。| \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-hfp-sys.md b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-hfp-sys.md index 34fe40775cfd828a61687b44d82c46221eb4b082..e082b1ba99334c20d05dc83edd4fa7c5f9b6e584 100644 --- a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-hfp-sys.md +++ b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-hfp-sys.md @@ -31,7 +31,7 @@ connect(deviceId: string): void | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | **错误码**： @@ -77,7 +77,7 @@ disconnect(deviceId: string): void | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | **错误码**： diff --git a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-hid-sys.md b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-hid-sys.md index d5ffe7d9704b33c9213497c7578a79d8bf4cc087..b4663cb4c6c27091c455691b7be279f5cbdb6fe4 100644 --- a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-hid-sys.md +++ b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-hid-sys.md @@ -34,7 +34,7 @@ connect(deviceId: string): void | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | **错误码**： @@ -80,7 +80,7 @@ disconnect(deviceId: string): void | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | **错误码**： diff --git a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-map-sys.md b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-map-sys.md index 42bc3d9653b68e1188b51baae204cbf3812f87a3..ed99485a4d3588ed741933f131f7e55de6711d6c 100644 --- a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-map-sys.md +++ b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-map-sys.md @@ -31,7 +31,7 @@ disconnect(deviceId: string): void | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | **错误码**： diff --git a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-pan-sys.md b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-pan-sys.md index 65a5f177ce4dea541a3ccb02f53b7d5309d3f241..533cfe31a9a49cefe6076a8f99f0479e54aff4e2 100644 --- a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-pan-sys.md +++ b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-pan-sys.md @@ -34,7 +34,7 @@ disconnect(deviceId: string): void | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | **错误码**： diff --git a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-pbap-sys.md b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-pbap-sys.md index 2ca19f46a5f64edf638725cb395617da4dfe60f2..f879f1ad12a8ab0bcf5a360c1a7dcf5b7c539836 100644 --- a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-pbap-sys.md +++ b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-pbap-sys.md @@ -34,7 +34,7 @@ disconnect(deviceId: string): void | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | **错误码**： diff --git a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-socket.md b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-socket.md index 9ec36be18f62f890e12e4be9085ceb9ad5a225f3..99945637ea1e64993e380e4ec9000c184ead5b4c 100644 --- a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-socket.md +++ b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-socket.md @@ -28,9 +28,9 @@ sppListen(name: string, options: SppOptions, callback: AsyncCallback<number&g | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------- | ---- | ----------------------- | -| name | string | 是 | 服务的名称。 | +| name | string | 是 | 服务的名称，该字符串的字符个数范围为[0, 256]。 | | options | [SppOptions](#sppoptions) | 是 | spp监听配置参数。 | -| callback | AsyncCallback<number> | 是 | 表示回调函数的入参，服务端Socket的id。 | +| callback | AsyncCallback<number> | 是 | 回调函数。当创建服务端scoket成功，err为undefined，data为获取到的服务端socket的id；否则为错误对象。 | **错误码**： @@ -82,8 +82,8 @@ sppAccept(serverSocket: number, callback: AsyncCallback<number>): void | 参数名 | 类型 | 必填 | 说明 | | ------------ | --------------------------- | ---- | ----------------------- | -| serverSocket | number | 是 | 服务端socket的id。 | -| callback | AsyncCallback<number> | 是 | 表示回调函数的入参，客户端socket的id。 | +| serverSocket | number | 是 | 服务端socket的id。
该值是调用[sppListen](#socketspplisten)接口后，通过其异步callback获取到的。 | +| callback | AsyncCallback<number> | 是 | 回调函数。当收到客户端的连接时，err为undefined，data为该客户端socket的id；否则为错误对象。 | **错误码**： @@ -137,7 +137,7 @@ sppConnect(deviceId: string, options: SppOptions, callback: AsyncCallback<num | -------- | --------------------------- | ---- | ------------------------------ | | deviceId | string | 是 | 对端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | | options | [SppOptions](#sppoptions) | 是 | spp客户端连接配置参数。 | -| callback | AsyncCallback<number> | 是 | 表示回调函数的入参，客户端socket的id。 | +| callback | AsyncCallback<number> | 是 | 回调函数。当客户端发起连接成功，err为undefined，data为当前客户端socket的id；否则为错误对象。 | **错误码**： @@ -188,13 +188,13 @@ getDeviceId(clientSocket: number): string | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------- | ---- | ------------------------------ | -| clientSocket | number | 是 | 客户端Socket的id。 | +| clientSocket | number | 是 | 客户端socket的id。
该值是调用[sppAccept](#socketsppaccept)或[sppConnect](#socketsppconnect)接口，通过其异步callback获取到的。 | **返回值：** | 类型 | 说明 | | ---------------------------------------- | -------------------------- | -| string | 返回对端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | +| string | 返回对端设备地址。 | **错误码**： @@ -239,7 +239,7 @@ sppCloseServerSocket(socket: number): void | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | --------------- | -| socket | number | 是 | 服务端监听socket的id。 | +| socket | number | 是 | 服务端监听socket的id。
该值是调用[sppListen](#socketspplisten)接口，通过其异步callback获取到的。 | **错误码**： @@ -277,7 +277,7 @@ sppCloseClientSocket(socket: number): void | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------------- | -| socket | number | 是 | 客户端socket的id。 | +| socket | number | 是 | 客户端socket的id。
该值是调用[sppAccept](#socketsppaccept)或[sppConnect](#socketsppconnect)接口，通过其异步callback获取到的。 | **错误码**： @@ -315,7 +315,7 @@ sppWrite(clientSocket: number, data: ArrayBuffer): void | 参数名 | 类型 | 必填 | 说明 | | ------------ | ----------- | ---- | ------------- | -| clientSocket | number | 是 | 客户端socket的id。 | +| clientSocket | number | 是 | 客户端socket的id。
该值是调用[sppAccept](#socketsppaccept)或[sppConnect](#socketsppconnect)接口，通过其异步callback获取到的。 | | data | ArrayBuffer | 是 | 写入的数据。 | **错误码**： @@ -357,9 +357,9 @@ on(type: 'sppRead', clientSocket: number, callback: Callback<ArrayBuffer>) | 参数名 | 类型 | 必填 | 说明 | | ------------ | --------------------------- | ---- | -------------------------- | -| type | string | 是 | 填写"sppRead"字符串，表示spp读请求事件。 | -| clientSocket | number | 是 | 客户端socket的id。 | -| callback | Callback<ArrayBuffer> | 是 | 表示回调函数的入参，读取到的数据。 | +| type | string | 是 | 事件回调类型，支持的事件为'sppRead'，表示订阅spp读请求事件。
当收到了对端发送的数据时，触发该事件。| +| clientSocket | number | 是 | 客户端socket的id。
该值是调用[sppAccept](#socketsppaccept)或[sppConnect](#socketsppconnect)接口，通过其异步callback获取到的。 | +| callback | Callback<ArrayBuffer> | 是 | 指定订阅的回调函数，会返回读取到的数据。 | **错误码**： @@ -401,9 +401,9 @@ off(type: 'sppRead', clientSocket: number, callback?: Callback<ArrayBuffer> | 参数名 | 类型 | 必填 | 说明 | | ------------ | --------------------------- | ---- | ---------------------------------------- | -| type | string | 是 | 填写"sppRead"字符串，表示spp读请求事件。 | -| clientSocket | number | 是 | 客户端Socket的id。 | -| callback | Callback<ArrayBuffer> | 否 | 表示取消订阅spp读请求事件上报。不填该参数则取消订阅该type对应的所有回调。 | +| type | string | 是 | 事件回调类型，支持的事件为'sppRead'，表示取消订阅spp读请求事件。 | +| clientSocket | number | 是 | 客户端socket的id。
该值是调用[sppAccept](#socketsppaccept)或[sppConnect](#socketsppconnect)接口，通过其异步callback获取到的。 | +| callback | Callback<ArrayBuffer> | 否 | 指定取消订阅的回调函数通知。
若传参，则需与[socket.on('sppRead')](#socketonsppread)中的回调函数一致；若无传参，则取消订阅该type对应的所有回调函数通知。 | **错误码**： @@ -439,14 +439,14 @@ sppWriteAsync(clientSocket: number, data: ArrayBuffer): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | ------------ | --------------------------- | ---- | ---------------------------------------- | -| clientSocket | number | 是 | 客户端Socket的id。 | +| clientSocket | number | 是 | 客户端socket的id。
该值是调用[sppAccept](#socketsppaccept)或[sppConnect](#socketsppconnect)接口，通过其异步callback获取到的。 | | data | ArrayBuffer | 是 | 写入的数据。 | **返回值：** | 类型 | 说明 | | ----------------------------- | ---------- | -| Promise<void> | 以Promise的形式返回结果。如果成功，err为undefined，否则为错误对象。 | +| Promise<void> | Promise对象，无返回结果。 | **错误码**： @@ -494,13 +494,13 @@ sppReadAsync(clientSocket: number): Promise<ArrayBuffer> | 参数名 | 类型 | 必填 | 说明 | | ------------ | --------------------------- | ---- | ---------------------------------------- | -| clientSocket | number | 是 | 客户端Socket的id。 | +| clientSocket | number | 是 | 客户端socket的id。
该值是调用[sppAccept](#socketsppaccept)或[sppConnect](#socketsppconnect)接口，通过其异步callback获取到的。 | **返回值：** | 类型 | 说明 | | ----------------------------- | ---------- | -| Promise<ArrayBuffer> | 以Promise的形式返回读取数据结果。如果成功，值在ArrayBuffer中返回，如果失败，返回对应错误码。 | +| Promise<ArrayBuffer> | Promise对象。返回读取的数据。 | **错误码**： diff --git a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-wearDetection-sys.md b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-wearDetection-sys.md index d2823392df967177457800aaef4ff0d5aa03cca8..c1650745cba5a678823dd2fbdd5a0f91d235d408 100644 --- a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-wearDetection-sys.md +++ b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetooth-wearDetection-sys.md @@ -32,8 +32,8 @@ enableWearDetection(deviceId: string, callback: AsyncCallback<void>): void | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | -| callback | AsyncCallback<void> | 是 | 通过注册回调函数获取使能佩戴检测的结果。如果成功，err为undefined，否则为错误对象。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当使能佩戴检测成功，err为undefined，否则为错误对象。 | **错误码**： @@ -79,13 +79,13 @@ enableWearDetection(deviceId: string): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | **返回值：** | 类型 | 说明 | | ----------------------------- | ---------- | -| Promise<void> | 以Promise的形式返回结果。如果成功，err为undefined，否则为错误对象。 | +| Promise<void> | Promise对象，无返回结果。 | **错误码**： @@ -129,8 +129,8 @@ disableWearDetection(deviceId: string, callback: AsyncCallback<void>): voi | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | -| callback | AsyncCallback<void> | 是 | 通过注册回调函数获取禁用佩戴检测的结果。如果成功，err为undefined，否则为错误对象。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | +| callback | AsyncCallback<void> | 是 | 回调函数。当禁用佩戴检测成功，err为undefined，否则为错误对象。 | **错误码**： @@ -176,13 +176,13 @@ disableWearDetection(deviceId: string): Promise<void> | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | **返回值：** | 类型 | 说明 | | ----------------------------- | ---------- | -| Promise<void> | 以Promise的形式返回结果。如果成功，err为undefined，否则为错误对象。 | +| Promise<void> | Promise对象，无返回结果。 | **错误码**： @@ -214,7 +214,7 @@ try { isWearDetectionSupported(deviceId: string, callback: AsyncCallback<boolean>): void -获取设备是否支持佩戴检测。使用Callback异步回调。 +判断设备是否支持佩戴检测能力。使用Callback异步回调。 **系统接口**：此接口为系统接口。 @@ -226,8 +226,8 @@ isWearDetectionSupported(deviceId: string, callback: AsyncCallback<boolean> | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | -| callback | AsyncCallback<boolean> | 是 | 通过注册回调函数获取设备是否支持佩戴检测。如果成功，值在supported中返回。如果失败，返回对应错误码。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | +| callback | AsyncCallback<boolean> | 是 | 回调函数。当接口调用成功，err为undefined，data为佩戴检测能力支持结果；否则为错误对象。 | **错误码**： @@ -259,7 +259,7 @@ try { isWearDetectionSupported(deviceId: string): Promise<boolean> -获取设备是否支持佩戴检测。使用Promise异步回调。 +判断设备是否支持佩戴检测能力。使用Promise异步回调。 **系统接口**：此接口为系统接口。 @@ -271,13 +271,13 @@ isWearDetectionSupported(deviceId: string): Promise<boolean> | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | **返回值：** | 类型 | 说明 | | ----------------------------- | ---------- | -| Promise<boolean> | 以Promise的形式获取设备是否支持佩戴检测。如果成功，值在supported中返回。如果失败，返回对应错误码。 | +| Promise<boolean> | Promise对象。返回true表示支持佩戴检测能力；返回false表示不支持佩戴检测能力。 | **错误码**： @@ -309,7 +309,7 @@ try { isWearDetectionEnabled(deviceId: string, callback: AsyncCallback<boolean>): void -获取设备佩戴检测是否开启。使用Callback异步回调。 +判断设备佩戴检测能力是否开启。使用Callback异步回调。 **系统接口**：此接口为系统接口。 @@ -321,8 +321,8 @@ isWearDetectionEnabled(deviceId: string, callback: AsyncCallback<boolean>) | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | -| callback | AsyncCallback<boolean> | 是 | 通过注册回调函数获取设备佩戴检测是否开启。如果成功，值在enabled中返回。如果失败，返回对应错误码。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | +| callback | AsyncCallback<boolean> | 是 | 回调函数。当接口调用成功，err为undefined，data为佩戴检测能力开启结果；否则为错误对象。 | **错误码**： @@ -354,7 +354,7 @@ try { isWearDetectionEnabled(deviceId: string): Promise<boolean> -获取设备佩戴检测是否开启。使用Promise异步回调。 +判断设备佩戴检测能力是否开启。使用Promise异步回调。 **系统接口**：此接口为系统接口。 @@ -366,13 +366,13 @@ isWearDetectionEnabled(deviceId: string): Promise<boolean> | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------- | -| deviceId | string | 是 | 远端设备地址。 | +| deviceId | string | 是 | 远端设备地址，例如："XX:XX:XX:XX:XX:XX"。 | **返回值：** | 类型 | 说明 | | ----------------------------- | ---------- | -| Promise<boolean> | 以Promise的形式获取设备佩戴检测是否开启。如果成功，值在enabled中返回。如果失败，返回对应错误码。 | +| Promise<boolean> | Promise对象。返回true表示佩戴检测能力开启；返回false表示佩戴检测能力未开启。 | **错误码**： diff --git a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetoothManager-sys.md b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetoothManager-sys.md index 211f88764cc8c92ae3977f8a4c3ffbc186dbb8b2..012f3b56fb78f8b6504fe9a8f9f41e5742e0391e 100644 --- a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetoothManager-sys.md +++ b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-bluetoothManager-sys.md @@ -65,7 +65,7 @@ try { ``` -### connect +### connect(deprecated) connect(device: string): void diff --git a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-system-bluetooth.md b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-system-bluetooth.md index 6b1e3c6ee01ef043166b28121acb04c66b2e7ddb..f5675f913bdbb3d730df4adcb68f9936bdd8c6f4 100644 --- a/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-system-bluetooth.md +++ b/zh-cn/application-dev/reference/apis-connectivity-kit/js-apis-system-bluetooth.md @@ -95,7 +95,7 @@ import bluetooth from '@system.bluetooth'; | success | Function | 是 | 寻找到新设备上报时调用的回调函数。 | | fail | Function | 否 | 接口调用失败的回调函数。 | -**表4** success返回值： +**表4** success返回值 | 参数名 | 类型 | 说明 | | -------- | -------- | -------- |