Merge header files

Author: lucasssvaz

libraries/BLE/src/BLE2901.h

@@ -26,8 +26,7 @@
 
 #include "BLEDescriptor.h"
 
-[[deprecated("This class is deprecated and will be removed in a future release. Use BLEDescriptor instead.")]]
-class BLE2901 : public BLEDescriptor {
+class [[deprecated("Use BLEDescriptor instead.")]] BLE2901 : public BLEDescriptor {
 public:
   BLE2901();
   void setDescription(String desc);

libraries/BLE/src/BLE2904.h

@@ -1,8 +1,18 @@
 /*
- * BLE2904.h
+ * Copyright 2020-2024 Ryan Powell <[email protected]> and
+ * esp-nimble-cpp, NimBLE-Arduino contributors.
  *
- *  Created on: Dec 23, 2017
- *      Author: kolban
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
  */
 
 #ifndef COMPONENTS_CPP_UTILS_BLE2904_H_
@@ -11,17 +21,16 @@
 #if SOC_BLE_SUPPORTED
 
 #include "sdkconfig.h"
-#if defined(CONFIG_BLUEDROID_ENABLED)
+#if defined(CONFIG_BLUEDROID_ENABLED) || (defined(CONFIG_NIMBLE_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL))
 
 #include "BLEDescriptor.h"
 
 struct BLE2904_Data {
-  uint8_t m_format;
-  int8_t m_exponent;
-  uint16_t m_unit;  // See https://www.bluetooth.com/specifications/assigned-numbers/units
-  uint8_t m_namespace;
-  uint16_t m_description;
-
+  uint8_t m_format{0};
+  int8_t m_exponent{0};
+  uint16_t m_unit{0x2700};    // Unitless; See https://www.bluetooth.com/specifications/assigned-numbers/units
+  uint8_t m_namespace{1};     // 1 = Bluetooth SIG Assigned Numbers
+  uint16_t m_description{0};  // unknown description
 } __attribute__((packed));
 
 /**
@@ -34,7 +43,11 @@ struct BLE2904_Data {
  */
 class BLE2904 : public BLEDescriptor {
 public:
+#if defined(CONFIG_BLUEDROID_ENABLED)
   BLE2904();
+#else
+  BLE2904(BLECharacteristic *pChr = nullptr);
+#endif
   static const uint8_t FORMAT_BOOLEAN = 1;
   static const uint8_t FORMAT_UINT2 = 2;
   static const uint8_t FORMAT_UINT4 = 3;
@@ -62,6 +75,7 @@ class BLE2904 : public BLEDescriptor {
   static const uint8_t FORMAT_UTF8 = 25;
   static const uint8_t FORMAT_UTF16 = 26;
   static const uint8_t FORMAT_OPAQUE = 27;
+  static const uint8_t FORMAT_MEDASN1 = 28;
 
   void setDescription(uint16_t);
   void setExponent(int8_t exponent);
@@ -70,9 +84,10 @@ class BLE2904 : public BLEDescriptor {
   void setUnit(uint16_t unit);
 
 private:
-  BLE2904_Data m_data;
+  friend class BLECharacteristic;
+  BLE2904_Data m_data{};
 };  // BLE2904
 
-#endif /* CONFIG_BLUEDROID_ENABLED */
+#endif /* CONFIG_BLUEDROID_ENABLED || (CONFIG_NIMBLE_ENABLED && CONFIG_BT_NIMBLE_ROLE_PERIPHERAL) */
 #endif /* SOC_BLE_SUPPORTED */
 #endif /* COMPONENTS_CPP_UTILS_BLE2904_H_ */

libraries/BLE/src/BLEAddress.h

@@ -1,8 +1,18 @@
 /*
- * BLEAddress.h
+ * Copyright 2020-2024 Ryan Powell <[email protected]> and
+ * esp-nimble-cpp, NimBLE-Arduino contributors.
  *
- *  Created on: Jul 2, 2017
- *      Author: kolban
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
  */
 
 #ifndef COMPONENTS_CPP_UTILS_BLEADDRESS_H_
@@ -12,7 +22,59 @@
 #if SOC_BLE_SUPPORTED
 
 #include "sdkconfig.h"
-#if defined(CONFIG_BLUEDROID_ENABLED)
+#if defined(CONFIG_NIMBLE_ENABLED)
+
+#include "nimble/ble.h"
+
+/****  FIX COMPILATION ****/
+#undef min
+#undef max
+/**************************/
+
+#include <string>
+
+/**
+ * @brief A BLE device address.
+ *
+ * Every BLE device has a unique address which can be used to identify it and form connections.
+ */
+class BLEAddress : private ble_addr_t {
+public:
+  /**
+     * @brief Create a blank address, i.e. 00:00:00:00:00:00, type 0.
+     */
+  BLEAddress() = default;
+  BLEAddress(const ble_addr_t address);
+  BLEAddress(const uint8_t address[BLE_DEV_ADDR_LEN], uint8_t type);
+  BLEAddress(const std::string &stringAddress, uint8_t type);
+  BLEAddress(const uint64_t &address, uint8_t type);
+
+  bool isRpa() const;
+  bool isNrpa() const;
+  bool isStatic() const;
+  bool isPublic() const;
+  bool isNull() const;
+  bool equals(const BLEAddress &otherAddress) const;
+  const ble_addr_t *getBase() const;
+  std::string toString() const;
+  uint8_t getType() const;
+  const uint8_t *getVal() const;
+  const BLEAddress &reverseByteOrder();
+  bool operator==(const BLEAddress &rhs) const;
+  bool operator!=(const BLEAddress &rhs) const;
+  operator std::string() const;
+  operator uint64_t() const;
+};
+
+#elif defined(CONFIG_BLUEDROID_ENABLED)
+
+/*
+ * BLEAddress.h
+ *
+ *  Created on: Jul 2, 2017
+ *      Author: kolban
+ */
+
 #include <esp_gap_ble_api.h>  // ESP32 BLE
 #include <string>
 
@@ -40,5 +102,6 @@ class BLEAddress {
 };
 
 #endif /* CONFIG_BLUEDROID_ENABLED */
+
 #endif /* SOC_BLE_SUPPORTED */
 #endif /* COMPONENTS_CPP_UTILS_BLEADDRESS_H_ */

libraries/BLE/src/BLEAdvertisedDevice.h

@@ -1,8 +1,18 @@
 /*
- * BLEAdvertisedDevice.h
+ * Copyright 2020-2024 Ryan Powell <[email protected]> and
+ * esp-nimble-cpp, NimBLE-Arduino contributors.
  *
- *  Created on: Jul 3, 2017
- *      Author: kolban
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
  */
 
 #ifndef COMPONENTS_CPP_UTILS_BLEADVERTISEDDEVICE_H_
@@ -11,7 +21,167 @@
 #if SOC_BLE_SUPPORTED
 
 #include "sdkconfig.h"
-#if defined(CONFIG_BLUEDROID_ENABLED)
+#if defined(CONFIG_NIMBLE_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)
+
+#include "BLEAddress.h"
+#include "BLEScan.h"
+#include "BLEUUID.h"
+
+#include "host/ble_hs_adv.h"
+#include "host/ble_gap.h"
+
+#include <vector>
+
+class BLEScan;
+/**
+ * @brief A representation of a %BLE advertised device found by a scan.
+ *
+ * When we perform a %BLE scan, the result will be a set of devices that are advertising.  This
+ * class provides a model of a detected device.
+ */
+class BLEAdvertisedDevice {
+public:
+  BLEAdvertisedDevice() = default;
+
+  uint8_t getAdvType() const;
+  uint8_t getAdvFlags() const;
+  uint16_t getAppearance() const;
+  uint16_t getAdvInterval() const;
+  uint16_t getMinInterval() const;
+  uint16_t getMaxInterval() const;
+  uint8_t getManufacturerDataCount() const;
+  const BLEAddress &getAddress() const;
+  std::string getManufacturerData(uint8_t index = 0) const;
+  std::string getURI() const;
+  std::string getPayloadByType(uint16_t type, uint8_t index = 0) const;
+  std::string getName() const;
+  int8_t getRSSI() const;
+  BLEScan *getScan() const;
+  uint8_t getServiceDataCount() const;
+  std::string getServiceData(uint8_t index = 0) const;
+  std::string getServiceData(const BLEUUID &uuid) const;
+  BLEUUID getServiceDataUUID(uint8_t index = 0) const;
+  BLEUUID getServiceUUID(uint8_t index = 0) const;
+  uint8_t getServiceUUIDCount() const;
+  BLEAddress getTargetAddress(uint8_t index = 0) const;
+  uint8_t getTargetAddressCount() const;
+  int8_t getTXPower() const;
+  uint8_t getAdvLength() const;
+  uint8_t getAddressType() const;
+  bool isAdvertisingService(const BLEUUID &uuid) const;
+  bool haveAppearance() const;
+  bool haveManufacturerData() const;
+  bool haveName() const;
+  bool haveServiceData() const;
+  bool haveServiceUUID() const;
+  bool haveTXPower() const;
+  bool haveConnParams() const;
+  bool haveAdvInterval() const;
+  bool haveTargetAddress() const;
+  bool haveURI() const;
+  bool haveType(uint16_t type) const;
+  std::string toString() const;
+  bool isConnectable() const;
+  bool isScannable() const;
+  bool isLegacyAdvertisement() const;
+#if CONFIG_BT_NIMBLE_EXT_ADV
+  uint8_t getSetId() const;
+  uint8_t getPrimaryPhy() const;
+  uint8_t getSecondaryPhy() const;
+  uint16_t getPeriodicInterval() const;
+#endif
+
+  const std::vector<uint8_t> &getPayload() const;
+  const std::vector<uint8_t>::const_iterator begin() const;
+  const std::vector<uint8_t>::const_iterator end() const;
+
+  /**
+     * @brief A template to convert the service data to <type\>.
+     * @tparam T The type to convert the data to.
+     * @param [in] skipSizeCheck If true it will skip checking if the data size is less than <tt>sizeof(<type\>)</tt>.
+     * @return The data converted to <type\> or NULL if skipSizeCheck is false and the data is
+     * less than <tt>sizeof(<type\>)</tt>.
+     * @details <b>Use:</b> <tt>getManufacturerData<type>(skipSizeCheck);</tt>
+     */
+  template<typename T> T getManufacturerData(bool skipSizeCheck = false) const {
+    std::string data = getManufacturerData();
+    if (!skipSizeCheck && data.size() < sizeof(T)) {
+      return T();
+    }
+    const char *pData = data.data();
+    return *((T *)pData);
+  }
+
+  /**
+     * @brief A template to convert the service data to <tt><type\></tt>.
+     * @tparam T The type to convert the data to.
+     * @param [in] index The vector index of the service data requested.
+     * @param [in] skipSizeCheck If true it will skip checking if the data size is less than <tt>sizeof(<type\>)</tt>.
+     * @return The data converted to <type\> or NULL if skipSizeCheck is false and the data is
+     * less than <tt>sizeof(<type\>)</tt>.
+     * @details <b>Use:</b> <tt>getServiceData<type>(skipSizeCheck);</tt>
+     */
+  template<typename T> T getServiceData(uint8_t index = 0, bool skipSizeCheck = false) const {
+    std::string data = getServiceData(index);
+    if (!skipSizeCheck && data.size() < sizeof(T)) {
+      return T();
+    }
+    const char *pData = data.data();
+    return *((T *)pData);
+  }
+
+  /**
+     * @brief A template to convert the service data to <tt><type\></tt>.
+     * @tparam T The type to convert the data to.
+     * @param [in] uuid The uuid of the service data requested.
+     * @param [in] skipSizeCheck If true it will skip checking if the data size is less than <tt>sizeof(<type\>)</tt>.
+     * @return The data converted to <type\> or NULL if skipSizeCheck is false and the data is
+     * less than <tt>sizeof(<type\>)</tt>.
+     * @details <b>Use:</b> <tt>getServiceData<type>(skipSizeCheck);</tt>
+     */
+  template<typename T> T getServiceData(const BLEUUID &uuid, bool skipSizeCheck = false) const {
+    std::string data = getServiceData(uuid);
+    if (!skipSizeCheck && data.size() < sizeof(T)) {
+      return T();
+    }
+    const char *pData = data.data();
+    return *((T *)pData);
+  }
+
+private:
+  friend class BLEScan;
+
+  BLEAdvertisedDevice(const ble_gap_event *event, uint8_t eventType);
+  void update(const ble_gap_event *event, uint8_t eventType);
+  uint8_t findAdvField(uint8_t type, uint8_t index = 0, size_t *data_loc = nullptr) const;
+  size_t findServiceData(uint8_t index, uint8_t *bytes) const;
+
+  BLEAddress m_address{};
+  uint8_t m_advType{};
+  int8_t m_rssi{};
+  uint8_t m_callbackSent{};
+  uint8_t m_advLength{};
+
+#if CONFIG_BT_NIMBLE_EXT_ADV
+  bool m_isLegacyAdv{};
+  uint8_t m_sid{};
+  uint8_t m_primPhy{};
+  uint8_t m_secPhy{};
+  uint16_t m_periodicItvl{};
+#endif
+
+  std::vector<uint8_t> m_payload;
+};
+
+#elif defined(CONFIG_BLUEDROID_ENABLED)
+
+/*
+ * BLEAdvertisedDevice.h
+ *
+ *  Created on: Jul 3, 2017
+ *      Author: kolban
+ */
+
 #include <esp_gattc_api.h>
 
 #include <map>
@@ -148,5 +318,6 @@ class BLEExtAdvertisingCallbacks {
 #endif  // SOC_BLE_50_SUPPORTED
 
 #endif /* CONFIG_BLUEDROID_ENABLED */
+
 #endif /* SOC_BLE_SUPPORTED */
 #endif /* COMPONENTS_CPP_UTILS_BLEADVERTISEDDEVICE_H_ */

libraries/BLE/src/BLEAdvertisementData.h

@@ -74,5 +74,5 @@ class BLEAdvertisementData {
   std::vector<uint8_t> m_payload{};
 };  // BLEAdvertisementData
 
-#endif  // CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_BROADCASTER && !CONFIG_BT_NIMBLE_EXT_ADV
+#endif  // CONFIG_NIMBLE_ENABLED && CONFIG_BT_NIMBLE_ROLE_BROADCASTER && !CONFIG_BT_NIMBLE_EXT_ADV
 #endif  // NIMBLE_CPP_ADVERTISEMENT_DATA_H_