move BleScanner to seperate lib

CMakeLists.txt

@@ -13,6 +13,7 @@ include_directories(${PROJECT_NAME}
         PRIVATE
         lib/Crc16
         lib/NimBLE-Arduino/src
+        lib/BleScanner/src
         lib/nuki_ble/src
         lib/ESP32_BLE_Arduino-1.0.1/src
         lib/WiFiManager
@@ -45,7 +46,8 @@ file(GLOB SRCFILES
         lib/nuki_ble/src/NukiConstants.h
         lib/nuki_ble/src/NukiDataTypes.h
         lib/nuki_ble/src/NukiUtils.cpp
-        lib/nuki_ble/src/BleScanner.cpp
+        lib/BleScanner/src/BleInterfaces.h
+        lib/BleScanner/src/BleScanner.cpp
         lib/pubsubclient/src/PubSubClient.cpp
 )
 

lib/BleScanner/.astylerc

@@ -0,0 +1,10 @@
+--indent=spaces=2
+--indent-classes
+--indent-preproc-cond
+--indent-preproc-block
+--indent-switches
+--pad-header
+--pad-oper
+--align-pointer=type
+--align-reference=type
+--add-braces

lib/BleScanner/.gitignore

@@ -0,0 +1,5 @@
+.pio
+.vscode/.browse.c_cpp.db*
+.vscode/c_cpp_properties.json
+.vscode/launch.json
+.vscode/ipch

lib/BleScanner/include/README

@@ -0,0 +1,39 @@
+
+This directory is intended for project header files.
+
+A header file is a file containing C declarations and macro definitions
+to be shared between several project source files. You request the use of a
+header file in your project source file (C, C++, etc) located in `src` folder
+by including it, with the C preprocessing directive `#include'.
+
+```src/main.c
+
+#include "header.h"
+
+int main (void)
+{
+ ...
+}
+```
+
+Including a header file produces the same results as copying the header file
+into each source file that needs it. Such copying would be time-consuming
+and error-prone. With a header file, the related declarations appear
+in only one place. If they need to be changed, they can be changed in one
+place, and programs that include the header file will automatically use the
+new version when next recompiled. The header file eliminates the labor of
+finding and changing all the copies as well as the risk that a failure to
+find one copy will result in inconsistencies within a program.
+
+In C, the usual convention is to give header files names that end with `.h'.
+It is most portable to use only letters, digits, dashes, and underscores in
+header file names, and at most one dot.
+
+Read more about using header files in official GCC documentation:
+
+* Include Syntax
+* Include Operation
+* Once-Only Headers
+* Computed Includes
+
+https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html

lib/BleScanner/lib/README

@@ -0,0 +1,46 @@
+
+This directory is intended for project specific (private) libraries.
+PlatformIO will compile them to static libraries and link into executable file.
+
+The source code of each library should be placed in a an own separate directory
+("lib/your_library_name/[here are source files]").
+
+For example, see a structure of the following two libraries `Foo` and `Bar`:
+
+|--lib
+|  |
+|  |--Bar
+|  |  |--docs
+|  |  |--examples
+|  |  |--src
+|  |     |- Bar.c
+|  |     |- Bar.h
+|  |  |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
+|  |
+|  |--Foo
+|  |  |- Foo.c
+|  |  |- Foo.h
+|  |
+|  |- README --> THIS FILE
+|
+|- platformio.ini
+|--src
+   |- main.c
+
+and a contents of `src/main.c`:
+```
+#include <Foo.h>
+#include <Bar.h>
+
+int main (void)
+{
+  ...
+}
+
+```
+
+PlatformIO Library Dependency Finder will find automatically dependent
+libraries scanning project source files.
+
+More information about PlatformIO Library Dependency Finder
+- https://docs.platformio.org/page/librarymanager/ldf.html

lib/BleScanner/library.json

@@ -0,0 +1,8 @@
+{
+  "name": "BleScanner",
+  "frameworks": "Arduino",
+  "platforms": [
+    "espressif32"
+  ],
+  "dependencies": []
+}

lib/BleScanner/platformio.ini

@@ -0,0 +1,14 @@
+; PlatformIO Project Configuration File
+;
+;   Build options: build flags, source filter
+;   Upload options: custom upload port, speed and extra flags
+;   Library options: dependencies, extra library storages
+;   Advanced options: extra scripting
+;
+; Please visit documentation for the other options and examples
+; https://docs.platformio.org/page/projectconf.html
+
+[env:esp32dev]
+platform = espressif32
+board = esp32dev
+framework = arduino

lib/BleScanner/src/BleInterfaces.h

@@ -0,0 +1,13 @@
+#pragma once
+#include <NimBLEDevice.h>
+
+class BLEScannerSubscriber {
+  public:
+    virtual void onResult(NimBLEAdvertisedDevice* advertisedDevice) = 0;
+};
+
+class BLEScannerPublisher {
+  public:
+    virtual void subscribe(BLEScannerSubscriber* subscriber) = 0;
+    virtual void unsubscribe(BLEScannerSubscriber* subscriber) = 0;
+};

lib/BleScanner/src/BleScanner.cpp

@@ -0,0 +1,54 @@
+#include "BleScanner.h"
+#include <NimBLEUtils.h>
+#include <NimBLEScan.h>
+#include <NimBLEAdvertisedDevice.h>
+
+BleScanner::BleScanner(int reservedSubscribers) {
+  subscribers.reserve(reservedSubscribers);
+}
+
+void BleScanner::initialize(const std::string& deviceName, const bool wantDuplicates, const uint16_t interval, const uint16_t window) {
+  if (!BLEDevice::getInitialized()) {
+    BLEDevice::init(deviceName);
+  }
+  bleScan = BLEDevice::getScan();
+  bleScan->setAdvertisedDeviceCallbacks(this, wantDuplicates);
+  bleScan->setActiveScan(true);
+  bleScan->setInterval(interval);
+  bleScan->setWindow(window);
+}
+
+void BleScanner::update() {
+  if (bleScan->isScanning()) {
+    return;
+  }
+  bool result = bleScan->start(scanDuration, nullptr, false);
+  if (!result) {
+    log_w("BLE Scan error");
+  }
+}
+
+void BleScanner::setScanDuration(const uint32_t value) {
+  scanDuration = value;
+}
+
+void BleScanner::subscribe(BLEScannerSubscriber* subscriber) {
+  if (std::find(subscribers.begin(), subscribers.end(), subscriber) != subscribers.end()) {
+    return;
+  }
+  subscribers.push_back(subscriber);
+}
+
+void BleScanner::unsubscribe(BLEScannerSubscriber* subscriber) {
+  auto it = std::find(subscribers.begin(), subscribers.end(), subscriber);
+  if (it != subscribers.end()) {
+    subscribers.erase(it);
+  }
+}
+
+void BleScanner::onResult(NimBLEAdvertisedDevice* advertisedDevice) {
+  for (const auto& subscriber : subscribers) {
+    subscriber->onResult(advertisedDevice);
+  }
+}
+

lib/BleScanner/src/BleScanner.h

@@ -0,0 +1,25 @@
+#pragma once
+
+#include <string>
+#include <NimBLEDevice.h>
+#include "BleInterfaces.h"
+
+class BleScanner : public BLEScannerPublisher, BLEAdvertisedDeviceCallbacks {
+  public:
+    BleScanner(int reservedSubscribers = 10);
+    ~BleScanner() = default;
+
+    void initialize(const std::string& deviceName = "blescanner", const bool wantDuplicates = false, const uint16_t interval = 40, const uint16_t window = 40);
+    void update();
+    void setScanDuration(const uint32_t value);
+
+    void subscribe(BLEScannerSubscriber* subscriber) override;
+    void unsubscribe(BLEScannerSubscriber* subscriber) override;
+
+    void onResult(NimBLEAdvertisedDevice* advertisedDevice) override;
+
+  private:
+    uint32_t scanDuration = 3;
+    BLEScan* bleScan = nullptr;
+    std::vector<BLEScannerSubscriber*> subscribers;
+};

lib/BleScanner/src/main.cpp

@@ -0,0 +1,9 @@
+#include <Arduino.h>
+
+void setup() {
+  // put your setup code here, to run once:
+}
+
+void loop() {
+  // put your main code here, to run repeatedly:
+}

lib/BleScanner/test/README

@@ -0,0 +1,11 @@
+
+This directory is intended for PlatformIO Unit Testing and project tests.
+
+Unit Testing is a software testing method by which individual units of
+source code, sets of one or more MCU program modules together with associated
+control data, usage procedures, and operating procedures, are tested to
+determine whether they are fit for use. Unit testing finds problems early
+in the development cycle.
+
+More information about PlatformIO Unit Testing:
+- https://docs.platformio.org/page/plus/unit-testing.html