ScStw/esp-nimble-cpp
2
0
Fork 0
mirror of https://github.com/h2zero/esp-nimble-cpp.git synced 2024-12-22 19:10:46 +01:00
Code Issues Projects Releases Packages Wiki Activity
esp-nimble-cpp/src/NimBLEDevice.h

293 lines
10 KiB
C
Raw Normal View History

Initial commit.
2020-03-30 01:44:20 +02:00
/*
Update license
2024-12-13 03:21:03 +01:00
* Copyright 2020-2024 Ryan Powell <ryan@nable-embedded.io> and
* esp-nimble-cpp, NimBLE-Arduino contributors.
Initial commit.
2020-03-30 01:44:20 +02:00
*
Update license
2024-12-13 03:21:03 +01:00
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
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
*
Update license
2024-12-13 03:21:03 +01:00
* http://www.apache.org/licenses/LICENSE-2.0
Initial commit.
2020-03-30 01:44:20 +02:00
*
Update license
2024-12-13 03:21:03 +01:00
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
Initial commit.
2020-03-30 01:44:20 +02:00
*/
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
#ifndef NIMBLE_CPP_DEVICE_H_
#define NIMBLE_CPP_DEVICE_H_
Initial commit.
2020-03-30 01:44:20 +02:00
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"
Refactor include directives to use different paths for arduino/idf. * Sets macros to allow compiling when Central role is enabled and Observer disabled, or Peripheral enabled and Broadcaster disabled. * Adds a macro definition for CONFIG_NIMBLE_CPP_IDF to enable different include paths/functionality for IDF / Arduino.
2021-09-07 05:14:43 +02:00
#if defined(CONFIG_BT_ENABLED)
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
# ifdef ESP_PLATFORM
Fix compilation with esp32p4 (#253)
2024-12-03 16:47:41 +01:00
# ifndef CONFIG_IDF_TARGET_ESP32P4
# include <esp_bt.h>
# endif
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
# 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
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
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
# if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)
class NimBLEScan;
# 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
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
# if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)
Add extended advertising support. (#72) Adds support for advertising and connections with coded/2M PHY's. Adds new classes `NimBLEExtAdvertising` and `NimBLEExtAdvertisement`. When extended advertising is enabled the original advertising classes become unavailable and the new classes must be used. Changed some return values for advertising methods for consistency with the new classes methods.
2022-04-10 18:21:45 +02:00
# if CONFIG_BT_NIMBLE_EXT_ADV
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
class NimBLEExtAdvertising;
Add extended advertising support. (#72) Adds support for advertising and connections with coded/2M PHY's. Adds new classes `NimBLEExtAdvertising` and `NimBLEExtAdvertisement`. When extended advertising is enabled the original advertising classes become unavailable and the new classes must be used. Changed some return values for advertising methods for consistency with the new classes methods.
2022-04-10 18:21:45 +02:00
# else
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
class NimBLEAdvertising;
Add extended advertising support. (#72) Adds support for advertising and connections with coded/2M PHY's. Adds new classes `NimBLEExtAdvertising` and `NimBLEExtAdvertisement`. When extended advertising is enabled the original advertising classes become unavailable and the new classes must be used. Changed some return values for advertising methods for consistency with the new classes methods.
2022-04-10 18:21:45 +02:00
# endif
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
# 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);
Initial commit.
2020-03-30 01:44:20 +02:00
Fix comments for doxygen (#16) * Fix comments for doxygen * Add documentation and update readme.
2020-07-09 03:27:26 +02:00
/**
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
* @brief A model of a BLE Device from which all the BLE roles are created.
Fix comments for doxygen (#16) * Fix comments for doxygen * Add documentation and update readme.
2020-07-09 03:27:26 +02:00
*/
Initial commit.
2020-03-30 01:44:20 +02:00
class NimBLEDevice {
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
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 setOwnAddrType(uint8_t type);
Add NimBLEDevice::setOwnAddr and NimBLEUtils::generateAddr functions. Adds a utility to generate random BLE addresses and set the address used.
2024-11-03 00:56:23 +01:00
static bool setOwnAddr(const NimBLEAddress& addr);
static bool setOwnAddr(const uint8_t* addr);
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
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();
Add asynchronous client connection secure * Adds parameter `rcPtr` to `NimBLEDevice::startSecurity`, default value works as the original method. * * `rcPtr`: if not nullptr, will allow caller to obtain the internal return code. * Adds parameter `async` to `NimBLEClient::secureConnection`, default value works as the original method. * * `async`; if true, will send the secure command and return immediately with a true value for successfully sending the command, else false.
2024-11-18 20:02:18 +01:00
static bool startSecurity(uint16_t connHandle, int* rcPtr = nullptr);
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
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);
NimBLEDevice::get/setPower support full power range. (#229) * Calculates the tx power level to and from dbm to `esp_power_level` types for esp32 devices. * Add esp32 specific funtions `NimBLEDevice::setPowerLevel` and `NimBLEDevice::getPowerLevel` which take and return the related `esp_power_level* ` types. --------- Co-authored-by: h2zero <powell.rg@gmail.com>
2024-12-02 23:19:44 +01:00
static int getPower();
static bool setPower(int8_t dbm);
Fix compilation with esp32p4 (#253)
2024-12-03 16:47:41 +01:00
# ifdef ESP_PLATFORM
# ifndef CONFIG_IDF_TARGET_ESP32P4
NimBLEDevice::get/setPower support full power range. (#229) * Calculates the tx power level to and from dbm to `esp_power_level` types for esp32 devices. * Add esp32 specific funtions `NimBLEDevice::setPowerLevel` and `NimBLEDevice::getPowerLevel` which take and return the related `esp_power_level* ` types. --------- Co-authored-by: h2zero <powell.rg@gmail.com>
2024-12-02 23:19:44 +01:00
static esp_power_level_t getPowerLevel(esp_ble_power_type_t powerType = ESP_BLE_PWR_TYPE_DEFAULT);
static bool setPowerLevel(esp_power_level_t powerLevel, esp_ble_power_type_t powerType = ESP_BLE_PWR_TYPE_DEFAULT);
Fix compilation with esp32p4 (#253)
2024-12-03 16:47:41 +01:00
# endif
NimBLEDevice::get/setPower support full power range. (#229) * Calculates the tx power level to and from dbm to `esp_power_level` types for esp32 devices. * Add esp32 specific funtions `NimBLEDevice::setPowerLevel` and `NimBLEDevice::getPowerLevel` which take and return the related `esp_power_level* ` types. --------- Co-authored-by: h2zero <powell.rg@gmail.com>
2024-12-02 23:19:44 +01:00
# endif
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
Add methods to set/get connection PHY's. * 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.
2024-11-28 20:50:24 +01:00
# if CONFIG_BT_NIMBLE_EXT_ADV
static bool setDefaultPhy(uint8_t txPhyMask, uint8_t rxPhyMask);
# endif
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
# 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)
Add extended advertising support. (#72) Adds support for advertising and connections with coded/2M PHY's. Adds new classes `NimBLEExtAdvertising` and `NimBLEExtAdvertisement`. When extended advertising is enabled the original advertising classes become unavailable and the new classes must be used. Changed some return values for advertising methods for consistency with the new classes methods.
2022-04-10 18:21:45 +02:00
# if CONFIG_BT_NIMBLE_EXT_ADV
static NimBLEExtAdvertising* getAdvertising();
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
static bool startAdvertising(uint8_t instId, int duration = 0, int maxEvents = 0);
static bool stopAdvertising(uint8_t instId);
Add extended advertising support. (#72) Adds support for advertising and connections with coded/2M PHY's. Adds new classes `NimBLEExtAdvertising` and `NimBLEExtAdvertisement`. When extended advertising is enabled the original advertising classes become unavailable and the new classes must be used. Changed some return values for advertising methods for consistency with the new classes methods.
2022-04-10 18:21:45 +02:00
static bool stopAdvertising();
Add docs build.
2022-08-27 20:38:53 +02:00
# endif
# if !CONFIG_BT_NIMBLE_EXT_ADV || defined(_DOXYGEN_)
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
static NimBLEAdvertising* getAdvertising();
static bool startAdvertising(uint32_t duration = 0);
static bool stopAdvertising();
Add extended advertising support. (#72) Adds support for advertising and connections with coded/2M PHY's. Adds new classes `NimBLEExtAdvertising` and `NimBLEExtAdvertisement`. When extended advertising is enabled the original advertising classes become unavailable and the new classes must be used. Changed some return values for advertising methods for consistency with the new classes methods.
2022-04-10 18:21:45 +02:00
# endif
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
# endif
# if defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL)
Add asyncronous client connect and MTU exchange. * Adds parameters `asyncConnect` and `exchangeMTU` to `NimBLEClient::connect`, default values work as the original connect method. * * `asyncConnect`; if true, will send the connect command and return immediately with a true value for successfully sending the command, else false. * * `exchangeMTU`; if true will send the exchange MTU command upon connection, otherwise not and the application can choose to do this later via the `exchangeMTU` method. * Adds `onMTUChange` callback to `NimBLEClientCallbacks` * Add `NimBLEDevice::getConnectedClients()` which returns a vector of pointers to the currently connected client instances. * Calling `NimBLEClient::connect` will no longer cancel already in progress connections.
2024-10-29 20:50:12 +01:00
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();
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
# 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)
Initial commit.
2020-03-30 01:44:20 +02:00
friend class NimBLEClient;
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
# 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
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
# if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)
Initial commit.
2020-03-30 01:44:20 +02:00
friend class NimBLEScan;
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
# 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
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
# if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
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
friend class NimBLEServer;
Merge bugfix branch into master
2020-04-14 03:13:51 +02:00
friend class NimBLECharacteristic;
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
# 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
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
# if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)
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
friend class NimBLEAdvertising;
Add extended advertising support. (#72) Adds support for advertising and connections with coded/2M PHY's. Adds new classes `NimBLEExtAdvertising` and `NimBLEExtAdvertisement`. When extended advertising is enabled the original advertising classes become unavailable and the new classes must be used. Changed some return values for advertising methods for consistency with the new classes methods.
2022-04-10 18:21:45 +02:00
# if CONFIG_BT_NIMBLE_EXT_ADV
friend class NimBLEExtAdvertising;
friend class NimBLEExtAdvertisement;
# endif
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
# 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
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
# 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)
Add extended advertising support. (#72) Adds support for advertising and connections with coded/2M PHY's. Adds new classes `NimBLEExtAdvertising` and `NimBLEExtAdvertisement`. When extended advertising is enabled the original advertising classes become unavailable and the new classes must be used. Changed some return values for advertising methods for consistency with the new classes methods.
2022-04-10 18:21:45 +02:00
# if CONFIG_BT_NIMBLE_EXT_ADV
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
# include "NimBLEExtAdvertising.h"
Add extended advertising support. (#72) Adds support for advertising and connections with coded/2M PHY's. Adds new classes `NimBLEExtAdvertising` and `NimBLEExtAdvertisement`. When extended advertising is enabled the original advertising classes become unavailable and the new classes must be used. Changed some return values for advertising methods for consistency with the new classes methods.
2022-04-10 18:21:45 +02:00
# else
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
# include "NimBLEAdvertising.h"
Fix compilation when CONFIG_BTDM_BLE_SCAN_DUPL is not enabled. * fix warning: variable 'pkey' set but not used [-Wunused-but-set-variable] --------- Co-authored-by: Franz Höpfinger <f.hoepfinger@hr-agrartechnik.de>
2023-05-29 17:08:14 +02:00
# endif
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
# endif
Initial commit.
2020-03-30 01:44:20 +02:00
Add missing NimBLEUtils and NimBLEConnInfo includes to NimBLEDevice.h In some cases compilation of examples would fail due to missing these headers so they should be included in NimBLEDevice.h
2024-12-15 18:38:11 +01:00
# if defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL) || defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
# include "NimBLEConnInfo.h"
# endif
# include "NimBLEUtils.h"
Initial commit.
2020-03-30 01:44:20 +02:00
#endif // CONFIG_BT_ENABLED
[BREAKING] Refactor NimBLEDevice * General code cleanup * `NimBLEDevice::getInitialized` renamed to `NimBLEDevice::isInitialized`. * `NimBLEDevice::setPower` no longer takes the `esp_power_level_t` and `esp_ble_power_type_t`, instead only an integer value in dbm units is accepted. * `NimBLEDevice::setPower` now returns a bool value, true = success. * `NimBLEDevice::setMTU` now returns a bool value, true = success. * `NimBLEDevice::injectConfirmPIN` renamed to `NimBLEDevice::injectConfirmPasskey` to use Bluetooth naming. * Fixes crash if `NimBLEDevice::deinit` is called when the stack has not been initialized. * Reverts 73f0277 as it would cause a crash when the NimBLEServer instance has a connection. * `NimBLEDevice::getAddress` will now return the address currently in use. * `NimBLEDevice::init` now returns a bool with `true` indicating success. * `NimBLEDevice::deinit` now returns a bool with `true` inidicating success. * `NimBLEDevice::setDeviceName` now returns a bool with `true` indicating success. * `NimBLEDevice::setCustomGapHandler` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` now returns a bool with `true` indicating success. * `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices. * `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter.
2024-09-29 23:59:42 +02:00
#endif // NIMBLE_CPP_DEVICE_H_
Reference in a new issue Copy permalink