forked from h2zero/esp-nimble-cpp
h2zero
91210b8610
Refactor attributes to reduce code duplication and improve maintainability. * Add attribute base classes to provide common code. * Add const where possible to functions and parameters. * `NimBLECharacteristic::notify` no longer takes a `bool is_notification` parameter, instead `indicate()` should be called to send indications. * `NimBLECharacteristic::indicate` now takes the same parameters as `notify`. * `NimBLECharacteristicCallbacks` and `NimBLEDescriptorCallbacks` methods now take `const NimBLEConnInfo&` instead of non-const. * `NimBLECharacteristic::onNotify` callback removed as unnecessary, the library does not call notify without app input. * `NimBLERemoteCharacteristic::getRemoteService` now returns a `const NimBLERemoteService*` instead of non-const. * Add NimBLEUUID constructor that takes a reference to `ble_uuid_any_t`. * `NimBLERemoteService::getCharacteristics` now returns a `const std::vector<NimBLERemoteCharacteristic*>&` instead of non-const `std::vector<NimBLERemoteCharacteristic*>*` * `NimBLERemoteService::getValue` now returns `NimBLEAttValue` instead of `std::string` * `NimBLEService::getCharacteristics` now returns a `const std::vector<NimBLECharacteristic*>&` instead of a copy of std::vector<NimBLECharacteristic *>. * Remove const requirement for NimBLEConnInfo parameter in callbacks. Const is unnecessary as the data can't be changed by application code. * Change NimBLERemoteCharacteristic::getRemoteService to return const pointer.
176 lines
7.5 KiB
C++
176 lines
7.5 KiB
C++
/*
|
|
* NimBLEClient.h
|
|
*
|
|
* Created: on Jan 26 2020
|
|
* Author H2zero
|
|
*
|
|
* Originally:
|
|
* BLEClient.h
|
|
*
|
|
* Created on: Mar 22, 2017
|
|
* Author: kolban
|
|
*/
|
|
|
|
#ifndef MAIN_NIMBLECLIENT_H_
|
|
#define MAIN_NIMBLECLIENT_H_
|
|
|
|
#include "nimconfig.h"
|
|
#if defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL)
|
|
|
|
#include "NimBLEAddress.h"
|
|
#include "NimBLEUUID.h"
|
|
#include "NimBLEUtils.h"
|
|
#include "NimBLEConnInfo.h"
|
|
#include "NimBLEAttValue.h"
|
|
#include "NimBLEAdvertisedDevice.h"
|
|
|
|
#include <vector>
|
|
#include <string>
|
|
|
|
class NimBLERemoteService;
|
|
class NimBLERemoteCharacteristic;
|
|
class NimBLEAdvertisedDevice;
|
|
class NimBLEClientCallbacks;
|
|
|
|
/**
|
|
* @brief A model of a %BLE client.
|
|
*/
|
|
class NimBLEClient {
|
|
public:
|
|
bool connect(NimBLEAdvertisedDevice* device, bool deleteAttributes = true);
|
|
bool connect(const NimBLEAddress &address, bool deleteAttributes = true);
|
|
bool connect(bool deleteAttributes = true);
|
|
int disconnect(uint8_t reason = BLE_ERR_REM_USER_CONN_TERM);
|
|
NimBLEAddress getPeerAddress() const;
|
|
void setPeerAddress(const NimBLEAddress &address);
|
|
int getRssi();
|
|
std::vector<NimBLERemoteService*>* getServices(bool refresh = false);
|
|
std::vector<NimBLERemoteService*>::iterator begin();
|
|
std::vector<NimBLERemoteService*>::iterator end();
|
|
NimBLERemoteService* getService(const char* uuid);
|
|
NimBLERemoteService* getService(const NimBLEUUID &uuid);
|
|
void deleteServices();
|
|
size_t deleteService(const NimBLEUUID &uuid);
|
|
NimBLEAttValue getValue(const NimBLEUUID &serviceUUID, const NimBLEUUID &characteristicUUID);
|
|
bool setValue(const NimBLEUUID &serviceUUID, const NimBLEUUID &characteristicUUID,
|
|
const NimBLEAttValue &value, bool response = false);
|
|
NimBLERemoteCharacteristic* getCharacteristic(const uint16_t handle);
|
|
bool isConnected();
|
|
void setClientCallbacks(NimBLEClientCallbacks *pClientCallbacks,
|
|
bool deleteCallbacks = true);
|
|
std::string toString();
|
|
uint16_t getConnId() const;
|
|
void clearConnection();
|
|
bool setConnection(NimBLEConnInfo &conn_info);
|
|
bool setConnection(uint16_t conn_id);
|
|
uint16_t getMTU() const;
|
|
bool secureConnection() const;
|
|
void setConnectTimeout(uint32_t timeout);
|
|
void setConnectionParams(uint16_t minInterval, uint16_t maxInterval,
|
|
uint16_t latency, uint16_t timeout,
|
|
uint16_t scanInterval=16, uint16_t scanWindow=16);
|
|
void updateConnParams(uint16_t minInterval, uint16_t maxInterval,
|
|
uint16_t latency, uint16_t timeout);
|
|
void setDataLen(uint16_t tx_octets);
|
|
bool discoverAttributes();
|
|
NimBLEConnInfo getConnInfo();
|
|
int getLastError();
|
|
#if CONFIG_BT_NIMBLE_EXT_ADV
|
|
void setConnectPhy(uint8_t mask);
|
|
#endif
|
|
|
|
private:
|
|
NimBLEClient(const NimBLEAddress &peerAddress);
|
|
~NimBLEClient();
|
|
|
|
friend class NimBLEDevice;
|
|
friend class NimBLERemoteService;
|
|
|
|
static int handleGapEvent(struct ble_gap_event *event, void *arg);
|
|
static int serviceDiscoveredCB(uint16_t conn_handle,
|
|
const struct ble_gatt_error *error,
|
|
const struct ble_gatt_svc *service,
|
|
void *arg);
|
|
static void dcTimerCb(ble_npl_event *event);
|
|
bool retrieveServices(const NimBLEUUID *uuidFilter = nullptr);
|
|
|
|
NimBLEAddress m_peerAddress;
|
|
mutable int m_lastErr;
|
|
uint16_t m_conn_id;
|
|
bool m_connEstablished;
|
|
bool m_deleteCallbacks;
|
|
int32_t m_connectTimeout;
|
|
NimBLEClientCallbacks* m_pClientCallbacks;
|
|
mutable ble_task_data_t* m_pTaskData;
|
|
ble_npl_callout m_dcTimer;
|
|
#if CONFIG_BT_NIMBLE_EXT_ADV
|
|
uint8_t m_phyMask;
|
|
#endif
|
|
|
|
std::vector<NimBLERemoteService*> m_servicesVector;
|
|
|
|
private:
|
|
friend class NimBLEClientCallbacks;
|
|
ble_gap_conn_params m_pConnParams;
|
|
|
|
}; // class NimBLEClient
|
|
|
|
|
|
/**
|
|
* @brief Callbacks associated with a %BLE client.
|
|
*/
|
|
class NimBLEClientCallbacks {
|
|
public:
|
|
virtual ~NimBLEClientCallbacks() {};
|
|
|
|
/**
|
|
* @brief Called after client connects.
|
|
* @param [in] pClient A pointer to the calling client object.
|
|
*/
|
|
virtual void onConnect(NimBLEClient* pClient);
|
|
|
|
/**
|
|
* @brief Called when disconnected from the server.
|
|
* @param [in] pClient A pointer to the calling client object.
|
|
* @param [in] reason Contains the reason code for the disconnection.
|
|
*/
|
|
virtual void onDisconnect(NimBLEClient* pClient, int reason);
|
|
|
|
/**
|
|
* @brief Called when server requests to update the connection parameters.
|
|
* @param [in] pClient A pointer to the calling client object.
|
|
* @param [in] params A pointer to the struct containing the connection parameters requested.
|
|
* @return True to accept the parameters.
|
|
*/
|
|
virtual bool onConnParamsUpdateRequest(NimBLEClient* pClient, const ble_gap_upd_params* params);
|
|
|
|
/**
|
|
* @brief Called when server requests a passkey for pairing.
|
|
* @param [in] connInfo A reference to a NimBLEConnInfo instance containing the peer info.
|
|
*/
|
|
virtual void onPassKeyEntry(NimBLEConnInfo& connInfo);
|
|
|
|
/**
|
|
* @brief Called when the pairing procedure is complete.
|
|
* @param [in] connInfo A reference to a NimBLEConnInfo instance containing the peer info.\n
|
|
* This can be used to check the status of the connection encryption/pairing.
|
|
*/
|
|
virtual void onAuthenticationComplete(NimBLEConnInfo& connInfo);
|
|
|
|
/**
|
|
* @brief Called when using numeric comparision for pairing.
|
|
* @param [in] connInfo A reference to a NimBLEConnInfo instance containing the peer info.
|
|
* @param [in] pin The pin to compare with the server.
|
|
*/
|
|
virtual void onConfirmPIN(NimBLEConnInfo& connInfo, uint32_t pin);
|
|
|
|
/**
|
|
* @brief Called when the peer identity address is resolved.
|
|
* @param [in] connInfo A reference to a NimBLEConnInfo instance with information
|
|
*/
|
|
virtual void onIdentity(NimBLEConnInfo& connInfo);
|
|
};
|
|
|
|
#endif /* CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_CENTRAL */
|
|
#endif /* MAIN_NIMBLECLIENT_H_ */
|