mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2025-02-23 22:48:54 +01:00
3cb9adb61a
* Added new method `NimBLEScan::setScanPhy` to enable/disable the PHY's to scan on. * Added new method `NimBLEScan::setScanPeriod` which will allow for setting a scan restart timer in the controller. * Updated `NimBLEScan::start` to allow the command to be sent with updated parameters if already scanning. * Added extended scan example. * Removed storing and restarting of the scan on host reset as it is more appropriate to call the scanEnded callback instead.
136 lines
4.4 KiB
C++
136 lines
4.4 KiB
C++
/*
|
|
* NimBLEScan.h
|
|
*
|
|
* Created: on Jan 24 2020
|
|
* Author H2zero
|
|
*
|
|
* Originally:
|
|
*
|
|
* BLEScan.h
|
|
*
|
|
* Created on: Jul 1, 2017
|
|
* Author: kolban
|
|
*/
|
|
#ifndef NIMBLE_CPP_SCAN_H_
|
|
#define NIMBLE_CPP_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() const;
|
|
int getCount() const;
|
|
const NimBLEAdvertisedDevice* getDevice(uint32_t idx) const;
|
|
const NimBLEAdvertisedDevice* getDevice(const NimBLEAddress& address) const;
|
|
std::vector<NimBLEAdvertisedDevice*>::const_iterator begin() const;
|
|
std::vector<NimBLEAdvertisedDevice*>::const_iterator end() const;
|
|
|
|
private:
|
|
friend NimBLEScan;
|
|
std::vector<NimBLEAdvertisedDevice*> m_deviceVec;
|
|
};
|
|
|
|
/**
|
|
* @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 isContinue = false, bool restart = true);
|
|
bool isScanning();
|
|
void setScanCallbacks(NimBLEScanCallbacks* pScanCallbacks, bool wantDuplicates = false);
|
|
void setActiveScan(bool active);
|
|
void setInterval(uint16_t intervalMs);
|
|
void setWindow(uint16_t windowMs);
|
|
void setDuplicateFilter(uint8_t enabled);
|
|
void setLimitedOnly(bool enabled);
|
|
void setFilterPolicy(uint8_t filter);
|
|
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);
|
|
void erase(const NimBLEAdvertisedDevice* device);
|
|
|
|
# if CONFIG_BT_NIMBLE_EXT_ADV
|
|
enum Phy { SCAN_1M = 0x01, SCAN_CODED = 0x02, SCAN_ALL = 0x03 };
|
|
void setPhy(Phy phyMask);
|
|
void setPeriod(uint32_t periodMs);
|
|
# endif
|
|
|
|
private:
|
|
friend class NimBLEDevice;
|
|
|
|
NimBLEScan();
|
|
~NimBLEScan();
|
|
static int handleGapEvent(ble_gap_event* event, void* arg);
|
|
void onHostSync();
|
|
|
|
NimBLEScanCallbacks* m_pScanCallbacks;
|
|
ble_gap_disc_params m_scanParams;
|
|
NimBLEScanResults m_scanResults;
|
|
NimBLETaskData* m_pTaskData;
|
|
uint8_t m_maxResults;
|
|
|
|
# if CONFIG_BT_NIMBLE_EXT_ADV
|
|
uint8_t m_phy{SCAN_ALL};
|
|
uint16_t m_period{0};
|
|
# endif
|
|
};
|
|
|
|
/**
|
|
* @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(const 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(const NimBLEAdvertisedDevice* advertisedDevice);
|
|
|
|
/**
|
|
* @brief Called when a scan operation ends.
|
|
* @param [in] scanResults The results of the scan that ended.
|
|
* @param [in] reason The reason code for why the scan ended.
|
|
*/
|
|
virtual void onScanEnd(const NimBLEScanResults& scanResults, int reason);
|
|
};
|
|
|
|
#endif // CONFIG_BT_ENABLED CONFIG_BT_NIMBLE_ROLE_OBSERVER
|
|
#endif // NIMBLE_CPP_SCAN_H_
|