2020-03-30 01:44:20 +02:00
|
|
|
/*
|
|
|
|
* NimBLEAdvertisedDevice.h
|
|
|
|
*
|
|
|
|
* Created: on Jan 24 2020
|
|
|
|
* Author H2zero
|
2020-05-14 06:03:56 +02:00
|
|
|
*
|
2020-03-30 01:44:20 +02:00
|
|
|
* Originally:
|
|
|
|
*
|
|
|
|
* BLEAdvertisedDevice.h
|
|
|
|
*
|
|
|
|
* Created on: Jul 3, 2017
|
|
|
|
* Author: kolban
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef COMPONENTS_NIMBLEADVERTISEDDEVICE_H_
|
|
|
|
#define COMPONENTS_NIMBLEADVERTISEDDEVICE_H_
|
|
|
|
#include "sdkconfig.h"
|
|
|
|
#if defined(CONFIG_BT_ENABLED)
|
|
|
|
|
2020-05-14 06:03:56 +02:00
|
|
|
#include "nimconfig.h"
|
|
|
|
#if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)
|
|
|
|
|
2020-03-30 01:44:20 +02:00
|
|
|
#include "NimBLEAddress.h"
|
|
|
|
#include "NimBLEScan.h"
|
|
|
|
#include "NimBLEUUID.h"
|
|
|
|
|
|
|
|
#include "host/ble_hs_adv.h"
|
|
|
|
|
|
|
|
#include <map>
|
2020-05-14 06:03:56 +02:00
|
|
|
#include <vector>
|
2020-03-30 01:44:20 +02:00
|
|
|
|
|
|
|
|
|
|
|
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();
|
2020-05-26 02:52:46 +02:00
|
|
|
uint8_t getAdvType();
|
2020-03-30 01:44:20 +02:00
|
|
|
uint16_t getAppearance();
|
|
|
|
std::string getManufacturerData();
|
2020-05-30 04:02:26 +02:00
|
|
|
|
2020-07-29 04:09:54 +02:00
|
|
|
/**
|
|
|
|
* @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>
|
|
|
|
*/
|
2020-05-30 04:02:26 +02:00
|
|
|
template<typename T>
|
2020-07-29 04:09:54 +02:00
|
|
|
T getManufacturerData(bool skipSizeCheck = false) {
|
2020-05-30 04:02:26 +02:00
|
|
|
std::string data = getManufacturerData();
|
|
|
|
if(!skipSizeCheck && data.size() < sizeof(T)) return T();
|
|
|
|
const char *pData = data.data();
|
|
|
|
return *((T *)pData);
|
|
|
|
}
|
|
|
|
|
2020-03-30 01:44:20 +02:00
|
|
|
std::string getName();
|
|
|
|
int getRSSI();
|
|
|
|
NimBLEScan* getScan();
|
2020-07-29 04:09:54 +02:00
|
|
|
size_t getServiceDataCount();
|
|
|
|
std::string getServiceData(uint8_t index = 0);
|
|
|
|
std::string getServiceData(const NimBLEUUID &uuid) const;
|
2020-05-30 04:02:26 +02:00
|
|
|
|
2020-07-29 04:09:54 +02:00
|
|
|
/**
|
|
|
|
* @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>
|
|
|
|
*/
|
2020-05-30 04:02:26 +02:00
|
|
|
template<typename T>
|
2020-07-29 04:09:54 +02:00
|
|
|
T getServiceData(const NimBLEUUID &uuid, bool skipSizeCheck = false) {
|
|
|
|
std::string data = getServiceData(uuid);
|
2020-05-30 04:02:26 +02:00
|
|
|
if(!skipSizeCheck && data.size() < sizeof(T)) return T();
|
|
|
|
const char *pData = data.data();
|
|
|
|
return *((T *)pData);
|
|
|
|
}
|
|
|
|
|
2020-07-29 04:09:54 +02:00
|
|
|
NimBLEUUID getServiceDataUUID(uint8_t index = 0);
|
|
|
|
NimBLEUUID getServiceUUID(uint8_t index = 0);
|
|
|
|
size_t getServiceUUIDCount();
|
2020-03-30 01:44:20 +02:00
|
|
|
int8_t getTXPower();
|
|
|
|
uint8_t* getPayload();
|
|
|
|
size_t getPayloadLength();
|
|
|
|
uint8_t getAddressType();
|
2020-05-30 02:26:41 +02:00
|
|
|
time_t getTimestamp();
|
|
|
|
void setAddressType(uint8_t type);
|
2020-03-30 01:44:20 +02:00
|
|
|
|
|
|
|
|
2020-07-29 04:09:54 +02:00
|
|
|
bool isAdvertisingService(const NimBLEUUID &uuid) const;
|
2020-03-30 01:44:20 +02:00
|
|
|
bool haveAppearance();
|
|
|
|
bool haveManufacturerData();
|
|
|
|
bool haveName();
|
|
|
|
bool haveRSSI();
|
|
|
|
bool haveServiceData();
|
|
|
|
bool haveServiceUUID();
|
|
|
|
bool haveTXPower();
|
|
|
|
|
|
|
|
std::string toString();
|
|
|
|
|
|
|
|
private:
|
|
|
|
friend class NimBLEScan;
|
|
|
|
|
2020-07-29 04:09:54 +02:00
|
|
|
void parseAdvertisement(uint8_t* payload, uint8_t length);
|
2020-03-30 01:44:20 +02:00
|
|
|
void setAddress(NimBLEAddress address);
|
|
|
|
void setAdvType(uint8_t advType);
|
|
|
|
void setAppearance(uint16_t appearance);
|
|
|
|
void setManufacturerData(std::string manufacturerData);
|
|
|
|
void setName(std::string name);
|
|
|
|
void setRSSI(int rssi);
|
2020-07-29 04:09:54 +02:00
|
|
|
void setServiceData(NimBLEUUID serviceUUID, std::string data);
|
2020-03-30 01:44:20 +02:00
|
|
|
void setServiceUUID(const char* serviceUUID);
|
|
|
|
void setServiceUUID(NimBLEUUID serviceUUID);
|
|
|
|
void setTXPower(int8_t txPower);
|
|
|
|
|
|
|
|
bool m_haveAppearance;
|
|
|
|
bool m_haveManufacturerData;
|
|
|
|
bool m_haveName;
|
|
|
|
bool m_haveRSSI;
|
|
|
|
bool m_haveServiceData;
|
|
|
|
bool m_haveServiceUUID;
|
|
|
|
bool m_haveTXPower;
|
|
|
|
|
|
|
|
|
2020-07-02 01:26:44 +02:00
|
|
|
NimBLEAddress m_address = NimBLEAddress("");
|
2020-03-30 01:44:20 +02:00
|
|
|
uint8_t m_advType;
|
|
|
|
uint16_t m_appearance;
|
|
|
|
std::string m_manufacturerData;
|
|
|
|
std::string m_name;
|
|
|
|
int m_rssi;
|
|
|
|
int8_t m_txPower;
|
|
|
|
uint8_t* m_payload;
|
2020-07-02 01:26:44 +02:00
|
|
|
size_t m_payloadLength;
|
2020-03-30 01:44:20 +02:00
|
|
|
uint8_t m_addressType;
|
2020-05-30 02:26:41 +02:00
|
|
|
time_t m_timestamp;
|
2020-07-02 01:26:44 +02:00
|
|
|
bool m_callbackSent;
|
2020-07-09 03:27:26 +02:00
|
|
|
|
|
|
|
std::vector<NimBLEUUID> m_serviceUUIDs;
|
2020-07-29 04:09:54 +02:00
|
|
|
std::vector<std::pair<NimBLEUUID, std::string>>m_serviceDataVec;
|
2020-03-30 01:44:20 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @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;
|
|
|
|
};
|
|
|
|
|
2020-05-14 06:03:56 +02:00
|
|
|
#endif // #if defined( CONFIG_BT_NIMBLE_ROLE_CENTRAL)
|
2020-03-30 01:44:20 +02:00
|
|
|
#endif /* CONFIG_BT_ENABLED */
|
|
|
|
#endif /* COMPONENTS_NIMBLEADVERTISEDDEVICE_H_ */
|