mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2024-05-20 16:01:20 +02:00
46e7bb9302
This adds a callback that is called when a device is initially discovered. It is always called wether scanning in passive or active mode. This allows for active scanning to receive device detection information in the case where the scan response is not sent/received. This callback is optional, the application may decide to implement it or not.
129 lines
4.1 KiB
C++
129 lines
4.1 KiB
C++
/*
|
|
* NimBLEScan.h
|
|
*
|
|
* Created: on Jan 24 2020
|
|
* Author H2zero
|
|
*
|
|
* Originally:
|
|
*
|
|
* BLEScan.h
|
|
*
|
|
* Created on: Jul 1, 2017
|
|
* Author: kolban
|
|
*/
|
|
#ifndef COMPONENTS_NIMBLE_SCAN_H_
|
|
#define COMPONENTS_NIMBLE_SCAN_H_
|
|
|
|
#include "nimconfig.h"
|
|
#if defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)
|
|
|
|
#include "NimBLEAdvertisedDevice.h"
|
|
#include "NimBLEUtils.h"
|
|
|
|
#if defined(CONFIG_NIMBLE_CPP_IDF)
|
|
#include "host/ble_gap.h"
|
|
#else
|
|
#include "nimble/nimble/host/include/host/ble_gap.h"
|
|
#endif
|
|
|
|
#include <vector>
|
|
|
|
class NimBLEDevice;
|
|
class NimBLEScan;
|
|
class NimBLEAdvertisedDevice;
|
|
class NimBLEScanCallbacks;
|
|
class NimBLEAddress;
|
|
|
|
/**
|
|
* @brief A class that contains and operates on the results of a BLE scan.
|
|
* @details When a scan completes, we have a set of found devices. Each device is described
|
|
* by a NimBLEAdvertisedDevice object. The number of items in the set is given by
|
|
* getCount(). We can retrieve a device by calling getDevice() passing in the
|
|
* index (starting at 0) of the desired device.
|
|
*/
|
|
class NimBLEScanResults {
|
|
public:
|
|
void dump();
|
|
int getCount();
|
|
NimBLEAdvertisedDevice getDevice(uint32_t i);
|
|
std::vector<NimBLEAdvertisedDevice*>::iterator begin();
|
|
std::vector<NimBLEAdvertisedDevice*>::iterator end();
|
|
NimBLEAdvertisedDevice *getDevice(const NimBLEAddress &address);
|
|
|
|
private:
|
|
friend NimBLEScan;
|
|
std::vector<NimBLEAdvertisedDevice*> m_advertisedDevicesVector;
|
|
};
|
|
|
|
/**
|
|
* @brief Perform and manage %BLE scans.
|
|
*
|
|
* Scanning is associated with a %BLE client that is attempting to locate BLE servers.
|
|
*/
|
|
class NimBLEScan {
|
|
public:
|
|
bool start(uint32_t duration, bool is_continue = false);
|
|
bool isScanning();
|
|
void setScanCallbacks(NimBLEScanCallbacks* pScanCallbacks, bool wantDuplicates = false);
|
|
void setActiveScan(bool active);
|
|
void setInterval(uint16_t intervalMSecs);
|
|
void setWindow(uint16_t windowMSecs);
|
|
void setDuplicateFilter(bool enabled);
|
|
void setLimitedOnly(bool enabled);
|
|
void setFilterPolicy(uint8_t filter);
|
|
void clearDuplicateCache();
|
|
bool stop();
|
|
void clearResults();
|
|
NimBLEScanResults getResults();
|
|
NimBLEScanResults getResults(uint32_t duration, bool is_continue = false);
|
|
void setMaxResults(uint8_t maxResults);
|
|
void erase(const NimBLEAddress &address);
|
|
|
|
|
|
private:
|
|
friend class NimBLEDevice;
|
|
|
|
NimBLEScan();
|
|
~NimBLEScan();
|
|
static int handleGapEvent(ble_gap_event* event, void* arg);
|
|
void onHostReset();
|
|
void onHostSync();
|
|
|
|
NimBLEScanCallbacks* m_pScanCallbacks;
|
|
ble_gap_disc_params m_scan_params;
|
|
bool m_ignoreResults;
|
|
NimBLEScanResults m_scanResults;
|
|
uint32_t m_duration;
|
|
ble_task_data_t *m_pTaskData;
|
|
uint8_t m_maxResults;
|
|
};
|
|
|
|
/**
|
|
* @brief A callback handler for callbacks associated device scanning.
|
|
*/
|
|
class NimBLEScanCallbacks {
|
|
public:
|
|
virtual ~NimBLEScanCallbacks() {}
|
|
|
|
/**
|
|
* @brief Called when a new device is discovered, before the scan result is received (if applicable).
|
|
* @param [in] advertisedDevice The device which was discovered.
|
|
*/
|
|
virtual void onDiscovered(NimBLEAdvertisedDevice* advertisedDevice) {};
|
|
|
|
/**
|
|
* @brief Called when a new scan result is complete, including scan response data (if applicable).
|
|
* @param [in] advertisedDevice The device for which the complete result is available.
|
|
*/
|
|
virtual void onResult(NimBLEAdvertisedDevice* advertisedDevice) {};
|
|
|
|
/**
|
|
* @brief Called when a scan operation ends.
|
|
* @param [in] scanResults The results of the scan that ended.
|
|
*/
|
|
virtual void onScanEnd(NimBLEScanResults scanResults) {};
|
|
};
|
|
|
|
#endif /* CONFIG_BT_ENABLED CONFIG_BT_NIMBLE_ROLE_OBSERVER */
|
|
#endif /* COMPONENTS_NIMBLE_SCAN_H_ */
|