mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2024-11-25 06:30:55 +01:00
[BREAKING] - Refactor NimBLEAdvertising
* General code cleanup. * `NimBLEAdvertisementData` moved to it's own .h and .cpp files. * Added new method, `NimBLEAdvertising::setPreferredParams` that takes the min and max preferred connection parameters as an alternative for `setMinPreferred` and `setMaxPreferred`. * Added new method, `NimBLEAdvertising::setAdvertisingInterval` Sets the advertisement interval for min and max to the same value instead of calling `setMinInterval` and `setMaxInterval` separately if there is not value difference. * `NimBLEAdvertisementData` payload is now stored in `std::vector<uint8_t>` instead of `std::string`. * `NimBLEAdvertisementData::getPayload` now returns `std::vector<uint8_t>` instead of `std::string`. * `NimBLEAdvertisementData::addData` now takes either a `std::vector<uint8_t>` or `uint8_t* + length` instead of `std::string` or `char + length`. * `NimBLEAdvertisementData::setName` now takes an optional `bool` parameter to indicate if the name is complete or incomplete, default = complete. * `NimBLEAdvertising::start` No longer takes a callback pointer parameter, instead the new method `NimBLEAdvertising::setAdvertisingCompleteCallback` should be used. * `NimBLEAdvertising::setAdvertisementType` has been renamed to `NimBLEAdvertising::setConnectableMode` to better reflect it's function. * Added new method, `NimBLEAdvertising::setDiscoverableMode` to allow applications to control the discoverability of the advertiser. * Advertising the name and TX power of the device will no longer happen by default and should be set manually by the application. * Added overload for `NimBLEAdvertising::setManufacturerData` that takes a `const uint8_t*` and , size_t` paramter. * Added overload for `NimBLEAdvertising::setServiceData` that takes `const NimBLEUUID& uuid`, ` const uint8_t* data`, ` size_t length` as parameters. * Added overload for `NimBLEAdvertising::setServiceData` that takes `const NimBLEUUID& uuid`, `const std::vector<uint8_t>&` as parameters. * All `NimBLEAdvertisementData` functions that change data values now return `bool`, true = success. * All `NimBLEAdvertising` functions that change data values now return `bool`, true = success. * `NimBLEAdvertising::setMinPreferred` and `NimBLEAdvertising::setMaxPreferred` have been removed, use `NimBLEAdvertising::setPreferredParams` instead. * All advertising data is now stored in instances of `NimBLEAdvertisingData` and vectors removed from `NimBLEAdvertising`. * `NimBLEAdvertising::setAdvertisementData` and `NimBLEAdvertising::setScanResponseData` now return `bool`, true = success. * Added new method, `NimBLEAdvertisementData::removeData`, which takes a parameter `uint8_t type`, the data type to remove. * Added new method, `NimBLEAdvertisementData::toString`, which will print the data in hex. * Added new method, `NimBLEAdvertising::getAdvertisementData`, which returns a reference to the currently set advertisement data. * Added new method, `NimBLEAdvertising::getScanData`, which returns a reference to the currently set scan response data. * Added overloads for `NimBLEAdvertising::removeServiceUUID` and `NimBLEAdvertisementData::removeServiceUUID` to accept a `const char*` * Added new method, `NimBLEAdvertising::clearData`, which will clear the advertisement and scan response data.
This commit is contained in:
h2zero
h2zero
parent
2151386057
commit
1034903a97
5 changed files with 1120 additions and 961 deletions
|
|
@ -44,6 +44,7 @@ idf_component_register(
|
|||
"src/NimBLE2904.cpp"
|
||||
"src/NimBLEAddress.cpp"
|
||||
"src/NimBLEAdvertisedDevice.cpp"
|
||||
"src/NimBLEAdvertisementData.cpp"
|
||||
"src/NimBLEAdvertising.cpp"
|
||||
"src/NimBLEAttValue.cpp"
|
||||
"src/NimBLEBeacon.cpp"
|
||||
|
|
|
|||
586
src/NimBLEAdvertisementData.cpp
Normal file
586
src/NimBLEAdvertisementData.cpp
Normal file
|
|
@ -0,0 +1,586 @@
|
|||
/*
|
||||
* NimBLEAdvertisementData.cpp
|
||||
*
|
||||
* Created: on November 24, 2024
|
||||
* Author H2zero
|
||||
*
|
||||
*/
|
||||
|
||||
#include "nimconfig.h"
|
||||
#if (defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER) && !CONFIG_BT_NIMBLE_EXT_ADV) || \
|
||||
defined(_DOXYGEN_)
|
||||
|
||||
#include "NimBLEAdvertisementData.h"
|
||||
#include "NimBLEDevice.h"
|
||||
#include "NimBLEUtils.h"
|
||||
#include "NimBLEUUID.h"
|
||||
#include "NimBLELog.h"
|
||||
|
||||
#if defined(CONFIG_NIMBLE_CPP_IDF)
|
||||
# include "host/ble_hs_adv.h"
|
||||
#else
|
||||
# include "nimble/nimble/host/include/host/ble_hs_adv.h"
|
||||
#endif
|
||||
|
||||
static const char* LOG_TAG = "NimBLEAdvertisementData";
|
||||
|
||||
/**
|
||||
* @brief Add data to the payload to be advertised.
|
||||
* @param [in] data The data to be added to the payload.
|
||||
* @param [in] length The size of data to be added to the payload.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::addData(const uint8_t* data, size_t length) {
|
||||
if ((m_payload.size() + length) > BLE_HS_ADV_MAX_SZ) {
|
||||
NIMBLE_LOGE(LOG_TAG, "Data length exceeded");
|
||||
return false;
|
||||
}
|
||||
|
||||
m_payload.insert(m_payload.end(), data, data + length);
|
||||
return true;
|
||||
} // addData
|
||||
|
||||
/**
|
||||
* @brief Add data to the payload to be advertised.
|
||||
* @param [in] data The data to be added to the payload.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::addData(const std::vector<uint8_t>& data) {
|
||||
return addData(&data[0], data.size());
|
||||
} // addData
|
||||
|
||||
/**
|
||||
* @brief Set the appearance.
|
||||
* @param [in] appearance The appearance code value.
|
||||
* @return True if successful.
|
||||
* @details If the appearance value is 0 then it will be removed from the advertisement if set previously.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::setAppearance(uint16_t appearance) {
|
||||
if (appearance == 0) {
|
||||
return removeData(BLE_HS_ADV_TYPE_APPEARANCE);
|
||||
}
|
||||
|
||||
uint8_t data[4];
|
||||
data[0] = 3;
|
||||
data[1] = BLE_HS_ADV_TYPE_APPEARANCE;
|
||||
data[2] = appearance;
|
||||
data[3] = (appearance >> 8) & 0xFF;
|
||||
return addData(data, 4);
|
||||
} // setAppearance
|
||||
|
||||
/**
|
||||
* @brief Set the advertisement flags.
|
||||
* @param [in] flag The flags to be set in the advertisement.
|
||||
* * BLE_HS_ADV_F_DISC_LTD
|
||||
* * BLE_HS_ADV_F_DISC_GEN
|
||||
* * BLE_HS_ADV_F_BREDR_UNSUP - must always use with NimBLE
|
||||
* A flag value of 0 will remove the flags from the advertisement.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::setFlags(uint8_t flag) {
|
||||
int dataLoc = getDataLocation(BLE_HS_ADV_TYPE_FLAGS);
|
||||
if (dataLoc != -1) {
|
||||
if (flag) {
|
||||
m_payload[dataLoc + 2] = flag | BLE_HS_ADV_F_BREDR_UNSUP;
|
||||
return true;
|
||||
} else {
|
||||
return removeData(BLE_HS_ADV_TYPE_FLAGS);
|
||||
}
|
||||
}
|
||||
|
||||
uint8_t data[3];
|
||||
data[0] = 2;
|
||||
data[1] = BLE_HS_ADV_TYPE_FLAGS;
|
||||
data[2] = flag | BLE_HS_ADV_F_BREDR_UNSUP;
|
||||
return addData(data, 3);
|
||||
} // setFlags
|
||||
|
||||
/**
|
||||
* @brief Adds Tx power level to the advertisement data.
|
||||
* @return True if successful.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::addTxPower() {
|
||||
uint8_t data[3];
|
||||
data[0] = BLE_HS_ADV_TX_PWR_LVL_LEN + 1;
|
||||
data[1] = BLE_HS_ADV_TYPE_TX_PWR_LVL;
|
||||
#ifndef CONFIG_IDF_TARGET_ESP32P4
|
||||
data[2] = NimBLEDevice::getPower();
|
||||
#else
|
||||
data[2] = 0;
|
||||
#endif
|
||||
return addData(data, 3);
|
||||
} // addTxPower
|
||||
|
||||
/**
|
||||
* @brief Set the preferred min and max connection intervals to advertise.
|
||||
* @param [in] minInterval The minimum preferred connection interval.
|
||||
* @param [in] maxInterval The Maximum preferred connection interval.
|
||||
* @details Range = 0x0006(7.5ms) to 0x0C80(4000ms), values not within the range will be limited to this range.
|
||||
* @return True if successful.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::setPreferredParams(uint16_t minInterval, uint16_t maxInterval) {
|
||||
minInterval = std::max<uint16_t>(minInterval, 0x6);
|
||||
minInterval = std::min<uint16_t>(minInterval, 0xC80);
|
||||
maxInterval = std::max<uint16_t>(maxInterval, 0x6);
|
||||
maxInterval = std::min<uint16_t>(maxInterval, 0xC80);
|
||||
maxInterval = std::max<uint16_t>(maxInterval, minInterval); // Max must be greater than or equal to min.
|
||||
|
||||
uint8_t data[6];
|
||||
data[0] = BLE_HS_ADV_SLAVE_ITVL_RANGE_LEN + 1;
|
||||
data[1] = BLE_HS_ADV_TYPE_SLAVE_ITVL_RANGE;
|
||||
data[2] = minInterval;
|
||||
data[3] = minInterval >> 8;
|
||||
data[4] = maxInterval;
|
||||
data[5] = maxInterval >> 8;
|
||||
return addData(data, 6);
|
||||
} // setPreferredParams
|
||||
|
||||
/**
|
||||
* @brief Add a service uuid to exposed list of services.
|
||||
* @param [in] serviceUUID The UUID of the service to expose.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::addServiceUUID(const NimBLEUUID& serviceUUID) {
|
||||
uint8_t bytes = serviceUUID.bitSize() / 8;
|
||||
int type;
|
||||
switch (bytes) {
|
||||
case 2:
|
||||
type = BLE_HS_ADV_TYPE_COMP_UUIDS16;
|
||||
break;
|
||||
case 4:
|
||||
type = BLE_HS_ADV_TYPE_COMP_UUIDS32;
|
||||
break;
|
||||
case 16:
|
||||
type = BLE_HS_ADV_TYPE_COMP_UUIDS128;
|
||||
break;
|
||||
default:
|
||||
return false;
|
||||
}
|
||||
|
||||
int dataLoc = getDataLocation(type);
|
||||
uint8_t length = bytes;
|
||||
if (dataLoc == -1) {
|
||||
length += 2;
|
||||
}
|
||||
|
||||
if (length + getPayload().size() > BLE_HS_ADV_MAX_SZ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
uint8_t data[31];
|
||||
if (dataLoc == -1) {
|
||||
data[0] = 1 + bytes;
|
||||
data[1] = type;
|
||||
memcpy(&data[2], serviceUUID.getValue(), bytes);
|
||||
} else {
|
||||
auto nextData = dataLoc + m_payload[dataLoc] + 1;
|
||||
memcpy(data, m_payload.data(), nextData);
|
||||
data[dataLoc] += bytes;
|
||||
memcpy(&data[nextData], serviceUUID.getValue(), bytes);
|
||||
memcpy(&data[nextData + bytes], m_payload.data() + nextData, m_payload.size() - nextData);
|
||||
length += getPayload().size();
|
||||
clearData();
|
||||
}
|
||||
|
||||
return addData(data, length);
|
||||
} // addServiceUUID
|
||||
|
||||
/**
|
||||
* @brief Add a service uuid to exposed list of services.
|
||||
* @param [in] serviceUUID The string representation of the service to expose.
|
||||
* @return True if successful.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::addServiceUUID(const char* serviceUUID) {
|
||||
return addServiceUUID(NimBLEUUID(serviceUUID));
|
||||
} // addServiceUUID
|
||||
|
||||
/**
|
||||
* @brief Remove a service UUID from the advertisement.
|
||||
* @param [in] serviceUUID The UUID of the service to remove.
|
||||
* @return True if successful or uuid not found, false if uuid error or data could not be reset.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::removeServiceUUID(const NimBLEUUID& serviceUUID) {
|
||||
uint8_t bytes = serviceUUID.bitSize() / 8;
|
||||
int type;
|
||||
switch (bytes) {
|
||||
case 2:
|
||||
type = BLE_HS_ADV_TYPE_COMP_UUIDS16;
|
||||
break;
|
||||
case 4:
|
||||
type = BLE_HS_ADV_TYPE_COMP_UUIDS32;
|
||||
break;
|
||||
case 16:
|
||||
type = BLE_HS_ADV_TYPE_COMP_UUIDS128;
|
||||
break;
|
||||
default:
|
||||
return false;
|
||||
}
|
||||
|
||||
int dataLoc = getDataLocation(type);
|
||||
if (dataLoc == -1) {
|
||||
return true;
|
||||
}
|
||||
|
||||
int uuidLoc = -1;
|
||||
for (int i = dataLoc + 2; i < m_payload.size(); i += bytes) {
|
||||
if (memcmp(&m_payload[i], serviceUUID.getValue(), bytes) == 0) {
|
||||
uuidLoc = i;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (uuidLoc == -1) {
|
||||
return true;
|
||||
}
|
||||
|
||||
auto nextData = dataLoc + m_payload[dataLoc] + 1;
|
||||
uint8_t length = m_payload.size() - bytes;
|
||||
uint8_t data[31];
|
||||
memcpy(data, m_payload.data(), uuidLoc);
|
||||
if (m_payload[dataLoc] - bytes == 1) {
|
||||
length -= 2;
|
||||
memcpy(&data[dataLoc], m_payload.data() + nextData, m_payload.size() - nextData);
|
||||
} else {
|
||||
data[dataLoc] -= bytes;
|
||||
memcpy(&data[uuidLoc], m_payload.data() + uuidLoc + bytes, m_payload.size() - uuidLoc - bytes);
|
||||
}
|
||||
|
||||
clearData();
|
||||
return addData(data, length);
|
||||
} // removeServiceUUID
|
||||
|
||||
/**
|
||||
* @brief Remove a service UUID from the advertisement.
|
||||
* @param [in] serviceUUID The UUID of the service to remove.
|
||||
* @return True if successful or uuid not found, false if uuid error or data could not be reset.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::removeServiceUUID(const char* serviceUUID) {
|
||||
return removeServiceUUID(NimBLEUUID(serviceUUID));
|
||||
} // removeServiceUUID
|
||||
|
||||
/**
|
||||
* @brief Remove all service UUIDs from the advertisement.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::removeServices() {
|
||||
return true;
|
||||
} // removeServices
|
||||
|
||||
/**
|
||||
* @brief Set manufacturer specific data.
|
||||
* @param [in] data The manufacturer data to advertise.
|
||||
* @param [in] length The length of the data.
|
||||
* @return True if successful.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::setManufacturerData(const uint8_t* data, size_t length) {
|
||||
uint8_t mdata[31];
|
||||
uint8_t mlen = 2 + std::min<uint8_t>(length, 29);
|
||||
mdata[0] = mlen - 1;
|
||||
mdata[1] = BLE_HS_ADV_TYPE_MFG_DATA;
|
||||
memcpy(&mdata[2], data, mlen - 2);
|
||||
return addData(mdata, mlen);
|
||||
} // setManufacturerData
|
||||
|
||||
/**
|
||||
* @brief Set manufacturer specific data.
|
||||
* @param [in] data The manufacturer data to advertise.
|
||||
* @return True if successful.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::setManufacturerData(const std::string& data) {
|
||||
return setManufacturerData(reinterpret_cast<const uint8_t*>(data.data()), data.length());
|
||||
} // setManufacturerData
|
||||
|
||||
/**
|
||||
* @brief Set manufacturer specific data.
|
||||
* @param [in] data The manufacturer data to advertise.
|
||||
* @return True if successful.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::setManufacturerData(const std::vector<uint8_t>& data) {
|
||||
return setManufacturerData(&data[0], data.size());
|
||||
} // setManufacturerData
|
||||
|
||||
/**
|
||||
* @brief Set the URI to advertise.
|
||||
* @param [in] uri The uri to advertise.
|
||||
* @return True if successful.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::setURI(const std::string& uri) {
|
||||
if (uri.length() > 29) {
|
||||
NIMBLE_LOGE(LOG_TAG, "URI too long");
|
||||
return false;
|
||||
}
|
||||
|
||||
uint8_t data[31];
|
||||
uint8_t length = 2 + uri.length();
|
||||
data[0] = length - 1;
|
||||
data[1] = BLE_HS_ADV_TYPE_URI;
|
||||
memcpy(&data[2], uri.c_str(), length - 2);
|
||||
return addData(data, length);
|
||||
} // setURI
|
||||
|
||||
/**
|
||||
* @brief Set the complete name of this device.
|
||||
* @param [in] name The name to advertise.
|
||||
* @param [in] isComplete If true the name is complete, which will set the data type accordingly.
|
||||
* @details If the name is longer than 29 characters it will be truncated.
|
||||
* and the data type will be set to incomplete name.
|
||||
* @return True if successful.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::setName(const std::string& name, bool isComplete) {
|
||||
if (name.length() > 29) {
|
||||
NIMBLE_LOGE(LOG_TAG, "Name too long - truncating");
|
||||
isComplete = false;
|
||||
}
|
||||
|
||||
uint8_t data[31];
|
||||
uint8_t length = 2 + std::min<uint8_t>(name.length(), 29);
|
||||
data[0] = length - 1;
|
||||
data[1] = isComplete ? BLE_HS_ADV_TYPE_COMP_NAME : BLE_HS_ADV_TYPE_INCOMP_NAME;
|
||||
memcpy(&data[2], name.c_str(), std::min<uint8_t>(name.length(), 29));
|
||||
return addData(data, length);
|
||||
} // setName
|
||||
|
||||
/**
|
||||
* @brief Set the short name.
|
||||
* @param [in] name The short name of the device.
|
||||
* @return True if successful.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::setShortName(const std::string& name) {
|
||||
return setName(name, false);
|
||||
} // setShortName
|
||||
|
||||
/**
|
||||
* @brief Set a single service to advertise as a complete list of services.
|
||||
* @param [in] uuid The service to advertise.
|
||||
* @return True if successful.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::setCompleteServices(const NimBLEUUID& uuid) {
|
||||
return setServices(true, uuid.bitSize(), {uuid});
|
||||
} // setCompleteServices
|
||||
|
||||
/**
|
||||
* @brief Set the complete list of 16 bit services to advertise.
|
||||
* @param [in] uuids A vector of 16 bit UUID's to advertise.
|
||||
* @return True if successful.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::setCompleteServices16(const std::vector<NimBLEUUID>& uuids) {
|
||||
return setServices(true, 16, uuids);
|
||||
} // setCompleteServices16
|
||||
|
||||
/**
|
||||
* @brief Set the complete list of 32 bit services to advertise.
|
||||
* @param [in] uuids A vector of 32 bit UUID's to advertise.
|
||||
* @return True if successful.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::setCompleteServices32(const std::vector<NimBLEUUID>& uuids) {
|
||||
return setServices(true, 32, uuids);
|
||||
} // setCompleteServices32
|
||||
|
||||
/**
|
||||
* @brief Set a single service to advertise as a partial list of services.
|
||||
* @param [in] uuid The service to advertise.
|
||||
* @return True if successful.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::setPartialServices(const NimBLEUUID& uuid) {
|
||||
return setServices(false, uuid.bitSize(), {uuid});
|
||||
} // setPartialServices
|
||||
|
||||
/**
|
||||
* @brief Set the partial list of services to advertise.
|
||||
* @param [in] uuids A vector of 16 bit UUID's to advertise.
|
||||
* @return True if successful.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::setPartialServices16(const std::vector<NimBLEUUID>& uuids) {
|
||||
return setServices(false, 16, uuids);
|
||||
} // setPartialServices16
|
||||
|
||||
/**
|
||||
* @brief Set the partial list of services to advertise.
|
||||
* @param [in] uuids A vector of 32 bit UUID's to advertise.
|
||||
* @return True if successful.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::setPartialServices32(const std::vector<NimBLEUUID>& uuids) {
|
||||
return setServices(false, 32, uuids);
|
||||
} // setPartialServices32
|
||||
|
||||
/**
|
||||
* @brief Utility function to create the list of service UUID's from a vector.
|
||||
* @param [in] complete If true the vector is the complete set of services.
|
||||
* @param [in] size The bit size of the UUID's in the vector. (16, 32, or 128).
|
||||
* @param [in] uuids The vector of service UUID's to advertise.
|
||||
* @return True if successful.
|
||||
* @details The number of services will be truncated if the total length exceeds 31 bytes.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::setServices(bool complete, uint8_t size, const std::vector<NimBLEUUID>& uuids) {
|
||||
uint8_t bytes = size / 8;
|
||||
uint8_t length = 2; // start with 2 for length + type bytes
|
||||
uint8_t data[31];
|
||||
|
||||
for (const auto& uuid : uuids) {
|
||||
if (uuid.bitSize() != size) {
|
||||
NIMBLE_LOGE(LOG_TAG, "Service UUID(%d) invalid", size);
|
||||
continue;
|
||||
} else {
|
||||
if (length + bytes >= 31) {
|
||||
NIMBLE_LOGW(LOG_TAG, "Too many services - truncating");
|
||||
complete = false;
|
||||
break;
|
||||
}
|
||||
memcpy(&data[length], uuid.getValue(), bytes);
|
||||
length += bytes;
|
||||
}
|
||||
}
|
||||
|
||||
data[0] = length - 1; // don't count the length byte as part of the AD length
|
||||
|
||||
switch (size) {
|
||||
case 16:
|
||||
data[1] = (complete ? BLE_HS_ADV_TYPE_COMP_UUIDS16 : BLE_HS_ADV_TYPE_INCOMP_UUIDS16);
|
||||
break;
|
||||
case 32:
|
||||
data[1] = (complete ? BLE_HS_ADV_TYPE_COMP_UUIDS32 : BLE_HS_ADV_TYPE_INCOMP_UUIDS32);
|
||||
break;
|
||||
case 128:
|
||||
data[1] = (complete ? BLE_HS_ADV_TYPE_COMP_UUIDS128 : BLE_HS_ADV_TYPE_INCOMP_UUIDS128);
|
||||
break;
|
||||
default:
|
||||
return false;
|
||||
}
|
||||
|
||||
return addData(data, length);
|
||||
} // setServices
|
||||
|
||||
/**
|
||||
* @brief Set the service data advertised for the UUID.
|
||||
* @param [in] uuid The UUID the service data belongs to.
|
||||
* @param [in] data The data to advertise.
|
||||
* @param [in] length The length of the data.
|
||||
* @note If data length is 0 the service data will not be advertised.
|
||||
* @return True if successful, false if data length is too long or could not be set.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::setServiceData(const NimBLEUUID& uuid, const uint8_t* data, size_t length) {
|
||||
uint8_t uuidBytes = uuid.bitSize() / 8;
|
||||
uint8_t sDataLen = 2 + uuidBytes + length;
|
||||
if (sDataLen > 31) {
|
||||
NIMBLE_LOGE(LOG_TAG, "Data too long");
|
||||
return false;
|
||||
}
|
||||
|
||||
uint8_t type;
|
||||
switch (uuidBytes) {
|
||||
case 2:
|
||||
type = BLE_HS_ADV_TYPE_SVC_DATA_UUID16;
|
||||
break;
|
||||
case 4:
|
||||
type = BLE_HS_ADV_TYPE_SVC_DATA_UUID32;
|
||||
break;
|
||||
case 16:
|
||||
type = BLE_HS_ADV_TYPE_SVC_DATA_UUID128;
|
||||
break;
|
||||
default:
|
||||
return false;
|
||||
}
|
||||
|
||||
if (length == 0) {
|
||||
removeData(type);
|
||||
return true;
|
||||
}
|
||||
|
||||
uint8_t sData[31];
|
||||
sData[0] = uuidBytes + length + 1;
|
||||
sData[1] = type;
|
||||
memcpy(&sData[2], uuid.getValue(), uuidBytes);
|
||||
memcpy(&sData[uuidBytes], data, length);
|
||||
return addData(sData, sDataLen);
|
||||
} // setServiceData
|
||||
|
||||
/**
|
||||
* @brief Set the service data (UUID + data)
|
||||
* @param [in] uuid The UUID to set with the service data.
|
||||
* @param [in] data The data to be associated with the service data advertised.
|
||||
* @return True if the service data was set successfully.
|
||||
* @note If data length is 0 the service data will not be advertised.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::setServiceData(const NimBLEUUID& uuid, const std::string& data) {
|
||||
return setServiceData(uuid, reinterpret_cast<const uint8_t*>(data.data()), data.length());
|
||||
} // setServiceData
|
||||
|
||||
/**
|
||||
* @brief Set the service data advertised for the UUID.
|
||||
* @param [in] uuid The UUID the service data belongs to.
|
||||
* @param [in] data The data to advertise.
|
||||
* @return True if the service data was set successfully.
|
||||
* @note If data length is 0 the service data will not be advertised.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::setServiceData(const NimBLEUUID& uuid, const std::vector<uint8_t>& data) {
|
||||
return setServiceData(uuid, &data[0], data.size());
|
||||
} // setServiceData
|
||||
|
||||
/**
|
||||
* @brief Get the location of the data in the payload.
|
||||
* @param [in] type The type of data to search for.
|
||||
* @return -1 if the data is not found, otherwise the index of the data in the payload.
|
||||
*/
|
||||
int NimBLEAdvertisementData::getDataLocation(uint8_t type) const {
|
||||
int index = 0;
|
||||
while (index < m_payload.size()) {
|
||||
if (m_payload[index + 1] == type) {
|
||||
return index;
|
||||
}
|
||||
index += m_payload[index] + 1;
|
||||
}
|
||||
return -1;
|
||||
} // getDataLocation
|
||||
|
||||
/**
|
||||
* @brief Remove data from the advertisement data.
|
||||
* @param [in] type The type of data to remove.
|
||||
* @return True if successful.
|
||||
*/
|
||||
bool NimBLEAdvertisementData::removeData(uint8_t type) {
|
||||
int dataLoc = getDataLocation(type);
|
||||
if (dataLoc != -1) {
|
||||
uint8_t data[31];
|
||||
int length = dataLoc;
|
||||
int nextData = dataLoc + m_payload[dataLoc] + 1;
|
||||
memcpy(data, m_payload.data(), dataLoc);
|
||||
if (nextData < m_payload.size()) {
|
||||
memcpy(&data[dataLoc], m_payload.data() + nextData, m_payload.size() - nextData);
|
||||
length += m_payload.size() - nextData;
|
||||
}
|
||||
clearData();
|
||||
return addData(data, length);
|
||||
}
|
||||
|
||||
return true;
|
||||
} // removeData
|
||||
|
||||
/**
|
||||
* @brief Retrieve the payload that is to be advertised.
|
||||
* @return The payload of the advertisement data.
|
||||
*/
|
||||
std::vector<uint8_t> NimBLEAdvertisementData::getPayload() const {
|
||||
return m_payload;
|
||||
} // getPayload
|
||||
|
||||
/**
|
||||
* @brief Clear the advertisement data for reuse.
|
||||
*/
|
||||
void NimBLEAdvertisementData::clearData() {
|
||||
std::vector<uint8_t>().swap(m_payload);
|
||||
} // clearData
|
||||
|
||||
/**
|
||||
* @brief Get the string representation of the advertisement data.
|
||||
* @return The string representation of the advertisement data.
|
||||
*/
|
||||
std::string NimBLEAdvertisementData::toString() const {
|
||||
std::string hexStr = NimBLEUtils::dataToHexString(&m_payload[0], m_payload.size());
|
||||
std::string str;
|
||||
for (size_t i = 0; i < hexStr.length(); i += 2) {
|
||||
str += hexStr[i];
|
||||
str += hexStr[i + 1];
|
||||
if (i + 2 < hexStr.length()) {
|
||||
str += " ";
|
||||
}
|
||||
}
|
||||
|
||||
return str;
|
||||
} // toString
|
||||
|
||||
#endif // CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_BROADCASTER && !CONFIG_BT_NIMBLE_EXT_ADV
|
||||
70
src/NimBLEAdvertisementData.h
Normal file
70
src/NimBLEAdvertisementData.h
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
/*
|
||||
* NimBLEAdvertisementData.h
|
||||
*
|
||||
* Created: on November 24, 2024
|
||||
* Author H2zero
|
||||
*
|
||||
*/
|
||||
|
||||
#ifndef NIMBLE_CPP_ADVERTISEMENT_DATA_H_
|
||||
#define NIMBLE_CPP_ADVERTISEMENT_DATA_H_
|
||||
|
||||
#include "nimconfig.h"
|
||||
#if (defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER) && !CONFIG_BT_NIMBLE_EXT_ADV) || \
|
||||
defined(_DOXYGEN_)
|
||||
|
||||
#include <cstdint>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
class NimBLEUUID;
|
||||
/**
|
||||
* @brief Advertisement data set by the programmer to be published by the BLE server.
|
||||
*/
|
||||
class NimBLEAdvertisementData {
|
||||
// Only a subset of the possible BLE architected advertisement fields are currently exposed. Others will
|
||||
// be exposed on demand/request or as time permits.
|
||||
//
|
||||
public:
|
||||
bool addData(const uint8_t* data, size_t length);
|
||||
bool addData(const std::vector<uint8_t>& data);
|
||||
bool setAppearance(uint16_t appearance);
|
||||
bool setFlags(uint8_t);
|
||||
bool addTxPower();
|
||||
bool setPreferredParams(uint16_t minInterval, uint16_t maxInterval);
|
||||
bool addServiceUUID(const NimBLEUUID& serviceUUID);
|
||||
bool addServiceUUID(const char* serviceUUID);
|
||||
bool removeServiceUUID(const NimBLEUUID& serviceUUID);
|
||||
bool removeServiceUUID(const char* serviceUUID);
|
||||
bool removeServices();
|
||||
bool setManufacturerData(const uint8_t* data, size_t length);
|
||||
bool setManufacturerData(const std::string& data);
|
||||
bool setManufacturerData(const std::vector<uint8_t>& data);
|
||||
bool setURI(const std::string& uri);
|
||||
bool setName(const std::string& name, bool isComplete = true);
|
||||
bool setShortName(const std::string& name);
|
||||
bool setCompleteServices(const NimBLEUUID& uuid);
|
||||
bool setCompleteServices16(const std::vector<NimBLEUUID>& uuids);
|
||||
bool setCompleteServices32(const std::vector<NimBLEUUID>& uuids);
|
||||
bool setPartialServices(const NimBLEUUID& uuid);
|
||||
bool setPartialServices16(const std::vector<NimBLEUUID>& uuids);
|
||||
bool setPartialServices32(const std::vector<NimBLEUUID>& uuids);
|
||||
bool setServiceData(const NimBLEUUID& uuid, const uint8_t* data, size_t length);
|
||||
bool setServiceData(const NimBLEUUID& uuid, const std::string& data);
|
||||
bool setServiceData(const NimBLEUUID& uuid, const std::vector<uint8_t>& data);
|
||||
bool removeData(uint8_t type);
|
||||
void clearData();
|
||||
int getDataLocation(uint8_t type) const;
|
||||
|
||||
std::string toString() const;
|
||||
std::vector<uint8_t> getPayload() const;
|
||||
|
||||
private:
|
||||
friend class NimBLEAdvertising;
|
||||
|
||||
bool setServices(bool complete, uint8_t size, const std::vector<NimBLEUUID>& v_uuid);
|
||||
std::vector<uint8_t> m_payload{};
|
||||
}; // NimBLEAdvertisementData
|
||||
|
||||
#endif // CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_BROADCASTER && !CONFIG_BT_NIMBLE_EXT_ADV
|
||||
#endif // NIMBLE_CPP_ADVERTISEMENT_DATA_H_
|
||||
File diff suppressed because it is too large
Load diff
|
|
@ -12,139 +12,95 @@
|
|||
* Author: kolban
|
||||
*/
|
||||
|
||||
#ifndef MAIN_BLEADVERTISING_H_
|
||||
#define MAIN_BLEADVERTISING_H_
|
||||
#include "nimconfig.h"
|
||||
#if (defined(CONFIG_BT_ENABLED) && \
|
||||
defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER) && \
|
||||
!CONFIG_BT_NIMBLE_EXT_ADV) || defined(_DOXYGEN_)
|
||||
#ifndef NIMBLE_CPP_ADVERTISING_H_
|
||||
#define NIMBLE_CPP_ADVERTISING_H_
|
||||
|
||||
#if defined(CONFIG_NIMBLE_CPP_IDF)
|
||||
#include "host/ble_gap.h"
|
||||
#else
|
||||
#include "nimble/nimble/host/include/host/ble_gap.h"
|
||||
#endif
|
||||
#include "nimconfig.h"
|
||||
#if (defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER) && !CONFIG_BT_NIMBLE_EXT_ADV) || \
|
||||
defined(_DOXYGEN_)
|
||||
|
||||
# if defined(CONFIG_NIMBLE_CPP_IDF)
|
||||
# include "host/ble_gap.h"
|
||||
# else
|
||||
# include "nimble/nimble/host/include/host/ble_gap.h"
|
||||
# endif
|
||||
|
||||
/**** FIX COMPILATION ****/
|
||||
#undef min
|
||||
#undef max
|
||||
# undef min
|
||||
# undef max
|
||||
/**************************/
|
||||
|
||||
#include "NimBLEUUID.h"
|
||||
#include "NimBLEAddress.h"
|
||||
# include "NimBLEUUID.h"
|
||||
# include "NimBLEAddress.h"
|
||||
# include "NimBLEAdvertisementData.h"
|
||||
|
||||
#include <functional>
|
||||
#include <vector>
|
||||
|
||||
/* COMPATIBILITY - DO NOT USE */
|
||||
#define ESP_BLE_ADV_FLAG_LIMIT_DISC (0x01 << 0)
|
||||
#define ESP_BLE_ADV_FLAG_GEN_DISC (0x01 << 1)
|
||||
#define ESP_BLE_ADV_FLAG_BREDR_NOT_SPT (0x01 << 2)
|
||||
#define ESP_BLE_ADV_FLAG_DMT_CONTROLLER_SPT (0x01 << 3)
|
||||
#define ESP_BLE_ADV_FLAG_DMT_HOST_SPT (0x01 << 4)
|
||||
#define ESP_BLE_ADV_FLAG_NON_LIMIT_DISC (0x00 )
|
||||
/* ************************* */
|
||||
# include <functional>
|
||||
# include <string>
|
||||
# include <vector>
|
||||
|
||||
class NimBLEAdvertising;
|
||||
|
||||
typedef std::function<void(NimBLEAdvertising*)> advCompleteCB_t;
|
||||
|
||||
/**
|
||||
* @brief Advertisement data set by the programmer to be published by the %BLE server.
|
||||
*/
|
||||
class NimBLEAdvertisementData {
|
||||
// Only a subset of the possible BLE architected advertisement fields are currently exposed. Others will
|
||||
// be exposed on demand/request or as time permits.
|
||||
//
|
||||
public:
|
||||
void setAppearance(uint16_t appearance);
|
||||
void setCompleteServices(const NimBLEUUID &uuid);
|
||||
void setCompleteServices16(const std::vector<NimBLEUUID> &v_uuid);
|
||||
void setCompleteServices32(const std::vector<NimBLEUUID> &v_uuid);
|
||||
void setFlags(uint8_t);
|
||||
void setManufacturerData(const std::string &data);
|
||||
void setManufacturerData(const std::vector<uint8_t> &data);
|
||||
void setURI(const std::string &uri);
|
||||
void setName(const std::string &name);
|
||||
void setPartialServices(const NimBLEUUID &uuid);
|
||||
void setPartialServices16(const std::vector<NimBLEUUID> &v_uuid);
|
||||
void setPartialServices32(const std::vector<NimBLEUUID> &v_uuid);
|
||||
void setServiceData(const NimBLEUUID &uuid, const std::string &data);
|
||||
void setShortName(const std::string &name);
|
||||
void addData(const std::string &data); // Add data to the payload.
|
||||
void addData(char * data, size_t length);
|
||||
void addTxPower();
|
||||
void setPreferredParams(uint16_t min, uint16_t max);
|
||||
std::string getPayload(); // Retrieve the current advert payload.
|
||||
void clearData(); // Clear the advertisement data.
|
||||
|
||||
private:
|
||||
friend class NimBLEAdvertising;
|
||||
void setServices(const bool complete, const uint8_t size,
|
||||
const std::vector<NimBLEUUID> &v_uuid);
|
||||
std::string m_payload; // The payload of the advertisement.
|
||||
}; // NimBLEAdvertisementData
|
||||
|
||||
|
||||
/**
|
||||
* @brief Perform and manage %BLE advertising.
|
||||
* @brief Perform and manage BLE advertising.
|
||||
*
|
||||
* A %BLE server will want to perform advertising in order to make itself known to %BLE clients.
|
||||
* A BLE server will want to perform advertising in order to make itself known to BLE clients.
|
||||
*/
|
||||
class NimBLEAdvertising {
|
||||
public:
|
||||
public:
|
||||
NimBLEAdvertising();
|
||||
void addServiceUUID(const NimBLEUUID &serviceUUID);
|
||||
void addServiceUUID(const char* serviceUUID);
|
||||
void removeServiceUUID(const NimBLEUUID &serviceUUID);
|
||||
bool start(uint32_t duration = 0, advCompleteCB_t advCompleteCB = nullptr, NimBLEAddress* dirAddr = nullptr);
|
||||
void removeServices();
|
||||
bool start(uint32_t duration = 0, const NimBLEAddress* dirAddr = nullptr);
|
||||
void setAdvertisingCompleteCallback(advCompleteCB_t callback);
|
||||
bool stop();
|
||||
void setAppearance(uint16_t appearance);
|
||||
void setName(const std::string &name);
|
||||
void setManufacturerData(const std::string &data);
|
||||
void setManufacturerData(const std::vector<uint8_t> &data);
|
||||
void setURI(const std::string &uri);
|
||||
void setServiceData(const NimBLEUUID &uuid, const std::string &data);
|
||||
void setAdvertisementType(uint8_t adv_type);
|
||||
void setMaxInterval(uint16_t maxinterval);
|
||||
void setMinInterval(uint16_t mininterval);
|
||||
void setAdvertisementData(NimBLEAdvertisementData& advertisementData);
|
||||
void setScanFilter(bool scanRequestWhitelistOnly, bool connectWhitelistOnly);
|
||||
void setScanResponseData(NimBLEAdvertisementData& advertisementData);
|
||||
void setScanResponse(bool);
|
||||
void setMinPreferred(uint16_t);
|
||||
void setMaxPreferred(uint16_t);
|
||||
void addTxPower();
|
||||
void reset();
|
||||
void advCompleteCB();
|
||||
bool setConnectableMode(uint8_t mode);
|
||||
bool setDiscoverableMode(uint8_t mode);
|
||||
bool reset();
|
||||
bool isAdvertising();
|
||||
bool setAdvertisementData(const NimBLEAdvertisementData& advertisementData);
|
||||
bool setScanResponseData(const NimBLEAdvertisementData& advertisementData);
|
||||
void setScanFilter(bool scanRequestWhitelistOnly, bool connectWhitelistOnly);
|
||||
void setScanResponse(bool enable);
|
||||
void setAdvertisingInterval(uint16_t interval);
|
||||
void setMaxInterval(uint16_t maxInterval);
|
||||
void setMinInterval(uint16_t minInterval);
|
||||
|
||||
private:
|
||||
bool addServiceUUID(const NimBLEUUID& serviceUUID);
|
||||
bool addServiceUUID(const char* serviceUUID);
|
||||
bool removeServiceUUID(const NimBLEUUID& serviceUUID);
|
||||
bool removeServiceUUID(const char* serviceUUID);
|
||||
bool removeServices();
|
||||
bool setAppearance(uint16_t appearance);
|
||||
bool setName(const std::string& name);
|
||||
bool setManufacturerData(const uint8_t* data, size_t length);
|
||||
bool setManufacturerData(const std::string& data);
|
||||
bool setManufacturerData(const std::vector<uint8_t>& data);
|
||||
bool setURI(const std::string& uri);
|
||||
bool setServiceData(const NimBLEUUID& uuid, const uint8_t* data, size_t length);
|
||||
bool setServiceData(const NimBLEUUID& uuid, const std::string& data);
|
||||
bool setServiceData(const NimBLEUUID& uuid, const std::vector<uint8_t>& data);
|
||||
bool setPreferredParams(uint16_t minInterval, uint16_t maxInterval);
|
||||
bool addTxPower();
|
||||
void clearData();
|
||||
|
||||
const NimBLEAdvertisementData& getAdvertisementData();
|
||||
const NimBLEAdvertisementData& getScanData();
|
||||
|
||||
private:
|
||||
friend class NimBLEDevice;
|
||||
friend class NimBLEServer;
|
||||
|
||||
void onHostSync();
|
||||
static int handleGapEvent(struct ble_gap_event *event, void *arg);
|
||||
void onHostSync();
|
||||
static int handleGapEvent(ble_gap_event* event, void* arg);
|
||||
|
||||
ble_hs_adv_fields m_advData;
|
||||
ble_hs_adv_fields m_scanData;
|
||||
NimBLEAdvertisementData m_advData;
|
||||
NimBLEAdvertisementData m_scanData;
|
||||
ble_gap_adv_params m_advParams;
|
||||
std::vector<NimBLEUUID> m_serviceUUIDs;
|
||||
bool m_customAdvData;
|
||||
bool m_customScanResponseData;
|
||||
bool m_scanResp;
|
||||
bool m_advDataSet;
|
||||
advCompleteCB_t m_advCompCB{nullptr};
|
||||
advCompleteCB_t m_advCompCb;
|
||||
uint8_t m_slaveItvl[4];
|
||||
uint32_t m_duration;
|
||||
std::vector<uint8_t> m_svcData16;
|
||||
std::vector<uint8_t> m_svcData32;
|
||||
std::vector<uint8_t> m_svcData128;
|
||||
std::vector<uint8_t> m_name;
|
||||
std::vector<uint8_t> m_mfgData;
|
||||
std::vector<uint8_t> m_uri;
|
||||
bool m_scanResp : 1;
|
||||
bool m_advDataSet : 1;
|
||||
};
|
||||
|
||||
#endif /* CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_BROADCASTER && !CONFIG_BT_NIMBLE_EXT_ADV */
|
||||
#endif /* MAIN_BLEADVERTISING_H_ */
|
||||
#endif /* NIMBLE_CPP_ADVERTISING_H_ */
|
||||
|
|
|
|||
Loading…
Reference in a new issue