mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2024-11-22 13:10:55 +01:00
[BREAKING] - Refactor NimBLEAdvertising
* General code cleanup. * Added new method, `NimBLEAdvertising::setPreferredConnectionInterval` 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. * The advertisement 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.
This commit is contained in:
h2zero
parent
5f2730de02
commit
1102bb71aa
2 changed files with 490 additions and 596 deletions
File diff suppressed because it is too large
Load diff
|
|
@ -12,38 +12,30 @@
|
|||
* 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 <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;
|
||||
|
||||
|
|
@ -56,35 +48,34 @@ 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:
|
||||
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 setCompleteServices(const NimBLEUUID& uuid);
|
||||
void setCompleteServices16(const std::vector<NimBLEUUID>& uuids);
|
||||
void setCompleteServices32(const std::vector<NimBLEUUID>& uuids);
|
||||
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 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, bool isComplete = true);
|
||||
void setPartialServices(const NimBLEUUID& uuid);
|
||||
void setPartialServices16(const std::vector<NimBLEUUID>& uuids);
|
||||
void setPartialServices32(const std::vector<NimBLEUUID>& uuids);
|
||||
void setServiceData(const NimBLEUUID& uuid, const std::string& data);
|
||||
void setShortName(const std::string& name);
|
||||
void addData(const std::vector<uint8_t>& data);
|
||||
void addData(uint8_t* 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.
|
||||
void clearData();
|
||||
|
||||
private:
|
||||
std::vector<uint8_t> getPayload() const;
|
||||
|
||||
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
|
||||
|
||||
void setServices(const bool complete, const uint8_t size, const std::vector<NimBLEUUID>& v_uuid);
|
||||
std::vector<uint8_t> m_payload; // The payload of the advertisement.
|
||||
}; // NimBLEAdvertisementData
|
||||
|
||||
/**
|
||||
* @brief Perform and manage %BLE advertising.
|
||||
|
|
@ -92,40 +83,43 @@ private:
|
|||
* 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 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 removeServiceUUID(const NimBLEUUID& serviceUUID);
|
||||
bool start(uint32_t duration = 0, const NimBLEAddress* dirAddr = nullptr);
|
||||
void setAdvertisingCompleteCallback(advCompleteCB_t callback);
|
||||
void removeServices();
|
||||
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 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 setConnectableMode(uint8_t mode);
|
||||
void setDiscoverableMode(uint8_t mode);
|
||||
void setAdvertisingInterval(uint16_t interval);
|
||||
void setMaxInterval(uint16_t maxInterval);
|
||||
void setMinInterval(uint16_t minInterval);
|
||||
void setAdvertisementData(const NimBLEAdvertisementData& advertisementData);
|
||||
void setScanFilter(bool scanRequestWhitelistOnly, bool connectWhitelistOnly);
|
||||
void setScanResponseData(NimBLEAdvertisementData& advertisementData);
|
||||
void setScanResponse(bool);
|
||||
void setMinPreferred(uint16_t);
|
||||
void setMaxPreferred(uint16_t);
|
||||
void setScanResponseData(const NimBLEAdvertisementData& advertisementData);
|
||||
void setScanResponse(bool enable);
|
||||
void setPreferredConnectionInterval(uint16_t minInterval, uint16_t maxInterval);
|
||||
void setMinPreferred(uint16_t min);
|
||||
void setMaxPreferred(uint16_t max);
|
||||
void addTxPower();
|
||||
void reset();
|
||||
void advCompleteCB();
|
||||
bool reset();
|
||||
bool isAdvertising();
|
||||
|
||||
private:
|
||||
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;
|
||||
|
|
@ -135,7 +129,7 @@ private:
|
|||
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;
|
||||
|
|
@ -147,4 +141,4 @@ private:
|
|||
};
|
||||
|
||||
#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