mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2024-10-22 16:09:44 +02:00
9e5db157f8
Adds support for advertising and connections with coded/2M PHY's. Adds new classes `NimBLEExtAdvertising` and `NimBLEExtAdvertisement`. When extended advertising is enabled the original advertising classes become unavailable and the new classes must be used. Changed some return values for advertising methods for consistency with the new classes methods.
198 lines
7.1 KiB
C++
198 lines
7.1 KiB
C++
/*
|
|
* NimBLEAdvertisedDevice.h
|
|
*
|
|
* Created: on Jan 24 2020
|
|
* Author H2zero
|
|
*
|
|
* Originally:
|
|
*
|
|
* BLEAdvertisedDevice.h
|
|
*
|
|
* Created on: Jul 3, 2017
|
|
* Author: kolban
|
|
*/
|
|
|
|
#ifndef COMPONENTS_NIMBLEADVERTISEDDEVICE_H_
|
|
#define COMPONENTS_NIMBLEADVERTISEDDEVICE_H_
|
|
#include "nimconfig.h"
|
|
#if defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)
|
|
|
|
#include "NimBLEAddress.h"
|
|
#include "NimBLEScan.h"
|
|
#include "NimBLEUUID.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
|
|
|
|
#include <map>
|
|
#include <vector>
|
|
#include <time.h>
|
|
|
|
|
|
class NimBLEScan;
|
|
/**
|
|
* @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 NimBLEAdvertisedDevice {
|
|
public:
|
|
NimBLEAdvertisedDevice();
|
|
|
|
NimBLEAddress getAddress();
|
|
uint8_t getAdvType();
|
|
uint16_t getAppearance();
|
|
uint16_t getAdvInterval();
|
|
uint16_t getMinInterval();
|
|
uint16_t getMaxInterval();
|
|
std::string getManufacturerData();
|
|
std::string getURI();
|
|
|
|
/**
|
|
* @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) {
|
|
std::string data = getManufacturerData();
|
|
if(!skipSizeCheck && data.size() < sizeof(T)) return T();
|
|
const char *pData = data.data();
|
|
return *((T *)pData);
|
|
}
|
|
|
|
std::string getName();
|
|
int getRSSI();
|
|
NimBLEScan* getScan();
|
|
uint8_t getServiceDataCount();
|
|
std::string getServiceData(uint8_t index = 0);
|
|
std::string getServiceData(const NimBLEUUID &uuid);
|
|
|
|
/**
|
|
* @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) {
|
|
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 NimBLEUUID &uuid, bool skipSizeCheck = false) {
|
|
std::string data = getServiceData(uuid);
|
|
if(!skipSizeCheck && data.size() < sizeof(T)) return T();
|
|
const char *pData = data.data();
|
|
return *((T *)pData);
|
|
}
|
|
|
|
NimBLEUUID getServiceDataUUID(uint8_t index = 0);
|
|
NimBLEUUID getServiceUUID(uint8_t index = 0);
|
|
uint8_t getServiceUUIDCount();
|
|
NimBLEAddress getTargetAddress(uint8_t index = 0);
|
|
uint8_t getTargetAddressCount();
|
|
int8_t getTXPower();
|
|
uint8_t* getPayload();
|
|
uint8_t getAdvLength();
|
|
size_t getPayloadLength();
|
|
uint8_t getAddressType();
|
|
time_t getTimestamp();
|
|
bool isAdvertisingService(const NimBLEUUID &uuid);
|
|
bool haveAppearance();
|
|
bool haveManufacturerData();
|
|
bool haveName();
|
|
bool haveRSSI();
|
|
bool haveServiceData();
|
|
bool haveServiceUUID();
|
|
bool haveTXPower();
|
|
bool haveConnParams();
|
|
bool haveAdvInterval();
|
|
bool haveTargetAddress();
|
|
bool haveURI();
|
|
std::string toString();
|
|
bool isConnectable();
|
|
bool isLegacyAdvertisement();
|
|
#if CONFIG_BT_NIMBLE_EXT_ADV
|
|
uint8_t getSetId();
|
|
uint8_t getPrimaryPhy();
|
|
uint8_t getSecondaryPhy();
|
|
uint16_t getPeriodicInterval();
|
|
#endif
|
|
|
|
private:
|
|
friend class NimBLEScan;
|
|
|
|
void setAddress(NimBLEAddress address);
|
|
void setAdvType(uint8_t advType, bool isLegacyAdv);
|
|
void setPayload(const uint8_t *payload, uint8_t length, bool append);
|
|
void setRSSI(int rssi);
|
|
#if CONFIG_BT_NIMBLE_EXT_ADV
|
|
void setSetId(uint8_t sid) { m_sid = sid; }
|
|
void setPrimaryPhy(uint8_t phy) { m_primPhy = phy; }
|
|
void setSecondaryPhy(uint8_t phy) { m_secPhy = phy; }
|
|
void setPeriodicInterval(uint16_t itvl) { m_periodicItvl = itvl; }
|
|
#endif
|
|
uint8_t findAdvField(uint8_t type, uint8_t index = 0, size_t * data_loc = nullptr);
|
|
size_t findServiceData(uint8_t index, uint8_t* bytes);
|
|
|
|
NimBLEAddress m_address = NimBLEAddress("");
|
|
uint8_t m_advType;
|
|
int m_rssi;
|
|
time_t m_timestamp;
|
|
bool 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;
|
|
};
|
|
|
|
/**
|
|
* @brief A callback handler for callbacks associated device scanning.
|
|
*
|
|
* When we are performing a scan as a %BLE client, we may wish to know when a new device that is advertising
|
|
* has been found. This class can be sub-classed and registered such that when a scan is performed and
|
|
* a new advertised device has been found, we will be called back to be notified.
|
|
*/
|
|
class NimBLEAdvertisedDeviceCallbacks {
|
|
public:
|
|
virtual ~NimBLEAdvertisedDeviceCallbacks() {}
|
|
/**
|
|
* @brief Called when a new scan result is detected.
|
|
*
|
|
* As we are scanning, we will find new devices. When found, this call back is invoked with a reference to the
|
|
* device that was found. During any individual scan, a device will only be detected one time.
|
|
*/
|
|
virtual void onResult(NimBLEAdvertisedDevice* advertisedDevice) = 0;
|
|
};
|
|
|
|
#endif /* CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_OBSERVER */
|
|
#endif /* COMPONENTS_NIMBLEADVERTISEDDEVICE_H_ */
|