esp-nimble-cpp  1.3.2
NimBLEAdvertisedDevice.h
1 /*
2  * NimBLEAdvertisedDevice.h
3  *
4  * Created: on Jan 24 2020
5  * Author H2zero
6  *
7  * Originally:
8  *
9  * BLEAdvertisedDevice.h
10  *
11  * Created on: Jul 3, 2017
12  * Author: kolban
13  */
14 
15 #ifndef COMPONENTS_NIMBLEADVERTISEDDEVICE_H_
16 #define COMPONENTS_NIMBLEADVERTISEDDEVICE_H_
17 #include "nimconfig.h"
18 #if defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)
19 
20 #include "NimBLEAddress.h"
21 #include "NimBLEScan.h"
22 #include "NimBLEUUID.h"
23 
24 #if defined(CONFIG_NIMBLE_CPP_IDF)
25 #include "host/ble_hs_adv.h"
26 #else
27 #include "nimble/nimble/host/include/host/ble_hs_adv.h"
28 #endif
29 
30 #include <map>
31 #include <vector>
32 #include <time.h>
33 
34 
35 class NimBLEScan;
43 public:
45 
47  uint8_t getAdvType();
48  uint16_t getAppearance();
49  uint16_t getAdvInterval();
50  uint16_t getMinInterval();
51  uint16_t getMaxInterval();
52  std::string getManufacturerData();
53  std::string getURI();
54 
63  template<typename T>
64  T getManufacturerData(bool skipSizeCheck = false) {
65  std::string data = getManufacturerData();
66  if(!skipSizeCheck && data.size() < sizeof(T)) return T();
67  const char *pData = data.data();
68  return *((T *)pData);
69  }
70 
71  std::string getName();
72  int getRSSI();
74  size_t getServiceDataCount();
75  std::string getServiceData(uint8_t index = 0);
76  std::string getServiceData(const NimBLEUUID &uuid);
77 
87  template<typename T>
88  T getServiceData(uint8_t index = 0, bool skipSizeCheck = false) {
89  std::string data = getServiceData(index);
90  if(!skipSizeCheck && data.size() < sizeof(T)) return T();
91  const char *pData = data.data();
92  return *((T *)pData);
93  }
94 
104  template<typename T>
105  T getServiceData(const NimBLEUUID &uuid, bool skipSizeCheck = false) {
106  std::string data = getServiceData(uuid);
107  if(!skipSizeCheck && data.size() < sizeof(T)) return T();
108  const char *pData = data.data();
109  return *((T *)pData);
110  }
111 
112  NimBLEUUID getServiceDataUUID(uint8_t index = 0);
113  NimBLEUUID getServiceUUID(uint8_t index = 0);
114  size_t getServiceUUIDCount();
115  NimBLEAddress getTargetAddress(uint8_t index = 0);
116  size_t getTargetAddressCount();
117  int8_t getTXPower();
118  uint8_t* getPayload();
119  uint8_t getAdvLength();
120  size_t getPayloadLength();
121  uint8_t getAddressType();
122  time_t getTimestamp();
123  bool isAdvertisingService(const NimBLEUUID &uuid);
124  bool haveAppearance();
125  bool haveManufacturerData();
126  bool haveName();
127  bool haveRSSI();
128  bool haveServiceData();
129  bool haveServiceUUID();
130  bool haveTXPower();
131  bool haveConnParams();
132  bool haveAdvInterval();
133  bool haveTargetAddress();
134  bool haveURI();
135  std::string toString();
136 
137 private:
138  friend class NimBLEScan;
139 
140  void setAddress(NimBLEAddress address);
141  void setAdvType(uint8_t advType);
142  void setPayload(const uint8_t *payload, uint8_t length, bool append);
143  void setRSSI(int rssi);
144  uint8_t findAdvField(uint8_t type, uint8_t index = 0, uint8_t *data_loc = nullptr);
145  uint8_t findServiceData(uint8_t index, uint8_t* bytes);
146 
147  NimBLEAddress m_address = NimBLEAddress("");
148  uint8_t m_advType;
149  int m_rssi;
150  time_t m_timestamp;
151  bool m_callbackSent;
152  uint8_t m_advLength;
153 
154  std::vector<uint8_t> m_payload;
155 };
156 
165 public:
166  virtual ~NimBLEAdvertisedDeviceCallbacks() {}
173  virtual void onResult(NimBLEAdvertisedDevice* advertisedDevice) = 0;
174 };
175 
176 #endif /* CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_OBSERVER */
177 #endif /* COMPONENTS_NIMBLEADVERTISEDDEVICE_H_ */
A BLE device address.
Definition: NimBLEAddress.h:39
A callback handler for callbacks associated device scanning.
Definition: NimBLEAdvertisedDevice.h:164
virtual void onResult(NimBLEAdvertisedDevice *advertisedDevice)=0
Called when a new scan result is detected.
A representation of a BLE advertised device found by a scan.
Definition: NimBLEAdvertisedDevice.h:42
bool haveTargetAddress()
Does the advertisement contain a target address?
Definition: NimBLEAdvertisedDevice.cpp:532
time_t getTimestamp()
Get the timeStamp of when the device last advertised.
Definition: NimBLEAdvertisedDevice.cpp:771
uint16_t getAppearance()
Get the appearance.
Definition: NimBLEAdvertisedDevice.cpp:71
bool haveConnParams()
Does this advertisement have preferred connection parameters?
Definition: NimBLEAdvertisedDevice.cpp:487
uint16_t getMinInterval()
Get the preferred min connection interval.
Definition: NimBLEAdvertisedDevice.cpp:107
bool isAdvertisingService(const NimBLEUUID &uuid)
Check advertised services for existance of the required UUID.
Definition: NimBLEAdvertisedDevice.cpp:453
uint16_t getMaxInterval()
Get the preferred max connection interval.
Definition: NimBLEAdvertisedDevice.cpp:125
NimBLEUUID getServiceDataUUID(uint8_t index=0)
Get the UUID of the serice data at the index.
Definition: NimBLEAdvertisedDevice.cpp:313
NimBLEAddress getTargetAddress(uint8_t index=0)
Get the target address at the index.
Definition: NimBLEAdvertisedDevice.cpp:232
bool haveServiceUUID()
Does this advertisement have a service UUID value?
Definition: NimBLEAdvertisedDevice.cpp:570
size_t getServiceDataCount()
Get the count of advertised service data UUIDS.
Definition: NimBLEAdvertisedDevice.cpp:369
bool haveRSSI()
Does this advertisement have a signal strength value?
Definition: NimBLEAdvertisedDevice.cpp:552
size_t getServiceUUIDCount()
Get the number of services advertised.
Definition: NimBLEAdvertisedDevice.cpp:434
bool haveURI()
Does this advertisement have a URI?
Definition: NimBLEAdvertisedDevice.cpp:523
bool haveName()
Does this advertisement have a name value?
Definition: NimBLEAdvertisedDevice.cpp:542
T getServiceData(uint8_t index=0, bool skipSizeCheck=false)
A template to convert the service data to <type>.
Definition: NimBLEAdvertisedDevice.h:88
size_t getTargetAddressCount()
Get the number of target addresses.
Definition: NimBLEAdvertisedDevice.cpp:217
uint16_t getAdvInterval()
Get the advertisement interval.
Definition: NimBLEAdvertisedDevice.cpp:89
T getServiceData(const NimBLEUUID &uuid, bool skipSizeCheck=false)
A template to convert the service data to <type>.
Definition: NimBLEAdvertisedDevice.h:105
uint8_t getAdvType()
Get the advertisement type.
Definition: NimBLEAdvertisedDevice.cpp:58
NimBLEAddress getAddress()
Get the address of the advertising device.
Definition: NimBLEAdvertisedDevice.cpp:44
bool haveAdvInterval()
Does this advertisement have have the advertising interval?
Definition: NimBLEAdvertisedDevice.cpp:496
NimBLEUUID getServiceUUID(uint8_t index=0)
Get the Service UUID.
Definition: NimBLEAdvertisedDevice.cpp:385
NimBLEAdvertisedDevice()
Constructor.
Definition: NimBLEAdvertisedDevice.cpp:29
bool haveManufacturerData()
Does this advertisement have manufacturer data?
Definition: NimBLEAdvertisedDevice.cpp:514
std::string toString()
Create a string representation of this device.
Definition: NimBLEAdvertisedDevice.cpp:678
size_t getPayloadLength()
Get the length of the payload advertised by the device.
Definition: NimBLEAdvertisedDevice.cpp:780
bool haveAppearance()
Does this advertisement have an appearance value?
Definition: NimBLEAdvertisedDevice.cpp:505
int getRSSI()
Get the RSSI.
Definition: NimBLEAdvertisedDevice.cpp:199
NimBLEScan * getScan()
Get the scan object that created this advertised device.
Definition: NimBLEAdvertisedDevice.cpp:208
std::string getURI()
Get the URI from the advertisement.
Definition: NimBLEAdvertisedDevice.cpp:161
std::string getName()
Get the advertised name.
Definition: NimBLEAdvertisedDevice.cpp:179
uint8_t getAdvLength()
Get the length of the advertisement data in the payload.
Definition: NimBLEAdvertisedDevice.cpp:749
T getManufacturerData(bool skipSizeCheck=false)
A template to convert the service data to <type>.
Definition: NimBLEAdvertisedDevice.h:64
std::string getServiceData(uint8_t index=0)
Get the service data.
Definition: NimBLEAdvertisedDevice.cpp:264
bool haveTXPower()
Does this advertisement have a transmission power value?
Definition: NimBLEAdvertisedDevice.cpp:579
std::string getManufacturerData()
Get the manufacturer data.
Definition: NimBLEAdvertisedDevice.cpp:143
uint8_t * getPayload()
Get the payload advertised by the device.
Definition: NimBLEAdvertisedDevice.cpp:724
bool haveServiceData()
Does this advertisement have a service data value?
Definition: NimBLEAdvertisedDevice.cpp:561
uint8_t getAddressType()
Get the advertised device address type.
Definition: NimBLEAdvertisedDevice.cpp:762
int8_t getTXPower()
Get the TX Power.
Definition: NimBLEAdvertisedDevice.cpp:469
Perform and manage BLE scans.
Definition: NimBLEScan.h:63
A model of a BLE UUID.
Definition: NimBLEUUID.h:37