Merge pull request #11751 from Kolcha/ble-cleanup

BLE: `BLECharacteristic::setValue()` cleanup and optimization

Author: me-no-dev

libraries/BLE/src/BLE2901.cpp

@@ -47,7 +47,7 @@ BLE2901::BLE2901() : BLEDescriptor(BLEUUID((uint16_t)BLE2901_UUID)) {}
 /**
  * @brief Set the Characteristic User Description
  */
-void BLE2901::setDescription(String userDesc) {
+void BLE2901::setDescription(const String &userDesc) {
   if (userDesc.length() > ESP_GATT_MAX_ATTR_LEN) {
     log_e("Size %d too large, must be no bigger than %d", userDesc.length(), ESP_GATT_MAX_ATTR_LEN);
     return;

libraries/BLE/src/BLE2901.h

@@ -40,7 +40,7 @@ class BLE2901 : public BLEDescriptor {
    ***************************************************************************/
 
   BLE2901();
-  void setDescription(String desc);
+  void setDescription(const String &desc);
 };  // BLE2901
 
 #endif /* CONFIG_BLUEDROID_ENABLED || CONFIG_NIMBLE_ENABLED */

libraries/BLE/src/BLECharacteristic.cpp

@@ -346,7 +346,7 @@ void BLECharacteristic::setReadProperty(bool value) {
  * @param [in] data The data to set for the characteristic.
  * @param [in] length The length of the data in bytes.
  */
-void BLECharacteristic::setValue(uint8_t *data, size_t length) {
+void BLECharacteristic::setValue(const uint8_t *data, size_t length) {
 // The call to BLEUtils::buildHexData() doesn't output anything if the log level is not
 // "VERBOSE". As it is quite CPU intensive, it is much better to not call it if not needed.
 #if ARDUHAL_LOG_LEVEL >= ARDUHAL_LOG_LEVEL_VERBOSE
@@ -371,43 +371,28 @@ void BLECharacteristic::setValue(uint8_t *data, size_t length) {
  * @param [in] Set the value of the characteristic.
  * @return N/A.
  */
-void BLECharacteristic::setValue(String value) {
-  setValue((uint8_t *)(value.c_str()), value.length());
+void BLECharacteristic::setValue(const String &value) {
+  setValue(reinterpret_cast<const uint8_t *>(value.c_str()), value.length());
 }  // setValue
 
-void BLECharacteristic::setValue(uint16_t &data16) {
-  uint8_t temp[2];
-  temp[0] = data16;
-  temp[1] = data16 >> 8;
-  setValue(temp, 2);
+void BLECharacteristic::setValue(uint16_t data16) {
+  setValue(reinterpret_cast<const uint8_t *>(&data16), sizeof(data16));
 }  // setValue
 
-void BLECharacteristic::setValue(uint32_t &data32) {
-  uint8_t temp[4];
-  temp[0] = data32;
-  temp[1] = data32 >> 8;
-  temp[2] = data32 >> 16;
-  temp[3] = data32 >> 24;
-  setValue(temp, 4);
+void BLECharacteristic::setValue(uint32_t data32) {
+  setValue(reinterpret_cast<const uint8_t *>(&data32), sizeof(data32));
 }  // setValue
 
-void BLECharacteristic::setValue(int &data32) {
-  uint8_t temp[4];
-  temp[0] = data32;
-  temp[1] = data32 >> 8;
-  temp[2] = data32 >> 16;
-  temp[3] = data32 >> 24;
-  setValue(temp, 4);
+void BLECharacteristic::setValue(int data32) {
+  setValue(reinterpret_cast<const uint8_t *>(&data32), sizeof(data32));
 }  // setValue
 
-void BLECharacteristic::setValue(float &data32) {
-  float temp = data32;
-  setValue((uint8_t *)&temp, 4);
+void BLECharacteristic::setValue(float data32) {
+  setValue(reinterpret_cast<const uint8_t *>(&data32), sizeof(data32));
 }  // setValue
 
-void BLECharacteristic::setValue(double &data64) {
-  double temp = data64;
-  setValue((uint8_t *)&temp, 8);
+void BLECharacteristic::setValue(double data64) {
+  setValue(reinterpret_cast<const uint8_t *>(&data64), sizeof(data64));
 }  // setValue
 
 /**

libraries/BLE/src/BLECharacteristic.h

@@ -184,13 +184,13 @@ class BLECharacteristic {
   void indicate();
   void notify(bool is_notification = true);
   void setCallbacks(BLECharacteristicCallbacks *pCallbacks);
-  void setValue(uint8_t *data, size_t size);
-  void setValue(String value);
-  void setValue(uint16_t &data16);
-  void setValue(uint32_t &data32);
-  void setValue(int &data32);
-  void setValue(float &data32);
-  void setValue(double &data64);
+  void setValue(const uint8_t *data, size_t size);
+  void setValue(const String &value);
+  void setValue(uint16_t data16);
+  void setValue(uint32_t data32);
+  void setValue(int data32);
+  void setValue(float data32);
+  void setValue(double data64);
   String toString();
   uint16_t getHandle();
   void setAccessPermissions(uint8_t perm);

libraries/BLE/src/BLEDescriptor.cpp

@@ -181,7 +181,7 @@ void BLEDescriptor::setHandle(uint16_t handle) {
  * @param [in] data The data to set for the descriptor.
  * @param [in] length The length of the data in bytes.
  */
-void BLEDescriptor::setValue(uint8_t *data, size_t length) {
+void BLEDescriptor::setValue(const uint8_t *data, size_t length) {
   if (length > m_value.attr_max_len) {
     log_e("Size %d too large, must be no bigger than %d", length, m_value.attr_max_len);
     return;
@@ -203,8 +203,8 @@ void BLEDescriptor::setValue(uint8_t *data, size_t length) {
  * @brief Set the value of the descriptor.
  * @param [in] value The value of the descriptor in string form.
  */
-void BLEDescriptor::setValue(String value) {
-  setValue((uint8_t *)value.c_str(), value.length());
+void BLEDescriptor::setValue(const String &value) {
+  setValue(reinterpret_cast<const uint8_t *>(value.c_str()), value.length());
 }  // setValue
 
 void BLEDescriptor::setAccessPermissions(uint8_t perm) {

libraries/BLE/src/BLEDescriptor.h

@@ -94,8 +94,8 @@ class BLEDescriptor {
 
   void setAccessPermissions(uint8_t perm);                // Set the permissions of the descriptor.
   void setCallbacks(BLEDescriptorCallbacks *pCallbacks);  // Set callbacks to be invoked for the descriptor.
-  void setValue(uint8_t *data, size_t size);              // Set the value of the descriptor as a pointer to data.
-  void setValue(String value);                            // Set the value of the descriptor as a data buffer.
+  void setValue(const uint8_t *data, size_t size);        // Set the value of the descriptor as a pointer to data.
+  void setValue(const String &value);                     // Set the value of the descriptor as a data buffer.
 
   String toString();  // Convert the descriptor to a string representation.
 

libraries/BLE/src/BLEValue.cpp

@@ -37,7 +37,7 @@ BLEValue::BLEValue() {
  * The accumulation is a growing set of data that is added to until a commit or cancel.
  * @param [in] part A message part being added.
  */
-void BLEValue::addPart(String part) {
+void BLEValue::addPart(const String &part) {
   log_v(">> addPart: length=%d", part.length());
   m_accumulation += part;
 }  // addPart
@@ -48,7 +48,7 @@ void BLEValue::addPart(String part) {
  * @param [in] pData A message part being added.
  * @param [in] length The number of bytes being added.
  */
-void BLEValue::addPart(uint8_t *pData, size_t length) {
+void BLEValue::addPart(const uint8_t *pData, size_t length) {
   log_v(">> addPart: length=%d", length);
   m_accumulation += String((char *)pData, length);
 }  // addPart
@@ -121,7 +121,7 @@ void BLEValue::setReadOffset(uint16_t readOffset) {
 /**
  * @brief Set the current value.
  */
-void BLEValue::setValue(String value) {
+void BLEValue::setValue(const String &value) {
   m_value = value;
 }  // setValue
 
@@ -130,7 +130,7 @@ void BLEValue::setValue(String value) {
  * @param [in] pData The data for the current value.
  * @param [in] The length of the new current value.
  */
-void BLEValue::setValue(uint8_t *pData, size_t length) {
+void BLEValue::setValue(const uint8_t *pData, size_t length) {
   m_value = String((char *)pData, length);
 }  // setValue
 

libraries/BLE/src/BLEValue.h

@@ -34,17 +34,17 @@ class BLEValue {
    ***************************************************************************/
 
   BLEValue();
-  void addPart(String part);
-  void addPart(uint8_t *pData, size_t length);
+  void addPart(const String &part);
+  void addPart(const uint8_t *pData, size_t length);
   void cancel();
   void commit();
   uint8_t *getData();
   size_t getLength();
   uint16_t getReadOffset();
   String getValue();
   void setReadOffset(uint16_t readOffset);
-  void setValue(String value);
-  void setValue(uint8_t *pData, size_t length);
+  void setValue(const String &value);
+  void setValue(const uint8_t *pData, size_t length);
 
 private:
   /***************************************************************************