Refactor NimBLERemoteCharacteristic::subscribe

h2zero · h2zero · commit 69bb782ac10a · 2020-07-08T21:10:02.000-06:00
* Rearrange subscribe parameters to remove requirement of specifying write response to register a callback.

* Update examples.
diff --git a/examples/NimBLE_Client/NimBLE_Client.ino b/examples/NimBLE_Client/NimBLE_Client.ino
@@ -107,9 +107,10 @@ class AdvertisedDeviceCallbacks: public NimBLEAdvertisedDeviceCallbacks {
 void notifyCB(NimBLERemoteCharacteristic* pRemoteCharacteristic, uint8_t* pData, size_t length, bool isNotify){
     std::string str = (isNotify == true) ? "Notification" : "Indication"; 
     str += " from ";
-    str += pRemoteCharacteristic->getRemoteService()->getClient()->getPeerAddress().toString();
-    str += ": Service = " + pRemoteCharacteristic->getRemoteService()->getUUID().toString();
-    str += ", Characteristic = " + pRemoteCharacteristic->getUUID().toString();
+    /** NimBLEAddress and NimBLEUUID have std::string operators */
+    str += std::string(pRemoteCharacteristic->getRemoteService()->getClient()->getPeerAddress());
+    str += ": Service = " + std::string(pRemoteCharacteristic->getRemoteService()->getUUID());
+    str += ", Characteristic = " + std::string(pRemoteCharacteristic->getUUID());
     str += ", Value = " + std::string((char*)pData, length);
     Serial.println(str.c_str());
 }
@@ -228,17 +229,22 @@ bool connectToServer() {
             }
         }
         
+        /** registerForNotify() has been deprecated and replaced with subscribe() / unsubscribe().
+         *  Subscribe parameter defaults are: notifications=true, notifyCallback=nullptr, response=false.
+         *  Unsubscribe parameter defaults are: response=false. 
+         */
         if(pChr->canNotify()) {
-            /** Must send a callback to subscribe, if nullptr it will unsubscribe */
-            if(!pChr->registerForNotify(notifyCB)) {
+            //if(!pChr->registerForNotify(notifyCB)) {
+            if(!pChr->subscribe(true, notifyCB)) {
                 /** Disconnect if subscribe failed */ 
                 pClient->disconnect();
                 return false;
             }
         }
         else if(pChr->canIndicate()) {
-            /** Send false as second argument to subscribe to indications instead of notifications */
-            if(!pChr->registerForNotify(notifyCB, false)) {
+            /** Send false as first argument to subscribe to indications instead of notifications */
+            //if(!pChr->registerForNotify(notifyCB, false)) {
+            if(!pChr->subscribe(false, notifyCB)) {
                 /** Disconnect if subscribe failed */ 
                 pClient->disconnect();
                 return false;
@@ -289,17 +295,22 @@ bool connectToServer() {
             }
         }
         
+        /** registerForNotify() has been deprecated and replaced with subscribe() / unsubscribe().
+         *  Subscribe parameter defaults are: notifications=true, notifyCallback=nullptr, response=false.
+         *  Unsubscribe parameter defaults are: response=false. 
+         */
         if(pChr->canNotify()) {
-            /** Must send a callback to subscribe, if nullptr it will unsubscribe */
-            if(!pChr->registerForNotify(notifyCB)) {
+            //if(!pChr->registerForNotify(notifyCB)) {
+            if(!pChr->subscribe(true, notifyCB)) {
                 /** Disconnect if subscribe failed */ 
                 pClient->disconnect();
                 return false;
             }
         }
         else if(pChr->canIndicate()) {
-            /** Send false as second argument to subscribe to indications instead of notifications */
-            if(!pChr->registerForNotify(notifyCB, false)) {
+            /** Send false as first argument to subscribe to indications instead of notifications */
+            //if(!pChr->registerForNotify(notifyCB, false)) {
+            if(!pChr->subscribe(false, notifyCB)) {
                 /** Disconnect if subscribe failed */ 
                 pClient->disconnect();
                 return false;
diff --git a/examples/NimBLE_Server/NimBLE_Server.ino b/examples/NimBLE_Server/NimBLE_Server.ino
@@ -9,8 +9,6 @@
 */
 
 #include <NimBLEDevice.h>
-#include <NimBLE2904.h>
-#include <NimBLE2902.h>
 
 static NimBLEServer* pServer;
 
@@ -112,8 +110,10 @@ class DescriptorCallbacks : public NimBLEDescriptorCallbacks {
             NimBLE2902* p2902 = (NimBLE2902*)pDescriptor;
             if(p2902->getNotifications()) {
                 Serial.println("Client Subscribed to notfications");
+            } else if(p2902->getIndications()) {
+                Serial.println("Client Subscribed to indications");
             } else {
-                Serial.println("Client Unubscribed to notfications");
+                Serial.println("Client Unubscribed");
             }
         } else {
             std::string dscVal((char*)pDescriptor->getValue(), pDescriptor->getLength());
diff --git a/src/NimBLERemoteCharacteristic.cpp b/src/NimBLERemoteCharacteristic.cpp
@@ -503,12 +503,12 @@ int NimBLERemoteCharacteristic::onReadCB(uint16_t conn_handle,
 /**
  * @brief Subscribe or unsubscribe for notifications or indications.
  * @param [in] val 0x00 to unsubscribe, 0x01 for notifications, 0x02 for indications.
- * @param [in] response If write response required set this to true.
  * @param [in] notifyCallback A callback to be invoked for a notification.
+ * @param [in] response If write response required set this to true.
  * If NULL is provided then no callback is performed.
  * @return true if successful.
  */
-bool NimBLERemoteCharacteristic::setNotify(uint16_t val, bool response, notify_callback notifyCallback) {
+bool NimBLERemoteCharacteristic::setNotify(uint16_t val, notify_callback notifyCallback, bool response) {
     NIMBLE_LOGD(LOG_TAG, ">> setNotify(): %s, %02x", toString().c_str(), val);
 
     NimBLERemoteDescriptor* desc = getDescriptor(NimBLEUUID((uint16_t)0x2902));
@@ -528,16 +528,16 @@ bool NimBLERemoteCharacteristic::setNotify(uint16_t val, bool response, notify_c
 /**
  * @brief Subscribe for notifications or indications.
  * @param [in] notifications If true, subscribe for notifications, false subscribe for indications.
- * @param [in] response If true, require a write response from the descriptor write operation.
  * @param [in] notifyCallback A callback to be invoked for a notification.
+ * @param [in] response If true, require a write response from the descriptor write operation.
  * If NULL is provided then no callback is performed.
  * @return true if successful.
  */
-bool NimBLERemoteCharacteristic::subscribe(bool notifications, bool response, notify_callback notifyCallback) {
+bool NimBLERemoteCharacteristic::subscribe(bool notifications, notify_callback notifyCallback, bool response) {
     if(notifications) {
-        return setNotify(0x01, response, notifyCallback);
+        return setNotify(0x01, notifyCallback, response);
     } else {
-        return setNotify(0x02, response, notifyCallback);
+        return setNotify(0x02, notifyCallback, response);
     }
 } // subscribe
 
@@ -548,7 +548,7 @@ bool NimBLERemoteCharacteristic::subscribe(bool notifications, bool response, no
  * @return true if successful.
  */
 bool NimBLERemoteCharacteristic::unsubscribe(bool response) {
-    return setNotify(0x00, response);
+    return setNotify(0x00, nullptr, response);
 } // unsubscribe
 
 
@@ -564,7 +564,7 @@ bool NimBLERemoteCharacteristic::unsubscribe(bool response) {
 bool NimBLERemoteCharacteristic::registerForNotify(notify_callback notifyCallback, bool notifications, bool response) {
     bool success;
     if(notifyCallback != nullptr) {
-        success = subscribe(notifications, response, notifyCallback);
+        success = subscribe(notifications, notifyCallback, response);
     } else {
         success = unsubscribe(response);
     }
diff --git a/src/NimBLERemoteCharacteristic.h b/src/NimBLERemoteCharacteristic.h
@@ -104,9 +104,9 @@ class NimBLERemoteCharacteristic {
     }
 
     bool                                           subscribe(bool notifications = true,
-                                                             bool response = true,
-                                                             notify_callback notifyCallback = nullptr);
-    bool                                           unsubscribe(bool response = true);
+                                                             notify_callback notifyCallback = nullptr,
+                                                             bool response = false);
+    bool                                           unsubscribe(bool response = false);
     bool                                           registerForNotify(notify_callback notifyCallback,
                                                                      bool notifications = true,
                                                                      bool response = true)
@@ -138,7 +138,7 @@ class NimBLERemoteCharacteristic {
     friend class      NimBLERemoteDescriptor;
 
     // Private member functions
-    bool              setNotify(uint16_t val, bool response = true, notify_callback notifyCallback = nullptr);
+    bool              setNotify(uint16_t val, notify_callback notifyCallback = nullptr, bool response = true);
     bool              retrieveDescriptors(const NimBLEUUID *uuid_filter = nullptr);
     static int        onReadCB(uint16_t conn_handle, const struct ble_gatt_error *error,
                                struct ble_gatt_attr *attr, void *arg);
