Jira 896, BLE scan withDuplicates logic inversion, git 476

Bug fixed:
  This feature was implemented in PR arduino#457, merged, and released
in Deneb.RC1.  However, it was discovered that the logic was
inverted and was report as Git issue arduino#476.  BLE scan() and
input parameter withDuplicates is true means reporting all
Peripherals detected regardless how many times it was reported.

Code mods:
1.  libraries/CurieBLE/src/BLEDevice.cpp:
    - In startScan, calls the correct routine to scan for all
      Peripherals if withDuplicates is true.  Otherwise,
      just scan for new ones.
2.  libraries/CurieBLE/src/BLEDevice.h:
    - Prototyping.
3.  libraries/CurieBLE/src/internal/BLEDeviceManager.h,
    libraries/CurieBLE/src/internal/BLEDeviceManager.cpp
    - Modified header comment to reflect the input parameter
      withDuplictes correct meaning.
    - Default the input parameter, withDupilcates, as true.
    - And, consequently, eliminated some redundant methods.

Author: SidLeung

libraries/CurieBLE/src/BLEDevice.cpp

@@ -247,38 +247,22 @@ bool BLEDevice::startScan(bool withDuplicates)
     }
     else
     {
-        return BLEDeviceManager::instance()->startScanning();
+        return BLEDeviceManager::instance()->startScanningNewPeripherals();
     }
 }
 
-
-void BLEDevice::scan()
-{
-    scan(false);
-}
-
 void BLEDevice::scan(bool withDuplicates)
 {
     BLEDeviceManager::instance()->clearAdvertiseCritical();
     startScan(withDuplicates);
 }
 
-void BLEDevice::scanForName(String name)
-{
-    scanForName(name, false);
-}
-
 void BLEDevice::scanForName(String name, bool withDuplicates)
 {
     BLEDeviceManager::instance()->setAdvertiseCritical(name);
     startScan(withDuplicates);
 }
 
-void BLEDevice::scanForUuid(String uuid)
-{
-    scanForUuid(uuid, false);
-}
-
 void BLEDevice::scanForUuid(String uuid, bool withDuplicates)
 {
     BLEService service_temp(uuid.c_str());

libraries/CurieBLE/src/BLEDevice.h

@@ -361,83 +361,70 @@ class BLEDevice
     //void scanForAddress(String address); // Not include in baseline. Add here as feature for feature release.
 
     /**
-     * @brief   Start scanning for peripherals without filter
+     * @brief   Start scanning for peripherals with the option of accepting all detectable
+     *          Peripherals or just the newly detected.
      *
-     * @param   none
-     *
-     * @return  none
-     *
-     * @note  none
-     */
-    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
-     *
-     * @param   name    The device's local name.
+     * @param[in] withDuplicates        true - return all detectable Peripherals.
+     *                                  false- return only new Peripherals.
      *
      * @return  none
      *
-     * @note   option to filter out duplicate addresses for Arduino.
-     *          The current only support fileter duplicate mode.
+     * @note  When, withDuplicates = true (default), accept all detectable Peripherals.
+     *        No Peripheral filtering process applied to the scan result.
      */
-    void scanForName(String name);
+    void scan(bool withDuplicates = true);
 
     /**
-     * @brief   Start scanning for peripherals and filter by device name in ADV
+     * @brief   Start scanning for peripherals and filter by device name in ADV and
+     *          the option of accepting all detectable Peripherals or just the
+     *          newly detected.
      *
      * @param[in]   name    The device's local name.
      *
-     * @param[in]   withDuplicates      true - with duplicate filter
-     *                                  false- without duplicate filter
+     * @param[in]   withDuplicates      true - return all detectable Peripherals.
+     *                                  false- return only new Peripherals.
      *
      * @return  none
      *
-     * @note   option to filter out duplicate addresses for Arduino.
-     *          The current only support fileter duplicate mode.
+     * @note   When, withDuplicates = true (default), accept all detectable Peripherals.
+     *        No Peripheral filtering process applied to the scan result.
      */
-    void scanForName(String name, bool withDuplicates);
+    void scanForName(String name, bool withDuplicates = true);
 
     /**
-     * @brief   Start scanning for peripherals and filter by service in ADV
+     * @brief   Start scanning for peripherals and filter by service in ADV and
+     *          the option of accepting all detectable Peripherals or just the
+     *          newly detected.
      *
-     * @param   service    The service
+     * @param[in]   service    The service
+     *
+     * @param[in]   withDuplicates      true - return all detectable Peripherals.
+     *                                  false- return only new Peripherals.
      *
      * @return  none
      *
-     * @note  none
+     * @note   When, withDuplicates = true (default), accept all detectable Peripherals.
+     *        No Peripheral filtering process applied to the scan result.
      */
-    void scanForUuid(String uuid);
+    void scanForUuid(String uuid, bool withDuplicates = true);
 
     /**
-     * @brief   Start scanning for peripherals and filter by service in ADV
+     * @brief   Start scanning for peripherals and filter by MAC address and
+     *          the option of accepting all detectable Peripherals or just the
+     *          newly detected.
      *
-     * @param[in]   service    The service
+     * @param[in]   macaddr     The Peripheral MAC address
      *
-     * @param[in]   withDuplicates      true - with duplicate filter
-     *                                  false- without duplicate filter
+     * @param[in]   withDuplicates      true - return all detectable Peripherals.
+     *                                  false- return only new Peripherals.
      *
      * @return  none
      *
-     * @note   option to filter out duplicate addresses for Arduino.
-     *          The current only support fileter duplicate mode.
+     * @note   When, withDuplicates = true (default), accept all detectable Peripherals.
+     *        No Peripheral filtering process applied to the scan result.
      */
-    void scanForUuid(String uuid, bool withDuplicates);
-    
     void scanForAddress(String macaddr, bool withDuplicates = true);
+
     /**
      * @brief   Stop scanning for peripherals
      *
@@ -679,15 +666,15 @@ class BLEDevice
     void preCheckProfile();
 
     /**
-     * @brief   Start scanning for peripherals with/without duplicate filter
+     * @brief   Start scanning for peripherals with the option of accepting all
+     *          detectable Peripherals or just the newly detected.
      *
      * @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.
+     * @note  When, withDuplicates = true (default), accept all detectable Peripherals.
      */
     bool startScan(bool withDuplicates);
 

libraries/CurieBLE/src/internal/BLEDeviceManager.cpp

@@ -593,7 +593,7 @@ void BLEDeviceManager::_clearAdvertiseBuffer()
 
 }
 
-bool BLEDeviceManager::startScanning()
+bool BLEDeviceManager::startScanningWithDuplicates()
 {
     _adv_duplicate_filter_enabled = false;
     _scan_param.filter_dup   = BT_HCI_LE_SCAN_FILTER_DUP_ENABLE;
@@ -609,7 +609,7 @@ bool BLEDeviceManager::startScanning()
     return true;
 }
 
-bool BLEDeviceManager::startScanningWithDuplicates()
+bool BLEDeviceManager::startScanningNewPeripherals()
 {
     _adv_duplicate_filter_enabled = true;
     memset(_peer_duplicate_address_buffer, 0, sizeof(_peer_duplicate_address_buffer));
@@ -1096,8 +1096,8 @@ bool BLEDeviceManager::connect(BLEDevice &device)
     _wait_for_connect_peripheral_adv_data_len = _available_for_connect_peripheral_adv_data_len;
     _wait_for_connect_peripheral_scan_rsp_data_len = _available_for_connect_peripheral_scan_rsp_data_len;
     _wait_for_connect_peripheral_adv_rssi = _available_for_connect_peripheral_adv_rssi;
-            
-    startScanning();
+
+    startScanningWithDuplicates();
 
     pr_debug(LOG_MODULE_BLE, "%s-%d", __FUNCTION__, __LINE__);
     // Wait for the connection

libraries/CurieBLE/src/internal/BLEDeviceManager.h

@@ -310,7 +310,7 @@ class BLEDeviceManager
     void setAdvertiseCritical(String name);
     void setAdvertiseCritical(BLEService& service);
     void setAdvertiseCritical(const char* macaddress);
-    bool startScanning(); // start scanning for peripherals
+    bool startScanningNewPeripherals(); // start scanning for new peripherals, don't report the detected ones
     bool startScanningWithDuplicates(); // start scanning for peripherals, and report all duplicates
     bool stopScanning(); // stop scanning for peripherals