Release 1.0.2

* Adds functionality to advertise for a set duration, similar to NimBLEScan::start.
The first parameter being the duration (in seconds).
The second parameter is a pointer to a callback function that is invoked when advertising stops.

* NimBLEAdvertising::isAdvertising method added, returns true if advertising is currently active.

CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.  
+
+## [1.0.2] - 2020-09-13
+
+### Changed
+
+- `NimBLEAdvertising::start` Now takes 2 optional parameters, the first is the duration to advertise for (in seconds), the second is a  
+callback that is invoked when advertsing ends and takes a pointer to a `NimBLEAdvertising` object (similar to the `NimBLEScan::start` API).
+
+- (Arduino) Maximum BLE connections can now be altered by only changing the value of `CONFIG_BT_NIMBLE_MAX_CONNECTIONS` in `nimconfig.h`.
+Any changes to the controller max connection settings in `sdkconfig.h` will now have no effect when using this library.
+
+- (Arduino) Revert the previous change to fix the advertising start delay. Instead a replacement fix that routes all BLE controller commands from  
+a task running on core 0 (same as the controller) has been implemented. This improves response times and reliability for all BLE functions.
+
+## [1.0.1] - 2020-09-02
+
+### Added
+
+- Empty `NimBLEAddress` constructor: `NimBLEAddress()` produces an address of 00:00:00:00:00:00 type 0.
+- Documentation of the difference of NimBLEAddress::getNative vs the original bluedroid library.
+
+### Changed
+
+- notify_callback typedef is now defined as std::function to enable the use of std::bind to call a class member function.
+
+### Fixed
+
+- Fix advertising start delay when first called.
+
+
+## [1.0.0] - 2020-08-22
+
+First stable release.
+
+All the original library functionality is complete and many extras added with full documentation.

README.md

@@ -1,3 +1,7 @@
+[Latest release ![Release Version](https://img.shields.io/github/release/h2zero/esp-nimble-cpp.svg?style=plastic)
+![Release Date](https://img.shields.io/github/release-date/h2zero/esp-nimble-cpp.svg?style=plastic)](https://github.com/h2zero/esp-nimble-cpp/releases/latest/)  
+<br/>
+
 # esp-nimble-cpp
 
 NimBLE CPP library for use with ESP32 that attempts to maintain compatibility with the [nkolban cpp_uitls BLE API](https://github.com/nkolban/esp32-snippets/tree/master/cpp_utils).
@@ -18,12 +22,6 @@ NimBLE is a completely open source Bluetooth Low Energy stack produced by [Apach
 It is more suited to resource constrained devices than bluedroid and has now been ported to the ESP32 by Espressif.  
 <br/>
 
-# Development Status
-[Latest release ![Release Version](https://img.shields.io/github/release/h2zero/esp-nimble-cpp.svg?style=plastic) 
-![Release Date](https://img.shields.io/github/release-date/h2zero/esp-nimble-cpp.svg?style=plastic)](https://github.com/h2zero/esp-nimble-cpp/releases/latest/) 
-![Downloads](https://img.shields.io/github/downloads/h2zero/esp-nimble-cpp/latest/total.svg?style=plastic)  
-<br/>
-
 # Installation
 
 ### ESP-IDF v4.0+
@@ -64,6 +62,8 @@ Also see [Improvements_and_updates](docs/Improvements_and_updates.md) for inform
 <br/>  
 
 # Todo
-1. Implement random addresses.
-2. Add BLE Mesh code.  
+- Improve host reset handler
+- Implement random address handling
+- Implement bond management
+- Add Bluetooth Mesh
 <br/>  

docs/Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = "esp-nimble-cpp / NimBLE-Arduino"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 1.0.0
+PROJECT_NUMBER         = 1.0.2
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

docs/Improvements_and_updates.md

@@ -4,6 +4,7 @@ Many improvements have been made to this library vs the original, this is a brie
 Refer to the [class documentation](https://h2zero.github.io/esp-nimble-cpp/annotated.html) for futher information on class specifics.  
 
 * [Server](#server)
+* [Advertising](#advertising)
 * [Client](#client)
 * [General](#general)  
 <br/>
@@ -60,6 +61,16 @@ it's characteristics / descriptors will remain valid and the service can be re-a
 using `NimBLEServer::addService`.  
 <br/>
 
+<a name="advertising"></a>
+# Advertising
+`NimBLEAdvertising::start`
+
+Now takes 2 optional parameters, the first is the duration to advertise for (in seconds), the second is a callback  
+that is invoked when advertsing ends and takes a pointer to a `NimBLEAdvertising` object (similar to the `NimBLEScan::start` API).  
+
+This provides an opportunity to update the advertisment data if desired.  
+<br/>
+
 <a name="client"></a>
 # Client  
 

docs/Migration_guide.md

@@ -47,6 +47,12 @@ For example `BLEAddress addr(11:22:33:44:55:66, 1)` will create the address obje
 
 As this paramameter is optional no changes to existing code are needed, it is mentioned here for information.  
 <br/>
+`BLEAddress::getNative` (`NimBLEAddress::getNative`) returns a uint8_t pointer to the native address byte array.  
+In this library the address bytes are stored in reverse order from the original library. This is due to the way  
+the NimBLE stack expects addresses to be presented to it. All other functions such as `toString` are  
+not affected as the endian change is made within them.  
+<br/>
+
 <a name="server-api"></a>
 ## Server API
 Creating a `BLEServer` instance is the same as original, no changes required.
@@ -203,12 +209,27 @@ This can be changed to use passkey authentication or numeric comparison. See [Se
 
 <a name="advertising-api"></a>
 ## Advertising API
-Advertising works the same as the original API except with the removal of:  
+Advertising works the same as the original API except:  
 > BLEAdvertising::setMinPreferred  
 > BLEAdvertising::setMaxPreferred  
 
 These methods were found to not provide useful functionality and consumed valuable advertising space (6 bytes of 31) if used unknowingly.  
-If you wish to advertise these parameters you can still do so manually via `NimBLEAdvertisementData::addData`.  
+If you wish to advertise these parameters you can still do so manually via `BLEAdvertisementData::addData` (`NimBLEAdvertisementData::addData`).  
+<br/>
+
+Calling `NimBLEAdvertising::setAdvertisementData` will entirely replace any data set with `NimBLEAdvertising::addServiceUUID`, or  
+`NimBLEAdvertising::setAppearance`. You should set all the data you wish to advertise within the `NimBLEAdvertisementData` instead.  
+
+Calling `NimBLEAdvertising::setScanResponseData` without also calling `NimBLEAdvertising::setAdvertisementData` will have no effect.  
+When using custom scan response data you must also use custom advertisement data.  
+<br/>
+
+> BLEAdvertising::start (NimBLEAdvertising::start)
+
+Now takes 2 optional parameters, the first is the duration to advertise for (in seconds), the second is a callback  
+that is invoked when advertsing ends and takes a pointer to a `NimBLEAdvertising` object (similar to the `NimBLEScan::start` API).  
+
+This provides an opportunity to update the advertisment data if desired.  
 <br/>
 
 <a name="client-api"></a>

src/NimBLEAddress.cpp

@@ -37,6 +37,14 @@ NimBLEAddress::NimBLEAddress(ble_addr_t address) {
 } // NimBLEAddress
 
 
+/**
+ * @brief Create a blank address, i.e. 00:00:00:00:00:00, type 0.
+ */
+NimBLEAddress::NimBLEAddress() {
+    NimBLEAddress("");
+} // NimBLEAddress
+
+
 /**
  * @brief Create an address from a hex string
  *

src/NimBLEAddress.h

@@ -33,6 +33,7 @@
  */
 class NimBLEAddress {
 public:
+    NimBLEAddress();
     NimBLEAddress(ble_addr_t address);
     NimBLEAddress(uint8_t address[6], uint8_t type = BLE_ADDR_PUBLIC);
     NimBLEAddress(const std::string &stringAddress, uint8_t type = BLE_ADDR_PUBLIC);

src/NimBLEAdvertising.cpp

@@ -54,6 +54,11 @@ NimBLEAdvertising::NimBLEAdvertising() {
     m_advParams.itvl_min             = 0;
     m_advParams.itvl_max             = 0;
 
+    m_customAdvData                  = false;
+    m_customScanResponseData         = false;
+    m_scanResp                       = true;
+    m_advDataSet                     = false;
+
 } // NimBLEAdvertising
 
 
@@ -178,6 +183,9 @@ void NimBLEAdvertising::setScanFilter(bool scanRequestWhitelistOnly, bool connec
 /**
  * @brief Set the advertisement data that is to be published in a regular advertisement.
  * @param [in] advertisementData The data to be advertised.
+ * @details The use of this function will replace any data set with addServiceUUID\n
+ * or setAppearance. If you wish for these to be advertised you must include them\n
+ * in the advertisementData parameter sent.
  */
 
 void NimBLEAdvertising::setAdvertisementData(NimBLEAdvertisementData& advertisementData) {
@@ -196,6 +204,8 @@ void NimBLEAdvertising::setAdvertisementData(NimBLEAdvertisementData& advertisem
 /**
  * @brief Set the advertisement data that is to be published in a scan response.
  * @param [in] advertisementData The data to be advertised.
+ * @details Calling this without also using setAdvertisementData will have no effect.\n
+ * When using custom scan response data you must also use custom advertisement data.
  */
 void NimBLEAdvertising::setScanResponseData(NimBLEAdvertisementData& advertisementData) {
     NIMBLE_LOGD(LOG_TAG, ">> setScanResponseData");
@@ -212,8 +222,10 @@ void NimBLEAdvertising::setScanResponseData(NimBLEAdvertisementData& advertiseme
 
 /**
  * @brief Start advertising.
+ * @param [in] duration The duration, in seconds, to advertise, 0 == advertise forever.
+ * @param [in] advCompleteCB A pointer to a callback to be invoked when advertising ends.
  */
-void NimBLEAdvertising::start() {
+void NimBLEAdvertising::start(uint32_t duration, void (*advCompleteCB)(NimBLEAdvertising *pAdv)) {
     NIMBLE_LOGD(LOG_TAG, ">> Advertising start: customAdvData: %d, customScanResponseData: %d", m_customAdvData, m_customScanResponseData);
 
     // If Host is not synced we cannot start advertising.
@@ -239,6 +251,15 @@ void NimBLEAdvertising::start() {
         return;
     }
 
+    if(duration == 0){
+        duration = BLE_HS_FOREVER;
+    }
+    else{
+        duration = duration*1000; // convert duration to milliseconds
+    }
+
+    m_advCompCB = advCompleteCB;
+
     int rc = 0;
 
     if (!m_customAdvData && !m_advDataSet) {
@@ -384,13 +405,13 @@ void NimBLEAdvertising::start() {
     }
 
 #if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
-    rc = ble_gap_adv_start(0, NULL, BLE_HS_FOREVER,
+    rc = ble_gap_adv_start(0, NULL, duration,
                            &m_advParams,
-                           (pServer != nullptr) ? NimBLEServer::handleGapEvent : NULL,
-                           pServer);
+                           (pServer != nullptr) ? NimBLEServer::handleGapEvent : NimBLEAdvertising::handleGapEvent,
+                           (pServer != nullptr) ? (void*)pServer : (void*)this);
 #else
-    rc = ble_gap_adv_start(0, NULL, BLE_HS_FOREVER,
-                           &m_advParams, NULL,NULL);
+    rc = ble_gap_adv_start(0, NULL, duration,
+                           &m_advParams, NimBLEAdvertising::handleGapEvent, this);
 #endif
     if (rc != 0) {
         NIMBLE_LOGC(LOG_TAG, "Error enabling advertising; rc=%d, %s", rc, NimBLEUtils::returnCodeToString(rc));
@@ -416,6 +437,25 @@ void NimBLEAdvertising::stop() {
 } // stop
 
 
+/**
+ * @brief Handles the callback when advertising stops.
+ */
+void NimBLEAdvertising::advCompleteCB() {
+    if(m_advCompCB != nullptr) {
+        m_advCompCB(this);
+    }
+}
+
+
+/**
+ * @brief Check if currently advertising.
+ * @return true if advertising is active.
+ */
+bool NimBLEAdvertising::isAdvertising() {
+    return ble_gap_adv_active();
+}
+
+
 /*
  * Host reset seems to clear advertising data,
  * we need clear the flag so it reloads it.
@@ -425,6 +465,22 @@ void NimBLEAdvertising::onHostReset() {
 }
 
 
+/**
+ * @brief Handler for gap events when not using peripheral role.
+ * @param [in] event the event data.
+ * @param [in] arg pointer to the advertising instance.
+ */
+/*STATIC*/
+int NimBLEAdvertising::handleGapEvent(struct ble_gap_event *event, void *arg) {
+    NimBLEAdvertising *pAdv = (NimBLEAdvertising*)arg;
+
+    if(event->type == BLE_GAP_EVENT_ADV_COMPLETE) {
+        pAdv->advCompleteCB();
+    }
+    return 0;
+}
+
+
 /**
  * @brief Add data to the payload to be advertised.
  * @param [in] data The data to be added to the payload.

src/NimBLEAdvertising.h

@@ -77,30 +77,34 @@ public:
     void addServiceUUID(const NimBLEUUID &serviceUUID);
     void addServiceUUID(const char* serviceUUID);
     void removeServiceUUID(const NimBLEUUID &serviceUUID);
-    void start();
+    void start(uint32_t duration = 0, void (*advCompleteCB)(NimBLEAdvertising *pAdv) = nullptr);
     void stop();
     void setAppearance(uint16_t appearance);
     void setAdvertisementType(uint8_t adv_type);
     void setMaxInterval(uint16_t maxinterval);
     void setMinInterval(uint16_t mininterval);
     void setAdvertisementData(NimBLEAdvertisementData& advertisementData);
-    void setScanFilter(bool scanRequertWhitelistOnly, bool connectWhitelistOnly);
+    void setScanFilter(bool scanRequestWhitelistOnly, bool connectWhitelistOnly);
     void setScanResponseData(NimBLEAdvertisementData& advertisementData);
     void setScanResponse(bool);
+    void advCompleteCB();
+    bool isAdvertising();
 
 private:
     friend class NimBLEDevice;
 
-    void                 onHostReset();
+    void                    onHostReset();
+    static int              handleGapEvent(struct ble_gap_event *event, void *arg);
 
-    ble_hs_adv_fields    m_advData;
-    ble_hs_adv_fields    m_scanData;
-    ble_gap_adv_params   m_advParams;
+    ble_hs_adv_fields       m_advData;
+    ble_hs_adv_fields       m_scanData;
+    ble_gap_adv_params      m_advParams;
     std::vector<NimBLEUUID> m_serviceUUIDs;
-    bool                 m_customAdvData = false;  // Are we using custom advertising data?
-    bool                 m_customScanResponseData = false;  // Are we using custom scan response data?
-    bool                 m_scanResp = true;
-    bool                 m_advDataSet = false;
+    bool                    m_customAdvData;
+    bool                    m_customScanResponseData;
+    bool                    m_scanResp;
+    bool                    m_advDataSet;
+    void                   (*m_advCompCB)(NimBLEAdvertising *pAdv);
 
 };
 

src/NimBLERemoteCharacteristic.h

@@ -24,13 +24,14 @@
 #include "NimBLERemoteDescriptor.h"
 
 #include <vector>
+#include <functional>
 
 class NimBLERemoteService;
 class NimBLERemoteDescriptor;
 
 
-typedef void (*notify_callback)(NimBLERemoteCharacteristic* pBLERemoteCharacteristic,
-                                uint8_t* pData, size_t length, bool isNotify);
+typedef std::function<void (NimBLERemoteCharacteristic* pBLERemoteCharacteristic,
+                                uint8_t* pData, size_t length, bool isNotify)> notify_callback;
 
 typedef struct {
     const NimBLEUUID *uuid;

src/NimBLEServer.cpp

@@ -353,6 +353,12 @@ size_t NimBLEServer::getConnectedCount() {
             return 0;
         } // BLE_GAP_EVENT_NOTIFY_TX
 
+        case BLE_GAP_EVENT_ADV_COMPLETE: {
+            NIMBLE_LOGD(LOG_TAG, "Advertising Complete");
+            NimBLEDevice::getAdvertising()->advCompleteCB();
+            return 0;
+        }
+
         case BLE_GAP_EVENT_CONN_UPDATE: {
             NIMBLE_LOGD(LOG_TAG, "Connection parameters updated.");
             return 0;

src/nimconfig.h

@@ -101,17 +101,7 @@
  */
 #define CONFIG_BT_NIMBLE_MEM_ALLOC_MODE_INTERNAL 1
 
-/**
- * @brief Sets the number of simultaneous connections (esp controller max is 9) 
- * @details To increase max connections in Arduino it is also required to change the
- * controller max connections defined in sdkconfig.h.\n
- *
- * This is located in your Arduino/hardware/espressif/esp32/tools/sdk/include/config folder.\n\n
- *
- * The values in sdkconfig.h you will need to change are:\n\n
- * `CONFIG_BTDM_CONTROLLER_BLE_MAX_CONN 3`\n
- * `CONFIG_BTDM_CONTROLLER_BLE_MAX_CONN_EFF 3`
- */
+/** @brief Sets the number of simultaneous connections (esp controller max is 9) */
 #define CONFIG_BT_NIMBLE_MAX_CONNECTIONS 3
 
 /** @brief Sets the number of devices allowed to store/bond with */