Use bool for public API's return types instead of BleStatus type

Author: sandeepmistry

libraries/CurieBle/examples/AutomationIO/AutomationIO.ino

@@ -126,19 +126,15 @@ BLEService ioService(SERVICE_UUID_AUTOMATIONIO);
 
 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x)[0])
 
-/* Serial port to use for printing informational messages to the user */
-#define LOG_SERIAL Serial
-
 /* For convenience, this macro will invoke a specified function call and will
  * check the status value returned to ensure it is successful.  If not, it will
  * print an error message to the serial port and will return from the current function
  */
 #define CHECK_STATUS(op)                               \
   do {                                                 \
-    BleStatus status = op;                             \
-    if (BLE_STATUS_SUCCESS != status) {                \
-      LOG_SERIAL.print(#op" returned error status: "); \
-      LOG_SERIAL.println(status);                      \
+    bool result = op;                             \
+    if (!result) {                \
+      Serial.println(#op" failed "); \
       return;                                          \
     }                                                  \
   } while(0)
@@ -147,12 +143,12 @@ BLEService ioService(SERVICE_UUID_AUTOMATIONIO);
  * Intel Curie BLE device */
 void blePeripheralConnectedEventCb(BLECentral &bleCentral)
 {
-  LOG_SERIAL.println("Got CONNECTED event");
+  Serial.println("Got CONNECTED event");
 }
 
 void blePeripheralDisconnectedEventCb(BLECentral &bleCentral)
 {
-  LOG_SERIAL.println("Got DISCONNECTED event");
+  Serial.println("Got DISCONNECTED event");
 }
 
 /* This function will be called when a connected remote peer sets a new value for a digital output characteristic */
@@ -187,19 +183,20 @@ void analogOutputCharWrittenEventCb(BLECentral &central, BLECharacteristic &char
 }
 
 void setup() {
-  LOG_SERIAL.begin(9600);
+  while(!Serial);
+  Serial.begin(9600);
 
   /* Set a name for the BLE device */
-  CHECK_STATUS(blePeripheral.setLocalName(LOCAL_NAME));
+  blePeripheral.setLocalName(LOCAL_NAME);
 
   /* Set a function to be called whenever a BLE GAP event occurs */
   blePeripheral.setEventHandler(BLEConnected, blePeripheralConnectedEventCb);
   blePeripheral.setEventHandler(BLEDisconnected, blePeripheralDisconnectedEventCb);
 
-  CHECK_STATUS(blePeripheral.setAdvertisedServiceUuid(ioService.uuid()));
+  blePeripheral.setAdvertisedServiceUuid(ioService.uuid());
 
   /* Add the Automation I/O Service, and include the UUID in BLE advertising data */
-  CHECK_STATUS(blePeripheral.addAttribute(ioService));
+  blePeripheral.addAttribute(ioService);
 
   /* Add characteristics for the Digital Inputs */
   for (unsigned i = 0; i < ARRAY_SIZE(digitalInputPins); i++) {
@@ -209,14 +206,14 @@ void setup() {
     pinMode(pin->pin, INPUT);
 
     /* Add the characteristic for this pin */
-    CHECK_STATUS(blePeripheral.addAttribute(pin->characteristic));
+    blePeripheral.addAttribute(pin->characteristic);
     /* Set an initial value for this characteristic; refreshed later in the loop() function */
     pin->val = digitalRead(pin->pin);
     CHECK_STATUS(pin->characteristic.setValue(DIGITAL_PIN_STATE_TO_VAL(pin->pin, pin->val)));
     /* Add a number_of_digitals descriptor for this characteristic */
-    CHECK_STATUS(blePeripheral.addAttribute(pin->userDescription));
-    CHECK_STATUS(blePeripheral.addAttribute(pin->presentationFormat));
-    CHECK_STATUS(blePeripheral.addAttribute(pin->numDigitalsDesc));
+    blePeripheral.addAttribute(pin->userDescription);
+    blePeripheral.addAttribute(pin->presentationFormat);
+    blePeripheral.addAttribute(pin->numDigitalsDesc);
   }
 
   /* Add characteristics for the Digital Outputs */
@@ -227,23 +224,23 @@ void setup() {
     pinMode(pin->pin, OUTPUT);
 
     /* Add the characteristic for this pin */
-    CHECK_STATUS(blePeripheral.addAttribute(pin->characteristic));
+    blePeripheral.addAttribute(pin->characteristic);
     /* Add a callback to be triggered if the remote device updates the value for this pin */
     pin->characteristic.setEventHandler(BLEWritten, digitalOutputCharWrittenEventCb);
     /* Add a number_of_digitals descriptor for this characteristic */
-    CHECK_STATUS(blePeripheral.addAttribute(pin->userDescription));
-    CHECK_STATUS(blePeripheral.addAttribute(pin->presentationFormat));
-    CHECK_STATUS(blePeripheral.addAttribute(pin->numDigitalsDesc));
+    blePeripheral.addAttribute(pin->userDescription);
+    blePeripheral.addAttribute(pin->presentationFormat);
+    blePeripheral.addAttribute(pin->numDigitalsDesc);
   }
 
   /* Add characteristics for the Analog Inputs */
   for (unsigned i = 0; i < ARRAY_SIZE(analogInputPins); i++) {
     AnalogPinConfig *pin = &analogInputPins[i];
 
     /* Add the characteristic for this pin */
-    CHECK_STATUS(blePeripheral.addAttribute(pin->characteristic));
-    CHECK_STATUS(blePeripheral.addAttribute(pin->userDescription));
-    CHECK_STATUS(blePeripheral.addAttribute(pin->presentationFormat));
+    blePeripheral.addAttribute(pin->characteristic);
+    blePeripheral.addAttribute(pin->userDescription);
+    blePeripheral.addAttribute(pin->presentationFormat);
     /* Set an initial value for this characteristic; refreshed later in the loop() function */
     pin->val = analogRead(pin->pin);
     CHECK_STATUS(pin->characteristic.setValue(pin->val));
@@ -254,9 +251,9 @@ void setup() {
     AnalogPinConfig *pin = &analogOutputPins[i];
 
     /* Add the characteristic for this pin */
-    CHECK_STATUS(blePeripheral.addAttribute(pin->characteristic));
-    CHECK_STATUS(blePeripheral.addAttribute(pin->userDescription));
-    CHECK_STATUS(blePeripheral.addAttribute(pin->presentationFormat));
+    blePeripheral.addAttribute(pin->characteristic);
+    blePeripheral.addAttribute(pin->userDescription);
+    blePeripheral.addAttribute(pin->presentationFormat);
     /* Add a callback to be triggered if the remote device updates the value for this pin */
     pin->characteristic.setEventHandler(BLEWritten, analogOutputCharWrittenEventCb);
   }
@@ -265,7 +262,7 @@ void setup() {
    * advertising packets and thus become visible to remote BLE central devices
    * (e.g smartphones) until it receives a new connection */
   CHECK_STATUS(blePeripheral.begin());
-  LOG_SERIAL.println("Bluetooth device active, waiting for connections...");
+  Serial.println("Bluetooth device active, waiting for connections...");
 }
 
 void loop() {

libraries/CurieBle/src/BLECentral.cpp

@@ -83,13 +83,13 @@ BLECentral::poll() {
     _peripheral->poll();
 }
 
-BleStatus
+bool
 BLECentral::disconnect() {
     if (connected()) {
         return _peripheral->disconnect();
     }
 
-    return BLE_STATUS_WRONG_STATE;
+    return false;
 }
 
 void

libraries/CurieBle/src/BLECentral.h

@@ -45,9 +45,8 @@ class BLECentral {
         /**
          * Disconnect the central if it is connected
          *
-         * @return BleStatus result of operation
          */
-        BleStatus disconnect(void);
+        bool disconnect(void);
 
         /**
          * Poll the central for events

libraries/CurieBle/src/BLECharacteristic.cpp

@@ -55,7 +55,7 @@ BLECharacteristic::properties() const
     return _properties;
 }
 
-BleStatus
+bool
 BLECharacteristic::setValue(const unsigned char value[], uint16_t length)
 {
     BleStatus status;
@@ -65,20 +65,20 @@ BLECharacteristic::setValue(const unsigned char value[], uint16_t length)
     if (_value_handle) {
         status = ble_client_gatts_set_attribute_value(_value_handle, _data_len, _data, 0);
         if (BLE_STATUS_SUCCESS != status) {
-            return status;
+            return false;
         }
 
         if (subscribed()) {
             boolean_t indication = (_cccd_value & BLE_CCCD_INDICATE_EN_MASK);
 
             status = ble_client_gatts_send_notif_ind(_value_handle, _data_len, _data, 0, indication);
             if (BLE_STATUS_SUCCESS != status) {
-                return status;
+                return false;
             }
         }
     }
 
-    return BLE_STATUS_SUCCESS;
+    return true;
 }
 
 void
@@ -143,7 +143,7 @@ BLECharacteristic::setEventHandler(BLECharacteristicEvent event, BLECharacterist
     interrupts();
 }
 
-BleStatus
+bool
 BLECharacteristic::add(uint16_t serviceHandle)
 {
     bt_uuid uuid = btUuid();
@@ -199,7 +199,7 @@ BLECharacteristic::add(uint16_t serviceHandle)
         _cccd_handle = handles.cccd_handle;
     }
 
-    return status;
+    return (BLE_STATUS_SUCCESS == status);
 }
 
 uint16_t

libraries/CurieBle/src/BLECharacteristic.h

@@ -88,14 +88,14 @@ class BLECharacteristic : public BLEAttribute {
      * @param length Length, in bytes, of valid data in the array to write.
      *               Must not exceed maxLength set for this characteristic.
      *
-     * @return BleStatus indicating success or error
+     * @return bool true set value success, false on error
      */
-    BleStatus setValue(const unsigned char value[], unsigned short length);
+    bool setValue(const unsigned char value[], unsigned short length);
 
     /**
      * Get the property mask of the Characteristic
      *
-     * @return uint8_t property mask of the Characteristic
+     * @return unsigned char property mask of the Characteristic
      */
     unsigned char properties(void) const;
 
@@ -145,7 +145,7 @@ class BLECharacteristic : public BLEAttribute {
     void setEventHandler(BLECharacteristicEvent event, BLECharacteristicEventHandler callback);
 
 protected:
-    BleStatus add(uint16_t serviceHandle);
+    bool add(uint16_t serviceHandle);
 
     uint16_t valueHandle(void);
 

libraries/CurieBle/src/BLEDescriptor.cpp

@@ -55,7 +55,7 @@ BLEDescriptor::operator[] (int offset) const
     return _data[offset];
 }
 
-BleStatus
+bool
 BLEDescriptor::add(uint16_t serviceHandle)
 {
     bt_uuid uuid = btUuid();
@@ -73,5 +73,5 @@ BLEDescriptor::add(uint16_t serviceHandle)
     desc.perms.rd = GAP_SEC_MODE_1 | GAP_SEC_LEVEL_1;
     desc.perms.wr = GAP_SEC_NO_PERMISSION;
 
-    return ble_client_gatts_add_descriptor(serviceHandle, &desc, &handle); 
+    return (ble_client_gatts_add_descriptor(serviceHandle, &desc, &handle) == BLE_STATUS_SUCCESS); 
 }

libraries/CurieBle/src/BLEDescriptor.h

@@ -63,7 +63,7 @@ class BLEDescriptor : public BLEAttribute {
     unsigned char operator[] (int offset) const;
 
 protected:
-    BleStatus add(uint16_t serviceHandle);
+    bool add(uint16_t serviceHandle);
 
     friend BLEPeripheral;