NimBLE-Arduino/_nim_b_l_e_device_8h_source.html

/*

 * NimBLEDevice.h

 *

 *  Created: on Jan 24 2020

 *      Author H2zero

 *

 * Originally:

 *

 * BLEDevice.h

 *

 *  Created on: Mar 16, 2017

 *      Author: kolban

 */


#ifndef MAIN_NIMBLEDEVICE_H_

#define MAIN_NIMBLEDEVICE_H_


#include "nimconfig.h"

#if defined(CONFIG_BT_ENABLED)


#if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)

#include "NimBLEScan.h"

#endif


#if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)

#  if CONFIG_BT_NIMBLE_EXT_ADV

#    include "NimBLEExtAdvertising.h"

#  else

#    include "NimBLEAdvertising.h"

#  endif

#endif


#if defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL)

#include "NimBLEClient.h"

#endif


#if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)

#include "NimBLEServer.h"

#endif


#include "NimBLEUtils.h"

#include "NimBLESecurity.h"

#include "NimBLEAddress.h"


#ifdef ESP_PLATFORM

#  include "esp_bt.h"

#endif


#include <map>

#include <string>

#include <list>


#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 BLESecurity                     NimBLESecurity

#define BLESecurityCallbacks            NimBLESecurityCallbacks

#define BLEAddress                      NimBLEAddress

#define BLEUtils                        NimBLEUtils

#define BLEClientCallbacks              NimBLEClientCallbacks

#define BLEAdvertisedDeviceCallbacks    NimBLEAdvertisedDeviceCallbacks

#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 BLE2902                         NimBLE2902

#define BLE2904                         NimBLE2904

#define BLEDescriptorCallbacks          NimBLEDescriptorCallbacks

#define BLEBeacon                       NimBLEBeacon

#define BLEEddystoneTLM                 NimBLEEddystoneTLM

#define BLEEddystoneURL                 NimBLEEddystoneURL


#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);


extern "C" void ble_store_config_init(void);


class NimBLEDevice {

public:

    static void             init(const std::string &deviceName);

    static void             deinit(bool clearAll = false);

    static void             setDeviceName(const std::string &deviceName);

    static bool             getInitialized();

    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);


#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


#ifdef ESP_PLATFORM

    static void             setPower(esp_power_level_t powerLevel, esp_ble_power_type_t powerType=ESP_BLE_PWR_TYPE_DEFAULT);

    static int              getPower(esp_ble_power_type_t powerType=ESP_BLE_PWR_TYPE_DEFAULT);

    static void             setOwnAddrType(uint8_t own_addr_type, bool useNRPA=false);

    static void             setScanDuplicateCacheSize(uint16_t cacheSize);

    static void             setScanFilterMode(uint8_t type);

#else

    static void             setPower(int dbm);

    static int              getPower();

#endif


    static void             setCustomGapHandler(gap_event_handler handler);

    static void             setSecurityAuth(bool bonding, bool mitm, bool sc);

    static void             setSecurityAuth(uint8_t auth_req);

    static void             setSecurityIOCap(uint8_t iocap);

    static void             setSecurityInitKey(uint8_t init_key);

    static void             setSecurityRespKey(uint8_t init_key);

    static void             setSecurityPasskey(uint32_t pin);

    static uint32_t         getSecurityPasskey();

    static void             setSecurityCallbacks(NimBLESecurityCallbacks* pCallbacks);

    static int              startSecurity(uint16_t conn_id);

    static int              setMTU(uint16_t mtu);

    static uint16_t         getMTU();

    static bool             isIgnored(const NimBLEAddress &address);

    static void             addIgnored(const NimBLEAddress &address);

    static void             removeIgnored(const NimBLEAddress &address);


#if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)

#  if CONFIG_BT_NIMBLE_EXT_ADV

    static NimBLEExtAdvertising* getAdvertising();

    static bool                  startAdvertising(uint8_t inst_id,

                                                  int duration = 0,

                                                  int max_events = 0);

    static bool                  stopAdvertising(uint8_t inst_id);

    static bool                  stopAdvertising();

#  endif

#  if !CONFIG_BT_NIMBLE_EXT_ADV || defined(_DOXYGEN_)

    static NimBLEAdvertising*    getAdvertising();

    static bool                  startAdvertising();

    static bool                  stopAdvertising();

#  endif

#endif


#if defined( CONFIG_BT_NIMBLE_ROLE_CENTRAL)

    static NimBLEClient*    createClient(NimBLEAddress peerAddress = NimBLEAddress(""));

    static bool             deleteClient(NimBLEClient* pClient);

    static NimBLEClient*    getClientByID(uint16_t conn_id);

    static NimBLEClient*    getClientByPeerAddress(const NimBLEAddress &peer_addr);

    static NimBLEClient*    getDisconnectedClient();

    static size_t           getClientListSize();

    static std::list<NimBLEClient*>* getClientList();

#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 void             deleteAllBonds();

    static NimBLEAddress    getBondedAddress(int index);

#endif


private:

#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


    static void        onReset(int reason);

    static void        onSync(void);

    static void        host_task(void *param);

    static bool        m_synced;


#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::list <NimBLEClient*>  m_cList;

#endif

    static std::list <NimBLEAddress>  m_ignoreList;

    static NimBLESecurityCallbacks*   m_securityCallbacks;

    static uint32_t                   m_passkey;

    static ble_gap_event_listener     m_listener;

    static gap_event_handler          m_customGapHandler;

    static uint8_t                    m_own_addr_type;

#ifdef ESP_PLATFORM

    static uint16_t                   m_scanDuplicateSize;

    static uint8_t                    m_scanFilterMode;

#endif

    static std::vector<NimBLEAddress> m_whiteList;

};


#endif // CONFIG_BT_ENABLED

#endif // MAIN_NIMBLEDEVICE_H_

NimBLEAddress
A BLE device address.
Definition: NimBLEAddress.h:39

NimBLEAdvertising
Perform and manage BLE advertising.
Definition: NimBLEAdvertising.h:94

NimBLECharacteristic
The model of a BLE Characteristic.
Definition: NimBLECharacteristic.h:63

NimBLEClient
A model of a BLE client.
Definition: NimBLEClient.h:39

NimBLEDevice
A model of a BLE Device from which all the BLE roles are created.
Definition: NimBLEDevice.h:96

NimBLEDevice::removeIgnored
static void removeIgnored(const NimBLEAddress &address)
Remove a device from the ignore list.
Definition: NimBLEDevice.cpp:1188

NimBLEDevice::getDisconnectedClient
static NimBLEClient * getDisconnectedClient()
Finds the first disconnected client in the list.
Definition: NimBLEDevice.cpp:333

NimBLEDevice::isIgnored
static bool isIgnored(const NimBLEAddress &address)
Check if the device address is on our ignore list.
Definition: NimBLEDevice.cpp:1162

NimBLEDevice::isBonded
static bool isBonded(const NimBLEAddress &address)
Checks if a peer device is bonded.
Definition: NimBLEDevice.cpp:596

NimBLEDevice::getClientList
static std::list< NimBLEClient * > * getClientList()
Get the list of created client objects.
Definition: NimBLEDevice.cpp:280

NimBLEDevice::deleteBond
static bool deleteBond(const NimBLEAddress &address)
Deletes a peer bond.
Definition: NimBLEDevice.cpp:576

NimBLEDevice::startSecurity
static int startSecurity(uint16_t conn_id)
Start the connection securing and authorization for this connection.
Definition: NimBLEDevice.cpp:1146

NimBLEDevice::stopAdvertising
static bool stopAdvertising()
Convenience function to stop all advertising.
Definition: NimBLEDevice.cpp:185

NimBLEDevice::getServer
static NimBLEServer * getServer()
Get the instance of the server.
Definition: NimBLEDevice.cpp:114

NimBLEDevice::getWhiteListAddress
static NimBLEAddress getWhiteListAddress(size_t index)
Gets the address at the vector index.
Definition: NimBLEDevice.cpp:746

NimBLEDevice::createServer
static NimBLEServer * createServer()
Create a new instance of a server.
Definition: NimBLEDevice.cpp:98

NimBLEDevice::getMTU
static uint16_t getMTU()
Get local MTU value set.
Definition: NimBLEDevice.cpp:490

NimBLEDevice::setSecurityRespKey
static void setSecurityRespKey(uint8_t init_key)
Set the keys we are willing to accept during pairing.
Definition: NimBLEDevice.cpp:1067

NimBLEDevice::init
static void init(const std::string &deviceName)
Initialize the BLE environment.
Definition: NimBLEDevice.cpp:848

NimBLEDevice::addIgnored
static void addIgnored(const NimBLEAddress &address)
Add a device to the ignore list.
Definition: NimBLEDevice.cpp:1178

NimBLEDevice::getAddress
static NimBLEAddress getAddress()
Get our device address.
Definition: NimBLEDevice.cpp:442

NimBLEDevice::setSecurityCallbacks
static void setSecurityCallbacks(NimBLESecurityCallbacks *pCallbacks)
Set callbacks that will be used to handle encryption negotiation events and authentication events.
Definition: NimBLEDevice.cpp:1098

NimBLEDevice::setMTU
static int setMTU(uint16_t mtu)
Setup local mtu that will be used to negotiate mtu during request from client peer.
Definition: NimBLEDevice.cpp:471

NimBLEDevice::getNumBonds
static int getNumBonds()
Gets the number of bonded peers stored.
Definition: NimBLEDevice.cpp:548

NimBLEDevice::whiteListRemove
static bool whiteListRemove(const NimBLEAddress &address)
Remove a peer address from the whitelist.
Definition: NimBLEDevice.cpp:695

NimBLEDevice::deleteClient
static bool deleteClient(NimBLEClient *pClient)
Delete the client object and remove it from the list. Checks if it is connected or trying to connect ...
Definition: NimBLEDevice.cpp:235

NimBLEDevice::setSecurityPasskey
static void setSecurityPasskey(uint32_t pin)
Set the passkey the server will ask for when pairing.
Definition: NimBLEDevice.cpp:1077

NimBLEDevice::setCustomGapHandler
static void setCustomGapHandler(gap_event_handler handler)
Set a custom callback for gap events.
Definition: NimBLEDevice.cpp:1203

NimBLEDevice::setSecurityInitKey
static void setSecurityInitKey(uint8_t init_key)
If we are the initiator of the security procedure this sets the keys we will distribute.
Definition: NimBLEDevice.cpp:1052

NimBLEDevice::getSecurityPasskey
static uint32_t getSecurityPasskey()
Get the current passkey used for pairing.
Definition: NimBLEDevice.cpp:1087

NimBLEDevice::setSecurityAuth
static void setSecurityAuth(bool bonding, bool mitm, bool sc)
Set the authorization mode for this device.
Definition: NimBLEDevice.cpp:1002

NimBLEDevice::getAdvertising
static NimBLEExtAdvertising * getAdvertising()
Get the instance of the advertising object.
Definition: NimBLEDevice.cpp:126

NimBLEDevice::whiteListAdd
static bool whiteListAdd(const NimBLEAddress &address)
Add a peer address to the whitelist.
Definition: NimBLEDevice.cpp:662

NimBLEDevice::getWhiteListCount
static size_t getWhiteListCount()
Gets the count of addresses in the whitelist.
Definition: NimBLEDevice.cpp:735

NimBLEDevice::deleteAllBonds
static void deleteAllBonds()
Deletes all bonding information.
Definition: NimBLEDevice.cpp:565

NimBLEDevice::setSecurityIOCap
static void setSecurityIOCap(uint8_t iocap)
Set the Input/Output capabilities of this device.
Definition: NimBLEDevice.cpp:1037

NimBLEDevice::getClientListSize
static size_t getClientListSize()
Get the number of created client objects.
Definition: NimBLEDevice.cpp:290

NimBLEDevice::toString
static std::string toString()
Return a string representation of the address of this device.
Definition: NimBLEDevice.cpp:460

NimBLEDevice::getClientByPeerAddress
static NimBLEClient * getClientByPeerAddress(const NimBLEAddress &peer_addr)
Get a reference to a client by peer address.
Definition: NimBLEDevice.cpp:318

NimBLEDevice::getClientByID
static NimBLEClient * getClientByID(uint16_t conn_id)
Get a reference to a client by connection ID.
Definition: NimBLEDevice.cpp:301

NimBLEDevice::getBondedAddress
static NimBLEAddress getBondedAddress(int index)
Get the address of a bonded peer device by index.
Definition: NimBLEDevice.cpp:622

NimBLEDevice::startAdvertising
static bool startAdvertising()
Convenience function to begin advertising.
Definition: NimBLEDevice.cpp:176

NimBLEDevice::getInitialized
static bool getInitialized()
Check if the initialization is complete.
Definition: NimBLEDevice.cpp:990

NimBLEDevice::setDeviceName
static void setDeviceName(const std::string &deviceName)
Set the BLEDevice's name.
Definition: NimBLEDevice.cpp:980

NimBLEDevice::onWhiteList
static bool onWhiteList(const NimBLEAddress &address)
Checks if a peer device is whitelisted.
Definition: NimBLEDevice.cpp:645

NimBLEDevice::deinit
static void deinit(bool clearAll=false)
Shutdown the NimBLE stack/controller.
Definition: NimBLEDevice.cpp:924

NimBLEDevice::createClient
static NimBLEClient * createClient(NimBLEAddress peerAddress=NimBLEAddress(""))
Creates a new client object and maintains a list of all client objects each client can connect to 1 p...
Definition: NimBLEDevice.cpp:216

NimBLEDevice::getScan
static NimBLEScan * getScan()
Retrieve the Scan object that we use for scanning.
Definition: NimBLEDevice.cpp:198

NimBLEExtAdvertisement
Extended advertisement data.
Definition: NimBLEExtAdvertising.h:37

NimBLEExtAdvertising
Extended advertising class.
Definition: NimBLEExtAdvertising.h:92

NimBLEScan
Perform and manage BLE scans.
Definition: NimBLEScan.h:63

NimBLESecurityCallbacks
Callbacks to handle GAP events related to authorization. Deprecated - provided for backward compatibi...
Definition: NimBLESecurity.h:94

NimBLEServer
The model of a BLE server.
Definition: NimBLEServer.h:46