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.
71 lines
2.6 KiB
C++
71 lines
2.6 KiB
C++
/*
|
|
* NimBLEService.h
|
|
*
|
|
* Created: on March 2, 2020
|
|
* Author H2zero
|
|
*
|
|
* Originally:
|
|
*
|
|
* BLEService.h
|
|
*
|
|
* Created on: Mar 25, 2017
|
|
* Author: kolban
|
|
*/
|
|
|
|
#ifndef NIMBLE_CPP_SERVICE_H_
|
|
#define NIMBLE_CPP_SERVICE_H_
|
|
|
|
#include "nimconfig.h"
|
|
#if defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
|
|
|
|
class NimBLEService;
|
|
|
|
# include "NimBLEAttribute.h"
|
|
# include "NimBLEServer.h"
|
|
# include "NimBLECharacteristic.h"
|
|
|
|
/**
|
|
* @brief The model of a BLE service.
|
|
*
|
|
*/
|
|
class NimBLEService : public NimBLELocalAttribute {
|
|
public:
|
|
NimBLEService(const char* uuid);
|
|
NimBLEService(const NimBLEUUID& uuid);
|
|
~NimBLEService();
|
|
|
|
NimBLEServer* getServer() const;
|
|
std::string toString() const;
|
|
void dump() const;
|
|
bool isStarted() const;
|
|
bool start();
|
|
NimBLECharacteristic* createCharacteristic(const char* uuid,
|
|
uint32_t properties = NIMBLE_PROPERTY::READ | NIMBLE_PROPERTY::WRITE,
|
|
uint16_t max_len = BLE_ATT_ATTR_MAX_LEN);
|
|
|
|
NimBLECharacteristic* createCharacteristic(const NimBLEUUID& uuid,
|
|
uint32_t properties = NIMBLE_PROPERTY::READ | NIMBLE_PROPERTY::WRITE,
|
|
uint16_t max_len = BLE_ATT_ATTR_MAX_LEN);
|
|
void addCharacteristic(NimBLECharacteristic* pCharacteristic);
|
|
void removeCharacteristic(NimBLECharacteristic* pCharacteristic, bool deleteChr = false);
|
|
NimBLECharacteristic* getCharacteristic(const char* uuid, uint16_t instanceId = 0) const;
|
|
NimBLECharacteristic* getCharacteristic(const NimBLEUUID& uuid, uint16_t instanceId = 0) const;
|
|
NimBLECharacteristic* getCharacteristicByHandle(uint16_t handle) const;
|
|
|
|
const std::vector<NimBLECharacteristic*>& getCharacteristics() const;
|
|
std::vector<NimBLECharacteristic*> getCharacteristics(const char* uuid) const;
|
|
std::vector<NimBLECharacteristic*> getCharacteristics(const NimBLEUUID& uuid) const;
|
|
|
|
private:
|
|
friend class NimBLEServer;
|
|
|
|
std::vector<NimBLECharacteristic*> m_vChars{};
|
|
// Nimble requires an array of services to be sent to the api
|
|
// Since we are adding 1 at a time we create an array of 2 and set the type
|
|
// of the second service to 0 to indicate the end of the array.
|
|
ble_gatt_svc_def m_pSvcDef[2]{};
|
|
}; // NimBLEService
|
|
|
|
#endif /* CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_PERIPHERAL */
|
|
#endif /* NIMBLE_CPP_SERVICE_H_ */
|