Update the scan interface based on latest updates

Author: sgbihu

libraries/BLE/examples/central/led_control/led_control.ino

@@ -37,7 +37,7 @@ void setup() {
   Serial.println("BLE Central - LED control");
 
   // start scanning for peripherals
-  BLE.startScanning();
+  BLE.scan();
 }
 
 void loop() {
@@ -57,12 +57,12 @@ void loop() {
     // see if peripheral is advertising the LED service
     if (peripheral.advertisedServiceUuid() == "19b10000-e8f2-537e-4f6c-d104768a1214") {
       // stop scanning
-      BLE.stopScanning();
+      BLE.stopScan();
 
       controlLed(peripheral);
 
       // peripheral disconnected, start scanning again
-      BLE.startScanning();
+      BLE.scan();
     }
   }
 }

libraries/BLE/examples/central/peripheral_explorer/peripheral_explorer.ino

@@ -28,7 +28,7 @@ void setup() {
   Serial.println("BLE Central - Peripheral Explorer");
 
   // start scanning for peripherals
-  BLE.startScanning();
+  BLE.scan();
 }
 
 void loop() {
@@ -48,7 +48,7 @@ void loop() {
     // see if peripheral is a SensorTag
     if (peripheral.localName() == "SensorTag") {
       // stop scanning
-      BLE.stopScanning();
+      BLE.stopScan();
 
       explorerPeripheral(peripheral);
 

libraries/BLE/examples/central/scan/scan.ino

@@ -28,7 +28,7 @@ void setup() {
   Serial.println("BLE Central scan");
 
   // start scanning for peripheral
-  BLE.startScanning();
+  BLE.scan();
 }
 
 void loop() {

libraries/BLE/examples/central/scan_callback/scan_callback.ino

@@ -31,7 +31,7 @@ void setup() {
   BLE.setEventHandler(BLEDiscovered, bleCentralDiscoverHandler);
 
   // start scanning for peripherals with duplicates
-  BLE.startScanningWithDuplicates();
+  BLE.scan(true);
 }
 
 void loop() {

libraries/BLE/examples/central/sensortag_button/sensortag_button.ino

@@ -28,7 +28,7 @@ void setup() {
   Serial.println("BLE Central - SensorTag button");
 
   // start scanning for peripheral
-  BLE.startScanning();
+  BLE.scan();
 }
 
 void loop() {
@@ -48,12 +48,12 @@ void loop() {
     // see if peripheral is a SensorTag
     if (peripheral.localName() == "SensorTag") {
       // stop scanning
-      BLE.stopScanning();
+      BLE.stopScan();
 
       monitorSensorTagButtons(peripheral);
 
       // peripheral disconnected, start scanning again
-      BLE.startScanning();
+      BLE.scan();
     }
   }
 }

libraries/BLE/src/BLEDevice.cpp

@@ -212,33 +212,55 @@ bool BLEDevice::operator!=(const BLEDevice& device) const
 }
 
 
-void BLEDevice::startScanning()
+bool BLEDevice::startScan(bool withDuplicates)
 {
     preCheckProfile();
+    if (withDuplicates)
+    {
+        return BLEDeviceManager::instance()->startScanningWithDuplicates();
+    }
+    else
+    {
+        return BLEDeviceManager::instance()->startScanning();
+    }
+}
+
+
+void BLEDevice::scan()
+{
+    scan(false);
+}
+
+void BLEDevice::scan(bool withDuplicates)
+{
     BLEDeviceManager::instance()->clearAdvertiseCritical();
-    BLEDeviceManager::instance()->startScanning();
+    startScan(withDuplicates);
 }
 
-void BLEDevice::startScanning(String name)
+void BLEDevice::scanFoName(String name)
+{
+    scanFoName(name, false);
+}
+
+void BLEDevice::scanFoName(String name, bool withDuplicates)
 {
-    preCheckProfile();
     BLEDeviceManager::instance()->setAdvertiseCritical(name);
-    BLEDeviceManager::instance()->startScanning();
+    startScan(withDuplicates);
 }
 
-void BLEDevice::startScanning(BLEService& service)
+void BLEDevice::scanForUuid(String uuid)
 {
-    preCheckProfile();
-    BLEDeviceManager::instance()->setAdvertiseCritical(service);
-    BLEDeviceManager::instance()->startScanning();
+    scanForUuid(uuid, false);
 }
 
-void BLEDevice::startScanningWithDuplicates()
+void BLEDevice::scanForUuid(String uuid, bool withDuplicates)
 {
-    // TODO
+    BLEService service_temp(uuid.c_str());
+    BLEDeviceManager::instance()->setAdvertiseCritical(service_temp);
+    startScan(withDuplicates);
 }
 
-void BLEDevice::stopScanning()
+void BLEDevice::stopScan()
 {
     BLEDeviceManager::instance()->stopScanning();
 }

libraries/BLE/src/BLEDevice.h

@@ -342,6 +342,9 @@ class BLEDevice
     bool operator!=(const BLEDevice& device) const;
 
     // central mode
+
+    //void scanForAddress(String address); // Not include in baseline. Add here as feature for feature release.
+    
     /**
      * @brief   Start scanning for peripherals without filter
      *
@@ -351,7 +354,20 @@ class BLEDevice
      *
      * @note  none
      */
-    void startScanning();
+    void scan();
+    
+    /**
+     * @brief   Start scanning for peripherals with filter
+     *
+     * @param[in] withDuplicates        true - with duplicate filter
+     *                                  false- without duplicate filter
+     *
+     * @return  none
+     *
+     * @note  option to filter out duplicate addresses for Arduino.
+     *          The current only support fileter duplicate mode.
+     */
+    void scan(bool withDuplicates);
 
     /**
      * @brief   Start scanning for peripherals and filter by device name in ADV
@@ -360,9 +376,25 @@ class BLEDevice
      *
      * @return  none
      *
-     * @note  none
+     * @note   option to filter out duplicate addresses for Arduino.
+     *          The current only support fileter duplicate mode.
      */
-    void startScanning(String name);
+    void scanFoName(String name);
+    
+    /**
+     * @brief   Start scanning for peripherals and filter by device name in ADV
+     *
+     * @param[in]   name    The device's local name.
+     *
+     * @param[in]   withDuplicates      true - with duplicate filter
+     *                                  false- without duplicate filter
+     *
+     * @return  none
+     *
+     * @note   option to filter out duplicate addresses for Arduino.
+     *          The current only support fileter duplicate mode.
+     */
+    void scanFoName(String name, bool withDuplicates);
 
     /**
      * @brief   Start scanning for peripherals and filter by service in ADV
@@ -373,20 +405,22 @@ class BLEDevice
      *
      * @note  none
      */
-    void startScanning(BLEService& service);
+    void scanForUuid(String uuid);
 
     /**
-     * @brief   start scanning for peripherals, and report all duplicates
+     * @brief   Start scanning for peripherals and filter by service in ADV
      *
-     * @param   none
+     * @param[in]   service    The service
+     *
+     * @param[in]   withDuplicates      true - with duplicate filter
+     *                                  false- without duplicate filter
      *
      * @return  none
      *
-     * @note  none 
-         // Does this necessory? This will take more memory to store the ADV
-         //  I suggest delete it.
+     * @note   option to filter out duplicate addresses for Arduino.
+     *          The current only support fileter duplicate mode.
      */
-    void startScanningWithDuplicates();
+    void scanForUuid(String uuid, bool withDuplicates); 
 
     /**
      * @brief   Stop scanning for peripherals
@@ -397,7 +431,7 @@ class BLEDevice
      *
      * @note  none
      */
-    void stopScanning();
+    void stopScan();
 
     /**
      * @brief   Retrieve a discovered peripheral
@@ -631,6 +665,19 @@ class BLEDevice
 private:
     void preCheckProfile();
 
+    /**
+     * @brief   Start scanning for peripherals with/without duplicate filter
+     *
+     * @param[in] withDuplicates        true - with duplicate filter
+     *                                  false- without duplicate filter
+     *
+     * @return  none
+     *
+     * @note  option to filter out duplicate addresses for Arduino.
+     *          The current only support fileter duplicate mode.
+     */
+    bool startScan(bool withDuplicates);
+    
 private:
     bt_addr_le_t _bt_addr;
 

libraries/BLE/src/BLEService.cpp

@@ -36,6 +36,7 @@ BLEService::BLEService(const char* uuid):_bledevice(),
 {
     bt_uuid_128_t uuid_tmp;
     memset(_uuid_cstr, 0, sizeof (_uuid_cstr));
+    
     BLEUtils::uuidString2BT(uuid, (bt_uuid_t *)&uuid_tmp);
     BLEUtils::uuidBT2String((const bt_uuid_t *)&uuid_tmp, _uuid_cstr);
 
@@ -55,6 +56,7 @@ BLEService::BLEService(BLEServiceImp* serviceImp, const BLEDevice* bledev):
     _service_local_imp(NULL)
 {
     memset(_uuid_cstr, 0, sizeof (_uuid_cstr));
+    
     BLEUtils::uuidBT2String(serviceImp->bt_uuid(), _uuid_cstr);
 }