Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
You need to sign in or sign up before continuing.
提交 c37d71e1 编写于 作者: A Annie_wang
浏览文件
操作

update docs 

Signed-off-by: NAnnie_wang <annie.wangli@huawei.com>
上级 93c4c64e
显示空白变更内容
内联 并排
Showing with 58 addition and 58 deletion
en/application-dev/reference/apis/js-apis-bluetooth.md
浏览文件 @ c37d71e1
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
> **NOTE**<br> > **NOTE**<br>
> The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. > The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.
Provides Classic Bluetooth capabilities and Bluetooth Low Energy (BLE) scan and advertising. The Bluetooth module provides classic Bluetooth capabilities and Bluetooth Low Energy (BLE) scan and advertising.
## Modules to Import ## Modules to Import
...@@ -13,17 +13,6 @@ import bluetooth from '@ohos.bluetooth'; ...@@ -13,17 +13,6 @@ import bluetooth from '@ohos.bluetooth';
``` ```
## Required Permissions
ohos.permission.USE_BLUETOOTH
ohos.permission.MANAGE_BLUETOOTH
ohos.permission.DISCOVER_BLUETOOTH
ohos.permission.LOCATION
## bluetooth.enableBluetooth<sup>8+</sup><a name="enableBluetooth"></a> ## bluetooth.enableBluetooth<sup>8+</sup><a name="enableBluetooth"></a>
enableBluetooth(): boolean enableBluetooth(): boolean
...@@ -202,7 +191,7 @@ let result = bluetooth.pairDevice("XX:XX:XX:XX:XX:XX"); ...@@ -202,7 +191,7 @@ let result = bluetooth.pairDevice("XX:XX:XX:XX:XX:XX");
getProfileConnState(profileId: ProfileId): ProfileConnectionState getProfileConnState(profileId: ProfileId): ProfileConnectionState
Obtains the connection status of a profile. Obtains the connection state of a profile.
**Required permissions**: ohos.permission.USE_BLUETOOTH **Required permissions**: ohos.permission.USE_BLUETOOTH
...@@ -233,6 +222,8 @@ cancelPairedDevice(deviceId: string): boolean ...@@ -233,6 +222,8 @@ cancelPairedDevice(deviceId: string): boolean
Cancels a paired remote device. Cancels a paired remote device.
This is a system API.
**Required permissions**: ohos.permission.DISCOVER_BLUETOOTH **Required permissions**: ohos.permission.DISCOVER_BLUETOOTH
**System capability**: SystemCapability.Communication.Bluetooth.Core **System capability**: SystemCapability.Communication.Bluetooth.Core
...@@ -397,7 +388,7 @@ startBluetoothDiscovery(): boolean ...@@ -397,7 +388,7 @@ startBluetoothDiscovery(): boolean
Starts Bluetooth scan to discover remote devices. Starts Bluetooth scan to discover remote devices.
**Required permissions**: ohos.permission.USE_BLUETOOTH and ohos.permission.LOCATION **Required permissions**: ohos.permission.DISCOVER_BLUETOOTH and ohos.permission.LOCATION
**System capability**: SystemCapability.Communication.Bluetooth.Core **System capability**: SystemCapability.Communication.Bluetooth.Core
...@@ -1277,7 +1268,7 @@ No value is returned. ...@@ -1277,7 +1268,7 @@ No value is returned.
getDeviceState(device: string): ProfileConnectionState getDeviceState(device: string): ProfileConnectionState
Obtains the connection status of the profile. Obtains the connection state of the profile.
**Required permissions**: ohos.permission.USE_BLUETOOTH **Required permissions**: ohos.permission.USE_BLUETOOTH
...@@ -1315,7 +1306,7 @@ Sets up an Advanced Audio Distribution Profile (A2DP) connection. ...@@ -1315,7 +1306,7 @@ Sets up an Advanced Audio Distribution Profile (A2DP) connection.
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| device | string | Yes | Address of the remote device to connect.| | device | string | Yes | Address of the target device.|
| |
**Return value** **Return value**
...@@ -1347,7 +1338,7 @@ Disconnects an A2DP connection. ...@@ -1347,7 +1338,7 @@ Disconnects an A2DP connection.
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| ------ | ------ | ---- | ------- | | ------ | ------ | ---- | ------- |
| device | string | Yes | Address of the remote device to disconnect.| | device | string | Yes | Address of the target device.|
| |
**Return value** **Return value**
...@@ -1369,7 +1360,7 @@ let ret = a2dpSrc.disconnect('XX:XX:XX:XX:XX:XX'); ...@@ -1369,7 +1360,7 @@ let ret = a2dpSrc.disconnect('XX:XX:XX:XX:XX:XX');
on(type: "connectionStateChange", callback: Callback&lt;[StateChangeParam](#StateChangeParam)&gt;): void on(type: "connectionStateChange", callback: Callback&lt;[StateChangeParam](#StateChangeParam)&gt;): void
Subscribes to the A2DP connection status change events. Subscribes to the A2DP connection state change events.
**System capability**: SystemCapability.Communication.Bluetooth.Core **System capability**: SystemCapability.Communication.Bluetooth.Core
...@@ -1396,9 +1387,9 @@ A2dpSourceProfile.on('connectionStateChange', onReceiveEvent); ...@@ -1396,9 +1387,9 @@ A2dpSourceProfile.on('connectionStateChange', onReceiveEvent);
### A2dpSourceProfile.off('connectionStateChange')<sup>8+</sup> ### A2dpSourceProfile.off('connectionStateChange')<sup>8+</sup>
off(type: "connectionStateChange", callback: Callback&lt;[StateChangeParam](#StateChangeParam)&gt;): void off(type: "connectionStateChange", callback?: Callback&lt;[StateChangeParam](#StateChangeParam)&gt;): void
Unsubscribes from the A2DP connection status change events. Unsubscribes from the A2DP connection state change events.
**System capability**: SystemCapability.Communication.Bluetooth.Core **System capability**: SystemCapability.Communication.Bluetooth.Core
...@@ -1423,11 +1414,13 @@ A2dpSourceProfile.off('connectionStateChange', onReceiveEvent); ...@@ -1423,11 +1414,13 @@ A2dpSourceProfile.off('connectionStateChange', onReceiveEvent);
``` ```
### getPlayingState ### getPlayingState<sup>9+</sup>
getPlayingState(device: string): PlayingState getPlayingState(device: string): PlayingState
Obtains the playing status of a device. Obtains the playing state of a device.
**Required permissions**: ohos.permission.USE_BLUETOOTH
**System capability**: SystemCapability.Communication.Bluetooth.Core **System capability**: SystemCapability.Communication.Bluetooth.Core
...@@ -1442,7 +1435,7 @@ Obtains the playing status of a device. ...@@ -1442,7 +1435,7 @@ Obtains the playing status of a device.
| | | | | |
| ----------------------------- | ---------- | | ----------------------------- | ---------- |
| Type | Description | | Type | Description |
| [PlayingState](#PlayingState) | Playing status obtained. | | [PlayingState](#PlayingState) | Playing state obtained. |
**Example** **Example**
...@@ -1524,7 +1517,7 @@ let ret = hfpAg.disconnect('XX:XX:XX:XX:XX:XX'); ...@@ -1524,7 +1517,7 @@ let ret = hfpAg.disconnect('XX:XX:XX:XX:XX:XX');
on(type: "connectionStateChange", callback: Callback&lt;[StateChangeParam](#StateChangeParam)&gt;): void on(type: "connectionStateChange", callback: Callback&lt;[StateChangeParam](#StateChangeParam)&gt;): void
Subscribes to the HFP connection status change events. Subscribes to the HFP connection state change events.
**System capability**: SystemCapability.Communication.Bluetooth.Core **System capability**: SystemCapability.Communication.Bluetooth.Core
...@@ -1533,7 +1526,7 @@ Subscribes to the HFP connection status change events. ...@@ -1533,7 +1526,7 @@ Subscribes to the HFP connection status change events.
| Name | Type | Mandatory | Description | | Name | Type | Mandatory | Description |
| -------- | ---------------------------------------- | ---- | ---------------------------------------- | | -------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | Yes | Event type. The value **connectionStateChange** indicates an HFP connection state change event.| | type | string | Yes | Event type. The value **connectionStateChange** indicates an HFP connection state change event.|
| callback | Callback&lt;[StateChangeParam](#StateChangeParam)&gt; | Yes | Callback invoked to return the HFP connection state change event. | | callback | Callback&lt;[StateChangeParam](#StateChangeParam)&gt; | Yes | Callback used to return the HFP connection state change event. |
**Return value** **Return value**
...@@ -1551,9 +1544,9 @@ HandsFreeAudioGatewayProfile.on('connectionStateChange', onReceiveEvent); ...@@ -1551,9 +1544,9 @@ HandsFreeAudioGatewayProfile.on('connectionStateChange', onReceiveEvent);
### HandsFreeAudioGatewayProfile.off('connectionStateChange')<sup>8+</sup> ### HandsFreeAudioGatewayProfile.off('connectionStateChange')<sup>8+</sup>
off(type: "connectionStateChange", callback: Callback&lt;[StateChangeParam](#StateChangeParam)&gt;): void off(type: "connectionStateChange", callback?: Callback&lt;[StateChangeParam](#StateChangeParam)&gt;): void
Unsubscribes from the HFP connection status change events. Unsubscribes from the HFP connection state change events.
**System capability**: SystemCapability.Communication.Bluetooth.Core **System capability**: SystemCapability.Communication.Bluetooth.Core
...@@ -1807,6 +1800,16 @@ Notifies the connected client device when a characteristic value changes. ...@@ -1807,6 +1800,16 @@ Notifies the connected client device when a characteristic value changes.
**Example** **Example**
```js ```js
// Create descriptors.
let descriptors = [];
let arrayBuffer = new ArrayBuffer(8);
let descV = new Uint8Array(arrayBuffer);
descV[0] = 11;
let descriptor = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB',
descriptorUuid: '00001830-0000-1000-8000-00805F9B34FB', descriptorValue: arrayBuffer};
descriptors[0] = descriptor;
let arrayBufferC = new ArrayBuffer(8); let arrayBufferC = new ArrayBuffer(8);
let characteristic = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB', let characteristic = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB', characteristicValue: arrayBufferC, descriptors:descriptors}; characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB', characteristicValue: arrayBufferC, descriptors:descriptors};
...@@ -2178,7 +2181,6 @@ let gattServer = bluetooth.BLE.createGattServer(); ...@@ -2178,7 +2181,6 @@ let gattServer = bluetooth.BLE.createGattServer();
gattServer.off("descriptorWrite"); gattServer.off("descriptorWrite");
``` ```
### on('connectStateChange') ### on('connectStateChange')
on(type: "connectStateChange", callback: Callback&lt;BLEConnectChangedState&gt;): void on(type: "connectStateChange", callback: Callback&lt;BLEConnectChangedState&gt;): void
...@@ -2325,7 +2327,7 @@ let ret = device.close(); ...@@ -2325,7 +2327,7 @@ let ret = device.close();
getServices(callback: AsyncCallback&lt;Array&lt;GattService&gt;&gt;): void getServices(callback: AsyncCallback&lt;Array&lt;GattService&gt;&gt;): void
Obtains all services of the remote BLE device. This method uses an asynchronous callback to return the result. Obtains all services of the remote BLE device. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.USE_BLUETOOTH **Required permissions**: ohos.permission.USE_BLUETOOTH
...@@ -2367,7 +2369,7 @@ device.getServices(getServices); ...@@ -2367,7 +2369,7 @@ device.getServices(getServices);
getServices(): Promise&lt;Array&lt;GattService&gt;&gt; getServices(): Promise&lt;Array&lt;GattService&gt;&gt;
Obtains all services of the remote BLE device. This method uses a promise to return the result. Obtains all services of the remote BLE device. This API uses a promise to return the result.
**Required permissions**: ohos.permission.USE_BLUETOOTH **Required permissions**: ohos.permission.USE_BLUETOOTH
...@@ -2385,14 +2387,9 @@ Obtains all services of the remote BLE device. This method uses a promise to ret ...@@ -2385,14 +2387,9 @@ Obtains all services of the remote BLE device. This method uses a promise to ret
```js ```js
// Promise // Promise
let device = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX'); gattClientDevice.getServices().then(result => {
device.connect(); console.info("Got services successfully:" + JSON.stringify(result));
var services = device.getServices(); });
console.log("bluetooth services size is ", services.length);
for (let i = 0; i < services.length; i++) {
console.log('bluetooth serviceUuid is ' + services[i].serviceUuid);
}
``` ```
...@@ -2400,7 +2397,7 @@ for (let i = 0; i < services.length; i++) { ...@@ -2400,7 +2397,7 @@ for (let i = 0; i < services.length; i++) {
readCharacteristicValue(characteristic: BLECharacteristic, callback: AsyncCallback&lt;BLECharacteristic&gt;): void readCharacteristicValue(characteristic: BLECharacteristic, callback: AsyncCallback&lt;BLECharacteristic&gt;): void
Reads the characteristic value of the specific service of the remote BLE device. This method uses an asynchronous callback to return the result. Reads the characteristic value of the specific service of the peer BLE device. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.USE_BLUETOOTH **Required permissions**: ohos.permission.USE_BLUETOOTH
...@@ -2454,7 +2451,7 @@ device.readCharacteristicValue(characteristic, readCcc); ...@@ -2454,7 +2451,7 @@ device.readCharacteristicValue(characteristic, readCcc);
readCharacteristicValue(characteristic: BLECharacteristic): Promise&lt;BLECharacteristic&gt; readCharacteristicValue(characteristic: BLECharacteristic): Promise&lt;BLECharacteristic&gt;
Reads the characteristic value of the specific service of the remote BLE device. This method uses a promise to return the result. Reads the characteristic value of the specific service of the remote BLE device. This API uses a promise to return the result.
**Required permissions**: ohos.permission.USE_BLUETOOTH **Required permissions**: ohos.permission.USE_BLUETOOTH
...@@ -2501,7 +2498,7 @@ device.readCharacteristicValue(characteristic); ...@@ -2501,7 +2498,7 @@ device.readCharacteristicValue(characteristic);
readDescriptorValue(descriptor: BLEDescriptor, callback: AsyncCallback&lt;BLEDescriptor&gt;): void readDescriptorValue(descriptor: BLEDescriptor, callback: AsyncCallback&lt;BLEDescriptor&gt;): void
Reads the descriptor contained in the specific characteristic of the remote BLE device. This method uses an asynchronous callback to return the result. Reads the descriptor contained in the specific characteristic of the peer BLE device. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.USE_BLUETOOTH **Required permissions**: ohos.permission.USE_BLUETOOTH
...@@ -2545,7 +2542,7 @@ device.readDescriptorValue(descriptor, readDesc); ...@@ -2545,7 +2542,7 @@ device.readDescriptorValue(descriptor, readDesc);
readDescriptorValue(descriptor: BLEDescriptor): Promise&lt;BLEDescriptor&gt; readDescriptorValue(descriptor: BLEDescriptor): Promise&lt;BLEDescriptor&gt;
Reads the descriptor contained in the specific characteristic of the remote BLE device. This method uses a promise to return the result. Reads the descriptor contained in the specific characteristic of the remote BLE device. This API uses a promise to return the result.
**Required permissions**: ohos.permission.USE_BLUETOOTH **Required permissions**: ohos.permission.USE_BLUETOOTH
...@@ -2725,6 +2722,16 @@ Sets the function of notifying the GATT client when the characteristic value of ...@@ -2725,6 +2722,16 @@ Sets the function of notifying the GATT client when the characteristic value of
**Example** **Example**
```js ```js
// Create descriptors.
let descriptors = [];
let arrayBuffer = new ArrayBuffer(8);
let descV = new Uint8Array(arrayBuffer);
descV[0] = 11;
let descriptor = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB',
descriptorUuid: '00001830-0000-1000-8000-00805F9B34FB', descriptorValue: arrayBuffer};
descriptors[0] = descriptor;
let arrayBufferC = new ArrayBuffer(8); let arrayBufferC = new ArrayBuffer(8);
let characteristic = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB', let characteristic = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB', characteristicValue: arrayBufferC, descriptors:descriptors}; characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB', characteristicValue: arrayBufferC, descriptors:descriptors};
...@@ -2862,7 +2869,7 @@ device.off('BLEConnectionStateChange'); ...@@ -2862,7 +2869,7 @@ device.off('BLEConnectionStateChange');
getDeviceName(callback: AsyncCallback&lt;string&gt;): void getDeviceName(callback: AsyncCallback&lt;string&gt;): void
Obtains the name of the remote BLE device. This method uses an asynchronous callback to return the result. Obtains the name of the remote BLE device. This API uses an asynchronous callback to return the result.
**Required permissions**: ohos.permission.USE_BLUETOOTH **Required permissions**: ohos.permission.USE_BLUETOOTH
...@@ -2894,7 +2901,7 @@ let deviceName = gattClient.getDeviceName((err, data)=> { ...@@ -2894,7 +2901,7 @@ let deviceName = gattClient.getDeviceName((err, data)=> {
getDeviceName(): Promise&lt;string&gt; getDeviceName(): Promise&lt;string&gt;
Obtains the name of the remote BLE device. This method uses a promise to return the result. Obtains the name of the remote BLE device. This API uses a promise to return the result.
**Required permissions**: ohos.permission.USE_BLUETOOTH **Required permissions**: ohos.permission.USE_BLUETOOTH
...@@ -2922,7 +2929,7 @@ let deviceName = gattClient.getDeviceName().then((data) => { ...@@ -2922,7 +2929,7 @@ let deviceName = gattClient.getDeviceName().then((data) => {
getRssiValue(callback: AsyncCallback&lt;number&gt;): void getRssiValue(callback: AsyncCallback&lt;number&gt;): void
Obtains the received signal strength indication (RSSI) of the remote BLE device. This method uses an asynchronous callback to return the result. It can be used only after a connection is set up by calling [connect](#connect). Obtains the received signal strength indication (RSSI) of the remote BLE device. This API uses an asynchronous callback to return the result. It can be used only after a connection is set up by calling [connect](#connect).
**Required permissions**: ohos.permission.USE_BLUETOOTH **Required permissions**: ohos.permission.USE_BLUETOOTH
...@@ -2955,7 +2962,7 @@ let rssi = gattClient.getRssiValue((err, data)=> { ...@@ -2955,7 +2962,7 @@ let rssi = gattClient.getRssiValue((err, data)=> {
getRssiValue(): Promise&lt;number&gt; getRssiValue(): Promise&lt;number&gt;
Obtains the RSSI of the remote BLE device. This method uses a promise to return the result. It can be used only after a connection is set up by calling [connect](#connect). Obtains the RSSI of the remote BLE device. This API uses a promise to return the result. It can be used only after a connection is set up by calling [connect](#connect).
**Required permissions**: ohos.permission.USE_BLUETOOTH **Required permissions**: ohos.permission.USE_BLUETOOTH
......
en/application-dev/reference/apis/js-apis-system-bluetooth.md
浏览文件 @ c37d71e1
...@@ -120,19 +120,12 @@ Subscribes to the newly detected BLE device. If this API is called multiple time ...@@ -120,19 +120,12 @@ Subscribes to the newly detected BLE device. If this API is called multiple time
**Example** **Example**
``` ```
bluetooth.startBLEScan({
success() {
bluetooth.subscribeBLEFound({ bluetooth.subscribeBLEFound({
success(data) { success(data) {
const [device] = data.devices; console.log('Called bluetooth.subscribeBLEFound successsully, data: ${data}.');
if (!!device) {
bluetooth.stopBLEScan();
}
}
});
}, },
fail(code, data) { fail(data, code) {
console.log('Failed to start BLE device scan, code: ${code}, data: ${data}'); console.log('Failed to call bluetooth.startBLEScan, data: ${data}, code: ${code}.');
} }
}); });
``` ```
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或