@system.bluetooth (Bluetooth)

NOTE

• The APIs of this module are no longer maintained since API version 7. You are advised to use @ohos.bluetooth.

• The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import bluetooth from '@system.bluetooth';

bluetooth.startBLEScan(OBJECT)

Scans for Bluetooth Low Energy (BLE) devices nearby. This operation consumes system resources. Call bluetooth.stopBLEScan to stop the scan after a BLE device is detected and connected.

System capability: SystemCapability.Communication.Bluetooth.Lite

Parameters

Table 1 StartBLEScanOptions

Example

bluetooth.startBLEScan({
  interval:0,
  success() {
    console.log('call bluetooth.startBLEScan success.');
  },
  fail(code, data) {
    console.log('call bluetooth.startBLEScan failed, code:' + code + ', data:' + data);
  },
  complete() {
    console.log('call bluetooth.startBLEScan complete.');
  }
});

bluetooth.stopBLEScan(OBJECT)

Stops scanning for BLE devices nearby. This API is used with bluetooth.startBLEScan(OBJECT) in pairs.

System capability: SystemCapability.Communication.Bluetooth.Lite

Parameters

Table 2 StopBLEScanOptions

Example

bluetooth.stopBLEScan({
  success() {
    console.log('call bluetooth.stopBLEScan success.');
  },
  fail(data, code) {
    console.log('call bluethooth.stopBLEScan fail, code:' + code + ', data:' + data);
  },
  complete() {
    console.log('call bluethooth.stopBLEScan complete.');
  }
});

bluetooth.subscribeBLEFound(OBJECT)

Subscribes to the newly detected BLE device. If this API is called multiple times, the last call takes effect.

System capability: SystemCapability.Communication.Bluetooth.Lite

Parameters Table 3 SubscribeBLEFoundOptions

Table 4 Return value in success

Table 5 BluethoothDevice

Example

bluetooth.subscribeBLEFound({
  success(data) {
    console.log('call bluetooth.subscribeBLEFound success, data: ${data}.');
  },
  fail(data, code) {
    console.log('call bluetooth.startBLEScan failed, code:' + code + ', data:' + data);
  }
});

bluetooth.unsubscribeBLEFound()

Unsubscribes from the newly detected devices.

System capability: SystemCapability.Communication.Bluetooth.Lite

Example

bluetooth.unsubscribeBLEFound();

Common Error Codes