The Arduino Reference text is licensed under a Creative Commons Attribution-Share Alike 3.0 License.

Find anything that can be improved? Suggest corrections and new documentation via GitHub.

Doubts on how to use Github? Learn everything you need to know in this tutorial.

Reference > Libraries > Arduinoble > Ble.scanforname

ArduinoBLE - BLE.scanForName()

Start scanning for Bluetooth® Low Energy devices that are advertising with a particular (local) name.

Syntax

BLE.scanForName(name)
BLE.scanForName(name, withDuplicates)

Parameters

  • name: (local) name of device (as a String) to filter for
  • withDuplicates: optional, defaults to false. If true, advertisements received more than once will not be filtered.

Returns

  • 1 on success,
  • 0 on failure.

Example


  // begin initialization
  if (!BLE.begin()) {
    Serial.println("starting Bluetooth® Low Energy module failed!");

    while (1);
  }

  Serial.println("BLE Central scan");

  // start scanning for peripheral
  BLE.scanForName("LED");

  

  BLEDevice peripheral = BLE.available();

  if (peripheral) {
     // ...
  }