mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2024-12-18 09:10:47 +01:00
c4c9f7913a
* Added `NimBLEDevice::setDefaultPhy` which will set the default preferred PHY for all connections. * Added `NimBLEClient::updatePhy` to request a PHY change with a peer. * Added `NimBLEClient::getPhy` to read the current connection PHY setting. * Added `NimBLEServer::updatePhy` to request a PHY change with a peer. * Added `NimBLEServer::getPhy` to read the PHY of a peer connection. * Added callbacks: * - `NimBLEClientCallbacks::onPhyUpdate` * - `NimBLEServerCallbacks::onPhyUpdate` Which are called when the PHY update is complete.
274 lines
9 KiB
C++
274 lines
9 KiB
C++
/*
|
|
* NimBLEDevice.h
|
|
*
|
|
* Created: on Jan 24 2020
|
|
* Author H2zero
|
|
*
|
|
* Originally:
|
|
*
|
|
* BLEDevice.h
|
|
*
|
|
* Created on: Mar 16, 2017
|
|
* Author: kolban
|
|
*/
|
|
|
|
#ifndef NIMBLE_CPP_DEVICE_H_
|
|
#define NIMBLE_CPP_DEVICE_H_
|
|
|
|
#include "nimconfig.h"
|
|
#if defined(CONFIG_BT_ENABLED)
|
|
# ifdef ESP_PLATFORM
|
|
# include <esp_bt.h>
|
|
# endif
|
|
|
|
# if defined(CONFIG_NIMBLE_CPP_IDF)
|
|
# include <host/ble_gap.h>
|
|
# else
|
|
# include <nimble/nimble/host/include/host/ble_gap.h>
|
|
# endif
|
|
|
|
/**** FIX COMPILATION ****/
|
|
# undef min
|
|
# undef max
|
|
/**************************/
|
|
|
|
# include <string>
|
|
# include <vector>
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL)
|
|
# include <array>
|
|
class NimBLEClient;
|
|
# endif
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)
|
|
class NimBLEScan;
|
|
# endif
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)
|
|
# if CONFIG_BT_NIMBLE_EXT_ADV
|
|
class NimBLEExtAdvertising;
|
|
# else
|
|
class NimBLEAdvertising;
|
|
# endif
|
|
# endif
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
|
|
class NimBLEServer;
|
|
# endif
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL) || defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL)
|
|
class NimBLEConnInfo;
|
|
# endif
|
|
|
|
class NimBLEAddress;
|
|
|
|
# define BLEDevice NimBLEDevice
|
|
# define BLEClient NimBLEClient
|
|
# define BLERemoteService NimBLERemoteService
|
|
# define BLERemoteCharacteristic NimBLERemoteCharacteristic
|
|
# define BLERemoteDescriptor NimBLERemoteDescriptor
|
|
# define BLEAdvertisedDevice NimBLEAdvertisedDevice
|
|
# define BLEScan NimBLEScan
|
|
# define BLEUUID NimBLEUUID
|
|
# define BLEAddress NimBLEAddress
|
|
# define BLEUtils NimBLEUtils
|
|
# define BLEClientCallbacks NimBLEClientCallbacks
|
|
# define BLEAdvertisedDeviceCallbacks NimBLEScanCallbacks
|
|
# define BLEScanResults NimBLEScanResults
|
|
# define BLEServer NimBLEServer
|
|
# define BLEService NimBLEService
|
|
# define BLECharacteristic NimBLECharacteristic
|
|
# define BLEAdvertising NimBLEAdvertising
|
|
# define BLEServerCallbacks NimBLEServerCallbacks
|
|
# define BLECharacteristicCallbacks NimBLECharacteristicCallbacks
|
|
# define BLEAdvertisementData NimBLEAdvertisementData
|
|
# define BLEDescriptor NimBLEDescriptor
|
|
# define BLE2904 NimBLE2904
|
|
# define BLEDescriptorCallbacks NimBLEDescriptorCallbacks
|
|
# define BLEBeacon NimBLEBeacon
|
|
# define BLEEddystoneTLM NimBLEEddystoneTLM
|
|
# define BLEEddystoneURL NimBLEEddystoneURL
|
|
# define BLEConnInfo NimBLEConnInfo
|
|
|
|
# ifdef CONFIG_BT_NIMBLE_MAX_CONNECTIONS
|
|
# define NIMBLE_MAX_CONNECTIONS CONFIG_BT_NIMBLE_MAX_CONNECTIONS
|
|
# else
|
|
# define NIMBLE_MAX_CONNECTIONS CONFIG_NIMBLE_MAX_CONNECTIONS
|
|
# endif
|
|
|
|
typedef int (*gap_event_handler)(ble_gap_event* event, void* arg);
|
|
|
|
/**
|
|
* @brief A model of a BLE Device from which all the BLE roles are created.
|
|
*/
|
|
class NimBLEDevice {
|
|
public:
|
|
static bool init(const std::string& deviceName);
|
|
static bool deinit(bool clearAll = false);
|
|
static bool setDeviceName(const std::string& deviceName);
|
|
static bool isInitialized();
|
|
static NimBLEAddress getAddress();
|
|
static std::string toString();
|
|
static bool whiteListAdd(const NimBLEAddress& address);
|
|
static bool whiteListRemove(const NimBLEAddress& address);
|
|
static bool onWhiteList(const NimBLEAddress& address);
|
|
static size_t getWhiteListCount();
|
|
static NimBLEAddress getWhiteListAddress(size_t index);
|
|
static bool setPower(int8_t dbm);
|
|
static int getPower();
|
|
static bool setOwnAddrType(uint8_t type);
|
|
static bool setOwnAddr(const NimBLEAddress& addr);
|
|
static bool setOwnAddr(const uint8_t* addr);
|
|
static void setScanDuplicateCacheSize(uint16_t cacheSize);
|
|
static void setScanFilterMode(uint8_t type);
|
|
static bool setCustomGapHandler(gap_event_handler handler);
|
|
static void setSecurityAuth(bool bonding, bool mitm, bool sc);
|
|
static void setSecurityAuth(uint8_t auth);
|
|
static void setSecurityIOCap(uint8_t iocap);
|
|
static void setSecurityInitKey(uint8_t initKey);
|
|
static void setSecurityRespKey(uint8_t respKey);
|
|
static void setSecurityPasskey(uint32_t passKey);
|
|
static uint32_t getSecurityPasskey();
|
|
static bool startSecurity(uint16_t connHandle);
|
|
static bool setMTU(uint16_t mtu);
|
|
static uint16_t getMTU();
|
|
static void onReset(int reason);
|
|
static void onSync(void);
|
|
static void host_task(void* param);
|
|
|
|
# if CONFIG_BT_NIMBLE_EXT_ADV
|
|
static bool setDefaultPhy(uint8_t txPhyMask, uint8_t rxPhyMask);
|
|
# endif
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)
|
|
static NimBLEScan* getScan();
|
|
# endif
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
|
|
static NimBLEServer* createServer();
|
|
static NimBLEServer* getServer();
|
|
# endif
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL) || defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL)
|
|
static bool injectConfirmPasskey(const NimBLEConnInfo& peerInfo, bool accept);
|
|
static bool injectPassKey(const NimBLEConnInfo& peerInfo, uint32_t pin);
|
|
# endif
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)
|
|
# if CONFIG_BT_NIMBLE_EXT_ADV
|
|
static NimBLEExtAdvertising* getAdvertising();
|
|
static bool startAdvertising(uint8_t instId, int duration = 0, int maxEvents = 0);
|
|
static bool stopAdvertising(uint8_t instId);
|
|
static bool stopAdvertising();
|
|
# endif
|
|
# if !CONFIG_BT_NIMBLE_EXT_ADV || defined(_DOXYGEN_)
|
|
static NimBLEAdvertising* getAdvertising();
|
|
static bool startAdvertising(uint32_t duration = 0);
|
|
static bool stopAdvertising();
|
|
# endif
|
|
# endif
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL)
|
|
static NimBLEClient* createClient();
|
|
static NimBLEClient* createClient(const NimBLEAddress& peerAddress);
|
|
static bool deleteClient(NimBLEClient* pClient);
|
|
static NimBLEClient* getClientByHandle(uint16_t connHandle);
|
|
static NimBLEClient* getClientByPeerAddress(const NimBLEAddress& peerAddress);
|
|
static NimBLEClient* getDisconnectedClient();
|
|
static size_t getCreatedClientCount();
|
|
static std::vector<NimBLEClient*> getConnectedClients();
|
|
# endif
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL) || defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
|
|
static bool deleteBond(const NimBLEAddress& address);
|
|
static int getNumBonds();
|
|
static bool isBonded(const NimBLEAddress& address);
|
|
static bool deleteAllBonds();
|
|
static NimBLEAddress getBondedAddress(int index);
|
|
# endif
|
|
|
|
private:
|
|
static bool m_synced;
|
|
static bool m_initialized;
|
|
static uint32_t m_passkey;
|
|
static ble_gap_event_listener m_listener;
|
|
static uint8_t m_ownAddrType;
|
|
static std::vector<NimBLEAddress> m_whiteList;
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)
|
|
static NimBLEScan* m_pScan;
|
|
# endif
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
|
|
static NimBLEServer* m_pServer;
|
|
# endif
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)
|
|
# if CONFIG_BT_NIMBLE_EXT_ADV
|
|
static NimBLEExtAdvertising* m_bleAdvertising;
|
|
# else
|
|
static NimBLEAdvertising* m_bleAdvertising;
|
|
# endif
|
|
# endif
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL)
|
|
static std::array<NimBLEClient*, NIMBLE_MAX_CONNECTIONS> m_pClients;
|
|
# endif
|
|
|
|
# ifdef ESP_PLATFORM
|
|
# ifdef CONFIG_BTDM_BLE_SCAN_DUPL
|
|
static uint16_t m_scanDuplicateSize;
|
|
static uint8_t m_scanFilterMode;
|
|
# endif
|
|
# endif
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL)
|
|
friend class NimBLEClient;
|
|
# endif
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)
|
|
friend class NimBLEScan;
|
|
# endif
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
|
|
friend class NimBLEServer;
|
|
friend class NimBLECharacteristic;
|
|
# endif
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)
|
|
friend class NimBLEAdvertising;
|
|
# if CONFIG_BT_NIMBLE_EXT_ADV
|
|
friend class NimBLEExtAdvertising;
|
|
friend class NimBLEExtAdvertisement;
|
|
# endif
|
|
# endif
|
|
};
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL)
|
|
# include "NimBLEClient.h"
|
|
# include "NimBLERemoteService.h"
|
|
# include "NimBLERemoteCharacteristic.h"
|
|
# include "NimBLERemoteDescriptor.h"
|
|
# endif
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)
|
|
# include "NimBLEScan.h"
|
|
# endif
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
|
|
# include "NimBLEServer.h"
|
|
# include "NimBLEService.h"
|
|
# include "NimBLECharacteristic.h"
|
|
# include "NimBLEDescriptor.h"
|
|
# endif
|
|
|
|
# if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)
|
|
# if CONFIG_BT_NIMBLE_EXT_ADV
|
|
# include "NimBLEExtAdvertising.h"
|
|
# else
|
|
# include "NimBLEAdvertising.h"
|
|
# endif
|
|
# endif
|
|
|
|
#endif // CONFIG_BT_ENABLED
|
|
#endif // NIMBLE_CPP_DEVICE_H_
|