ScStw/esp-nimble-cpp
2
0
Fork 0
mirror of https://github.com/h2zero/esp-nimble-cpp.git synced 2024-11-25 06:30:55 +01:00
Code Issues Projects Releases Packages Wiki Activity
esp-nimble-cpp/src/NimBLEDevice.h

196 lines
6.8 KiB
C
Raw Normal View History

Initial commit.
2020-03-30 01:44:20 +02:00
/*
* NimBLEDevice.h
*
* Created: on Jan 24 2020
* Author H2zero
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
*
Initial commit.
2020-03-30 01:44:20 +02:00
* Originally:
*
* BLEDevice.h
*
* Created on: Mar 16, 2017
* Author: kolban
*/
#ifndef MAIN_NIMBLEDEVICE_H_
#define MAIN_NIMBLEDEVICE_H_
#include "sdkconfig.h"
#if defined(CONFIG_BT_ENABLED)
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
#include "nimconfig.h"
#if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)
Fix typo's.
2020-03-31 00:12:22 +02:00
#include "NimBLEScan.h"
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
#endif
#if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)
#include "NimBLEAdvertising.h"
#endif
#if defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL)
Initial commit.
2020-03-30 01:44:20 +02:00
#include "NimBLEClient.h"
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
#endif
#if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
Initial commit.
2020-03-30 01:44:20 +02:00
#include "NimBLEServer.h"
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
#endif
#include "NimBLEUtils.h"
Initial commit.
2020-03-30 01:44:20 +02:00
#include "NimBLESecurity.h"
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
#include "NimBLEAddress.h"
Initial commit.
2020-03-30 01:44:20 +02:00
#include "esp_bt.h"
#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
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
#define BLEAdvertisementData NimBLEAdvertisementData
#define BLEDescriptor NimBLEDescriptor
#define BLE2902 NimBLE2902
#define BLE2904 NimBLE2904
#define BLEDescriptorCallbacks NimBLEDescriptorCallbacks
Initial commit.
2020-03-30 01:44:20 +02:00
#define BLEBeacon NimBLEBeacon
#define BLEEddystoneTLM NimBLEEddystoneTLM
#define BLEEddystoneURL NimBLEEddystoneURL
Merge bugfix branch into master
2020-04-14 03:13:51 +02:00
#ifdef CONFIG_BT_NIMBLE_MAX_CONNECTIONS
Initial commit.
2020-03-30 01:44:20 +02:00
#define NIMBLE_MAX_CONNECTIONS CONFIG_BT_NIMBLE_MAX_CONNECTIONS
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
#else
Merge bugfix branch into master
2020-04-14 03:13:51 +02:00
#define NIMBLE_MAX_CONNECTIONS CONFIG_NIMBLE_MAX_CONNECTIONS
#endif
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
Fix comments for doxygen (#16) * Fix comments for doxygen * Add documentation and update readme.
2020-07-09 03:27:26 +02:00
typedef int (*gap_event_handler)(ble_gap_event *event, void *arg);
Initial commit.
2020-03-30 01:44:20 +02:00
extern "C" void ble_store_config_init(void);
Fix comments for doxygen (#16) * Fix comments for doxygen * Add documentation and update readme.
2020-07-09 03:27:26 +02:00
/**
* @brief A model of a %BLE Device from which all the BLE roles are created.
*/
Initial commit.
2020-03-30 01:44:20 +02:00
class NimBLEDevice {
public:
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
static void init(const std::string &deviceName);
Add clearAll parameter to deinit() (#22) * Add clearAll parameter to deinit() Adds the ability to clear all resources consumed during BLE operation when deinitializing and shutting down BLE. Useful when BLE is used intermittently or in a task that initializes, performs operations then deinitializes. By setting the clearAll parameter to true all created BLE objects will be deleted, freeing the memory for other tasks. Warning: This will invalidate any pointers that may be referencing the deleted objects. * Add bool deleteCallbacks parameter to NimBLEServer::setCallbacks, if true (default) will delete the callback class when server is destructed. * Delete scan results when scan is destructed.
2020-07-29 04:57:33 +02:00
static void deinit(bool clearAll = false);
Initial commit.
2020-03-30 01:44:20 +02:00
static bool getInitialized();
static NimBLEAddress getAddress();
static std::string toString();
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
#if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)
static NimBLEScan* getScan();
#endif
#if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
static NimBLEServer* createServer();
Add new getServer() method. Previously we used createServer() to get a reference to the server instance. This was problematic when using advertising only as it would create a server when starting advertising. This prevents that and provides better semantics.
2020-05-14 20:59:35 +02:00
static NimBLEServer* getServer();
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
#endif
Merge bugfix branch into master
2020-04-14 03:13:51 +02:00
static void setPower(esp_power_level_t powerLevel, esp_ble_power_type_t powerType=ESP_BLE_PWR_TYPE_DEFAULT);
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
static int getPower(esp_ble_power_type_t powerType=ESP_BLE_PWR_TYPE_DEFAULT);
Initial commit.
2020-03-30 01:44:20 +02:00
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);
Add option to use resolvable and non-resolvable private address. Adds the possibility to configure a resolvable or non-resolvable address (BLE privacy).
2021-01-14 02:00:48 +01:00
static void setOwnAddrType(uint8_t own_addr_type, bool useNRPA=false);
Make NimBLEDevice::startSecurity() public.
2020-06-23 05:46:22 +02:00
static int startSecurity(uint16_t conn_id);
Initial commit.
2020-03-30 01:44:20 +02:00
static int setMTU(uint16_t mtu);
static uint16_t getMTU();
Add ==,!= operators to NimBLEAddress, pass parameters by const reference.
2020-05-10 15:21:46 +02:00
static bool isIgnored(const NimBLEAddress &address);
static void addIgnored(const NimBLEAddress &address);
static void removeIgnored(const NimBLEAddress &address);
Add controller scan filter options and refactor nimconfig.h * Add the option to change the scan filter mode through NimBLEDevice::setScanFilterMode * Add the option to change the scan filter cache size through NimBLEDevice::setScanDuplicateCacheSize * Refactor nimconfig to make it for doxygen use only.
2021-02-01 05:15:31 +01:00
static void setScanDuplicateCacheSize(uint16_t cacheSize);
static void setScanFilterMode(uint8_t type);
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
#if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)
Initial commit.
2020-03-30 01:44:20 +02:00
static NimBLEAdvertising* getAdvertising();
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
static void startAdvertising();
static void stopAdvertising();
#endif
#if defined( CONFIG_BT_NIMBLE_ROLE_CENTRAL)
Set peer address of client when creating the instance. * Adds new client connect method that will connect to the address already set. Co-authored-by: wakwak-koba <wakwak-koba@users.noreply.github.com>
2020-07-30 18:04:34 +02:00
static NimBLEClient* createClient(NimBLEAddress peerAddress = NimBLEAddress(""));
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
static bool deleteClient(NimBLEClient* pClient);
Initial commit.
2020-03-30 01:44:20 +02:00
static NimBLEClient* getClientByID(uint16_t conn_id);
Add ==,!= operators to NimBLEAddress, pass parameters by const reference.
2020-05-10 15:21:46 +02:00
static NimBLEClient* getClientByPeerAddress(const NimBLEAddress &peer_addr);
Initial commit.
2020-03-30 01:44:20 +02:00
static NimBLEClient* getDisconnectedClient();
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
static size_t getClientListSize();
static std::list<NimBLEClient*>* getClientList();
#endif
Initial commit.
2020-03-30 01:44:20 +02:00
private:
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
#if defined( CONFIG_BT_NIMBLE_ROLE_CENTRAL)
Initial commit.
2020-03-30 01:44:20 +02:00
friend class NimBLEClient;
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
#endif
#if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)
Initial commit.
2020-03-30 01:44:20 +02:00
friend class NimBLEScan;
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
#endif
#if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
friend class NimBLEServer;
Merge bugfix branch into master
2020-04-14 03:13:51 +02:00
friend class NimBLECharacteristic;
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
#endif
#if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)
friend class NimBLEAdvertising;
#endif
Initial commit.
2020-03-30 01:44:20 +02:00
static void onReset(int reason);
static void onSync(void);
static void host_task(void *param);
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
static bool m_synced;
#if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)
Initial commit.
2020-03-30 01:44:20 +02:00
static NimBLEScan* m_pScan;
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
#endif
#if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
Initial commit.
2020-03-30 01:44:20 +02:00
static NimBLEServer* m_pServer;
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
#endif
#if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)
Initial commit.
2020-03-30 01:44:20 +02:00
static NimBLEAdvertising* m_bleAdvertising;
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
#endif
#if defined( CONFIG_BT_NIMBLE_ROLE_CENTRAL)
Initial commit.
2020-03-30 01:44:20 +02:00
static std::list <NimBLEClient*> m_cList;
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
#endif
Initial commit.
2020-03-30 01:44:20 +02:00
static std::list <NimBLEAddress> m_ignoreList;
static NimBLESecurityCallbacks* m_securityCallbacks;
Conditionally compile code for specific roles. This allows NimBLE options in menuconfig to reduce code size based on the roles selected (scan/advertising/central/peripheral). Significant code space can be saved by removing unnecessary roles for the application.
2020-05-14 06:03:56 +02:00
static uint32_t m_passkey;
static ble_gap_event_listener m_listener;
Initial commit.
2020-03-30 01:44:20 +02:00
static gap_event_handler m_customGapHandler;
Add option to use resolvable and non-resolvable private address. Adds the possibility to configure a resolvable or non-resolvable address (BLE privacy).
2021-01-14 02:00:48 +01:00
static uint8_t m_own_addr_type;
Add controller scan filter options and refactor nimconfig.h * Add the option to change the scan filter mode through NimBLEDevice::setScanFilterMode * Add the option to change the scan filter cache size through NimBLEDevice::setScanDuplicateCacheSize * Refactor nimconfig to make it for doxygen use only.
2021-02-01 05:15:31 +01:00
static uint16_t m_scanDuplicateSize;
static uint8_t m_scanFilterMode;
Initial commit.
2020-03-30 01:44:20 +02:00
};
#endif // CONFIG_BT_ENABLED
#endif // MAIN_NIMBLEDEVICE_H_
Reference in a new issue Copy permalink