wip

If the server has not created a client instance then the device would crash when the peer disconnects due to nullptr access.

.clang-format

@@ -0,0 +1,42 @@
+BasedOnStyle: Google
+Language: Cpp
+ColumnLimit: 120
+IndentWidth: 4
+TabWidth: 4
+UseTab: Never
+SortIncludes: Never
+PPIndentWidth : 1
+IndentPPDirectives: AfterHash
+ReflowComments: true
+SpacesBeforeTrailingComments: 1
+AlignTrailingComments: true
+AlignAfterOpenBracket: Align
+AlignConsecutiveMacros:
+  Enabled: true
+  AcrossEmptyLines: true
+  AcrossComments: true
+AlignConsecutiveAssignments:
+  Enabled: true
+  AcrossEmptyLines: false
+  AcrossComments: true
+  AlignCompound: true
+  PadOperators: true
+AlignConsecutiveDeclarations:
+  Enabled: true
+  AcrossEmptyLines: false
+  AcrossComments: true
+AlignEscapedNewlines: Left
+AccessModifierOffset: -2
+AlignArrayOfStructures: Right
+AlignOperands: Align
+AllowAllArgumentsOnNextLine: false
+AllowShortFunctionsOnASingleLine: Inline
+AllowShortBlocksOnASingleLine: Empty
+BreakBeforeBinaryOperators: None
+BinPackArguments: false
+BinPackParameters: false
+DerivePointerAlignment: false
+PenaltyBreakAssignment: 4
+PenaltyExcessCharacter: 4
+PenaltyBreakBeforeFirstCallParameter: 1
+PointerAlignment: Left

.github/workflows/build.yml

@@ -0,0 +1,65 @@
+name: Build
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  build-esp-idf-component:
+    name: Build with ESP-IDF ${{ matrix.idf_ver }} for ${{ matrix.idf_target }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        # The version names here correspond to the versions of espressif/idf Docker image.
+        # See https://hub.docker.com/r/espressif/idf/tags and
+        # https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-docker-image.html
+        # for details.
+        idf_ver: ["release-v4.4", "release-v5.1", "release-v5.3"]
+        idf_target: ["esp32", "esp32s3", "esp32c2", "esp32c3", "esp32c6", "esp32h2", "esp32p4"]
+        example:
+          - NimBLE_Client
+          - NimBLE_Server
+          - Bluetooth_5/NimBLE_extended_client
+          - Bluetooth_5/NimBLE_extended_server
+        exclude:
+          - idf_target: "esp32"
+            example: Bluetooth_5/NimBLE_extended_client
+          - idf_target: "esp32"
+            example: Bluetooth_5/NimBLE_extended_server
+          - idf_ver: release-v4.4
+            idf_target: "esp32c2"
+          - idf_ver: release-v4.4
+            idf_target: "esp32c6"
+          - idf_ver: release-v4.4
+            idf_target: "esp32h2"
+          - idf_ver: release-v4.4
+            idf_target: "esp32p4"
+          - idf_ver: release-v5.1
+            idf_target: "esp32p4"
+
+    container: espressif/idf:${{ matrix.idf_ver }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          path: components/esp-nimble-cpp
+      - name: Build examples
+        env:
+          IDF_TARGET: ${{ matrix.idf_target }}
+        shell: bash
+        run: |
+          . ${IDF_PATH}/export.sh
+          cp -r components/esp-nimble-cpp/examples/* .
+          idf.py -C ${{ matrix.example }} -DEXTRA_COMPONENT_DIRS=$PWD/components build
+
+  build_docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Doxygen Action
+        uses: mattnotmitt/doxygen-action@v1.9.8
+        with:
+          working-directory: 'docs/'

.gitignore

@@ -0,0 +1 @@
+docs/doxydocs

CHANGELOG.md

@@ -1,6 +1,239 @@
 # Changelog
 
 All notable changes to this project will be documented in this file.
+## [Unreleased]
+
+## **Breaking changes**
+- All connection oriented callbacks now receive a reference to `NimBLEConnInfo`, the `ble_gap_conn_desc` has also been replace with `NimBLEConnInfo` in the functions that received it.
+- All functions that take a time input parameter now expect the value to be in milliseconds instead of seconds.
+- Removed Eddystone URL as it has been shutdown by google since 2021.
+- NimBLESecurity class removed.
+- `NimBLEDevice` Ignore list functions removed.
+- `NimBLEDevice::startSecurity` now returns a `bool`, true on success, instead of an int to be consistent with the rest of the library.
+- `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::setOwnAddrType` no longer takes a `bool nrpa` parameter.
+- `NimBLEDevice::getClientListSize` replaced with `NimBLEDevice::getCreatedClientCount`.
+- `NimBLEDevice::getClientList` was removed.
+- `NimBLEServer::disconnect` now returns `bool`, true = success,  instead of `int` to be consistent with the rest of the library.
+- `NimBLEServerCallbacks::onMTUChanged` renamed to `NimBLEServerCallbacks::onMTUChange` to be consistent with the client callback.
+- `NimBLEServer::getPeerIDInfo` renamed to `NimBLEServer::getPeerInfoByHandle` to better describe it's use.
+- `NimBLEServerCallbacks::onPassKeyRequest` has been replaced with `NimBLEServer::onPassKeyDisplay` which should display the pairing pin that the client is expected to send.
+- `NimBLEServerCallbacks::onAuthenticationComplete` now takes a `NimBLEConnInfo&` parameter.
+- `NimBLEClient::getServices` now returns a const reference to std::vector<NimBLERemoteService*> instead of a pointer to the internal vector.
+- `NimBLEClient::getConnId` has been renamed to `getConnHandle` to be consistent with bluetooth terminology.
+- `NimBLEClient::disconnect` now returns a `bool`, true on success, instead of an int to be consistent with the rest of the library.
+- `NimBLEClientCallbacks::onDisconnect` now takes an additional `int reason` parameter to let the application know why the disconnect occurred.
+- `NimBLEClientCallbacks::onPassKeyRequest` has been changed to `NimBLEClientCallbacks::onPassKeyEntry` which takes a `NimBLEConnInfo&` parameter and does not return a value. Instead or returning a value this callback should prompt a user to enter a pin number which is sent later via `NimBLEDevice::injectPassKey`.
+- `NimBLEClientCallbacks::onConfirmPIN` renamed to `NimBLEClientCallbacks::onConfirmPasskey` and no longer returns a value and now takes a `NimBLEConnInfo&` parameter. This should be used to prompt a user to confirm the pin on the display (YES/NO) after which the response should be sent with `NimBLEDevice::injectConfirmPasskey`.
+- `NimBLEAdvertising::setMinPreferred` and `NimBLEAdvertising::setMaxPreferred` have been removed, use `NimBLEAdvertising::setPreferredParams` instead.
+- Advertising the name and TX power of the device will no longer happen by default and should be set manually by the application.
+- `NimBLEAdvertising::setAdvertisementType` has been renamed to `NimBLEAdvertising::setConnectableMode` to better reflect it's function.
+- `NimBLEAdvertising::setScanResponse` has been renamed to `NimBLEAdvertising::enableScanResponse` to better reflect it's function.
+- `NimBLEAdvertising`; Scan response is no longer enabled by default.
+- `NimBLEAdvertising::start` No longer takes a callback pointer parameter, instead the new method `NimBLEAdvertising::setAdvertisingCompleteCallback` should be used.
+- `NimBLEAdvertisementData::addData` now takes either a `std::vector<uint8_t>` or `uint8_t* + length` instead of `std::string` or `char + length`.
+- `NimBLEAdvertisementData::getPayload` now returns `std::vector<uint8_t>` instead of `std::string`.
+- The callback parameter for `NimBLEScan::start` has been removed and the blocking overload of `NimBLEScan::start` has been replaced by an overload of `NimBLEScan::getResults` with the same parameters.
+- `NimBLEAdvertisedDeviceCallbacks` Has been replaced by `NimBLEScanCallbacks` which contains the following methods: `onResult`, `onScanEnd`, and `onDiscovered
+- - `NimBLEScanCallbacks::onResult`, functions the same as the old `NimBLEAdvertisedDeviceCallbacks::onResult` but now takes aa `const NimBLEAdvertisedDevice*` instead of non-const.
+- - `NimBLEScanCallbacks::onScanEnd`, replaces the scanEnded callback passed to `NimBLEScan::start` and now takes a `const NimBLEScanResults&` and `int reason` parameter.
+- - `NimBLEScanCallbacks::onDiscovered`, This is called immediately when a device is first scanned, before any scan response data is available and takes a `const NimBLEAdvertisedDevice*` parameter.
+- `NimBLEScan::stop` will no longer call the `onScanEnd` callback as the caller should know its been stopped when this is called.
+- `NimBLEScan::clearDuplicateCache` has been removed as it was problematic and only for the esp32. Stop and start the scanner for the same effect.
+- `NimBLEScanResults::getDevice` methods now return `const NimBLEAdvertisedDevice*`.
+- `NimBLEScanResults` iterators are now `const_iterator`.
+- `NimBLEAdvertisedDevice::hasRSSI` removed as redundant, RSSI is always available.
+- `NimBLEAdvertisedDevice::getPayload` now returns `const std::vector<uint8_t>` instead of a pointer to internal memory.
+- `NimBLEAdvertisedDevice` Timestamp removed, if needed then the app should track the time from the callback.
+- `NimBLECharacteristic::notify` no longer takes a `bool is_notification` parameter, instead `indicate()` should be called to send indications.
+- `NimBLECharacteristicCallbacks::onNotify` removed as unnecessary, the library does not call notify without app input.
+- `NimBLECharacteristicCallbacks::onStatus` No longer takes a `status` parameter, refer to the return code for success/failure.
+- `NimBLERemoteCharacteristic::getRemoteService` now returns a `const NimBLERemoteService*` instead of non-const.
+- `NimBLERemoteCharacteristic::readUInt32` Has been removed.
+- `NimBLERemoteCharacteristic::readUInt16` Has been removed.
+- `NimBLERemoteCharacteristic::readUInt8` Has been removed.
+- `NimBLERemoteCharacteristic::readFloat` Has been removed.
+- `NimBLERemoteCharacteristic::registerForNotify` Has been removed.
+- `NimBLERemoteService::getCharacteristics` now returns a `const std::vector<NimBLERemoteCharacteristic*>&` instead of non-const `std::vector<NimBLERemoteCharacteristic*>*`.
+- `NimBLERemoteService::getValue` now returns `NimBLEAttValue` instead of `std::string`.
+- `NimBLEService::getCharacteristics` now returns a `const std::vector<NimBLECharacteristic*>&` instead of std::vector<NimBLECharacteristic *>.
+- `NimBLEUUID::getNative` method replaced with `NimBLEUUID::getBase` which returns a read-only pointer to the underlying `ble_uuid_t` struct.
+- `NimBLEUUID`; `msbFirst` parameter has been removed from constructor, caller should reverse the data first or call the new `reverseByteOrder` method after.
+- `NimBLEAddress::getNative` replaced with `NimBLEAddress::getBase` and now returns a pointer to `const ble_addr_t` instead of a pointer to the address value.
+- `NimBLEAddress::equals` method and `NimBLEAddress::== operator` will now also test if the address types are the same.
+- `NimBLEUtils::dumpGapEvent` function removed.
+- `NimBLEUtils::buildHexData` replaced with `NimBLEUtils::dataToHexString`, which returns a `std::string` containing the hex string.
+- `NimBLEEddystoneTLM::setTemp` now takes an `int16_t` parameter instead of float to be friendly to devices without floating point support.
+- `NimBLEEddystoneTLM::getTemp` now returns `int16_t` to work with devices that don't have floating point support.
+- `NimBLEEddystoneTLM::setData` now takes a reference to * `NimBLEEddystoneTLM::BeaconData` instead of `std::string`.
+- `NimBLEEddystoneTLM::getData` now returns a reference to * `NimBLEEddystoneTLM::BeaconData` instead of `std::string`.
+- `NimBLEBeacon::setData` now takes `const NimBLEBeacon::BeaconData&` instead of `std::string`.
+- `NimBLEBeacon::getData` now returns `const NimBLEBeacon::BeaconData&` instead of `std::string`.
+- `NimBLEHIDDevice::reportMap` renamed to `NimBLEHIDDevice::getReportMap`.
+- `NimBLEHIDDevice::hidControl` renamed to `NimBLEHIDDevice::getHidControl`.
+- `NimBLEHIDDevice::inputReport`renamed to `NimBLEHIDDevice::getInputReport`.
+- `NimBLEHIDDevice::outputReport`renamed to `NimBLEHIDDevice::getOutputReport`.
+- `NimBLEHIDDevice::featureReport`renamed to `NimBLEHIDDevice::getFeatureReport`.
+- `NimBLEHIDDevice::protocolMode`renamed to `NimBLEHIDDevice::getProtocolMode`.
+- `NimBLEHIDDevice::bootOutput`renamed to `NimBLEHIDDevice::getBootOutput`.
+- `NimBLEHIDDevice::pnp`renamed to `NimBLEHIDDevice::setPnp`.
+- `NimBLEHIDDevice::hidInfo`renamed to `NimBLEHIDDevice::setHidInfo`.
+- `NimBLEHIDDevice::deviceInfo`renamed to `NimBLEHIDDevice::getDeviceInfoService`.
+- `NimBLEHIDDevice::hidService`renamed to `NimBLEHIDDevice::getHidService`.
+- `NimBLEHIDDevice::batteryService`renamed to `NimBLEHIDDevice::getBatteryService`.
+
+## Fixed
+- `NimBLEDevice::getPower` and `NimBLEDevice::getPowerLevel` bug worked around for the esp32s3 and esp32c3.
+- `NimBLEDevice::setPower` and `NimBLEDevice::getPower` now support the full power range for all esp devices.
+- `NimBLEDevice::setOwnAddrType` will now correctly apply the provided address type for all devices.
+- `NimBLEDevice::getPower` (esp32) return value is now calculated to support devices with different min/max ranges.
+- Crash if `NimBLEDevice::deinit` is called when the stack has not been initialized.
+- `NimBLEServer` service changed notifications will now wait until the changes have taken effect and the server re-started before indicating the change to peers, reducing difficultly for some clients to update their data.
+- `NimBLEService::getHandle` will now fetch the handle from the stack if not valid to avoid returning an invalid value.
+- `std::vector` input to set/write values template.
+- `NimBLEHIDDevice::pnp` will now set the data correctly.
+- Check for Arduino component 
+- Fixed building with esp-idf version 5.x.
+- Fixed pairing failing when the process was started by the peer first.
+- Fixed building with esp-idf and Arduino component.
+- Workaround for esp32s3 and esp32c3 not returning the correct txPower with some IDF versions.
+
+### Changed
+- `NimBLEClient::secureConnection` now takes an additional parameter `bool async`, if true, will send the secure command and return immediately with a true value for successfully sending the command, else false. This allows for asynchronously securing a connection.
+- Deleting the client instance from the `onDisconnect` callback is now supported.
+- `NimBLEClient::connect` will no longer cancel already in progress connections.
+- `NimBLEClient::setDataLen` now returns bool, true if successful.
+- `NimBLEClient::updateConnParams` now returns bool, true if successful.
+- `NimBLEClient::setPeerAddress` now returns a bool, true on success.
+- `NimBLEDevice::startSecurity` now takes and additional parameter `int* rcPtr` which will provide the return code from the stack if provided.
+- `NimBLEDevice::deleteClient` no longer blocks tasks.
+- `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` indicating 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 and works with non-esp32 devices.
+- `NimBLEDevice::setPower` now returns a bool value, true = success.
+- `NimBLEDevice::setMTU` now returns a bool value, true = success.
+- `NimBLEDevice::deleteAllBonds` now returns true on success, otherwise false.
+- `NimBLEEddystoneTLM` internal data struct type `BeaconData` is now public and usable by the application.
+- `NimBLEBeacon` internal data struct type `BeaconData` is now public and can be used by the application.
+- Removed tracking of client characteristic subscription status from `NimBLEServer` and `NimBLECharacteristic` and instead uses
+the functions and tracking in the host stack.
+- `NimBLECharacteristic::indicate` now takes the same parameters as `notify`.
+- `NimBLECharacteristic::notify` and `NimBLECharacteristic::indicate` now return a `bool`, true = success.
+- Added optional `connHandle` parameter to `NimBLECharacteristic::notify` to allow for sending notifications to specific clients.
+- `NimBLEServer` Now uses a std::array to store client connection handles instead of std::vector to reduce memory allocation.
+- `NimBLEExtAdvertisement` : All functions that set data now return `bool`, true = success.
+- `NimBLEAdvertising` Advertising data is now stored in instances of `NimBLEAdvertisingData` and old vectors removed.
+- `NimBLEAdvertising::setAdvertisementData` and `NimBLEAdvertising::setScanResponseData` now return `bool`, true = success.
+- Added optional `NimBLEAddress` parameter to `NimBLEAdvertising::start` to allow for directed advertising to a peer.
+- All `NimBLEAdvertising` functions that change data values now return `bool`, true = success.
+- All `NimBLEAdvertisementData` functions that change data values now return `bool`, true = success.
+- `NimBLEAdvertising` advertising complete callback is now defined as std::function to allow for using std::bind for callback functions.
+- `NimBLEAdvertisementData::setName` now takes an optional `bool` parameter to indicate if the name is complete or incomplete, default = complete.
+- `NimBLEAdvertisementData` moved to it's own .h and .cpp files.
+- `NimBLEScan::start` takes a new `bool restart` parameter, default `true`, that will restart an already in progress scan and clear the duplicate filter so all devices will be discovered again.
+- Scan response data that is received without advertisement first will now create the device and send a callback.
+- `NimBLEScan::start` will no longer clear cache or results if scanning is already in progress.
+- `NimBLEScan::start` will now allow the start command to be sent with updated parameters if already scanning.
+- `NimBLEScan::clearResults` will now reset the vector capacity to 0.
+- Host reset will now no longer restart scanning and instead will call `NimBLEScanCallbacks::onScanEnd`.
+- Added optional `index` parameter to `NimBLEAdvertisedDevice::getPayloadByType`
+- `NimBLEAdvertisedDevice::getManufacturerData` now takes an optional index parameter for use in the case of multiple manufacturer data fields.
+- `NimBLEUtils`: Add missing GAP event strings.
+- `NimBLEUtils`: Add missing return code strings.
+- `NimBLEUtils`: Event/error code strings optimized.
+- `NimBLEAttValue` cleanup and optimization.
+- cleaned up code, removed assert/abort calls, replaced with a configurable option to enable debug asserts.
+
+### Added
+- (esp32 specific) `NimBLEDevice::setPowerLevel` and `NimBLEDevice::getPowerLevel` which take and return the related `esp_power_level* ` types.
+- `NimBLEDevice::setDefaultPhy` which will set the default preferred PHY for all connections.
+- `NimBLEDevice::getConnectedClients`, which returns a vector of pointers to the currently connected client instances.
+- `NimBLEDevice::setOwnAddr` function added, which takes a `uint8_t*` or `NimBLEAddress&` and will set the mac address of the device, returns `bool` true= success.
+- `NimBLEDevice::injectPassKey` Used to send the pairing passkey instead of a return value from the client callback.
+- `NimBLEDevice::injectConfirmPasskey` Used to send the numeric comparison pairing passkey confirmation instead of a return value from the client callback.
+- `NimBLEDevice::setDeviceName` to change the device name after initialization.
+- `NimBLECharacteristic::create2904` which will specifically create a Characteristic Presentation Format (0x2904) descriptor.
+- `NimBLEAdvertising::refreshAdvertisingData` refreshes the advertisement data while still actively advertising.
+- `NimBLEClient::updatePhy` to request a PHY change with a peer.
+- `NimBLEClient::getPhy` to read the current connection PHY setting.
+- `Config` struct to `NimBLEClient` to efficiently set single bit config settings.
+- `NimBLEClient::setSelfDelete` that takes the bool parameters `deleteOnDisconnect` and `deleteOnConnectFail`, which will configure the client to delete itself when disconnected or the connection attempt fails.
+- `NimBLEClient::setConfig` and `NimBLEClient::getConfig` which takes or returns a `NimBLEClient::Config` object respectively.
+- `NimBLEClient::cancelConnect()` to cancel an in-progress connection, returns `bool`, true = success.
+- Non-blocking `NimBLEClient::connect` option added via 2 new `bool` parameters added to the function:
+- * `asyncConnect`; if true, will send the connect command and return immediately.
+- * `exchangeMTU`; if true will send the exchange MTU command upon connection.
+- `NimBLEClientCallbacks::onConnectFail` callback that is called when the connection attempt fail while connecting asynchronously.
+- `NimBLEClientCallbacks::onMTUChange` callback which will be called when the MTU exchange completes and takes a `NimBLEClient*` and `uint16_t MTU` parameter.
+- `NimBLEClientCallbacks::onPhyUpdate` and -`NimBLEServerCallbacks::onPhyUpdate` Which are called when the PHY update is complete.
+- Extended scan example.
+- `NimBLEServer::updatePhy` to request a PHY change with a peer.
+- `NimBLEServer::getPhy` to read the PHY of a peer connection.
+- `NimBLEServer::getClient` which will create a client instance from the provided peer connHandle or connInfo to facilitate reading/write from the connected client.
+- `NimBLEServerCallbacks::onConnParamsUpdate` callback.
+- `NimBLEScan::erase` overload that takes a `const NimBLEAdvertisedDevice*` parameter.
+- `NimBLEScan::setScanPhy` to enable/disable the PHY's to scan on (extended advertising only).
+- `NimBLEScan::setScanPeriod` which will allow for setting a scan restart timer in the controller (extended advertising only).
+- `NimBLEAdvertisedDevice::isScannable()` that returns true if the device is scannable.
+- `NimBLEAdvertisedDevice::begin` and `NimBLEAdvertisedDevice::end` read-only iterators for convenience and use in range loops.
+- `NimBLEAdvertisedDevice::getAdvFlags` returns the advertisement flags of the advertiser.
+- `NimBLEAdvertisedDevice::getPayloadByType` Generic use function that returns the data from the advertisement with the specified type.
+- `NimBLEAdvertisedDevice::haveType` Generic use function that returns true if the advertisement data contains a field with the specified type.
+- Support for esp32c6, esp32c2, esp32h2, and esp32p4.
+- `NimBLEExtAdvertisement::removeData`, which will remove the data of the specified type from the advertisement.
+- `NimBLEExtAdvertisement::addServiceUUID`, which will append to the service uuids advertised.
+- `NimBLEExtAdvertisement::removeServiceUUID`, which will remove the service from the uuids advertised.
+- `NimBLEExtAdvertisement::removeServices`, which will remove all service uuids advertised.
+- New overloads for `NimBLEExtAdvertisement::setServiceData` with the parameters `const NimBLEUUID& uuid, const uint8_t* data, size_t length` and `const NimBLEUUID& uuid, const std::vector<uint8_t>& data`.
+- `NimBLEExtAdvertisement::getDataLocation`, which returns the location in the advertisement data of the type requested in parameter `uint8_t type`.
+- `NimBLEExtAdvertisement::toString` which returns a hex string representation of the advertisement data.
+- `NimBLEAdvertising::getAdvertisementData`, which returns a reference to the currently set advertisement data.
+- `NimBLEAdvertising::getScanData`, which returns a reference to the currently set scan response data.
+- New overloads for `NimBLEAdvertising::removeServiceUUID` and `NimBLEAdvertisementData::removeServiceUUID` to accept a `const char*`
+- `NimBLEAdvertising::clearData`, which will clear the advertisement and scan response data.
+- `NimBLEAdvertising::setManufacturerData` Overload that takes a `const uint8_t*` and , size_t` parameter.
+- `NimBLEAdvertising::setServiceData` Overload that takes `const NimBLEUUID& uuid`, ` const uint8_t* data`, ` size_t length` as parameters.
+- `NimBLEAdvertising::setServiceData` Overload that takes `const NimBLEUUID& uuid`, `const std::vector<uint8_t>&` as parameters.
+- `NimBLEAdvertising::setDiscoverableMode` to allow applications to control the discoverability of the advertiser.
+- `NimBLEAdvertising::setAdvertisingCompleteCallback` sets the callback to call when advertising ends.
+- `NimBLEAdvertising::setPreferredParams` that takes the min and max preferred connection parameters as an alternative for `setMinPreferred` and `setMaxPreferred`.
+- `NimBLEAdvertising::setAdvertisingInterval` Sets the advertisement interval for min and max to the same value instead of calling `setMinInterval` and `setMaxInterval` separately if there is not value difference.
+- `NimBLEAdvertisementData::removeData`, which takes a parameter `uint8_t type`, the data type to remove.
+- `NimBLEAdvertisementData::toString`, which will print the data in hex.
+- `NimBLEUtils::taskWait` which causes the calling task to wait for an event.
+- `NimBLEUtils::taskRelease` releases the task from and event.
+- `NimBLEUtils::generateAddr` function added with will generate a random address and takes a `bool` parameter, true = create non-resolvable private address, otherwise a random static address is created, returns `NimBLEAddress`.
+- `NimBLEUUID::getValue` which returns a read-only `uint8_t` pointer to the UUID value.
+- `NimBLEUUID::reverseByteOrder`, this will reverse the bytes of the UUID, which can be useful for advertising/logging.
+- `NimBLEUUID` constructor overload that takes a reference to `ble_uuid_any_t`.
+- `NimBLEAddress::isNrpa` method to test if an address is random non-resolvable.
+- `NimBLEAddress::isStatic` method to test if an address is random static.
+- `NimBLEAddress::isPublic` method to test if an address is a public address.
+- `NimBLEAddress::isNull` methods to test if an address is NULL.
+- `NimBLEAddress::getValue` method which returns a read-only pointer to the address value.
+- `NimBLEAddress::reverseByteOrder` method which will reverse the byte order of the address value.
+- `NimBLEHIDDevice::batteryLevel` returns the HID device battery level characteristic.
+- `NimBLEBeacon::setData` overload that takes `uint8_t* data` and `uint8_t length`.
+- `NimBLEHIDDevice::getPnp` function added to access the pnp characteristic.
+- `NimBLEHIDDevice::getHidInfo` function added to access the hid info characteristic.
+
+## [1.4.1] - 2022-10-30
+
+### Fixed
+ - NimBLEDevice::getPower incorrect value when power level is -3db.
+ - Failed pairing when already in progress.
+
+### Changed
+ - Revert previous change that forced writing with response when subscribing in favor of allowing the application to decide.
+
+### Added
+ - Added NimBLEHIDDevice::batteryLevel.
+ - Added NimBLEDevice::setDeviceName allowing for changing the device name while the BLE stack is active.
+ - CI Builds
 
 ## [1.4.0] - 2022-07-31
 
@@ -63,7 +296,7 @@ All notable changes to this project will be documented in this file.
 ## [1.3.0] - 2021-08-02
 
 ### Added
-- `NimBLECharacteristic::removeDescriptor`: Dynamically remove a descriptor from a characterisic. Takes effect after all connections are closed and sends a service changed indication.
+- `NimBLECharacteristic::removeDescriptor`: Dynamically remove a descriptor from a characteristic. Takes effect after all connections are closed and sends a service changed indication.
 - `NimBLEService::removeCharacteristic`: Dynamically remove a characteristic from a service. Takes effect after all connections are closed and sends a service changed indication
 - `NimBLEServerCallbacks::onMTUChange`: This is callback is called when the MTU is updated after connection with a client.
 - ESP32C3 support
@@ -94,12 +327,12 @@ All notable changes to this project will be documented in this file.
 ### Fixed
 - `NimBLECharacteristicCallbacks::onSubscribe` Is now called after the connection is added to the vector.
 - Corrected bonding failure when reinitializing the BLE stack.
-- Writing to a characterisic with a std::string value now correctly writes values with null characters.
-- Retrieving remote descriptors now uses the characterisic end handle correctly.
+- Writing to a characteristic with a std::string value now correctly writes values with null characters.
+- Retrieving remote descriptors now uses the characteristic end handle correctly.
 - Missing data in long writes to remote descriptors.
 - Hanging on task notification when sending an indication from the characteristic callback.
 - BLE controller memory could be released when using Arduino as a component.
-- Complile errors with NimBLE release 1.3.0.
+- Compile errors with NimBLE release 1.3.0.
 
 ## [1.2.0] - 2021-02-08
 
@@ -112,7 +345,7 @@ All notable changes to this project will be documented in this file.
 
 - `NimBLEService::getCharacteristicByHandle`: Get a pointer to the characteristic object with the specified handle.
 
-- `NimBLEService::getCharacteristics`: Get the vector containing pointers to each characteristic associated with this service.  
+- `NimBLEService::getCharacteristics`: Get the vector containing pointers to each characteristic associated with this service.
 Overloads to get a vector containing pointers to all the characteristics in a service with the UUID. (supports multiple same UUID's in a service)
   - `NimBLEService::getCharacteristics(const char *uuid)`
   - `NimBLEService::getCharacteristics(const NimBLEUUID &uuid)`
@@ -154,12 +387,12 @@ Overloads to get a vector containing pointers to all the characteristics in a se
 
 - `NimBLEAdvertising` Transmission power is no longer advertised by default and can be added to the advertisement by calling `NimBLEAdvertising::addTxPower`
 
-- `NimBLEAdvertising` Custom scan response data can now be used without custom advertisment.
+- `NimBLEAdvertising` Custom scan response data can now be used without custom advertisement.
 
-- `NimBLEScan` Now uses the controller duplicate filter.  
+- `NimBLEScan` Now uses the controller duplicate filter.
 
-- `NimBLEAdvertisedDevice` Has been refactored to store the complete advertisement payload and no longer parses the data from each advertisement.  
-Instead the data will be parsed on-demand when the user application asks for specific data.  
+- `NimBLEAdvertisedDevice` Has been refactored to store the complete advertisement payload and no longer parses the data from each advertisement.
+Instead the data will be parsed on-demand when the user application asks for specific data.
 
 ### Fixed
 - `NimBLEHIDDevice` Characteristics now use encryption, this resolves an issue with communicating with devices requiring encryption for HID devices.
@@ -168,84 +401,84 @@ Instead the data will be parsed on-demand when the user application asks for spe
 ## [1.1.0] - 2021-01-20
 
 ### Added
-- `NimBLEDevice::setOwnAddrType` added to enable the use of random and random-resolvable addresses, by asukiaaa  
+- `NimBLEDevice::setOwnAddrType` added to enable the use of random and random-resolvable addresses, by asukiaaa
 
-- New examples for securing and authenticating client/server connections, by mblasee.  
+- New examples for securing and authenticating client/server connections, by mblasee.
 
-- `NimBLEAdvertising::SetMinPreferred` and `NimBLEAdvertising::SetMinPreferred` re-added.  
+- `NimBLEAdvertising::SetMinPreferred` and `NimBLEAdvertising::SetMinPreferred` re-added.
 
-- Conditional checks added for command line config options in `nimconfig.h` to support custom configuration in platformio.  
+- Conditional checks added for command line config options in `nimconfig.h` to support custom configuration in platformio.
 
-- `NimBLEClient::setValue` Now takes an extra bool parameter `response` to enable the use of write with response (default = false).  
+- `NimBLEClient::setValue` Now takes an extra bool parameter `response` to enable the use of write with response (default = false).
 
-- `NimBLEClient::getCharacteristic(uint16_t handle)` Enabling the use of the characteristic handle to be used to find 
-the NimBLERemoteCharacteristic object.  
+- `NimBLEClient::getCharacteristic(uint16_t handle)` Enabling the use of the characteristic handle to be used to find
+the NimBLERemoteCharacteristic object.
 
-- `NimBLEHIDDevice` class added by wakwak-koba.  
+- `NimBLEHIDDevice` class added by wakwak-koba.
 
-- `NimBLEServerCallbacks::onDisconnect` overloaded callback added to provide a ble_gap_conn_desc parameter for the application  
-to obtain information about the disconnected client.  
+- `NimBLEServerCallbacks::onDisconnect` overloaded callback added to provide a ble_gap_conn_desc parameter for the application
+to obtain information about the disconnected client.
 
-- Conditional checks in `nimconfig.h` for command line defined macros to support platformio config settings.  
+- Conditional checks in `nimconfig.h` for command line defined macros to support platformio config settings.
 
 ### Changed
-- `NimBLEAdvertising::start` now returns a bool value to indicate success/failure.  
+- `NimBLEAdvertising::start` now returns a bool value to indicate success/failure.
 
-- Some asserts were removed in `NimBLEAdvertising::start` and replaced with better return code handling and logging.    
+- Some asserts were removed in `NimBLEAdvertising::start` and replaced with better return code handling and logging.
 
-- If a host reset event occurs, scanning and advertising will now only be restarted if their previous duration was indefinite.  
+- If a host reset event occurs, scanning and advertising will now only be restarted if their previous duration was indefinite.
 
 - `NimBLERemoteCharacteristic::subscribe` and `NimBLERemoteCharacteristic::registerForNotify` will now set the callback
-regardless of the existance of the CCCD and return true unless the descriptor write operation failed.  
+regardless of the existence of the CCCD and return true unless the descriptor write operation failed.
 
-- Advertising tx power level is now sent in the advertisement packet instead of scan response.  
+- Advertising tx power level is now sent in the advertisement packet instead of scan response.
 
-- `NimBLEScan` When the scan ends the scan stopped flag is now set before calling the scan complete callback (if used)  
-this allows the starting of a new scan from the callback function.  
+- `NimBLEScan` When the scan ends the scan stopped flag is now set before calling the scan complete callback (if used)
+this allows the starting of a new scan from the callback function.
 
 ### Fixed
-- Sometimes `NimBLEClient::connect` would hang on the task block if no event arrived to unblock.  
-A time limit has been added to timeout appropriately.  
+- Sometimes `NimBLEClient::connect` would hang on the task block if no event arrived to unblock.
+A time limit has been added to timeout appropriately.
 
-- When getting descriptors for a characterisic the end handle of the service was used as a proxy for the characteristic end  
-handle. This would be rejected by some devices and has been changed to use the next characteristic handle as the end when possible.  
+- When getting descriptors for a characteristic the end handle of the service was used as a proxy for the characteristic end
+handle. This would be rejected by some devices and has been changed to use the next characteristic handle as the end when possible.
 
-- An exception could occur when deleting a client instance if a notification arrived while the attribute vectors were being  
-deleted. A flag has been added to prevent this.  
-  
-- An exception could occur after a host reset event when the host re-synced if the tasks that were stopped during the event did  
-not finish processing. A yield has been added after re-syncing to allow tasks to finish before proceeding.  
-  
-- Occasionally the controller would fail to send a disconnected event causing the client to indicate it is connected  
-and would be unable to reconnect. A timer has been added to reset the host/controller if it expires.  
-  
-- Occasionally the call to start scanning would get stuck in a loop on BLE_HS_EBUSY, this loop has been removed.  
+- An exception could occur when deleting a client instance if a notification arrived while the attribute vectors were being
+deleted. A flag has been added to prevent this.
 
-- 16bit and 32bit UUID's in some cases were not discovered or compared correctly if the device  
-advertised them as 16/32bit but resolved them to 128bits. Both are now checked.  
-  
-- `FreeRTOS` compile errors resolved in latest Ardruino core and IDF v3.3.  
+- An exception could occur after a host reset event when the host re-synced if the tasks that were stopped during the event did
+not finish processing. A yield has been added after re-syncing to allow tasks to finish before proceeding.
 
-- Multiple instances of `time()` called inside critical sections caused sporadic crashes, these have been moved out of critical regions.  
+- Occasionally the controller would fail to send a disconnected event causing the client to indicate it is connected
+and would be unable to reconnect. A timer has been added to reset the host/controller if it expires.
 
-- Advertisement type now correctly set when using non-connectable (advertiser only) mode.  
+- Occasionally the call to start scanning would get stuck in a loop on BLE_HS_EBUSY, this loop has been removed.
 
-- Advertising payload length correction, now accounts for appearance.  
+- 16bit and 32bit UUID's in some cases were not discovered or compared correctly if the device
+advertised them as 16/32bit but resolved them to 128bits. Both are now checked.
 
-- (Arduino) Ensure controller mode is set to BLE Only.  
+- `FreeRTOS` compile errors resolved in latest Arduino core and IDF v3.3.
+
+- Multiple instances of `time()` called inside critical sections caused sporadic crashes, these have been moved out of critical regions.
+
+- Advertisement type now correctly set when using non-connectable (advertiser only) mode.
+
+- Advertising payload length correction, now accounts for appearance.
+
+- (Arduino) Ensure controller mode is set to BLE Only.
 
 
 ## [1.0.2] - 2020-09-13
 
 ### Changed
 
-- `NimBLEAdvertising::start` Now takes 2 optional parameters, the first is the duration to advertise for (in seconds), the second is a  
-callback that is invoked when advertsing ends and takes a pointer to a `NimBLEAdvertising` object (similar to the `NimBLEScan::start` API).
+- `NimBLEAdvertising::start` Now takes 2 optional parameters, the first is the duration to advertise for (in seconds), the second is a
+callback that is invoked when advertising ends and takes a pointer to a `NimBLEAdvertising` object (similar to the `NimBLEScan::start` API).
 
 - (Arduino) Maximum BLE connections can now be altered by only changing the value of `CONFIG_BT_NIMBLE_MAX_CONNECTIONS` in `nimconfig.h`.
 Any changes to the controller max connection settings in `sdkconfig.h` will now have no effect when using this library.
 
-- (Arduino) Revert the previous change to fix the advertising start delay. Instead a replacement fix that routes all BLE controller commands from  
+- (Arduino) Revert the previous change to fix the advertising start delay. Instead a replacement fix that routes all BLE controller commands from
 a task running on core 0 (same as the controller) has been implemented. This improves response times and reliability for all BLE functions.
 
 

CMakeLists.txt

@@ -2,50 +2,64 @@
 # CMakeLists in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.5)
 
-idf_build_get_property(__hack_component_targets __COMPONENT_TARGETS)
-
-if("esp-nimble-component" IN_LIST BUILD_COMPONENTS OR "__esp-nimble-component" IN_LIST __hack_component_targets)
+if(__COMPONENT_TARGETS MATCHES "___idf_esp-nimble-component")
     list(APPEND ESP_NIMBLE_PRIV_REQUIRES
         esp-nimble-component
     )
-elseif("nimble" IN_LIST BUILD_COMPONENTS OR "__nimble" IN_LIST __hack_component_targets)
+elseif(__COMPONENT_TARGETS MATCHES "__idf_nimble")
     list(APPEND ESP_NIMBLE_PRIV_REQUIRES
         nimble
     )
 endif()
 
-if("arduino" IN_LIST BUILD_COMPONENTS OR __hack_component_targets MATCHES "__idf_arduino")
+# Arduino install using IDF component manager
+if(__COMPONENT_TARGETS MATCHES "___idf_espressif__arduino-esp32")
+    list(APPEND ESP_NIMBLE_PRIV_REQUIRES
+        arduino-esp32
+    )
+# Manual installation of Arduino framework
+elseif(__COMPONENT_TARGETS MATCHES "__idf_arduino")
     list(APPEND ESP_NIMBLE_PRIV_REQUIRES
         arduino
     )
+# PlatformIO
+elseif(__COMPONENT_TARGETS MATCHES "___idf_framework-arduinoespressif32")
+    list(APPEND ESP_NIMBLE_PRIV_REQUIRES
+        framework-arduinoespressif32
+    )
 endif()
 
 idf_component_register(
   REQUIRED_IDF_TARGETS
     "esp32"
     "esp32s3"
+    "esp32c2"
     "esp32c3"
+    "esp32c6"
+    "esp32h2"
+    "esp32p4"
   INCLUDE_DIRS
     "src"
   SRCS
     "src/NimBLE2904.cpp"
     "src/NimBLEAddress.cpp"
     "src/NimBLEAdvertisedDevice.cpp"
+    "src/NimBLEAdvertisementData.cpp"
     "src/NimBLEAdvertising.cpp"
+    "src/NimBLEAttValue.cpp"
     "src/NimBLEBeacon.cpp"
     "src/NimBLECharacteristic.cpp"
     "src/NimBLEClient.cpp"
     "src/NimBLEDescriptor.cpp"
     "src/NimBLEDevice.cpp"
     "src/NimBLEEddystoneTLM.cpp"
-    "src/NimBLEEddystoneURL.cpp"
     "src/NimBLEExtAdvertising.cpp"
     "src/NimBLEHIDDevice.cpp"
     "src/NimBLERemoteCharacteristic.cpp"
     "src/NimBLERemoteDescriptor.cpp"
     "src/NimBLERemoteService.cpp"
+    "src/NimBLERemoteValueAttribute.cpp"
     "src/NimBLEScan.cpp"
-    "src/NimBLESecurity.cpp"
     "src/NimBLEServer.cpp"
     "src/NimBLEService.cpp"
     "src/NimBLEUtils.cpp"
@@ -53,6 +67,7 @@ idf_component_register(
   REQUIRES
     bt
     nvs_flash
+    driver
   PRIV_REQUIRES
     ${ESP_NIMBLE_PRIV_REQUIRES}
 )

Kconfig

@@ -33,7 +33,7 @@ config NIMBLE_CPP_ENABLE_RETURN_CODE_TEXT
         Enabling this option will display return code values as text
         messages in the debug log. This will use approximately 8kB
         of flash memory.
-        
+
 config NIMBLE_CPP_ENABLE_GAP_EVENT_CODE_TEXT
     bool "Show NimBLE gap events as text in debug log."
     default "n"
@@ -47,7 +47,7 @@ config NIMBLE_CPP_ENABLE_ADVERTISEMENT_TYPE_TEXT
     default "n"
     help
         Enabling this option will display advertisment types recieved
-        while scanning as text messages in the debug log. 
+        while scanning as text messages in the debug log.
         This will use approximately 250 bytes of flash memory.
 
 config NIMBLE_CPP_ATT_VALUE_TIMESTAMP_ENABLED
@@ -68,5 +68,66 @@ config NIMBLE_CPP_ATT_VALUE_INIT_LENGTH
         when the constructor is called. This is also the size used when a remote
         characteristic or descriptor is constructed before a value is read/notifed.
         Increasing this will reduce reallocations but increase memory footprint.
+
+config NIMBLE_CPP_DEBUG_ASSERT_ENABLED
+    bool "Enable debug asserts."
+    default "n"
+    help
+        Enabling this option will add debug asserts to the NimBLE CPP library.
+        This will use approximately 1kB of flash memory.
+
+config NIMBLE_CPP_FREERTOS_TASK_BLOCK_BIT
+    int "FreeRTOS task block bit"
+    default 31
+    help
+        Configure the bit to set in the task notification value when a task is blocked waiting for an event.
+        This should be set to a bit that is not used by other notifications in the system.
         
+#
+# BT config
+#
+config BT_ENABLED
+    bool "Bluetooth"
+    default "y"
+    help
+        Select this option to enable Bluetooth and show the submenu with Bluetooth configuration choices.
+
+
+config BT_NIMBLE_ENABLED
+    bool "NimBLE - BLE only"
+    default "y"
+    help
+        This option is recommended for BLE only usecases to save on memory
+
+if IDF_TARGET_ESP32P4
+
+    config BT_NIMBLE_TRANSPORT_UART
+        bool "Enable Uart Transport"
+        default "n"
+
+    #
+    # Enable ESP Hosted BT
+    # Used as VHCI transport between BT Host and Controller
+    #
+    config ESP_ENABLE_BT
+        bool "Enable Hosted Bluetooth support"
+        default "y"
+        help
+            Enable Bluetooth Support via Hosted
+
+    choice ESP_WIFI_REMOTE_LIBRARY
+        prompt "Choose WiFi-remote implementation"
+        default ESP_WIFI_REMOTE_LIBRARY_HOSTED
+        help
+            Select type of WiFi Remote implementation
+
+            ESP-HOSTED is the default and most versatile option.
+            It's also possible to use EPPP, which uses PPPoS link between micros and NAPT, so it's slower
+            and less universal.
+
+        config ESP_WIFI_REMOTE_LIBRARY_HOSTED
+            bool "ESP-HOSTED"
+    endchoice
+endif
+
 endmenu

docs/1.x_to2.x_migration_guide.md

@@ -0,0 +1,165 @@
+# Migrating from 1.x to 2.x
+
+Nearly all of the codebase has been updated and changed under the surface, which has greatly reduced the resource use of the library and improved it's performance. To be able to support these changes it required various API changes and additions.
+
+This guide will help you migrate your application code to use the new API.
+
+The changes listed here are only the required changes that must be made, and a short overview of options for migrating existing applications.
+
+* [General changes](#general-changes)
+* [BLE Device](#ble-device)
+* [BLE Addresses](#ble-addresses)
+* [BLE UUID's](#ble-uuids)
+* [Server](#server)
+    * [Services](#services)
+    * [Characteristics](#characteristics)
+    * [Characteristic Callbacks](#characteristic-callbacks)
+    * [Security](#server)
+* [Client](#client)
+    * [Client Callbacks](#client-callbacks)
+    * [Remote Services](#remote-services)
+    * [Remote characteristics](#remote-characteristics)
+* [Scanning](#scan)
+    * [Advertise device](#advertised-device)
+* [Advertising](#advertising)
+* [Beacons](#beacons)
+* [Utilities](#utilities)  
+<br/>
+
+## General changes
+- All functions that take a time parameter now require the time in milliseconds instead of seconds, i.e. `NimBLEScan::start(10000); // 10 seconds`
+- `NimBLESecurity` class has been removed it's functionality has been merged into the `NimBLEServer` and `NimBLEClient` classes.
+- All connection oriented callbacks now receive a reference to `NimBLEConnInfo` and the `ble_gap_conn_desc` parameter has been replaced with `NimBLEConnInfo` in the functions that received it.  
+    For instance `onAuthenticationComplete(ble_gap_conn_desc* desc)` signature is now `onAuthenticationComplete(NimBLEConnInfo& connInfo)` and  
+    `NimBLEServerCallbacks::onConnect(NimBLEServer* pServer)` signature is now `NimBLEServerCallbacks::onConnect(NimBLEServer* pServer, NimBLEConnInfo& connInfo)`.  
+<br/>
+
+## BLE Device
+- Ignore list functions and vector have been removed, the application should implement this if desired. It was no longer used by the library.
+- `NimBLEDevice::startSecurity` now returns a `bool`, true on success, instead of an int to be consistent with the rest of the library.
+- `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, so instead of `ESP_PWR_LVL_P9` an `int8_t` value of `9` would be used for the same result.
+- `NimBLEDevice::setOwnAddrType` no longer takes a `bool nrpa` parameter, the random address type will be determined by the bits the in the address instead.  
+    Note: If setting a custom address, it should be set with `NimBLEDevice::setOwnAddr` first before calling  `NimBLEDevice::setOwnAddrType`.
+- `NimBLEDevice::getClientListSize` replaced with `NimBLEDevice::getCreatedClientCount`.
+- `NimBLEDevice::getClientList` was removed and `NimBLEDevice::getConnectedClients` can be used instead which returns a `std::vector` of pointers to the connected client instances. This was done because internally the clients are managed in a `std::array` which replaced the 'std::list`.  
+<br/>
+
+## BLE Addresses
+NimBLEAddress comparisons have changed to now consider the address type. If 2 address values are the same but the type is different then they are no longer considered equal. This is a correction to the 1.x version which did not consider the type, whereas the BLE specification states:
+> Whenever two device addresses are compared, the comparison shall include the device address type (i.e. if the two addresses have different types, they are different even if the two 48-bit addresses are the same).
+
+This means that if in your application you create a NimBLEAddress instance and are comparing a scan result or some other address created by the library and you did not define the address type then the comparison may fail.
+The default address type is public `0`, whereas many devices use a random `1` address type.
+If you experience this issue please create your address instances with the address type specified, i.e. `NimBLEAddress address("11:22:33:44:55:66", TYPE_HERE)`
+
+`NimBLEAddress::getNative` has been removed and replaced with `NimBLEAddress::getBase`.
+This returns a pointer to `const ble_addr_t` instead of a pointer to the address value that `getNative` did. The value can be accessed through this struct via `ble_addr_t.value` and type is in `ble_addr_t.type`.  
+<br/>
+
+## BLE UUID's
+- `NimBLEUUID::getNative` method replaced with `NimBLEUUID::getBase` which returns a read-only pointer to the underlying `ble_uuid_t` struct.
+- `NimBLEUUID`; `msbFirst` parameter has been removed from constructor, caller should reverse the data first or call the new `NimBLEUUID::reverseByteOrder` method after.  
+<br/>
+
+## Server
+- `NimBLEServer::disconnect` now returns `bool`, true = success,  instead of `int` to be consistent with the rest of the library.
+- `NimBLEServerCallbacks::onMTUChanged` renamed to `NimBLEServerCallbacks::onMTUChange` to be consistent with the client callback.
+- `NimBLEServer::getPeerIDInfo` renamed to `NimBLEServer::getPeerInfoByHandle` to better describe it's use.  
+<br/>
+
+### Services
+- `NimBLEService::getCharacteristics` now returns a `const std::vector<NimBLECharacteristic*>&` instead of a copy of the vector.  
+<br/>
+
+### Characteristics
+- `NimBLECharacteristic::notify` no longer takes a `bool is_notification` parameter, instead `NimBLECharacteristic::indicate` should be called to send indications.  
+<br/>
+
+#### Characteristic callbacks
+- `NimBLECharacteristicCallbacks::onNotify` removed as unnecessary, the library does not call notify without app input.
+- `NimBLECharacteristicCallbacks::onStatus` No longer takes a `status` parameter, refer to the return code parameter for success/failure.  
+<br/>
+
+### Server Security
+- `NimBLEServerCallbacks::onPassKeyRequest` has been renamed to `NimBLEServerCallbacks::onPassKeyDisplay` as it is intended that the device should display the passkey for the client to enter.
+- `NimBLEServerCallbacks::onAuthenticationComplete` now takes a `NimBLEConnInfo&` parameter.  
+<br/>
+
+## Client
+- `NimBLEClient::getServices` now returns a const reference to std::vector<NimBLERemoteService*> instead of a pointer to the internal vector.
+- `NimBLEClient::getConnId` has been renamed to `getConnHandle` to be consistent with bluetooth terminology.
+- `NimBLEClient::disconnect` now returns a `bool`, true on success, instead of an `int` to be consistent with the rest of the library.  
+<br/>
+
+### Client callbacks
+- `NimBLEClientCallbacks::onConfirmPIN` renamed to `NimBLEClientCallbacks::onConfirmPasskey`,  takes a `NimBLEConnInfo&` parameter and no longer returns a value. This should be used to prompt a user to confirm the pin on the display (YES/NO) after which the response should be sent with `NimBLEDevice::injectConfirmPasskey`.
+- `NimBLEClientCallbacks::onPassKeyRequest` has been changed to `NimBLEClientCallbacks::onPassKeyEntry` which takes a `NimBLEConnInfo&` parameter and no longer returns a value. Instead of returning a value this callback should prompt a user to enter a passkey number which is sent later via `NimBLEDevice::injectPassKey`.  
+<br/>
+
+### Remote Services
+- `NimBLERemoteService::getCharacteristics` now returns a `const std::vector<NimBLERemoteCharacteristic*>&` instead of non-const `std::vector<NimBLERemoteCharacteristic*>*`.  
+<br/>
+
+### Remote Characteristics
+- `NimBLERemoteCharacteristic::getRemoteService` now returns a `const NimBLERemoteService*` instead of non-const.
+- `NimBLERemoteCharacteristic::registerForNotify`, has been removed, the application should use `NimBLERemoteCharacteristic::subscribe` and `NimBLERemoteCharacteristic::unSubscribe`.
+
+        `NimBLERemoteCharacteristic::readUInt32`
+        `NimBLERemoteCharacteristic::readUInt16`
+        `NimBLERemoteCharacteristic::readUInt8`
+        `NimBLERemoteCharacteristic::readFloat`
+
+Have been removed, instead the application should use `NimBLERemoteCharacteristic::readValue<type\>`.  
+<br/>
+
+## Scan
+- `NimBLEScan::stop` will no longer call the `onScanEnd` callback as the caller should know it has been stopped either by initiating a connection or calling this function itself.
+- `NimBLEScan::clearDuplicateCache` has been removed as it was problematic and only for the original esp32. The application should stop and start the scanner for the same effect or call `NimBLEScan::start` with the new `bool restart` parameter set to true.
+- `NimBLEScanResults::getDevice` methods now return `const NimBLEAdvertisedDevice*` instead of a non-const pointer.
+- `NimBLEScanResults` iterators are now `const_iterator`.
+- The callback parameter for `NimBLEScan::start` has been removed and the blocking overload of `NimBLEScan::start` has been replaced by an overload of `NimBLEScan::getResults` with the same parameters.
+
+    So if your code prior was this:
+
+        NimBLEScanResults results = pScan->start(10, false);
+
+    It should now be:
+
+        NimBLEScanResults results = pScan->getResults(10000, false); // note the time is now in milliseconds
+
+- `NimBLEAdvertisedDeviceCallbacks` Has been replaced by `NimBLEScanCallbacks` which contains the following methods:
+- - `NimBLEScanCallbacks::onResult`, functions the same as the old `NimBLEAdvertisedDeviceCallbacks::onResult` but now takes aa `const NimBLEAdvertisedDevice*` instead of non-const.
+- - `NimBLEScanCallbacks::onScanEnd`, replaces the scanEnded callback passed to `NimBLEScan::start` and now takes a `const NimBLEScanResults&` and `int reason` parameter.
+- - `NimBLEScanCallbacks::onDiscovered`, This is called immediately when a device is first scanned, before any scan response data is available and takes a `const NimBLEAdvertisedDevice*` parameter.  
+<br/>
+
+### Advertised Device
+- `NimBLEAdvertisedDevice::hasRSSI` removed as redundant, RSSI is always available.
+- `NimBLEAdvertisedDevice::getPayload` now returns `const std::vector<uint8_t>&` instead of a pointer to internal memory.
+- `NimBLEAdvertisedDevice` Timestamp removed, if needed then the app should track the time from the callback.  
+<br/>
+
+## Advertising
+- `NimBLEAdvertising::setMinPreferred` and `NimBLEAdvertising::setMaxPreferred` have been removed and replaced by `NimBLEAdvertising::setPreferredParams` which takes both the min and max parameters.
+- Advertising the name and TX power of the device will no longer happen by default and should be set manually by the application using `NimBLEAdvertising::setName` and `NimBLEAdvertising::addTxPower`.
+- `NimBLEAdvertising::setAdvertisementType` has been renamed to `NimBLEAdvertising::setConnectableMode` to better reflect it's function.
+- `NimBLEAdvertising::setScanResponse` has been renamed to `NimBLEAdvertising::enableScanResponse` to better reflect it's function.
+- `NimBLEAdvertising`; Scan response is no longer enabled by default.
+- `NimBLEAdvertising::start` No longer takes a callback pointer parameter, instead the new method `NimBLEAdvertising::setAdvertisingCompleteCallback` should be used to set the callback function.  
+<br/>
+
+## Beacons
+- Removed Eddystone URL as it has been shutdown by google since 2021.
+- `NimBLEEddystoneTLM::setTemp` now takes an `int16_t` parameter instead of float to be friendly to devices without floating point support.
+- `NimBLEEddystoneTLM::getTemp` now returns `int16_t` to work with devices that don't have floating point support.
+- `NimBLEEddystoneTLM::setData` now takes a reference to * `NimBLEEddystoneTLM::BeaconData` instead of `std::string`.
+- `NimBLEEddystoneTLM::getData` now returns a reference to * `NimBLEEddystoneTLM::BeaconData` instead of `std::string`.
+- `NimBLEBeacon::setData` now takes `const NimBLEBeacon::BeaconData&` instead of `std::string`.
+- `NimBLEBeacon::getData` now returns `const NimBLEBeacon::BeaconData&` instead of `std::string`.  
+<br/>
+
+## Utilities
+- `NimBLEUtils::dumpGapEvent` function removed.
+- `NimBLEUtils::buildHexData` replaced with `NimBLEUtils::dataToHexString`, which returns a `std::string` containing the hex string.  
+<br/>

docs/Improvements_and_updates.md

@@ -1,148 +0,0 @@
-# Improvements and updates
-
-Many improvements have been made to this library vs the original, this is a brief overview of the most significant changes. Refer to the [class documentation](https://h2zero.github.io/esp-nimble-cpp/annotated.html) for further information on class specifics.
-
-* [Server](#server)
-* [Advertising](#advertising)
-* [Client](#client)
-* [General](#general)  
-<br/>
-
-<a name="server"></a>
-# Server
-
-`NimBLEService::NimBLEService::createCharacteristic` takes a 3rd parameter to specify the maximum data size that can be stored by the characteristic. This allows for limiting the RAM use of the characteristic in cases where small amounts of data are expected.  
-<br/>
-
-`NimBLECharacteristic::setValue(const T &s)`
-`NimBLEDescriptor::setValue(const T &s)`
-
-Now use the `NimbleAttValue` class and templates to accommodate standard and custom types/values.
-
-**Example**
-```
-struct my_struct {
-    uint8_t  one;
-    uint16_t two;
-    uint32_t four;
-    uint64_t eight;
-    float    flt;
-} myStruct;
-
-    myStruct.one = 1;
-    myStruct.two = 2;
-    myStruct.four = 4;
-    myStruct.eight = 8;
-    myStruct.flt = 1234.56;
-
-    pCharacteristic->setValue(myStruct);
-
-    // Arduino String support
-    String myString = "Hello";
-    pCharacteristic->setValue(myString);
- ```
-This will send the struct to the receiving client when read or a notification sent.
-
-`NimBLECharacteristic::getValue` now takes an optional timestamp parameter which will update it's value with the time the last value was received. In addition an overloaded template has been added to retrieve the value as a type specified by the user.
-
-**Example**
-```
-    time_t timestamp;
-    myStruct = pCharacteristic->getValue<myStruct>(&timestamp); // timestamp optional
-```
-<br/>
-
-**Advertising will automatically start when a client disconnects.**
-
-A new method `NimBLEServer::advertiseOnDisconnect(bool)` has been implemented to control this, true(default) = enabled.  
-<br/>
-
-`NimBLEServer::removeService` takes an additional parameter `bool deleteSvc` that if true will delete the service and all characteristics / descriptors belonging to it and invalidating any pointers to them.
-
-If false the service is only removed from visibility by clients. The pointers to the service and it's characteristics / descriptors will remain valid and the service can be re-added in the future using `NimBLEServer::addService`.  
-<br/>
-
-<a name="advertising"></a>
-# Advertising
-`NimBLEAdvertising::start`
-
-Now takes 2 optional parameters, the first is the duration to advertise for (in seconds), the second is a callback that is invoked when advertising ends and takes a pointer to a `NimBLEAdvertising` object (similar to the `NimBLEScan::start` API).
-
-This provides an opportunity to update the advertisement data if desired.
-
-Also now returns a bool value to indicate if advertising successfully started or not.  
-<br/>
-
-<a name="client"></a>
-# Client
-
-`NimBLERemoteCharacteristic::readValue(time_t\*, bool)`
-`NimBLERemoteDescriptor::readValue(bool)`
-
-Have been added as templates to allow reading the values as any specified type.
-
-**Example**
-```
-struct my_struct{
-    uint8_t  one;
-    uint16_t two;
-    uint32_t four;
-    uint64_t eight;
-    float    flt;
-}myStruct;
-
-    time_t timestamp;
-    myStruct = pRemoteCharacteristic->readValue<myStruct>(&timestamp); // timestamp optional
-```
-<br/>
-
-`NimBLERemoteCharacteristic::registerForNotify`
-Has been **deprecated** as now the internally stored characteristic value is updated when notification/indication is received.
-
-`NimBLERemoteCharacteristic::subscribe` and `NimBLERemoteCharacteristic::unsubscribe` have been implemented to replace it.
-A callback is no longer required to get the most recent value unless timing is important. Instead, the application can call `NimBLERemoteCharacteristic::getValue` to get the last updated value any time.  
-<br/>
-
-The `notify_callback` function is now defined as a `std::function` to take advantage of using `std::bind` to specify a class member function for the callback.
-
-Example:
-```
-using namespace std::placeholders;
-notify_callback callback = std::bind(&<ClassName>::<memberFunctionCallbackName>, this, _1, _2, _3, _4);
-
-<remoteCharacteristicInstance>->subscribe(true, callback);
-```
-
-`NimBLERemoteCharacteristic::readValue` and `NimBLERemoteCharacteristic::getValue` take an optional timestamp parameter which will update it's value with
-the time the last value was received.
-
-> NimBLEClient::getService  
-> NimBLERemoteService::getCharacteristic  
-> NimBLERemoteCharacteristic::getDescriptor
-
-These methods will now check the respective vectors for the attribute object and, if not found, will retrieve (only)
-the specified attribute from the peripheral.
-
-These changes allow more control for the user to manage the resources used for the attributes.  
-<br/>
-
-`NimBLEClient::connect()` can now be called without an address or advertised device parameter. This will connect to the device with the address previously set when last connected or set with `NimBLEDevice::setPeerAddress()`.
-
-<a name="general"></a>
-# General
-To reduce resource use all instances of `std::map` have been replaced with `std::vector`.
-
-Use of `FreeRTOS::Semaphore` has been removed as it was consuming too much ram, the related files have been left in place to accomodate application use.
-
-Operators `==`, `!=` and `std::string` have been added to `NimBLEAddress` and `NimBLEUUID` for easier comparison and logging.
-
-New constructor for `NimBLEUUID(uint32_t, uint16_t, uint16_t, uint64_t)` added to lower memory use vs string construction. See: [#21](https://github.com/h2zero/NimBLE-Arduino/pull/21).
-
-Security/pairing operations are now handled in the respective `NimBLEClientCallbacks` and `NimBLEServerCallbacks` classes, `NimBLESecurity`(deprecated) remains for backward compatibility.
-
-Configuration options have been added to add or remove debugging information, when disabled (default) significantly reduces binary size.
-In ESP-IDF the options are in menuconfig: `Main menu -> ESP-NimBLE-cpp configuration`.  
-For Arduino the options must be commented / uncommented in nimconfig.h.
-
-Characteristics and descriptors now use the `NimBLEAttValue` class to store their data. This is a polymorphic container class capable of converting to/from many different types efficiently. See: [#286](https://github.com/h2zero/NimBLE-Arduino/pull/286)
-

docs/Migration_guide.md

@@ -4,37 +4,40 @@ This guide describes the required changes to existing projects migrating from th
 
 **The changes listed here are only the required changes that must be made**, and a short overview of options for migrating existing applications.
 
-For more information on the improvements and additions please refer to the [class documentation](https://h2zero.github.io/NimBLE-Arduino/annotated.html) and [Improvements and updates](Improvements_and_updates.md)
+For more information on the improvements and additions please refer to the [class documentation](https://h2zero.github.io/esp-nimble-cpp/annotated.html)
 
 * [General Changes](#general-information)
 * [Server](#server-api)
     * [Services](#services)
-    * [characteristics](#characteristics)
-    * [descriptors](#descriptors)
+    * [Characteristics](#characteristics)
+    * [Characteristic Callbacks](#characteristic-callbacks)
+    * [Descriptors](#descriptors)
+    * [Descriptor Callbacks](#descriptor-callbacks)
     * [Security](#server-security)
 * [Advertising](#advertising-api)
 * [Client](#client-api)
     * [Remote Services](#remote-services)
     * [Remote characteristics](#remote-characteristics)
+    * [Client Callbacks](#client-callbacks)
     * [Security](#client-security)
+* [BLE scan](#ble-scan)
 * [General Security](#security-api)
 * [Configuration](#arduino-configuration)
 <br/>
 
-<a name="general-information"></a>
 ## General Information
 
 ### Header Files
 All classes are accessible by including `NimBLEDevice.h` in your application, no further headers need to be included.
 
-(Mainly for Arduino) You may choose to include `NimBLELog.h` in your application if you want to use the `NIMBLE_LOGx` macros for debugging. These macros are used the same way as the `ESP_LOGx` macros.
+(Mainly for Arduino) You may choose to include `NimBLELog.h` in your application if you want to use the `NIMBLE_LOGx` macros for debugging. These macros are used the same way as the `ESP_LOGx` macros.  
 <br/>
 
 ### Class Names
 Class names remain the same as the original with the addition of a "Nim" prefix.
 For example `BLEDevice` is now `NimBLEDevice` and `BLEServer` is now `NimBLEServer` etc.
 
-For convenience definitions have been added to allow applications to use either name for all classes this means **no class names need to be changed in existing code** and makes migrating easier.
+For convenience definitions have been added to allow applications to use either name for all classes this means **no class names need to be changed in existing code** and makes migrating easier.  
 <br/>
 
 ### BLE Addresses
@@ -44,52 +47,70 @@ For example `BLEAddress addr(11:22:33:44:55:66, 1)` will create the address obje
 
 As this parameter is optional no changes to existing code are needed, it is mentioned here for information.
 
-`BLEAddress::getNative` (`NimBLEAddress::getNative`) returns a uint8_t pointer to the native address byte array. In this library the address bytes are stored in reverse order from the original library. This is due to the way the NimBLE stack expects addresses to be presented to it. All other functions such as `toString` are
-not affected as the endian change is made within them.
+`BLEAddress::getNative` is now named `NimBLEAddress::getBase` and returns a pointer to `const ble_addr_t` instead of a pointer to the address value.  
 <br/>
 
-<a name="server-api"></a>
 ## Server API
 Creating a `BLEServer` instance is the same as original, no changes required.
 For example `BLEDevice::createServer()` will work just as it did before.
 
-`BLEServerCallbacks` (`NimBLEServerCallbacks`) has new methods for handling security operations.
-**Note:** All callback methods have default implementations which allows the application to implement only the methods applicable.
+`BLEServerCallbacks` (`NimBLEServerCallbacks`) has new methods for handling security operations.  
+<br/>
+
+`BLEServerCallbacks::onConnect` (`NimBLEServerCallbacks::onConnect`) only has a single callback declaration which takes an additional (required) parameter `NimBLEConnInfo & connInfo`, which has methods to get information about the connected peer.
+```
+void onConnect(NimBLEServer* pServer, NimBLEConnInfo& connInfo)`
+```
+<br/>
+
+`BLEServerCallbacks::onDisconnect` (`NimBLEServerCallbacks::onDisconnect`) only has a single callback declaration which takes 2 additional (required) parameters `NimBLEConnInfo & connInfo`, which provides information about the peer and `int reason`, which gives the reason code for disconnection.
+
+```
+void onDisconnect(NimBLEServer* pServer, NimBLEConnInfo& connInfo, int reason)`
+```
+<br/>
+
+`BLEServerCallbacks::onMtuChanged` is now (`NimBLEServerCallbacks::onMtuChange`) and takes the parameter `NimBLEConnInfo & connInfo` instead of `esp_ble_gatts_cb_param_t`, which has methods to get information about the connected peer.
+
+```
+onMTUChange(uint16_t MTU, NimBLEConnInfo& connInfo)
+```
+
+**Note:** All callback methods have default implementations which allows the application to implement only the methods applicable.  
 <br/>
 
-<a name="services"></a>
 ### Services
 Creating a `BLEService` (`NimBLEService`) instance is the same as original, no changes required.
-For example `BLEServer::createService(SERVICE_UUID)` will work just as it did before.
+For example `BLEServer::createService(SERVICE_UUID)` will work just as it did before.  
+<br/>
 
-<a name="characteristics"></a>
 ### Characteristics
 `BLEService::createCharacteristic` (`NimBLEService::createCharacteristic`) is used the same way as originally except the properties parameter has changed.
 
 When creating a characteristic the properties are now set with `NIMBLE_PROPERTY::XXXX` instead of `BLECharacteristic::XXXX`.
 
 #### Originally
-> BLECharacteristic::PROPERTY_READ |
-> BLECharacteristic::PROPERTY_WRITE
+> BLECharacteristic::PROPERTY_READ |  
+BLECharacteristic::PROPERTY_WRITE
 
 #### Is Now
-> NIMBLE_PROPERTY::READ |
-> NIMBLE_PROPERTY::WRITE
+> NIMBLE_PROPERTY::READ |  
+NIMBLE_PROPERTY::WRITE
 <br/>
 
 #### The full list of properties
-> NIMBLE_PROPERTY::READ
-> NIMBLE_PROPERTY::READ_ENC
-> NIMBLE_PROPERTY::READ_AUTHEN
-> NIMBLE_PROPERTY::READ_AUTHOR
-> NIMBLE_PROPERTY::WRITE
-> NIMBLE_PROPERTY::WRITE_NR
-> NIMBLE_PROPERTY::WRITE_ENC
-> NIMBLE_PROPERTY::WRITE_AUTHEN
-> NIMBLE_PROPERTY::WRITE_AUTHOR
-> NIMBLE_PROPERTY::BROADCAST
-> NIMBLE_PROPERTY::NOTIFY
-> NIMBLE_PROPERTY::INDICATE
+> NIMBLE_PROPERTY::READ  
+NIMBLE_PROPERTY::READ_ENC  
+NIMBLE_PROPERTY::READ_AUTHEN  
+NIMBLE_PROPERTY::READ_AUTHOR  
+NIMBLE_PROPERTY::WRITE  
+NIMBLE_PROPERTY::WRITE_NR  
+NIMBLE_PROPERTY::WRITE_ENC  
+NIMBLE_PROPERTY::WRITE_AUTHEN  
+NIMBLE_PROPERTY::WRITE_AUTHOR  
+NIMBLE_PROPERTY::BROADCAST  
+NIMBLE_PROPERTY::NOTIFY  
+NIMBLE_PROPERTY::INDICATE  
 
 <br/>
 
@@ -112,9 +133,17 @@ BLECharacteristic *pCharacteristic = pService->createCharacteristic(
 ```
 <br/>
 
+#### Characteristic callbacks
+
 `BLECharacteristicCallbacks` (`NimBLECharacteristicCallbacks`) has a new method `NimBLECharacteristicCallbacks::onSubscribe` which is called when a client subscribes to notifications/indications.
 
-**Note:** All callback methods have default implementations which allows the application to implement only the methods applicable.
+`BLECharacteristicCallbacks::onRead` (`NimBLECharacteristicCallbacks::onRead`)  only has a single callback declaration, which takes an additional (required) parameter of `NimBLEConnInfo& connInfo`, which provides connection information about the peer.
+
+`BLECharacteristicCallbacks::onWrite` (`NimBLECharacteristicCallbacks::onWrite`)  only has a single callback declaration, which takes an additional (required) parameter of `NimBLEConnInfo& connInfo`, which provides connection information about the peer.  
+
+`BLECharacteristicCallbacks::onStatus` (`NimBLECharacteristicCallbacks::onStatus`) has had the status parameter removed as it was unnecessary since the status code from the BLE stack was also provided. The status code for success is 0 for notifications and BLE_HS_EDONE for indications, any other value is an error.
+
+**Note:** All callback methods have default implementations which allows the application to implement only the methods applicable.  
 <br/>
 
 > BLECharacteristic::getData
@@ -135,7 +164,6 @@ my_struct_t myStruct = pChr->getValue<my_struct_t>();
 ```
 <br/>
 
-<a name="descriptors"></a>
 ### Descriptors
 
 Descriptors are now created using the `NimBLECharacteristic::createDescriptor` method.
@@ -146,8 +174,7 @@ NimBLE automatically creates the 0x2902 descriptor if a characteristic has a not
 It was no longer useful to have a class for the 0x2902 descriptor as a new callback `NimBLECharacteristicCallbacks::onSubscribe` was added
 to handle callback functionality and the client subscription status is handled internally.
 
-**Note:** Attempting to create a 0x2902 descriptor will trigger an assert to notify the error,
-allowing the creation of it would cause a fault in the NimBLE stack.
+**Note:** Attempting to create a 0x2902 descriptor will trigger a warning message and flag it internally as removed and will not be functional.
 
 All other descriptors are now created just as characteristics are by using the `NimBLECharacteristic::createDescriptor` method (except 0x2904, see below).
 Which are defined as:
@@ -164,7 +191,7 @@ NimBLEDescriptor* createDescriptor(NimBLEUUID uuid,
                                    NIMBLE_PROPERTY::WRITE,
                                    uint16_t max_len = 100);
 ```
-##### Example
+#### Example
 ```
 pDescriptor = pCharacteristic->createDescriptor("ABCD",
                                                 NIMBLE_PROPERTY::READ |
@@ -175,49 +202,46 @@ pDescriptor = pCharacteristic->createDescriptor("ABCD",
 Would create a descriptor with the UUID 0xABCD, publicly readable but only writable if paired/bonded (encrypted) and has a max value length of 25 bytes.
 <br/>
 
-For the 0x2904, there is a special class that is created when you call `createDescriptor("2904").
-
-The pointer returned is of the base class `NimBLEDescriptor` but the call will create the derived class of `NimBLE2904` so you must cast the returned pointer to
-`NimBLE2904` to access the specific class methods.
-
-##### Example
-```
-p2904 = (NimBLE2904*)pCharacteristic->createDescriptor("2904");
-```
+For the 0x2904, there is a specialized class that is created through `NimBLECharacteristic::create2904` which returns a pointer to a `NimBLE2904` instance which has specific 
+functions for handling the data expect in the Characteristic Presentation Format Descriptor specification.  
+<br/>
+
+#### Descriptor callbacks
+
+> `BLEDescriptorCallbacks::onRead` (`NimBLEDescriptorCallbacks::onRead`)
+ `BLEDescriptorCallbacks::onWrite` (`NimBLEDescriptorCallbacks::onWrite`)
+
+The above descriptor callbacks take an additional (required) parameter `NimBLEConnInfo& connInfo`, which contains the connection information of the peer.
 <br/>
 
-<a name="server-security"></a>
 ### Server Security
 Security is set on the characteristic or descriptor properties by applying one of the following:
-> NIMBLE_PROPERTY::READ_ENC
-> NIMBLE_PROPERTY::READ_AUTHEN
-> NIMBLE_PROPERTY::READ_AUTHOR
-> NIMBLE_PROPERTY::WRITE_ENC
-> NIMBLE_PROPERTY::WRITE_AUTHEN
-> NIMBLE_PROPERTY::WRITE_AUTHOR
+> NIMBLE_PROPERTY::READ_ENC  
+NIMBLE_PROPERTY::READ_AUTHEN  
+NIMBLE_PROPERTY::READ_AUTHOR  
+NIMBLE_PROPERTY::WRITE_ENC  
+NIMBLE_PROPERTY::WRITE_AUTHEN  
+NIMBLE_PROPERTY::WRITE_AUTHOR  
 
 <br/>
 
 When a peer wants to read or write a characteristic or descriptor with any of these properties applied it will trigger the pairing process. By default the "just-works" pairing will be performed automatically.
 
-This can be changed to use passkey authentication or numeric comparison. See [Security API](#security-api) for details.
+This can be changed to use passkey authentication or numeric comparison. See [Security API](#security-api) for details.  
 <br/>
 
-<a name="advertising-api"></a>
 ## Advertising API
 Advertising works the same as the original API except:
 
 Calling `NimBLEAdvertising::setAdvertisementData` will entirely replace any data set with `NimBLEAdvertising::addServiceUUID`, or
-`NimBLEAdvertising::setAppearance` or similar methods. You should set all the data you wish to advertise within the `NimBLEAdvertisementData` instead.
+`NimBLEAdvertising::setAppearance` or similar methods. You should set all the data you wish to advertise within the `NimBLEAdvertisementData` instead.  
 <br/>
 
 > BLEAdvertising::start (NimBLEAdvertising::start)
 
-Now takes 2 optional parameters, the first is the duration to advertise for (in seconds), the second is a callback that is invoked when advertising ends and takes a pointer to a `NimBLEAdvertising` object (similar to the `NimBLEScan::start` API).
-This provides an opportunity to update the advertisement data if desired.
+Now takes 2 optional parameters, the first is the duration to advertise for (in milliseconds), the second `NimBLEAddress` to direct advertising to a specific device.  
 <br/>
 
-<a name="client-api"></a>
 ## Client API
 
 Client instances are created just as before with `BLEDevice::createClient` (`NimBLEDevice::createClient`).
@@ -226,70 +250,69 @@ Multiple client instances can be created, up to the maximum number of connection
 
 `BLEClient::connect`(`NimBLEClient::connect`) Has had it's parameters altered.
 Defined as:
-> NimBLEClient::connect(bool deleteServices = true);
-> NimBLEClient::connect(NimBLEAdvertisedDevice\* device, bool deleteServices = true);
-> NimBLEClient::connect(NimBLEAddress address, bool deleteServices = true);
+> NimBLEClient::connect(bool deleteServices = true, , bool asyncConnect = false, bool exchangeMTU = true);  
+> NimBLEClient::connect(const NimBLEAddress& address, bool deleteAttributes = true, bool asyncConnect = false, bool exchangeMTU = true);  
+> NimBLEClient::connect(const NimBLEAdvertisedDevice* device, bool deleteServices = true, bool asyncConnect = false, bool exchangeMTU = true);
 
 The type parameter has been removed and a new bool parameter has been added to indicate if the client should delete the attribute database previously retrieved (if applicable) for the peripheral, default value is true.
 
-If set to false the client will use the attribute database it retrieved from the peripheral when previously connected.
+If set to false the client will use the attribute database it retrieved from the peripheral when previously connected. This allows for faster connections and power saving if the devices dropped connection and are reconnecting.  
 
-This allows for faster connections and power saving if the devices dropped connection and are reconnecting.
+The parameter `bool asyncConnect` if true, will cause the client to send the connect command to the stack and return immediately without blocking. The return value will represent wether the command was sent successfully or not and the `NimBLEClientCallbacks::onConnect` or `NimBLEClientCallbacks::onConnectFail` will be called when the operation is complete.  
+
+The parameter `bool exchangeMTU` if true, will cause the client to perform the exchange MTU process upon connecting. If false the MTU exchange will need to be performed by the application by calling `NimBLEClient::exchangeMTU`. If the connection is only sending small payloads it may be advantageous to not exchange the MTU to gain performance in the connection process.  
 <br/>
 
 > `BLEClient::getServices` (`NimBLEClient::getServices`)
 
 This method now takes an optional (bool) parameter to indicate if the services should be retrieved from the server (true) or the currently known database returned (false : default).
-Also now returns a pointer to `std::vector` instead of `std::map`.
+Also now returns a pointer to `std::vector` instead of `std::map`.  
 <br/>
 
 **Removed:** the automatic discovery of all peripheral attributes as they consumed time and resources for data the user may not be interested in.
 
-**Added:** `NimBLEClient::discoverAttributes` for the user to discover all the peripheral attributes to replace the the removed automatic functionality.
+**Added:** `NimBLEClient::discoverAttributes` for the user to discover all the peripheral attributes to replace the the removed automatic functionality.  
 <br/>
 
-<a name="remote-services"></a>
 ### Remote Services
 `BLERemoteService` (`NimBLERemoteService`) Methods remain mostly unchanged with the exceptions of:
 
 > BLERemoteService::getCharacteristicsByHandle
 
-This method has been removed.
+This method has been removed.  
 <br/>
 
 > `BLERemoteService::getCharacteristics` (`NimBLERemoteService::getCharacteristics`)
 
-This method now takes an optional (bool) parameter to indicate if the characteristics should be retrieved from the server (true) or
-the currently known database returned (false : default).
-Also now returns a pointer to `std::vector` instead of `std::map`.
+This method now takes an optional (bool) parameter to indicate if the characteristics should be retrieved from the server (true) or the currently known database returned, default = false.  
+Also now returns a pointer to `std::vector` instead of `std::map`.  
 <br/>
 
-<a name="remote-characteristics"></a>
 ### Remote Characteristics
 `BLERemoteCharacteristic` (`NimBLERemoteCharacteristic`)
  There have been a few changes to the methods in this class:
 
 > `BLERemoteCharacteristic::writeValue` (`NimBLERemoteCharacteristic::writeValue`)
-> `BLERemoteCharacteristic::registerForNotify` (`NimBLERemoteCharacteristic::registerForNotify`)
 
-Now return true or false to indicate success or failure so you can choose to disconnect or try again.
+Now returns true or false to indicate success or failure so you can choose to disconnect or try again.  
 <br/>
 
-> `BLERemoteCharacteristic::registerForNotify` (`NimBLERemoteCharacteristic::registerForNotify`)
+> `BLERemoteCharacteristic::registerForNotify`
 
-Is now **deprecated**.
-> `NimBLERemoteCharacteristic::subscribe`
-> `NimBLERemoteCharacteristic::unsubscribe`
+Has been removed.
 
-Are the new methods added to replace it.
+> `NimBLERemoteCharacteristic::subscribe`  
+> `NimBLERemoteCharacteristic::unsubscribe`  
+
+Are the new methods added to replace it.  
 <br/>
 
-> `BLERemoteCharacteristic::readUInt8` (`NimBLERemoteCharacteristic::readUInt8`)
-> `BLERemoteCharacteristic::readUInt16` (`NimBLERemoteCharacteristic::readUInt16`)
-> `BLERemoteCharacteristic::readUInt32` (`NimBLERemoteCharacteristic::readUInt32`)
+> `BLERemoteCharacteristic::readUInt8` (`NimBLERemoteCharacteristic::readUInt8`)  
+> `BLERemoteCharacteristic::readUInt16` (`NimBLERemoteCharacteristic::readUInt16`)  
+> `BLERemoteCharacteristic::readUInt32` (`NimBLERemoteCharacteristic::readUInt32`)  
 > `BLERemoteCharacteristic::readFloat` (`NimBLERemoteCharacteristic::readFloat`)
 
-Are **deprecated** a template: `NimBLERemoteCharacteristic::readValue<type\>(time_t\*, bool)` has been added to replace them.
+Are **removed** a template: `NimBLERemoteCharacteristic::readValue<type\>(time_t\*, bool)` has been added to replace them.  
 <br/>
 
 > `BLERemoteCharacteristic::readRawData`
@@ -297,10 +320,10 @@ Are **deprecated** a template: `NimBLERemoteCharacteristic::readValue<type\>(tim
 **Has been removed from the API**
 Originally it stored an unnecessary copy of the data and was returning a `uint8_t` pointer to volatile internal data.
 The user application should use `NimBLERemoteCharacteristic::readValue` or `NimBLERemoteCharacteristic::getValue`.
-To obtain a copy of the data, then cast the returned std::string to the type required such as:
+To obtain a copy of the data as a `NimBLEAttValue` instance and use the `NimBLEAttValue::data` member function to obtain the pointer.
 ```
-std::string value = pChr->readValue();
-uint8_t *data = (uint8_t*)value.data();
+NimBLEAttValue value = pChr->readValue();
+const uint8_t *data = value.data();
 ```
 Alternatively use the `readValue` template:
 ```
@@ -310,70 +333,85 @@ my_struct_t myStruct = pChr->readValue<my_struct_t>();
 
 > `BLERemoteCharacteristic::getDescriptors` (`NimBLERemoteCharacteristic::getDescriptors`)
 
-This method now takes an optional (bool) parameter to indicate if the descriptors should be retrieved from the server (true) or
-the currently known database returned (false : default).
-Also now returns a pointer to `std::vector` instead of `std::map`.
+This method now takes an optional (bool) parameter to indicate if the descriptors should be retrieved from the server (true) or the currently known database returned, default = false.
+Also now returns a pointer to `std::vector` instead of `std::map`.  
+<br/>
+
+### Client callbacks
+
+> `BLEClientCallbacks::onDisconnect` (`NimBLEClientCallbacks::onDisconnect`)
+
+This now takes a second parameter `int reason` which provides the reason code for disconnection.  
 <br/>
 
-<a name="client-security"></a>
 ### Client Security
 The client will automatically initiate security when the peripheral responds that it's required.
-The default configuration will use "just-works" pairing with no bonding, if you wish to enable bonding see below.
+The default configuration will use "just-works" pairing with no bonding, if you wish to enable bonding see below.  
 <br/>
 
-<a name="security-api"></a>
-## Security API
-Security operations have been moved to `BLEDevice` (`NimBLEDevice`).
+## BLE Scan
+The scan API is mostly unchanged from the original except for `NimBLEScan::start`, which has the following changes:  
+* The duration parameter is now in milliseconds instead of seconds.
+* The callback parameter has been removed.
+* A new parameter `bool restart` has been added, when set to true to restart the scan if already in progress and clear the duplicate cache.
 
-Also security callback methods are now incorporated in the `NimBLEServerCallbacks` / `NimBLEClientCallbacks` classes.
-However backward compatibility with the original `BLESecurity` (`NimBLESecurity`) class is retained to minimize application code changes.
+ The blocking overload of `NimBLEScan::start` has been replaced by an overload of `NimBLEScan::getResults` with the same parameters. 
+<br/>
+
+## Security API
+Security operations have been moved to `BLEDevice` (`NimBLEDevice`).  
+The security callback methods are now incorporated in the `NimBLEServerCallbacks` / `NimBLEClientCallbacks` classes.
 
 The callback methods are:
 
-> `bool onConfirmPIN(uint32_t pin)`
+> `bool onConfirmPasskey(NimBLEConnInfo& connInfo, uint32_t pin)`
 
-Receives the pin when using numeric comparison authentication, `return true;` to accept.
+Receives the pin when using numeric comparison authentication.
+Call `NimBLEDevice::injectConfirmPasskey(connInfo, true);` to accept or `NimBLEDevice::injectConfirmPasskey(connInfo, false);` to reject.
 <br/>
 
-> `uint32_t onPassKeyRequest()`
+> `void onPassKeyEntry(NimBLEConnInfo& connInfo)`
 
-For server callback; return the passkey expected from the client.
-For client callback; return the passkey to send to the server.
+Client callback; client should respond with the passkey (pin) by calling `NimBLEDevice::injectPassKey(connInfo, 123456);`
 <br/>
 
-> `void onAuthenticationComplete(ble_gap_conn_desc\* desc)`
+> `uint32_t onPassKeyDisplay()`
 
-Authentication complete, success or failed information is in `desc`.
+Server callback; should return the passkey (pin) expected from the client.
+<br/>
+
+> `void onAuthenticationComplete(NimBLEConnInfo& connInfo)`
+
+Authentication complete, success or failed information is available from the `NimBLEConnInfo` methods.  
 <br/>
 
 Security settings and IO capabilities are now set by the following methods of NimBLEDevice.
 > `NimBLEDevice::setSecurityAuth(bool bonding, bool mitm, bool sc)`
 > `NimBLEDevice::setSecurityAuth(uint8_t auth_req)`
 
-Sets the authorization mode for this device.
+Sets the authorization mode for this device.  
 <br/>
 
 > `NimBLEDevice::setSecurityIOCap(uint8_t iocap)`
 
-Sets the Input/Output capabilities of this device.
+Sets the Input/Output capabilities of this device.  
 <br/>
 
 > `NimBLEDevice::setSecurityInitKey(uint8_t init_key)`
 
-If we are the initiator of the security procedure this sets the keys we will distribute.
+If we are the initiator of the security procedure this sets the keys we will distribute.  
 <br/>
 
 > `NimBLEDevice::setSecurityRespKey(uint8_t resp_key)`
 
-Sets the keys we are willing to accept from the peer during pairing.
+Sets the keys we are willing to accept from the peer during pairing.  
 <br/>
 
-<a name="arduino-configuration"></a>
 ## Arduino Configuration
 
 Unlike the original library pre-packaged in the esp32-arduino, this library has all the configuration options that are normally set in menuconfig available in the *src/nimconfig.h* file.
 
 This allows Arduino users to fully customize the build, such as increasing max connections or loading the BLE stack into external PSRAM.
 
-For details on the options, they are fully commented in *nimconfig.h*
+For details on the options, they are fully commented in *nimconfig.h*  
 <br/>

docs/New_user_guide.md

@@ -21,7 +21,6 @@ If you're not creating a server or do not want to advertise a name, simply pass
 This can be called any time you wish to use BLE functions and does not need to be called from app_main(IDF) or setup(Arduino) but usually is.  
 <br/>
 
-<a name="creating-a-server"></a>
 ## Creating a Server
 BLE servers perform 2 tasks, they advertise their existence for clients to find them and they provide services which contain information for the connecting client.  
 
@@ -137,7 +136,6 @@ Now if you scan with your phone using nRFConnect or any other BLE app you should
 For more advanced features and options please see the server examples in the examples folder.  
 <br/>
 
-<a name="creating-a-client"></a>
 ## Creating a Client 
 
 BLE clients perform 2 tasks, they scan for advertising servers and form connections to them to read and write to their characteristics/descriptors.
@@ -146,7 +144,7 @@ After initializing the NimBLE stack we create a scan instance by calling `NimBLE
 
 Once we have created the scan we can start looking for advertising servers.  
 
-To do this we call `NimBLEScan::start(duration)`, the duration parameter is a uint32_t that specifies the number of seconds to scan for,  
+To do this we call `NimBLEScan::start(duration)`, the duration parameter is a uint32_t that specifies the number of milliseconds to scan for,  
 passing 0 will scan forever.  
 
 In this example we will scan for 10 seconds. This is a blocking function (a non blocking overload is also available).  
@@ -162,7 +160,7 @@ void app_main(void)
     NimBLEDevice::init("");
     
     NimBLEScan *pScan = NimBLEDevice::getScan();
-    NimBLEScanResults results = pScan->start(10);
+    NimBLEScanResults results = pScan->getResults(10 * 1000);
 }
 ```
 <br/>
@@ -302,7 +300,7 @@ void app_main(void)
     NimBLEDevice::init("");
     
     NimBLEScan *pScan = NimBLEDevice::getScan();
-    NimBLEScanResults results = pScan->start(10);
+    NimBLEScanResults results = pScan->start(10 * 1000);
     
     NimBLEUUID serviceUuid("ABCD");
     

docs/index.md

@@ -14,7 +14,7 @@ It is more suited to resource constrained devices than bluedroid and has now bee
 <br/>
 
 # ESP-IDF Installation
-### v4.0+
+## v4.0+
 Download as .zip and extract or clone into the components folder in your esp-idf project.
 
 Run menuconfig, go to `Component config->Bluetooth` enable Bluetooth and in `Bluetooth host` NimBLE.  
@@ -38,9 +38,7 @@ This library is intended to be compatible with the original ESP32 BLE functions
 
 If you have not used the original Bluedroid library please refer to the [New user guide](New_user_guide.md).
 
-If you are familiar with the original library, see: [The migration guide](Migration_guide.md) for details.  
-
-Also see [Improvements and updates](Improvements_and_updates.md) for information about non-breaking changes.  
+If you are familiar with the original library, see: [The migration guide](Migration_guide.md) for details.   
 
 For more advanced usage see [Usage tips](Usage_tips.md) for more performance and optimization.  
 <br/>

examples/Advanced/NimBLE_Client/Makefile

@@ -1,3 +0,0 @@
-PROJECT_NAME := NimBLE_Client
-
-include $(IDF_PATH)/make/project.mk

examples/Advanced/NimBLE_Client/main/component.mk

@@ -1,4 +0,0 @@
-#
-# "main" pseudo-component makefile.
-#
-# (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.)

examples/Advanced/NimBLE_Client/main/main.cpp

@@ -1,372 +0,0 @@
-
-/** NimBLE_Server Demo:
- *
- *  Demonstrates many of the available features of the NimBLE client library.
- *  
- *  Created: on March 24 2020
- *      Author: H2zero
- * 
-*/
-#include <NimBLEDevice.h>
-
-extern "C" {void app_main(void);}
-
-void scanEndedCB(NimBLEScanResults results);
-
-static NimBLEAdvertisedDevice* advDevice;
-
-static bool doConnect = false;
-static uint32_t scanTime = 0; /** 0 = scan forever */
-
-
-/**  None of these are required as they will be handled by the library with defaults. **
- **                       Remove as you see fit for your needs                        */  
-class ClientCallbacks : public NimBLEClientCallbacks {
-    void onConnect(NimBLEClient* pClient) {
-        printf("Connected\n");
-        /** After connection we should change the parameters if we don't need fast response times.
-         *  These settings are 150ms interval, 0 latency, 450ms timout. 
-         *  Timeout should be a multiple of the interval, minimum is 100ms.
-         *  I find a multiple of 3-5 * the interval works best for quick response/reconnect.
-         *  Min interval: 120 * 1.25ms = 150, Max interval: 120 * 1.25ms = 150, 0 latency, 45 * 10ms = 450ms timeout 
-         */
-        pClient->updateConnParams(120,120,0,45);
-    };
-
-    void onDisconnect(NimBLEClient* pClient) {
-        printf("%s Disconnected - Starting scan\n", pClient->getPeerAddress().toString().c_str());
-        NimBLEDevice::getScan()->start(scanTime, scanEndedCB);
-    };
-    
-    /********************* Security handled here **********************
-    ****** Note: these are the same return values as defaults ********/
-    uint32_t onPassKeyRequest(){
-        printf("Client Passkey Request\n");
-        /** return the passkey to send to the server */
-        return 123456;
-    };
-
-    bool onConfirmPIN(uint32_t pass_key){
-        printf("The passkey YES/NO number: %d\n", pass_key);
-    /** Return false if passkeys don't match. */
-        return true;
-    };
-
-    /** Pairing process complete, we can check the results in ble_gap_conn_desc */
-    void onAuthenticationComplete(ble_gap_conn_desc* desc){
-        if(!desc->sec_state.encrypted) {
-            printf("Encrypt connection failed - disconnecting\n");
-            /** Find the client with the connection handle provided in desc */
-            NimBLEDevice::getClientByID(desc->conn_handle)->disconnect();
-            return;
-        }
-    };
-};
-
-
-/** Define a class to handle the callbacks when advertisments are received */
-class AdvertisedDeviceCallbacks: public NimBLEAdvertisedDeviceCallbacks {
-    
-    void onResult(NimBLEAdvertisedDevice* advertisedDevice) {
-        printf("Advertised Device found: %s\n", advertisedDevice->toString().c_str());
-        if(advertisedDevice->isAdvertisingService(NimBLEUUID("DEAD")))
-        {
-            printf("Found Our Service\n");
-            /** stop scan before connecting */
-            NimBLEDevice::getScan()->stop();
-            /** Save the device reference in a global for the client to use*/ 
-            advDevice = advertisedDevice;
-            /** Ready to connect now */ 
-            doConnect = true;
-        }
-    };
-};
-
-
-/** Notification / Indication receiving handler callback */
-void notifyCB(NimBLERemoteCharacteristic* pRemoteCharacteristic, uint8_t* pData, size_t length, bool isNotify){
-    std::string str = (isNotify == true) ? "Notification" : "Indication"; 
-    str += " from ";
-    str += pRemoteCharacteristic->getRemoteService()->getClient()->getPeerAddress().toString();
-    str += ": Service = " + pRemoteCharacteristic->getRemoteService()->getUUID().toString();
-    str += ", Characteristic = " + pRemoteCharacteristic->getUUID().toString();
-    str += ", Value = " + std::string((char*)pData, length);
-    printf("%s\n", str.c_str());
-}
-
-/** Callback to process the results of the last scan or restart it */
-void scanEndedCB(NimBLEScanResults results){
-    printf("Scan Ended\n");
-}
-
-
-/** Create a single global instance of the callback class to be used by all clients */
-static ClientCallbacks clientCB;
-
-
-/** Handles the provisioning of clients and connects / interfaces with the server */
-bool connectToServer() {
-    NimBLEClient* pClient = nullptr;
-    
-    /** Check if we have a client we should reuse first **/
-    if(NimBLEDevice::getClientListSize()) {
-        /** Special case when we already know this device, we send false as the 
-         *  second argument in connect() to prevent refreshing the service database.
-         *  This saves considerable time and power.
-         */
-        pClient = NimBLEDevice::getClientByPeerAddress(advDevice->getAddress());
-        if(pClient){
-            if(!pClient->connect(advDevice, false)) {
-                printf("Reconnect failed\n");
-                return false;
-            }
-            printf("Reconnected client\n");
-        } 
-        /** We don't already have a client that knows this device,
-         *  we will check for a client that is disconnected that we can use.
-         */
-        else {
-            pClient = NimBLEDevice::getDisconnectedClient();
-        }
-    }
-    
-    /** No client to reuse? Create a new one. */
-    if(!pClient) {
-        if(NimBLEDevice::getClientListSize() >= NIMBLE_MAX_CONNECTIONS) {
-            printf("Max clients reached - no more connections available\n");
-            return false;
-        }
-        
-        pClient = NimBLEDevice::createClient();
-        
-        printf("New client created\n");
-    
-        pClient->setClientCallbacks(&clientCB, false);
-        /** Set initial connection parameters: These settings are 15ms interval, 0 latency, 120ms timout. 
-         *  These settings are safe for 3 clients to connect reliably, can go faster if you have less 
-         *  connections. Timeout should be a multiple of the interval, minimum is 100ms.
-         *  Min interval: 12 * 1.25ms = 15, Max interval: 12 * 1.25ms = 15, 0 latency, 12 * 10ms = 120ms timeout 
-         */
-        pClient->setConnectionParams(6,6,0,15);
-        /** Set how long we are willing to wait for the connection to complete (seconds), default is 30. */
-        pClient->setConnectTimeout(5);
-        
-
-        if (!pClient->connect(advDevice)) {
-            /** Created a client but failed to connect, don't need to keep it as it has no data */
-            NimBLEDevice::deleteClient(pClient);
-            printf("Failed to connect, deleted client\n");
-            return false;
-        }
-    }         
-    
-    if(!pClient->isConnected()) {
-        if (!pClient->connect(advDevice)) {
-            printf("Failed to connect\n");
-            return false;
-        }
-    }
-    
-    printf("Connected to: %s RSSI: %d\n", 
-          pClient->getPeerAddress().toString().c_str(),
-          pClient->getRssi());
-    
-    /** Now we can read/write/subscribe the charateristics of the services we are interested in */
-    NimBLERemoteService* pSvc = nullptr;
-    NimBLERemoteCharacteristic* pChr = nullptr;
-    NimBLERemoteDescriptor* pDsc = nullptr;
-    
-    pSvc = pClient->getService("DEAD");
-    if(pSvc) {     /** make sure it's not null */
-        pChr = pSvc->getCharacteristic("BEEF");
-    }
-
-    if(pChr) {     /** make sure it's not null */
-        if(pChr->canRead()) {
-            printf("%s Value: %s\n",
-            pChr->getUUID().toString().c_str(),
-            pChr->readValue().c_str());
-        }
-        
-        if(pChr->canWrite()) {
-            if(pChr->writeValue("Tasty")) {
-                printf("Wrote new value to: %s\n", pChr->getUUID().toString().c_str());
-            }
-            else {
-                /** Disconnect if write failed */ 
-                pClient->disconnect();
-                return false;
-            }
-            
-            if(pChr->canRead()) {
-                printf("The value of: %s is now: %s\n",
-                       pChr->getUUID().toString().c_str(),
-                       pChr->readValue().c_str());
-            }
-        }
-        
-        /** registerForNotify() has been deprecated and replaced with subscribe() / unsubscribe().
-         *  Subscribe parameter defaults are: notifications=true, notifyCallback=nullptr, response=false.
-         *  Unsubscribe parameter defaults are: response=false. 
-         */
-        if(pChr->canNotify()) {
-            //if(!pChr->registerForNotify(notifyCB)) {
-            if(!pChr->subscribe(true, notifyCB)) {
-                /** Disconnect if subscribe failed */ 
-                pClient->disconnect();
-                return false;
-            }
-        }
-        else if(pChr->canIndicate()) {
-            /** Send false as first argument to subscribe to indications instead of notifications */
-            //if(!pChr->registerForNotify(notifyCB, false)) {
-            if(!pChr->subscribe(false, notifyCB)) {
-                /** Disconnect if subscribe failed */ 
-                pClient->disconnect();
-                return false;
-            }
-        }
-    }
-    
-    else{
-        printf("DEAD service not found.\n");
-    }
-    
-    pSvc = pClient->getService("BAAD");
-    if(pSvc) {     /** make sure it's not null */
-        pChr = pSvc->getCharacteristic("F00D");
-    }
-
-    if(pChr) {     /** make sure it's not null */
-        if(pChr->canRead()) {
-            printf("%s Value: %s\n",
-            pChr->getUUID().toString().c_str(),
-            pChr->readValue().c_str());
-        }
-        
-        pDsc = pChr->getDescriptor(NimBLEUUID("C01D"));
-        if(pDsc) {   /** make sure it's not null */
-            printf("Descriptor: %s  Value: %s\n",
-                   pDsc->getUUID().toString().c_str(),
-                   pDsc->readValue().c_str());
-        }
-        
-        if(pChr->canWrite()) {
-            if(pChr->writeValue("No tip!")) {
-                printf("Wrote new value to: %s\n", pChr->getUUID().toString().c_str());
-            }
-            else {
-                /** Disconnect if write failed */ 
-                pClient->disconnect();
-                return false;
-            }
-            
-            if(pChr->canRead()) {
-                printf("The value of: %s is now: %s\n",
-                       pChr->getUUID().toString().c_str(),
-                       pChr->readValue().c_str());
-            }
-        }
-        
-        /** registerForNotify() has been deprecated and replaced with subscribe() / unsubscribe().
-         *  Subscribe parameter defaults are: notifications=true, notifyCallback=nullptr, response=false.
-         *  Unsubscribe parameter defaults are: response=false. 
-         */
-        if(pChr->canNotify()) {
-            //if(!pChr->registerForNotify(notifyCB)) {
-            if(!pChr->subscribe(true, notifyCB)) {
-                /** Disconnect if subscribe failed */ 
-                pClient->disconnect();
-                return false;
-            }
-        }
-        else if(pChr->canIndicate()) {
-            /** Send false as first argument to subscribe to indications instead of notifications */
-            //if(!pChr->registerForNotify(notifyCB, false)) {
-            if(!pChr->subscribe(false, notifyCB)) {
-                /** Disconnect if subscribe failed */ 
-                pClient->disconnect();
-                return false;
-            }
-        }    
-    }        
-
-    else{
-        printf("BAAD service not found.\n");
-    }
-    
-    printf("Done with this device!\n");
-    return true;
-}
-
-void connectTask (void * parameter){
-    /** Loop here until we find a device we want to connect to */
-    for(;;) {
-        if(doConnect) {
-            doConnect = false;
-            /** Found a device we want to connect to, do it now */
-            if(connectToServer()) {
-                printf("Success! we should now be getting notifications, scanning for more!\n");
-            } else {
-                printf("Failed to connect, starting scan\n");
-            }
-    
-            NimBLEDevice::getScan()->start(scanTime,scanEndedCB);
-        }
-        vTaskDelay(10/portTICK_PERIOD_MS);
-    }
-    
-    vTaskDelete(NULL);
-}
-
-void app_main (void){
-    printf("Starting NimBLE Client\n");
-    /** Initialize NimBLE, no device name spcified as we are not advertising */
-    NimBLEDevice::init("");
-    
-    /** Set the IO capabilities of the device, each option will trigger a different pairing method.
-     *  BLE_HS_IO_KEYBOARD_ONLY    - Passkey pairing
-     *  BLE_HS_IO_DISPLAY_YESNO   - Numeric comparison pairing
-     *  BLE_HS_IO_NO_INPUT_OUTPUT - DEFAULT setting - just works pairing
-     */
-    //NimBLEDevice::setSecurityIOCap(BLE_HS_IO_KEYBOARD_ONLY); // use passkey
-    //NimBLEDevice::setSecurityIOCap(BLE_HS_IO_DISPLAY_YESNO); //use numeric comparison
-  
-    /** 2 different ways to set security - both calls achieve the same result.
-     *  no bonding, no man in the middle protection, secure connections.
-     *     
-     *  These are the default values, only shown here for demonstration.   
-     */ 
-    //NimBLEDevice::setSecurityAuth(false, false, true); 
-    NimBLEDevice::setSecurityAuth(/*BLE_SM_PAIR_AUTHREQ_BOND | BLE_SM_PAIR_AUTHREQ_MITM |*/ BLE_SM_PAIR_AUTHREQ_SC);
-  
-    /** Optional: set the transmit power, default is -3db */
-    NimBLEDevice::setPower(ESP_PWR_LVL_P9); /** 12db */
-    
-    /** Optional: set any devices you don't want to get advertisments from */
-    // NimBLEDevice::addIgnored(NimBLEAddress ("aa:bb:cc:dd:ee:ff")); 
-  
-    /** create new scan */  
-    NimBLEScan* pScan = NimBLEDevice::getScan(); 
-    
-    /** create a callback that gets called when advertisers are found */
-    pScan->setAdvertisedDeviceCallbacks(new AdvertisedDeviceCallbacks());
-    
-    /** Set scan interval (how often) and window (how long) in milliseconds */
-    pScan->setInterval(400);
-    pScan->setWindow(100);
-    
-    /** Active scan will gather scan response data from advertisers
-     *  but will use more energy from both devices
-     */
-    pScan->setActiveScan(true);
-    /** Start scanning for advertisers for the scan time specified (in seconds) 0 = forever
-     *  Optional callback for when scanning stops. 
-     */
-    pScan->start(scanTime, scanEndedCB);
-    
-    printf("Scanning for peripherals\n");
-    
-    xTaskCreate(connectTask, "connectTask", 5000, NULL, 1, NULL);
-}
-

examples/Advanced/NimBLE_Server/Makefile

@@ -1,3 +0,0 @@
-PROJECT_NAME := NimBLE_Server
-
-include $(IDF_PATH)/make/project.mk

examples/Advanced/NimBLE_Server/main/component.mk

@@ -1,4 +0,0 @@
-#
-# "main" pseudo-component makefile.
-#
-# (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.)

examples/Advanced/NimBLE_Server/main/main.cpp

@@ -1,229 +0,0 @@
-
-/** NimBLE_Server Demo:
- *
- *  Demonstrates many of the available features of the NimBLE server library.
- *  
- *  Created: on March 22 2020
- *      Author: H2zero
- * 
-*/
-#include "NimBLEDevice.h"
-#include "NimBLELog.h"
-
-#include <stdio.h>
-
-extern "C" {void app_main(void);}
-
-static NimBLEServer* pServer;
-
-/**  None of these are required as they will be handled by the library with defaults. **
- **                       Remove as you see fit for your needs                        */  
-class ServerCallbacks: public NimBLEServerCallbacks {
-    void onConnect(NimBLEServer* pServer) {
-        printf("Client connected\n");
-        NimBLEDevice::startAdvertising();
-    };
-    /** Alternative onConnect() method to extract details of the connection. 
-     *  See: src/ble_gap.h for the details of the ble_gap_conn_desc struct.
-     */  
-    void onConnect(NimBLEServer* pServer, ble_gap_conn_desc* desc) {
-        printf("Client address: %s\n", NimBLEAddress(desc->peer_ota_addr).toString().c_str());
-        /** We can use the connection handle here to ask for different connection parameters.
-         *  Args: connection handle, min connection interval, max connection interval
-         *  latency, supervision timeout.
-         *  Units; Min/Max Intervals: 1.25 millisecond increments.
-         *  Latency: number of intervals allowed to skip.
-         *  Timeout: 10 millisecond increments, try for 3x interval time for best results.  
-         */
-        pServer->updateConnParams(desc->conn_handle, 24, 48, 0, 18);
-    };
-    void onDisconnect(NimBLEServer* pServer) {
-        printf("Client disconnected - start advertising\n");
-        NimBLEDevice::startAdvertising();
-    };
-    void onMTUChange(uint16_t MTU, ble_gap_conn_desc* desc) {
-        printf("MTU updated: %u for connection ID: %u\n", MTU, desc->conn_handle);
-    };
-    
-/********************* Security handled here **********************
-****** Note: these are the same return values as defaults ********/
-    uint32_t onPassKeyRequest(){
-        printf("Server Passkey Request\n");
-        /** This should return a random 6 digit number for security 
-         *  or make your own static passkey as done here.
-         */
-        return 123456; 
-    };
-
-    bool onConfirmPIN(uint32_t pass_key){
-        printf("The passkey YES/NO number: %d\n", pass_key);
-        /** Return false if passkeys don't match. */
-        return true; 
-    };
-
-    void onAuthenticationComplete(ble_gap_conn_desc* desc){
-        /** Check that encryption was successful, if not we disconnect the client */  
-        if(!desc->sec_state.encrypted) {
-            /** NOTE: createServer returns the current server reference unless one is not already created */
-            NimBLEDevice::createServer()->disconnect(desc->conn_handle);
-            printf("Encrypt connection failed - disconnecting client\n");
-            return;
-        }
-        printf("Starting BLE work!");
-    };
-};
-
-/** Handler class for characteristic actions */
-class CharacteristicCallbacks: public NimBLECharacteristicCallbacks {
-    void onRead(NimBLECharacteristic* pCharacteristic){
-        printf("%s : onRead(), value: %s\n", 
-                            pCharacteristic->getUUID().toString().c_str(),
-                            pCharacteristic->getValue().c_str());
-    };
-
-    void onWrite(NimBLECharacteristic* pCharacteristic) {
-        printf("%s : onWrite(), value: %s\n", 
-                            pCharacteristic->getUUID().toString().c_str(),
-                            pCharacteristic->getValue().c_str());
-    };
-    /** Called before notification or indication is sent, 
-     *  the value can be changed here before sending if desired.
-     */
-    void onNotify(NimBLECharacteristic* pCharacteristic) {
-        printf("Sending notification to clients\n");
-    };
-
-
-    /** The status returned in status is defined in NimBLECharacteristic.h.
-     *  The value returned in code is the NimBLE host return code.
-     */
-    void onStatus(NimBLECharacteristic* pCharacteristic, Status status, int code) {
-        printf("Notification/Indication status code: %d , return code: %d, %s\n",
-                            status,
-                            code,
-                            NimBLEUtils::returnCodeToString(code));
-    };
-};
-    
-/** Handler class for descriptor actions */    
-class DescriptorCallbacks : public NimBLEDescriptorCallbacks {
-    void onWrite(NimBLEDescriptor* pDescriptor) {
-        std::string dscVal((char*)pDescriptor->getValue(), pDescriptor->getLength());
-        printf("Descriptor witten value: %s\n", dscVal.c_str());
-    };
-
-    void onRead(NimBLEDescriptor* pDescriptor) {
-        printf("%s Descriptor read\n", pDescriptor->getUUID().toString().c_str());
-    };;
-};
-
-
-/** Define callback instances globally to use for multiple Charateristics \ Descriptors */ 
-static DescriptorCallbacks dscCallbacks;
-static CharacteristicCallbacks chrCallbacks;
-
-void notifyTask(void * parameter){
-    for(;;) {
-        if(pServer->getConnectedCount()) {
-            NimBLEService* pSvc = pServer->getServiceByUUID("BAAD");
-            if(pSvc) {
-                NimBLECharacteristic* pChr = pSvc->getCharacteristic("F00D");
-                if(pChr) {
-                    pChr->notify(true);
-                }
-            }
-        }
-        vTaskDelay(2000/portTICK_PERIOD_MS);
-    }
-    
-    vTaskDelete(NULL);
-}
-
-void app_main(void) {
-    printf("Starting NimBLE Server\n");
-
-    /** sets device name */
-    NimBLEDevice::init("NimBLE");
-
-    /** Set the IO capabilities of the device, each option will trigger a different pairing method.
-     *  BLE_HS_IO_DISPLAY_ONLY    - Passkey pairing
-     *  BLE_HS_IO_DISPLAY_YESNO   - Numeric comparison pairing
-     *  BLE_HS_IO_NO_INPUT_OUTPUT - DEFAULT setting - just works pairing
-     */
-    //NimBLEDevice::setSecurityIOCap(BLE_HS_IO_DISPLAY_ONLY); // use passkey
-    //NimBLEDevice::setSecurityIOCap(BLE_HS_IO_DISPLAY_YESNO); //use numeric comparison
-
-    /** 2 different ways to set security - both calls achieve the same result.
-     *  no bonding, no man in the middle protection, secure connections.
-     *   
-     *  These are the default values, only shown here for demonstration.   
-     */ 
-    //NimBLEDevice::setSecurityAuth(false, false, true); 
-    NimBLEDevice::setSecurityAuth(/*BLE_SM_PAIR_AUTHREQ_BOND | BLE_SM_PAIR_AUTHREQ_MITM |*/ BLE_SM_PAIR_AUTHREQ_SC);
-
-    pServer = NimBLEDevice::createServer();
-    pServer->setCallbacks(new ServerCallbacks());
-
-    NimBLEService* pDeadService = pServer->createService("DEAD");
-    NimBLECharacteristic* pBeefCharacteristic = pDeadService->createCharacteristic(
-                                               "BEEF",
-                                               NIMBLE_PROPERTY::READ |
-                                               NIMBLE_PROPERTY::WRITE |
-                               /** Require a secure connection for read and write access */
-                                               NIMBLE_PROPERTY::READ_ENC |  // only allow reading if paired / encrypted
-                                               NIMBLE_PROPERTY::WRITE_ENC   // only allow writing if paired / encrypted
-                                              );
-  
-    pBeefCharacteristic->setValue("Burger");
-    pBeefCharacteristic->setCallbacks(&chrCallbacks);
-
-    /** 2902 and 2904 descriptors are a special case, when createDescriptor is called with
-     *  either of those uuid's it will create the associated class with the correct properties
-     *  and sizes. However we must cast the returned reference to the correct type as the method
-     *  only returns a pointer to the base NimBLEDescriptor class.
-     */
-    NimBLE2904* pBeef2904 = (NimBLE2904*)pBeefCharacteristic->createDescriptor("2904"); 
-    pBeef2904->setFormat(NimBLE2904::FORMAT_UTF8);
-    pBeef2904->setCallbacks(&dscCallbacks);
-  
-
-    NimBLEService* pBaadService = pServer->createService("BAAD");
-    NimBLECharacteristic* pFoodCharacteristic = pBaadService->createCharacteristic(
-                                               "F00D",
-                                               NIMBLE_PROPERTY::READ |
-                                               NIMBLE_PROPERTY::WRITE |
-                                               NIMBLE_PROPERTY::NOTIFY
-                                              );
-
-    pFoodCharacteristic->setValue("Fries");
-    pFoodCharacteristic->setCallbacks(&chrCallbacks);
-
-    /** Custom descriptor: Arguments are UUID, Properties, max length in bytes of the value */
-    NimBLEDescriptor* pC01Ddsc = pFoodCharacteristic->createDescriptor(
-                                               "C01D",
-                                               NIMBLE_PROPERTY::READ | 
-                                               NIMBLE_PROPERTY::WRITE|
-                                               NIMBLE_PROPERTY::WRITE_ENC, // only allow writing if paired / encrypted
-                                               20
-                                              );
-    pC01Ddsc->setValue("Send it back!");
-    pC01Ddsc->setCallbacks(&dscCallbacks);
-
-    /** Start the services when finished creating all Characteristics and Descriptors */  
-    pDeadService->start();
-    pBaadService->start();
-
-    NimBLEAdvertising* pAdvertising = NimBLEDevice::getAdvertising();
-    /** Add the services to the advertisment data **/
-    pAdvertising->addServiceUUID(pDeadService->getUUID());
-    pAdvertising->addServiceUUID(pBaadService->getUUID());
-    /** If your device is battery powered you may consider setting scan response
-     *  to false as it will extend battery life at the expense of less data sent.
-     */
-    pAdvertising->setScanResponse(true);
-    pAdvertising->start();
-
-    printf("Advertising Started\n");
-    
-    xTaskCreate(notifyTask, "notifyTask", 5000, NULL, 1, NULL);
-}

examples/Bluetooth_5/NimBLE_extended_client/CMakeLists.txt

@@ -3,5 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-set(SUPPORTED_TARGETS esp32c3 esp32s3)
 project(NimBLE_extended_client)

examples/Bluetooth_5/NimBLE_extended_client/Makefile

@@ -1,3 +0,0 @@
-PROJECT_NAME := NimBLE_extended_client
-
-include $(IDF_PATH)/make/project.mk

examples/Bluetooth_5/NimBLE_extended_client/main/component.mk

@@ -1,4 +0,0 @@
-#
-# "main" pseudo-component makefile.
-#
-# (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.)

examples/Bluetooth_5/NimBLE_extended_client/main/main.cpp

@@ -1,77 +1,62 @@
 
-/** NimBLE Extended Client Demo:
+/**
+ *  NimBLE Extended Client Demo:
  *
  *  Demonstrates the Bluetooth 5.x client capabilities.
  *
  *  Created: on April 2 2022
  *      Author: H2zero
- *
-*/
+ */
+
 #include <NimBLEDevice.h>
 
-extern "C" void app_main(void);
-
-void scanEndedCB(NimBLEScanResults results);
-
 #define SERVICE_UUID        "ABCD"
 #define CHARACTERISTIC_UUID "1234"
 
-static NimBLEAdvertisedDevice* advDevice;
-static bool doConnect = false;
-static uint32_t scanTime = 10; /* 0 = scan forever */
+static const NimBLEAdvertisedDevice* advDevice;
+static bool                          doConnect = false;
+static uint32_t                      scanTime  = 10 * 1000; // In milliseconds, 0 = scan forever
 
-/* Define the PHY's to use when connecting to peer devices, can be 1, 2, or all 3 (default).*/
-static uint8_t connectPhys = BLE_GAP_LE_PHY_CODED_MASK | BLE_GAP_LE_PHY_1M_MASK /*| BLE_GAP_LE_PHY_2M_MASK */ ;
+/** Define the PHY's to use when connecting to peer devices, can be 1, 2, or all 3 (default).*/
+static uint8_t connectPhys = BLE_GAP_LE_PHY_CODED_MASK | BLE_GAP_LE_PHY_1M_MASK /*| BLE_GAP_LE_PHY_2M_MASK */;
 
-/* Define a class to handle the callbacks for client connection events */
+/** Define a class to handle the callbacks for client connection events */
 class ClientCallbacks : public NimBLEClientCallbacks {
-    void onConnect(NimBLEClient* pClient) {
-        printf("Connected\n");
-    };
+    void onConnect(NimBLEClient* pClient) override { printf("Connected\n"); };
 
-    void onDisconnect(NimBLEClient* pClient) {
-        printf("%s Disconnected - Starting scan\n", pClient->getPeerAddress().toString().c_str());
-        NimBLEDevice::getScan()->start(scanTime, scanEndedCB);
-    };
-};
+    void onDisconnect(NimBLEClient* pClient, int reason) override {
+        printf("%s Disconnected, reason = %d - Starting scan\n", pClient->getPeerAddress().toString().c_str(), reason);
+        NimBLEDevice::getScan()->start(scanTime);
+    }
+} clientCallbacks;
 
-
-/* Define a class to handle the callbacks when advertisements are received */
-class AdvertisedDeviceCallbacks: public NimBLEAdvertisedDeviceCallbacks {
-
-    void onResult(NimBLEAdvertisedDevice* advertisedDevice) {
+/** Define a class to handle the callbacks when advertisements are received */
+class scanCallbacks : public NimBLEScanCallbacks {
+    void onResult(const NimBLEAdvertisedDevice* advertisedDevice) override {
         printf("Advertised Device found: %s\n", advertisedDevice->toString().c_str());
-        if(advertisedDevice->isAdvertisingService(NimBLEUUID("ABCD")))
-        {
+        if (advertisedDevice->isAdvertisingService(NimBLEUUID("ABCD"))) {
             printf("Found Our Service\n");
-            /* Ready to connect now */
             doConnect = true;
-            /* Save the device reference in a global for the client to use*/
+            /** Save the device reference in a global for the client to use*/
             advDevice = advertisedDevice;
-            /* stop scan before connecting */
+            /** stop scan before connecting */
             NimBLEDevice::getScan()->stop();
         }
-    };
-};
-
-
-/* Callback to process the results of the last scan or restart it */
-void scanEndedCB(NimBLEScanResults results){
-    printf("Scan Ended\n");
-    if (!doConnect) { /* Don't start the scan while connecting */
-        NimBLEDevice::getScan()->start(scanTime, scanEndedCB);
     }
-}
 
+    /** Callback to process the results of the completed scan or restart it */
+    void onScanEnd(const NimBLEScanResults& results, int rc) override { printf("Scan Ended\n"); }
+} scanCallbacks;
 
-/* Handles the provisioning of clients and connects / interfaces with the server */
+/** Handles the provisioning of clients and connects / interfaces with the server */
 bool connectToServer() {
     NimBLEClient* pClient = nullptr;
 
     pClient = NimBLEDevice::createClient();
-    pClient->setClientCallbacks(new ClientCallbacks, false);
+    pClient->setClientCallbacks(&clientCallbacks, false);
 
-    /* Set the PHY's to use for this connection. This is a bitmask that represents the PHY's:
+    /**
+     * Set the PHY's to use for this connection. This is a bitmask that represents the PHY's:
      * * 0x01 BLE_GAP_LE_PHY_1M_MASK
      * * 0x02 BLE_GAP_LE_PHY_2M_MASK
      * * 0x04 BLE_GAP_LE_PHY_CODED_MASK
@@ -79,31 +64,26 @@ bool connectToServer() {
      */
     pClient->setConnectPhy(connectPhys);
 
-    /** Set how long we are willing to wait for the connection to complete (seconds), default is 30. */
-    pClient->setConnectTimeout(10);
+    /** Set how long we are willing to wait for the connection to complete (milliseconds), default is 30000. */
+    pClient->setConnectTimeout(10 * 1000);
 
     if (!pClient->connect(advDevice)) {
-        /* Created a client but failed to connect, don't need to keep it as it has no data */
+        /** Created a client but failed to connect, don't need to keep it as it has no data */
         NimBLEDevice::deleteClient(pClient);
         printf("Failed to connect, deleted client\n");
         return false;
     }
 
-    printf("Connected to: %s RSSI: %d\n",
-           pClient->getPeerAddress().toString().c_str(),
-           pClient->getRssi());
+    printf("Connected to: %s RSSI: %d\n", pClient->getPeerAddress().toString().c_str(), pClient->getRssi());
 
-    /* Now we can read/write/subscribe the charateristics of the services we are interested in */
-    NimBLERemoteService* pSvc = nullptr;
+    /** Now we can read/write/subscribe the characteristics of the services we are interested in */
+    NimBLERemoteService*        pSvc = nullptr;
     NimBLERemoteCharacteristic* pChr = nullptr;
 
     pSvc = pClient->getService(SERVICE_UUID);
-
     if (pSvc) {
         pChr = pSvc->getCharacteristic(CHARACTERISTIC_UUID);
-
         if (pChr) {
-            // Read the value of the characteristic.
             if (pChr->canRead()) {
                 std::string value = pChr->readValue();
                 printf("Characteristic value: %s\n", value.c_str());
@@ -119,11 +99,37 @@ bool connectToServer() {
     return true;
 }
 
-void connectTask (void * parameter){
-    /* Loop here until we find a device we want to connect to */
+extern "C" void app_main(void) {
+    printf("Starting NimBLE Client\n");
+
+    /** Initialize NimBLE and set the device name */
+    NimBLEDevice::init("NimBLE Extended Client");
+
+    /** Create aNimBLE Scan instance and set the callbacks for scan events */
+    NimBLEScan* pScan = NimBLEDevice::getScan();
+    pScan->setScanCallbacks(&scanCallbacks);
+
+    /** Set scan interval (how often) and window (how long) in milliseconds */
+    pScan->setInterval(97);
+    pScan->setWindow(67);
+
+    /**
+     * Active scan will gather scan response data from advertisers
+     *  but will use more energy from both devices
+     */
+    pScan->setActiveScan(true);
+
+    /**
+     *  Start scanning for advertisers for the scan time specified (in milliseconds) 0 = forever
+     *  Optional callback for when scanning stops.
+     */
+    pScan->start(scanTime);
+
+    printf("Scanning for peripherals\n");
+
+    /** Loop here until we find a device we want to connect to */
     for (;;) {
         if (doConnect) {
-            /* Found a device we want to connect to, do it now */
             if (connectToServer()) {
                 printf("Success!, scanning for more!\n");
             } else {
@@ -131,39 +137,8 @@ void connectTask (void * parameter){
             }
 
             doConnect = false;
-            NimBLEDevice::getScan()->start(scanTime, scanEndedCB);
+            NimBLEDevice::getScan()->start(scanTime);
         }
         vTaskDelay(pdMS_TO_TICKS(10));
     }
-
-    vTaskDelete(NULL);
-}
-
-void app_main (void) {
-    printf("Starting NimBLE Client\n");
-    /* Create a task to handle connecting to peers */
-    xTaskCreate(connectTask, "connectTask", 5000, NULL, 1, NULL);
-
-    /* Initialize NimBLE, no device name specified as we are not advertising */
-    NimBLEDevice::init("");
-    NimBLEScan* pScan = NimBLEDevice::getScan();
-
-    /* create a callback that gets called when advertisers are found */
-    pScan->setAdvertisedDeviceCallbacks(new AdvertisedDeviceCallbacks());
-
-    /* Set scan interval (how often) and window (how long) in milliseconds */
-    pScan->setInterval(97);
-    pScan->setWindow(67);
-
-    /*  Active scan will gather scan response data from advertisers
-     *  but will use more energy from both devices
-     */
-    pScan->setActiveScan(true);
-
-    /*  Start scanning for advertisers for the scan time specified (in seconds) 0 = forever
-     *  Optional callback for when scanning stops.
-     */
-    pScan->start(scanTime, scanEndedCB);
-
-    printf("Scanning for peripherals\n");
 }

examples/Bluetooth_5/NimBLE_extended_client/sdkconfig.defaults

@@ -0,0 +1,13 @@
+# Override some defaults so BT stack is enabled
+# in this example
+
+#
+# BT config
+#
+CONFIG_BT_ENABLED=y
+CONFIG_BTDM_CTRL_MODE_BLE_ONLY=y
+CONFIG_BTDM_CTRL_MODE_BR_EDR_ONLY=n
+CONFIG_BTDM_CTRL_MODE_BTDM=n
+CONFIG_BT_BLUEDROID_ENABLED=n
+CONFIG_BT_NIMBLE_ENABLED=y
+CONFIG_BT_NIMBLE_EXT_ADV=y

examples/Bluetooth_5/NimBLE_extended_scan/CMakeLists.txt

@@ -3,5 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-set(SUPPORTED_TARGETS esp32)
-project(BLE_scan)
+project(NimBLE_extended_scan)

examples/Bluetooth_5/NimBLE_extended_scan/main/CMakeLists.txt

@@ -1,4 +1,4 @@
 set(COMPONENT_SRCS "main.cpp")
 set(COMPONENT_ADD_INCLUDEDIRS ".")
 
-register_component()
+register_component()

examples/Bluetooth_5/NimBLE_extended_scan/main/main.cpp

@@ -0,0 +1,69 @@
+/**
+ *  NimBLE Extended Scanner Demo:
+ *
+ *  Demonstrates the Bluetooth 5.x scanning capabilities of the NimBLE library.
+ *
+ *  Created: on November 28, 2024
+ *      Author: H2zero
+ */
+
+#include <NimBLEDevice.h>
+
+static uint32_t        scanTime = 10 * 1000; // In milliseconds, 0 = scan forever
+static NimBLEScan::Phy scanPhy  = NimBLEScan::Phy::SCAN_ALL;
+
+/** Define a class to handle the callbacks when advertisements are received */
+class ScanCallbacks : public NimBLEScanCallbacks {
+    void onResult(const NimBLEAdvertisedDevice* advertisedDevice) {
+        printf("Advertised Device found: %s\n PHY1: %d\n PHY2: %d\n",
+               advertisedDevice->toString().c_str(),
+               advertisedDevice->getPrimaryPhy(),
+               advertisedDevice->getSecondaryPhy());
+    }
+
+    /** Callback to process the results of the completed scan or restart it */
+    void onScanEnd(const NimBLEScanResults& scanResults, int reason) {
+        printf("Scan Ended, reason: %d; found %d devices\n", reason, scanResults.getCount());
+
+        /** Try Different PHY's */
+        switch (scanPhy) {
+            case NimBLEScan::Phy::SCAN_ALL:
+                printf("Scanning only 1M PHY\n");
+                scanPhy = NimBLEScan::Phy::SCAN_1M;
+                break;
+            case NimBLEScan::Phy::SCAN_1M:
+                printf("Scanning only CODED PHY\n");
+                scanPhy = NimBLEScan::Phy::SCAN_CODED;
+                break;
+            case NimBLEScan::Phy::SCAN_CODED:
+                printf("Scanning all PHY's\n");
+                scanPhy = NimBLEScan::Phy::SCAN_ALL;
+                break;
+        }
+
+        NimBLEScan* pScan = NimBLEDevice::getScan();
+        pScan->setPhy(scanPhy);
+        pScan->start(scanTime);
+    }
+} scanCallbacks;
+
+extern "C" void app_main(void) {
+    printf("Starting Extended Scanner\n");
+
+    /** Initialize NimBLE and set the device name */
+    NimBLEDevice::init("NimBLE Extended Scanner");
+    NimBLEScan* pScan = NimBLEDevice::getScan();
+
+    /** Set the callbacks that the scanner will call on events. */
+    pScan->setScanCallbacks(&scanCallbacks);
+
+    /** Use active scanning to obtain scan response data from advertisers */
+    pScan->setActiveScan(true);
+
+    /** Set the initial PHY's to scan on, default is SCAN_ALL */
+    pScan->setPhy(scanPhy);
+
+    /** Start scanning for scanTime */
+    pScan->start(scanTime);
+    printf("Scanning for peripherals\n");
+}

examples/Bluetooth_5/NimBLE_extended_scan/sdkconfig.defaults

@@ -0,0 +1,13 @@
+# Override some defaults so BT stack is enabled
+# in this example
+
+#
+# BT config
+#
+CONFIG_BT_ENABLED=y
+CONFIG_BTDM_CTRL_MODE_BLE_ONLY=y
+CONFIG_BTDM_CTRL_MODE_BR_EDR_ONLY=n
+CONFIG_BTDM_CTRL_MODE_BTDM=n
+CONFIG_BT_BLUEDROID_ENABLED=n
+CONFIG_BT_NIMBLE_ENABLED=y
+CONFIG_BT_NIMBLE_EXT_ADV=y

examples/Bluetooth_5/NimBLE_extended_server/CMakeLists.txt

@@ -3,5 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-set(SUPPORTED_TARGETS esp32c3 esp32s3)
 project(NimBLE_extended_server)

examples/Bluetooth_5/NimBLE_extended_server/Makefile

@@ -1,3 +0,0 @@
-PROJECT_NAME := NimBLE_extended_server
-
-include $(IDF_PATH)/make/project.mk

examples/Bluetooth_5/NimBLE_extended_server/main/component.mk

@@ -1,4 +0,0 @@
-#
-# "main" pseudo-component makefile.
-#
-# (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.)

examples/Bluetooth_5/NimBLE_extended_server/main/main.cpp

@@ -1,4 +1,5 @@
-/** NimBLE Extended Server Demo:
+/**
+ *  NimBLE Extended Server Demo:
  *
  *  Demonstrates the Bluetooth 5.x extended advertising capabilities.
  *
@@ -9,55 +10,52 @@
  *
  *  Created: on April 2 2022
  *      Author: H2zero
- *
-*/
+ */
 
-#include "NimBLEDevice.h"
-#include "esp_sleep.h"
-
-extern "C" void app_main(void);
+#include <NimBLEDevice.h>
+#include <esp_sleep.h>
 
 #define SERVICE_UUID        "ABCD"
 #define CHARACTERISTIC_UUID "1234"
 
-/* Time in milliseconds to advertise */
+/** Time in milliseconds to advertise */
 static uint32_t advTime = 5000;
 
-/* Time to sleep between advertisements */
+/** Time to sleep between advertisements */
 static uint32_t sleepSeconds = 20;
 
-/* Primary PHY used for advertising, can be one of BLE_HCI_LE_PHY_1M or BLE_HCI_LE_PHY_CODED */
+/** Primary PHY used for advertising, can be one of BLE_HCI_LE_PHY_1M or BLE_HCI_LE_PHY_CODED */
 static uint8_t primaryPhy = BLE_HCI_LE_PHY_CODED;
 
-/* Secondary PHY used for advertising and connecting,
- * can be one of BLE_HCI_LE_PHY_1M, BLE_HCI_LE_PHY_2M or BLE_HCI_LE_PHY_CODED
+/**
+ *  Secondary PHY used for advertising and connecting,
+ *  can be one of BLE_HCI_LE_PHY_1M, BLE_HCI_LE_PHY_2M or BLE_HCI_LE_PHY_CODED
  */
 static uint8_t secondaryPhy = BLE_HCI_LE_PHY_1M;
 
+/** Handler class for server events */
+class ServerCallbacks : public NimBLEServerCallbacks {
+    void onConnect(NimBLEServer* pServer, NimBLEConnInfo& connInfo) override {
+        printf("Client connected:: %s\n", connInfo.getAddress().toString().c_str());
+    }
 
-/* Handler class for server events */
-class ServerCallbacks: public NimBLEServerCallbacks {
-    void onConnect(NimBLEServer* pServer, ble_gap_conn_desc* desc) {
-        printf("Client connected: %s\n", NimBLEAddress(desc->peer_ota_addr).toString().c_str());
-    };
-
-    void onDisconnect(NimBLEServer* pServer) {
-        printf("Client disconnected - sleeping for %u seconds\n", sleepSeconds);
+    void onDisconnect(NimBLEServer* pServer, NimBLEConnInfo& connInfo, int reason) override {
+        printf("Client disconnected - sleeping for %" PRIu32 " seconds\n", sleepSeconds);
         esp_deep_sleep_start();
-    };
-};
+    }
+} serverCallbacks;
 
-/* Callback class to handle advertising events */
-class advertisingCallbacks: public NimBLEExtAdvertisingCallbacks {
-    void onStopped(NimBLEExtAdvertising* pAdv, int reason, uint8_t inst_id) {
+/** Callback class to handle advertising events */
+class AdvertisingCallbacks : public NimBLEExtAdvertisingCallbacks {
+    void onStopped(NimBLEExtAdvertising* pAdv, int reason, uint8_t instId) override {
         /* Check the reason advertising stopped, don't sleep if client is connecting */
-        printf("Advertising instance %u stopped\n", inst_id);
+        printf("Advertising instance %u stopped\n", instId);
         switch (reason) {
             case 0:
                 printf("Client connecting\n");
                 return;
             case BLE_HS_ETIMEOUT:
-                printf("Time expired - sleeping for %u seconds\n", sleepSeconds);
+                printf("Time expired - sleeping for %" PRIu32 " seconds\n", sleepSeconds);
                 break;
             default:
                 break;
@@ -65,66 +63,69 @@ class advertisingCallbacks: public NimBLEExtAdvertisingCallbacks {
 
         esp_deep_sleep_start();
     }
-};
+} advertisingCallbacks;
 
-void app_main (void) {
+extern "C"
+void app_main(void) {
+    /** Initialize NimBLE and set the device name */
     NimBLEDevice::init("Extended advertiser");
 
-    /* Create the server and add the services/characteristics/descriptors */
-    NimBLEServer *pServer = NimBLEDevice::createServer();
-    pServer->setCallbacks(new ServerCallbacks);
+    /** Create the server and add the services/characteristics/descriptors */
+    NimBLEServer* pServer = NimBLEDevice::createServer();
+    pServer->setCallbacks(&serverCallbacks);
 
-    NimBLEService *pService = pServer->createService(SERVICE_UUID);
-    NimBLECharacteristic *pCharacteristic = pService->createCharacteristic(CHARACTERISTIC_UUID,
-                                                                           NIMBLE_PROPERTY::READ |
-                                                                           NIMBLE_PROPERTY::WRITE |
-                                                                           NIMBLE_PROPERTY::NOTIFY);
+    NimBLEService*        pService = pServer->createService(SERVICE_UUID);
+    NimBLECharacteristic* pCharacteristic =
+        pService->createCharacteristic(CHARACTERISTIC_UUID,
+                                       NIMBLE_PROPERTY::READ | NIMBLE_PROPERTY::WRITE | NIMBLE_PROPERTY::NOTIFY);
 
     pCharacteristic->setValue("Hello World");
 
-    /* Start the services */
+    /** Start the service */
     pService->start();
 
-    /*
-    * Create an extended advertisement with the instance ID 0 and set the PHY's.
-    * Multiple instances can be added as long as the instance ID is incremented.
-    */
+    /**
+     *  Create an extended advertisement with the instance ID 0 and set the PHY's.
+     *  Multiple instances can be added as long as the instance ID is incremented.
+     */
     NimBLEExtAdvertisement extAdv(primaryPhy, secondaryPhy);
 
-    /* Set the advertisement as connectable */
+    /** Set the advertisement as connectable */
     extAdv.setConnectable(true);
 
-    /* As per Bluetooth specification, extended advertising cannot be both scannable and connectable */
+    /** As per Bluetooth specification, extended advertising cannot be both scannable and connectable */
     extAdv.setScannable(false); // The default is false, set here for demonstration.
 
-    /* Extended advertising allows for 251 bytes (minus header bytes ~20) in a single advertisement or up to 1650 if chained */
-    extAdv.setServiceData(NimBLEUUID(SERVICE_UUID), std::string("Extended Advertising Demo.\r\n"
-                                                                "Extended advertising allows for "
-                                                                "251 bytes of data in a single advertisement,\r\n"
-                                                                "or up to 1650 bytes with chaining.\r\n"
-                                                                "This example message is 226 bytes long "
-                                                                "and is using CODED_PHY for long range."));
+    /** Extended advertising allows for 251 bytes (minus header bytes ~20) in a single advertisement or up to 1650 if chained */
+    extAdv.setServiceData(NimBLEUUID(SERVICE_UUID),
+                          std::string("Extended Advertising Demo.\r\n"
+                                      "Extended advertising allows for "
+                                      "251 bytes of data in a single advertisement,\r\n"
+                                      "or up to 1650 bytes with chaining.\r\n"
+                                      "This example message is 226 bytes long "
+                                      "and is using CODED_PHY for long range."));
 
     extAdv.setCompleteServices16({NimBLEUUID(SERVICE_UUID)});
+    extAdv.setName("Extended advertiser");
 
-    /* When extended advertising is enabled `NimBLEDevice::getAdvertising` returns a pointer to `NimBLEExtAdvertising */
+    /** When extended advertising is enabled `NimBLEDevice::getAdvertising` returns a pointer to `NimBLEExtAdvertising */
     NimBLEExtAdvertising* pAdvertising = NimBLEDevice::getAdvertising();
 
-    /* Set the callbacks for advertising events */
-    pAdvertising->setCallbacks(new advertisingCallbacks);
+    /** Set the callbacks for advertising events */
+    pAdvertising->setCallbacks(&advertisingCallbacks);
 
-    /*
-     * NimBLEExtAdvertising::setInstanceData takes the instance ID and
-     * a reference to a `NimBLEExtAdvertisement` object. This sets the data
-     * that will be advertised for this instance ID, returns true if successful.
+    /**
+     *  NimBLEExtAdvertising::setInstanceData takes the instance ID and
+     *  a reference to a `NimBLEExtAdvertisement` object. This sets the data
+     *  that will be advertised for this instance ID, returns true if successful.
      *
-     * Note: It is safe to create the advertisement as a local variable if setInstanceData
-     * is called before exiting the code block as the data will be copied.
+     *  Note: It is safe to create the advertisement as a local variable if setInstanceData
+     *  is called before exiting the code block as the data will be copied.
      */
     if (pAdvertising->setInstanceData(0, extAdv)) {
-        /*
-         * `NimBLEExtAdvertising::start` takes the advertisement instance ID to start
-         * and a duration in milliseconds or a max number of advertisements to send (or both).
+        /**
+         *  NimBLEExtAdvertising::start takes the advertisement instance ID to start
+         *  and a duration in milliseconds or a max number of advertisements to send (or both).
          */
         if (pAdvertising->start(0, advTime)) {
             printf("Started advertising\n");
@@ -132,7 +133,7 @@ void app_main (void) {
             printf("Failed to start advertising\n");
         }
     } else {
-        printf("Failed to register advertisment data\n");
+        printf("Failed to register advertisement data\n");
     }
 
     esp_sleep_enable_timer_wakeup(sleepSeconds * 1000000);

examples/Bluetooth_5/NimBLE_extended_server/sdkconfig.defaults

@@ -0,0 +1,13 @@
+# Override some defaults so BT stack is enabled
+# in this example
+
+#
+# BT config
+#
+CONFIG_BT_ENABLED=y
+CONFIG_BTDM_CTRL_MODE_BLE_ONLY=y
+CONFIG_BTDM_CTRL_MODE_BR_EDR_ONLY=n
+CONFIG_BTDM_CTRL_MODE_BTDM=n
+CONFIG_BT_BLUEDROID_ENABLED=n
+CONFIG_BT_NIMBLE_ENABLED=y
+CONFIG_BT_NIMBLE_EXT_ADV=y

examples/Bluetooth_5/NimBLE_multi_advertiser/CMakeLists.txt

@@ -3,5 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-set(SUPPORTED_TARGETS esp32c3 esp32s3)
 project(NimBLE_multi_advertiser)

examples/Bluetooth_5/NimBLE_multi_advertiser/Makefile

@@ -1,3 +0,0 @@
-PROJECT_NAME := NimBLE_multi_advertiser
-
-include $(IDF_PATH)/make/project.mk

examples/Bluetooth_5/NimBLE_multi_advertiser/main/component.mk

@@ -1,4 +0,0 @@
-#
-# "main" pseudo-component makefile.
-#
-# (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.)

examples/Bluetooth_5/NimBLE_multi_advertiser/main/main.cpp

@@ -1,4 +1,5 @@
-/** NimBLE Multi Advertiser Demo:
+/**
+ *  NimBLE Multi Advertiser Demo:
  *
  *  Demonstrates the Bluetooth 5.x extended advertising capabilities.
  *
@@ -9,59 +10,56 @@
  *
  *  Created: on April 9 2022
  *      Author: H2zero
- *
-*/
+ */
 
-#include "NimBLEDevice.h"
-#include "esp_sleep.h"
-
-extern "C" void app_main(void);
+#include <NimBLEDevice.h>
+#include <esp_sleep.h>
 
 #define SERVICE_UUID        "ABCD"
 #define CHARACTERISTIC_UUID "1234"
 
-/* Time in milliseconds to advertise */
+/** Time in milliseconds to advertise */
 static uint32_t advTime = 5000;
 
-/* Time to sleep between advertisements */
+/** Time to sleep between advertisements */
 static uint32_t sleepTime = 20;
 
-/* Primary PHY used for advertising, can be one of BLE_HCI_LE_PHY_1M or BLE_HCI_LE_PHY_CODED */
+/** Primary PHY used for advertising, can be one of BLE_HCI_LE_PHY_1M or BLE_HCI_LE_PHY_CODED */
 static uint8_t primaryPhy = BLE_HCI_LE_PHY_CODED;
 
-/* Secondary PHY used for advertising and connecting,
- * can be one of BLE_HCI_LE_PHY_1M, BLE_HCI_LE_PHY_2M or BLE_HCI_LE_PHY_CODED
+/**
+ *  Secondary PHY used for advertising and connecting,
+ *  can be one of BLE_HCI_LE_PHY_1M, BLE_HCI_LE_PHY_2M or BLE_HCI_LE_PHY_CODED
  */
 static uint8_t secondaryPhy = BLE_HCI_LE_PHY_1M;
 
+/** Handler class for server events */
+class ServerCallbacks : public NimBLEServerCallbacks {
+    void onConnect(NimBLEServer* pServer, NimBLEConnInfo& connInfo) override {
+        printf("Client connected: %s\n", connInfo.getAddress().toString().c_str());
+    }
 
-/* Handler class for server events */
-class ServerCallbacks: public NimBLEServerCallbacks {
-    void onConnect(NimBLEServer* pServer, ble_gap_conn_desc* desc) {
-        printf("Client connected: %s\n", NimBLEAddress(desc->peer_ota_addr).toString().c_str());
-    };
-
-    void onDisconnect(NimBLEServer* pServer) {
+    void onDisconnect(NimBLEServer* pServer, NimBLEConnInfo& connInfo, int reason) override {
         printf("Client disconnected\n");
         // if still advertising we won't sleep yet.
         if (!pServer->getAdvertising()->isAdvertising()) {
-            printf("Sleeping for %u seconds\n", sleepTime);
+            printf("Sleeping for %" PRIu32 " seconds\n", sleepTime);
             esp_deep_sleep_start();
         }
-    };
-};
+    }
+} serverCallbacks;
 
-/* Callback class to handle advertising events */
-class advCallbacks: public NimBLEExtAdvertisingCallbacks {
-    void onStopped(NimBLEExtAdvertising* pAdv, int reason, uint8_t inst_id) {
+/** Callback class to handle advertising events */
+class AdvCallbacks : public NimBLEExtAdvertisingCallbacks {
+    void onStopped(NimBLEExtAdvertising* pAdv, int reason, uint8_t instId) override {
         /* Check the reason advertising stopped, don't sleep if client is connecting */
-        printf("Advertising instance %u stopped\n", inst_id);
+        printf("Advertising instance %u stopped\n", instId);
         switch (reason) {
             case 0:
                 printf(" client connecting\n");
                 return;
             case BLE_HS_ETIMEOUT:
-                printf("Time expired - sleeping for %u seconds\n", sleepTime);
+                printf("Time expired - sleeping for %" PRIu32 " seconds\n", sleepTime);
                 break;
             default:
                 break;
@@ -72,90 +70,90 @@ class advCallbacks: public NimBLEExtAdvertisingCallbacks {
 
     bool m_updatedSR = false;
 
-    void onScanRequest(NimBLEExtAdvertising* pAdv, uint8_t inst_id, NimBLEAddress addr) {
-        printf("Scan request for instance %u\n", inst_id);
+    void onScanRequest(NimBLEExtAdvertising* pAdv, uint8_t instId, NimBLEAddress addr) override {
+        printf("Scan request for instance %u\n", instId);
         // if the data has already been updated we don't need to change it again.
         if (!m_updatedSR) {
             printf("Updating scan data\n");
             NimBLEExtAdvertisement sr;
             sr.setServiceData(NimBLEUUID(SERVICE_UUID), std::string("Hello from scan response!"));
-            pAdv->setScanResponseData(inst_id, sr);
+            pAdv->setScanResponseData(instId, sr);
             m_updatedSR = true;
         }
     }
-};
+} advCallbacks;
 
-void app_main (void) {
+extern "C" void app_main(void) {
+    /** Initialize NimBLE and set the device name */
     NimBLEDevice::init("Multi advertiser");
 
-    /* Create a server for our legacy advertiser */
-    NimBLEServer *pServer = NimBLEDevice::createServer();
-    pServer->setCallbacks(new ServerCallbacks);
+    /** Create a server for our legacy advertiser */
+    NimBLEServer* pServer = NimBLEDevice::createServer();
+    pServer->setCallbacks(&serverCallbacks);
 
-    NimBLEService *pService = pServer->createService(SERVICE_UUID);
-    NimBLECharacteristic *pCharacteristic = pService->createCharacteristic(CHARACTERISTIC_UUID,
-                                                                           NIMBLE_PROPERTY::READ |
-                                                                           NIMBLE_PROPERTY::WRITE |
-                                                                           NIMBLE_PROPERTY::NOTIFY);
+    NimBLEService*        pService = pServer->createService(SERVICE_UUID);
+    NimBLECharacteristic* pCharacteristic =
+        pService->createCharacteristic(CHARACTERISTIC_UUID,
+                                       NIMBLE_PROPERTY::READ | NIMBLE_PROPERTY::WRITE | NIMBLE_PROPERTY::NOTIFY);
 
     pCharacteristic->setValue("Hello World");
 
-    /* Start the service */
+    /** Start the service */
     pService->start();
 
-    /* Create our multi advertising instances */
+    /** Create our multi advertising instances */
 
-    // extended scannable instance advertising on coded and 1m PHY's.
+    /** extended scannable instance advertising on coded and 1m PHY's. */
     NimBLEExtAdvertisement extScannable(primaryPhy, secondaryPhy);
 
-    // Legacy advertising as a connectable device.
+    /** Legacy advertising as a connectable device. */
     NimBLEExtAdvertisement legacyConnectable;
 
-    // Optional scan response data.
+    /** Optional scan response data. */
     NimBLEExtAdvertisement legacyScanResponse;
 
-    /* As per Bluetooth specification, extended advertising cannot be both scannable and connectable */
+    /** As per Bluetooth specification, extended advertising cannot be both scannable and connectable */
     extScannable.setScannable(true);
     extScannable.setConnectable(false);
 
-    /* Set the initial data */
+    /** Set the initial data */
     extScannable.setServiceData(NimBLEUUID(SERVICE_UUID), std::string("Scan me!"));
 
-    /* enable the scan response callback, we will use this to update the data. */
+    /** Enable the scan response callback, we will use this to update the data. */
     extScannable.enableScanRequestCallback(true);
 
-    /* Optional custom address for this advertisment. */
+    /** Optional custom address for this advertisment. */
     legacyConnectable.setAddress(NimBLEAddress("DE:AD:BE:EF:BA:AD"));
 
-    /* Set the advertising data. */
+    /** Set the advertising data. */
     legacyConnectable.setName("Legacy");
     legacyConnectable.setCompleteServices16({NimBLEUUID(SERVICE_UUID)});
 
-    /* Set the legacy and connectable flags. */
+    /** Set the legacy and connectable flags. */
     legacyConnectable.setLegacyAdvertising(true);
     legacyConnectable.setConnectable(true);
 
-    /* Put some data in the scan response if desired. */
+    /** Put some data in the scan response if desired. */
     legacyScanResponse.setServiceData(NimBLEUUID(SERVICE_UUID), "Legacy SR");
 
-    /* Get the advertising ready */
+    /** Get the advertising ready */
     NimBLEExtAdvertising* pAdvertising = NimBLEDevice::getAdvertising();
 
-    /* Set the callbacks to handle advertising events */
-    pAdvertising->setCallbacks(new advCallbacks);
+    /** Set the callbacks to handle advertising events */
+    pAdvertising->setCallbacks(&advCallbacks);
 
-    /* Set instance data.
-     * Up to 5 instances can be used if configured in menuconfig, instance 0 is always available.
+    /**
+     *  Set instance data.
+     *  Up to 5 instances can be used if configured in menuconfig, instance 0 is always available.
      *
-     * We will set the extended scannable data on instance 0 and the legacy data on instance 1.
-     * Note that the legacy scan response data needs to be set to the same instance (1).
+     *  We will set the extended scannable data on instance 0 and the legacy data on instance 1.
+     *  Note that the legacy scan response data needs to be set to the same instance (1).
      */
-    if (pAdvertising->setInstanceData( 0, extScannable )  &&
-        pAdvertising->setInstanceData( 1, legacyConnectable ) &&
-        pAdvertising->setScanResponseData( 1, legacyScanResponse )) {
-        /*
-         * `NimBLEExtAdvertising::start` takes the advertisement instance ID to start
-         * and a duration in milliseconds or a max number of advertisements to send (or both).
+    if (pAdvertising->setInstanceData(0, extScannable) && pAdvertising->setInstanceData(1, legacyConnectable) &&
+        pAdvertising->setScanResponseData(1, legacyScanResponse)) {
+        /**
+         *  NimBLEExtAdvertising::start takes the advertisement instance ID to start
+         *  and a duration in milliseconds or a max number of advertisements to send (or both).
          */
         if (pAdvertising->start(0, advTime) && pAdvertising->start(1, advTime)) {
             printf("Started advertising\n");
@@ -163,7 +161,7 @@ void app_main (void) {
             printf("Failed to start advertising\n");
         }
     } else {
-        printf("Failed to register advertisment data\n");
+        printf("Failed to register advertisement data\n");
     }
 
     esp_sleep_enable_timer_wakeup(sleepTime * 1000000);

examples/Bluetooth_5/NimBLE_multi_advertiser/sdkconfig.defaults

@@ -0,0 +1,13 @@
+# Override some defaults so BT stack is enabled
+# in this example
+
+#
+# BT config
+#
+CONFIG_BT_ENABLED=y
+CONFIG_BTDM_CTRL_MODE_BLE_ONLY=y
+CONFIG_BTDM_CTRL_MODE_BR_EDR_ONLY=n
+CONFIG_BTDM_CTRL_MODE_BTDM=n
+CONFIG_BT_BLUEDROID_ENABLED=n
+CONFIG_BT_NIMBLE_ENABLED=y
+CONFIG_BT_NIMBLE_EXT_ADV=y

examples/Continuous_scan/CMakeLists.txt

@@ -3,5 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-set(SUPPORTED_TARGETS esp32)
-project(BLE_uart)
+project(Continuous_scan)

examples/Continuous_scan/main/main.cpp

@@ -0,0 +1,46 @@
+/**
+ *  Continuous Scan Example
+ *
+ *  This example demonstrates how to continuously scan for BLE devices.
+ *  When devices are found the onDiscovered and onResults callbacks will be called with the device data.
+ *  The scan will not store the results, only the callbacks will be used
+ *  When the scan timeout is reached the onScanEnd callback will be called and the scan will be restarted.
+ *  This will clear the duplicate cache in the controller and allow the same devices to be reported again.
+ *
+ *  Created: on March 24 2020
+ *      Author: H2zero
+ */
+
+#include <NimBLEDevice.h>
+
+static constexpr uint32_t scanTime = 30 * 1000; // 30 seconds scan time.
+
+class scanCallbacks : public NimBLEScanCallbacks {
+    /** Initial discovery, advertisement data only. */
+    void onDiscovered(const NimBLEAdvertisedDevice* advertisedDevice) override {
+        printf("Discovered Device: %s\n", advertisedDevice->toString().c_str());
+    }
+
+    /**
+     *  If active scanning the result here will have the scan response data.
+     *  If not active scanning then this will be the same as onDiscovered.
+     */
+    void onResult(const NimBLEAdvertisedDevice* advertisedDevice) override {
+        printf("Device result: %s\n", advertisedDevice->toString().c_str());
+    }
+
+    void onScanEnd(const NimBLEScanResults& results, int reason) override {
+        printf("Scan ended reason = %d; restarting scan\n", reason);
+        NimBLEDevice::getScan()->start(scanTime, false, true);
+    }
+} scanCallbacks;
+
+extern "C" void app_main() {
+    NimBLEDevice::init("");                         // Initialize the device, you can specify a device name if you want.
+    NimBLEScan* pBLEScan = NimBLEDevice::getScan(); // Create the scan object.
+    pBLEScan->setScanCallbacks(&scanCallbacks, false); // Set the callback for when devices are discovered, no duplicates.
+    pBLEScan->setActiveScan(true);          // Set active scanning, this will get more data from the advertiser.
+    pBLEScan->setMaxResults(0);             // Do not store the scan results, use callback only.
+    pBLEScan->start(scanTime, false, true); // duration, not a continuation of last scan, restart to get all devices again.
+    printf("Scanning...\n");
+}

examples/Continuous_scan/sdkconfig.defaults

@@ -0,0 +1,12 @@
+# Override some defaults so BT stack is enabled
+# in this example
+
+#
+# BT config
+#
+CONFIG_BT_ENABLED=y
+CONFIG_BTDM_CTRL_MODE_BLE_ONLY=y
+CONFIG_BTDM_CTRL_MODE_BR_EDR_ONLY=n
+CONFIG_BTDM_CTRL_MODE_BTDM=n
+CONFIG_BT_BLUEDROID_ENABLED=n
+CONFIG_BT_NIMBLE_ENABLED=y

examples/NimBLE_Async_Client/CMakeLists.txt

@@ -3,5 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-set(SUPPORTED_TARGETS esp32)
-project(BLE_client)
+project(NimBLE_Async_Client)

examples/NimBLE_Async_Client/main/main.cpp

@@ -0,0 +1,83 @@
+
+/**
+ *  NimBLE_Async_client Demo:
+ *
+ *  Demonstrates asynchronous client operations.
+ *
+ *  Created: on November 4, 2024
+ *      Author: H2zero
+ */
+
+#include <NimBLEDevice.h>
+
+static constexpr uint32_t scanTimeMs = 5 * 1000;
+
+class ClientCallbacks : public NimBLEClientCallbacks {
+    void onConnect(NimBLEClient* pClient) override {
+        printf("Connected to: %s\n", pClient->getPeerAddress().toString().c_str());
+    }
+
+    void onDisconnect(NimBLEClient* pClient, int reason) override {
+        printf("%s Disconnected, reason = %d - Starting scan\n", pClient->getPeerAddress().toString().c_str(), reason);
+        NimBLEDevice::getScan()->start(scanTimeMs);
+    }
+} clientCallbacks;
+
+class ScanCallbacks : public NimBLEScanCallbacks {
+    void onResult(const NimBLEAdvertisedDevice* advertisedDevice) override {
+        printf("Advertised Device found: %s\n", advertisedDevice->toString().c_str());
+        if (advertisedDevice->haveName() && advertisedDevice->getName() == "NimBLE-Server") {
+            printf("Found Our Device\n");
+
+            /** Async connections can be made directly in the scan callbacks */
+            auto pClient = NimBLEDevice::getDisconnectedClient();
+            if (!pClient) {
+                pClient = NimBLEDevice::createClient(advertisedDevice->getAddress());
+                if (!pClient) {
+                    printf("Failed to create client\n");
+                    return;
+                }
+            }
+
+            pClient->setClientCallbacks(&clientCallbacks, false);
+            if (!pClient->connect(true, true, false)) { // delete attributes, async connect, no MTU exchange
+                NimBLEDevice::deleteClient(pClient);
+                printf("Failed to connect\n");
+                return;
+            }
+        }
+    }
+
+    void onScanEnd(const NimBLEScanResults& results, int reason) override {
+        printf("Scan Ended\n");
+        NimBLEDevice::getScan()->start(scanTimeMs);
+    }
+} scanCallbacks;
+
+extern "C" void app_main(void) {
+    printf("Starting NimBLE Async Client\n");
+    NimBLEDevice::init("Async-Client");
+    NimBLEDevice::setPower(3); /** +3db */
+
+    NimBLEScan* pScan = NimBLEDevice::getScan();
+    pScan->setScanCallbacks(&scanCallbacks);
+    pScan->setInterval(45);
+    pScan->setWindow(15);
+    pScan->setActiveScan(true);
+    pScan->start(scanTimeMs);
+
+    for (;;) {
+        vTaskDelay(pdMS_TO_TICKS(1000));
+        auto pClients = NimBLEDevice::getConnectedClients();
+        if (!pClients.size()) {
+            continue;
+        }
+
+        for (auto& pClient : pClients) {
+            printf("%s\n", pClient->toString().c_str());
+            NimBLEDevice::deleteClient(pClient);
+        }
+
+        NimBLEDevice::getScan()->start(scanTimeMs);
+    }
+}

examples/NimBLE_Async_Client/sdkconfig.defaults

@@ -0,0 +1,12 @@
+# Override some defaults so BT stack is enabled
+# in this example
+
+#
+# BT config
+#
+CONFIG_BT_ENABLED=y
+CONFIG_BTDM_CTRL_MODE_BLE_ONLY=y
+CONFIG_BTDM_CTRL_MODE_BR_EDR_ONLY=n
+CONFIG_BTDM_CTRL_MODE_BTDM=n
+CONFIG_BT_BLUEDROID_ENABLED=n
+CONFIG_BT_NIMBLE_ENABLED=y

examples/NimBLE_Client/CMakeLists.txt

@@ -3,5 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-set(SUPPORTED_TARGETS esp32)
 project(NimBLE_Client)

examples/NimBLE_Client/main/main.cpp

@@ -0,0 +1,305 @@
+
+/** NimBLE_Client Demo:
+ *
+ *  Demonstrates many of the available features of the NimBLE client library.
+ *
+ *  Created: on March 24 2020
+ *      Author: H2zero
+ */
+
+#include <NimBLEDevice.h>
+
+static const NimBLEAdvertisedDevice* advDevice;
+static bool                          doConnect = false;
+static uint32_t                      scanTime  = 5000; /** scan time in milliseconds, 0 = scan forever */
+
+/**  None of these are required as they will be handled by the library with defaults. **
+ **                       Remove as you see fit for your needs                        */
+class ClientCallbacks : public NimBLEClientCallbacks {
+    void onConnect(NimBLEClient* pClient) override { printf("Connected\n"); }
+
+    void onDisconnect(NimBLEClient* pClient, int reason) override {
+        printf("%s Disconnected, reason = %d - Starting scan\n", pClient->getPeerAddress().toString().c_str(), reason);
+        NimBLEDevice::getScan()->start(scanTime, false, true);
+    }
+
+    /********************* Security handled here *********************/
+    void onPassKeyEntry(NimBLEConnInfo& connInfo) override {
+        printf("Server Passkey Entry\n");
+        /**
+         * This should prompt the user to enter the passkey displayed
+         * on the peer device.
+         */
+        NimBLEDevice::injectPassKey(connInfo, 123456);
+    }
+
+    void onConfirmPasskey(NimBLEConnInfo& connInfo, uint32_t pass_key) override {
+        printf("The passkey YES/NO number: %" PRIu32 "\n", pass_key);
+        /** Inject false if passkeys don't match. */
+        NimBLEDevice::injectConfirmPasskey(connInfo, true);
+    }
+
+    /** Pairing process complete, we can check the results in connInfo */
+    void onAuthenticationComplete(NimBLEConnInfo& connInfo) override {
+        if (!connInfo.isEncrypted()) {
+            printf("Encrypt connection failed - disconnecting\n");
+            /** Find the client with the connection handle provided in connInfo */
+            NimBLEDevice::getClientByHandle(connInfo.getConnHandle())->disconnect();
+            return;
+        }
+    }
+} clientCB;
+
+/** Define a class to handle the callbacks when scan events are received */
+class scanCallbacks : public NimBLEScanCallbacks {
+    void onResult(const NimBLEAdvertisedDevice* advertisedDevice) override {
+        printf("Advertised Device found: %s\n", advertisedDevice->toString().c_str());
+        if (advertisedDevice->isAdvertisingService(NimBLEUUID("DEAD"))) {
+            printf("Found Our Service\n");
+            /** stop scan before connecting */
+            NimBLEDevice::getScan()->stop();
+            /** Save the device reference in a global for the client to use*/
+            advDevice = advertisedDevice;
+            /** Ready to connect now */
+            doConnect = true;
+        }
+    }
+
+    /** Callback to process the results of the completed scan or restart it */
+    void onScanEnd(const NimBLEScanResults& results, int reason) override {
+        printf("Scan Ended, reason: %d, device count: %d; Restarting scan\n", reason, results.getCount());
+        NimBLEDevice::getScan()->start(scanTime, false, true);
+    }
+} scanCB;
+
+/** Notification / Indication receiving handler callback */
+void notifyCB(NimBLERemoteCharacteristic* pRemoteCharacteristic, uint8_t* pData, size_t length, bool isNotify) {
+    std::string str  = (isNotify == true) ? "Notification" : "Indication";
+    str             += " from ";
+    str             += pRemoteCharacteristic->getClient()->getPeerAddress().toString();
+    str             += ": Service = " + pRemoteCharacteristic->getRemoteService()->getUUID().toString();
+    str             += ", Characteristic = " + pRemoteCharacteristic->getUUID().toString();
+    str             += ", Value = " + std::string((char*)pData, length);
+    printf("%s\n", str.c_str());
+}
+
+/** Handles the provisioning of clients and connects / interfaces with the server */
+bool connectToServer() {
+    NimBLEClient* pClient = nullptr;
+
+    /** Check if we have a client we should reuse first **/
+    if (NimBLEDevice::getCreatedClientCount()) {
+        /**
+         *  Special case when we already know this device, we send false as the
+         *  second argument in connect() to prevent refreshing the service database.
+         *  This saves considerable time and power.
+         */
+        pClient = NimBLEDevice::getClientByPeerAddress(advDevice->getAddress());
+        if (pClient) {
+            if (!pClient->connect(advDevice, false)) {
+                printf("Reconnect failed\n");
+                return false;
+            }
+            printf("Reconnected client\n");
+        } else {
+            /**
+             *  We don't already have a client that knows this device,
+             *  check for a client that is disconnected that we can use.
+             */
+            pClient = NimBLEDevice::getDisconnectedClient();
+        }
+    }
+
+    /** No client to reuse? Create a new one. */
+    if (!pClient) {
+        if (NimBLEDevice::getCreatedClientCount() >= NIMBLE_MAX_CONNECTIONS) {
+            printf("Max clients reached - no more connections available\n");
+            return false;
+        }
+
+        pClient = NimBLEDevice::createClient();
+
+        printf("New client created\n");
+
+        pClient->setClientCallbacks(&clientCB, false);
+        /**
+         *  Set initial connection parameters:
+         *  These settings are safe for 3 clients to connect reliably, can go faster if you have less
+         *  connections. Timeout should be a multiple of the interval, minimum is 100ms.
+         *  Min interval: 12 * 1.25ms = 15, Max interval: 12 * 1.25ms = 15, 0 latency, 150 * 10ms = 1500ms timeout
+         */
+        pClient->setConnectionParams(12, 12, 0, 150);
+
+        /** Set how long we are willing to wait for the connection to complete (milliseconds), default is 30000. */
+        pClient->setConnectTimeout(5 * 1000);
+
+        if (!pClient->connect(advDevice)) {
+            /** Created a client but failed to connect, don't need to keep it as it has no data */
+            NimBLEDevice::deleteClient(pClient);
+            printf("Failed to connect, deleted client\n");
+            return false;
+        }
+    }
+
+    if (!pClient->isConnected()) {
+        if (!pClient->connect(advDevice)) {
+            printf("Failed to connect\n");
+            return false;
+        }
+    }
+
+    printf("Connected to: %s RSSI: %d\n", pClient->getPeerAddress().toString().c_str(), pClient->getRssi());
+
+    /** Now we can read/write/subscribe the characteristics of the services we are interested in */
+    NimBLERemoteService*        pSvc = nullptr;
+    NimBLERemoteCharacteristic* pChr = nullptr;
+    NimBLERemoteDescriptor*     pDsc = nullptr;
+
+    pSvc = pClient->getService("DEAD");
+    if (pSvc) {
+        pChr = pSvc->getCharacteristic("BEEF");
+    }
+
+    if (pChr) {
+        if (pChr->canRead()) {
+            printf("%s Value: %s\n", pChr->getUUID().toString().c_str(), pChr->readValue().c_str());
+        }
+
+        if (pChr->canWrite()) {
+            if (pChr->writeValue("Tasty")) {
+                printf("Wrote new value to: %s\n", pChr->getUUID().toString().c_str());
+            } else {
+                pClient->disconnect();
+                return false;
+            }
+
+            if (pChr->canRead()) {
+                printf("The value of: %s is now: %s\n", pChr->getUUID().toString().c_str(), pChr->readValue().c_str());
+            }
+        }
+
+        if (pChr->canNotify()) {
+            if (!pChr->subscribe(true, notifyCB)) {
+                pClient->disconnect();
+                return false;
+            }
+        } else if (pChr->canIndicate()) {
+            /** Send false as first argument to subscribe to indications instead of notifications */
+            if (!pChr->subscribe(false, notifyCB)) {
+                pClient->disconnect();
+                return false;
+            }
+        }
+    } else {
+        printf("DEAD service not found.\n");
+    }
+
+    pSvc = pClient->getService("BAAD");
+    if (pSvc) {
+        pChr = pSvc->getCharacteristic("F00D");
+        if (pChr) {
+            if (pChr->canRead()) {
+                printf("%s Value: %s\n", pChr->getUUID().toString().c_str(), pChr->readValue().c_str());
+            }
+
+            pDsc = pChr->getDescriptor(NimBLEUUID("C01D"));
+            if (pDsc) {
+                printf("Descriptor: %s  Value: %s\n", pDsc->getUUID().toString().c_str(), pDsc->readValue().c_str());
+            }
+
+            if (pChr->canWrite()) {
+                if (pChr->writeValue("No tip!")) {
+                    printf("Wrote new value to: %s\n", pChr->getUUID().toString().c_str());
+                } else {
+                    pClient->disconnect();
+                    return false;
+                }
+
+                if (pChr->canRead()) {
+                    printf("The value of: %s is now: %s\n", pChr->getUUID().toString().c_str(), pChr->readValue().c_str());
+                }
+            }
+
+            if (pChr->canNotify()) {
+                if (!pChr->subscribe(true, notifyCB)) {
+                    pClient->disconnect();
+                    return false;
+                }
+            } else if (pChr->canIndicate()) {
+                /** Send false as first argument to subscribe to indications instead of notifications */
+                if (!pChr->subscribe(false, notifyCB)) {
+                    pClient->disconnect();
+                    return false;
+                }
+            }
+        }
+    } else {
+        printf("BAAD service not found.\n");
+    }
+
+    printf("Done with this device!\n");
+    return true;
+}
+
+extern "C"
+void app_main(void) {
+    printf("Starting NimBLE Client\n");
+    /** Initialize NimBLE and set the device name */
+    NimBLEDevice::init("NimBLE-Client");
+
+    /**
+     * Set the IO capabilities of the device, each option will trigger a different pairing method.
+     *  BLE_HS_IO_KEYBOARD_ONLY   - Passkey pairing
+     *  BLE_HS_IO_DISPLAY_YESNO   - Numeric comparison pairing
+     *  BLE_HS_IO_NO_INPUT_OUTPUT - DEFAULT setting - just works pairing
+     */
+    // NimBLEDevice::setSecurityIOCap(BLE_HS_IO_KEYBOARD_ONLY); // use passkey
+    // NimBLEDevice::setSecurityIOCap(BLE_HS_IO_DISPLAY_YESNO); //use numeric comparison
+
+    /**
+     * 2 different ways to set security - both calls achieve the same result.
+     *  no bonding, no man in the middle protection, BLE secure connections.
+     *  These are the default values, only shown here for demonstration.
+     */
+    // NimBLEDevice::setSecurityAuth(false, false, true);
+
+    NimBLEDevice::setSecurityAuth(/*BLE_SM_PAIR_AUTHREQ_BOND | BLE_SM_PAIR_AUTHREQ_MITM |*/ BLE_SM_PAIR_AUTHREQ_SC);
+
+    /** Optional: set the transmit power */
+    NimBLEDevice::setPower(3); // 9dbm
+    NimBLEScan* pScan = NimBLEDevice::getScan();
+
+    /** Set the callbacks to call when scan events occur, no duplicates */
+    pScan->setScanCallbacks(&scanCB, false);
+
+    /** Set scan interval (how often) and window (how long) in milliseconds */
+    pScan->setInterval(100);
+    pScan->setWindow(100);
+
+    /**
+     * Active scan will gather scan response data from advertisers
+     *  but will use more energy from both devices
+     */
+    pScan->setActiveScan(true);
+
+    /** Start scanning for advertisers */
+    pScan->start(scanTime);
+    printf("Scanning for peripherals\n");
+
+    /** Loop here until we find a device we want to connect to */
+    for (;;) {
+        vTaskDelay(10 / portTICK_PERIOD_MS);
+
+        if (doConnect) {
+            doConnect = false;
+            /** Found a device we want to connect to, do it now */
+            if (connectToServer()) {
+                printf("Success! we should now be getting notifications, scanning for more!\n");
+            } else {
+                printf("Failed to connect, starting scan\n");
+            }
+
+            NimBLEDevice::getScan()->start(scanTime, false, true);
+        }
+    }
+}

examples/NimBLE_Client/sdkconfig.defaults

@@ -0,0 +1,12 @@
+# Override some defaults so BT stack is enabled
+# in this example
+
+#
+# BT config
+#
+CONFIG_BT_ENABLED=y
+CONFIG_BTDM_CTRL_MODE_BLE_ONLY=y
+CONFIG_BTDM_CTRL_MODE_BR_EDR_ONLY=n
+CONFIG_BTDM_CTRL_MODE_BTDM=n
+CONFIG_BT_BLUEDROID_ENABLED=n
+CONFIG_BT_NIMBLE_ENABLED=y

examples/NimBLE_Server/CMakeLists.txt

@@ -3,5 +3,4 @@
 cmake_minimum_required(VERSION 3.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-set(SUPPORTED_TARGETS esp32)
 project(NimBLE_Server)

examples/NimBLE_Server/main/main.cpp

@@ -0,0 +1,218 @@
+
+/**
+ *  NimBLE_Server Demo:
+ *
+ *  Demonstrates many of the available features of the NimBLE server library.
+ *
+ *  Created: on March 22 2020
+ *      Author: H2zero
+ */
+
+#include <NimBLEDevice.h>
+
+static NimBLEServer* pServer;
+
+/**  None of these are required as they will be handled by the library with defaults. **
+ **                       Remove as you see fit for your needs                        */
+class ServerCallbacks : public NimBLEServerCallbacks {
+    void onConnect(NimBLEServer* pServer, NimBLEConnInfo& connInfo) override {
+        printf("Client address: %s\n", connInfo.getAddress().toString().c_str());
+
+        /**
+         *  We can use the connection handle here to ask for different connection parameters.
+         *  Args: connection handle, min connection interval, max connection interval
+         *  latency, supervision timeout.
+         *  Units; Min/Max Intervals: 1.25 millisecond increments.
+         *  Latency: number of intervals allowed to skip.
+         *  Timeout: 10 millisecond increments.
+         */
+        pServer->updateConnParams(connInfo.getConnHandle(), 24, 48, 0, 18);
+    }
+
+    void onDisconnect(NimBLEServer* pServer, NimBLEConnInfo& connInfo, int reason) override {
+        printf("Client disconnected - start advertising\n");
+        NimBLEDevice::startAdvertising();
+    }
+
+    void onMTUChange(uint16_t MTU, NimBLEConnInfo& connInfo) override {
+        printf("MTU updated: %u for connection ID: %u\n", MTU, connInfo.getConnHandle());
+    }
+
+    /********************* Security handled here *********************/
+    uint32_t onPassKeyDisplay() override {
+        printf("Server Passkey Display\n");
+        /**
+         * This should return a random 6 digit number for security
+         *  or make your own static passkey as done here.
+         */
+        return 123456;
+    }
+
+    void onConfirmPassKey(NimBLEConnInfo& connInfo, uint32_t pass_key) override {
+        printf("The passkey YES/NO number: %" PRIu32 "\n", pass_key);
+        /** Inject false if passkeys don't match. */
+        NimBLEDevice::injectConfirmPasskey(connInfo, true);
+    }
+
+    void onAuthenticationComplete(NimBLEConnInfo& connInfo) override {
+        /** Check that encryption was successful, if not we disconnect the client */
+        if (!connInfo.isEncrypted()) {
+            NimBLEDevice::getServer()->disconnect(connInfo.getConnHandle());
+            printf("Encrypt connection failed - disconnecting client\n");
+            return;
+        }
+
+        printf("Secured connection to: %s\n", connInfo.getAddress().toString().c_str());
+    }
+} serverCallbacks;
+
+/** Handler class for characteristic actions */
+class CharacteristicCallbacks : public NimBLECharacteristicCallbacks {
+    void onRead(NimBLECharacteristic* pCharacteristic, NimBLEConnInfo& connInfo) override {
+        printf("%s : onRead(), value: %s\n",
+               pCharacteristic->getUUID().toString().c_str(),
+               pCharacteristic->getValue().c_str());
+    }
+
+    void onWrite(NimBLECharacteristic* pCharacteristic, NimBLEConnInfo& connInfo) override {
+        printf("%s : onWrite(), value: %s\n",
+               pCharacteristic->getUUID().toString().c_str(),
+               pCharacteristic->getValue().c_str());
+    }
+
+    /**
+     *  The value returned in code is the NimBLE host return code.
+     */
+    void onStatus(NimBLECharacteristic* pCharacteristic, int code) override {
+        printf("Notification/Indication return code: %d, %s\n", code, NimBLEUtils::returnCodeToString(code));
+    }
+
+    /** Peer subscribed to notifications/indications */
+    void onSubscribe(NimBLECharacteristic* pCharacteristic, NimBLEConnInfo& connInfo, uint16_t subValue) override {
+        std::string str  = "Client ID: ";
+        str             += connInfo.getConnHandle();
+        str             += " Address: ";
+        str             += connInfo.getAddress().toString();
+        if (subValue == 0) {
+            str += " Unsubscribed to ";
+        } else if (subValue == 1) {
+            str += " Subscribed to notifications for ";
+        } else if (subValue == 2) {
+            str += " Subscribed to indications for ";
+        } else if (subValue == 3) {
+            str += " Subscribed to notifications and indications for ";
+        }
+        str += std::string(pCharacteristic->getUUID());
+
+        printf("%s\n", str.c_str());
+    }
+} chrCallbacks;
+
+/** Handler class for descriptor actions */
+class DescriptorCallbacks : public NimBLEDescriptorCallbacks {
+    void onWrite(NimBLEDescriptor* pDescriptor, NimBLEConnInfo& connInfo) override {
+        std::string dscVal = pDescriptor->getValue();
+        printf("Descriptor written value: %s\n", dscVal.c_str());
+    }
+
+    void onRead(NimBLEDescriptor* pDescriptor, NimBLEConnInfo& connInfo) override {
+        printf("%s Descriptor read\n", pDescriptor->getUUID().toString().c_str());
+    }
+} dscCallbacks;
+
+extern "C" void app_main(void) {
+    printf("Starting NimBLE Server\n");
+
+    /** Initialize NimBLE and set the device name */
+    NimBLEDevice::init("NimBLE");
+
+    /**
+     * Set the IO capabilities of the device, each option will trigger a different pairing method.
+     *  BLE_HS_IO_DISPLAY_ONLY    - Passkey pairing
+     *  BLE_HS_IO_DISPLAY_YESNO   - Numeric comparison pairing
+     *  BLE_HS_IO_NO_INPUT_OUTPUT - DEFAULT setting - just works pairing
+     */
+    // NimBLEDevice::setSecurityIOCap(BLE_HS_IO_DISPLAY_ONLY); // use passkey
+    // NimBLEDevice::setSecurityIOCap(BLE_HS_IO_DISPLAY_YESNO); //use numeric comparison
+
+    /**
+     *  2 different ways to set security - both calls achieve the same result.
+     *  no bonding, no man in the middle protection, BLE secure connections.
+     *
+     *  These are the default values, only shown here for demonstration.
+     */
+    // NimBLEDevice::setSecurityAuth(false, false, true);
+
+    NimBLEDevice::setSecurityAuth(/*BLE_SM_PAIR_AUTHREQ_BOND | BLE_SM_PAIR_AUTHREQ_MITM |*/ BLE_SM_PAIR_AUTHREQ_SC);
+    pServer = NimBLEDevice::createServer();
+    pServer->setCallbacks(&serverCallbacks);
+
+    NimBLEService*        pDeadService = pServer->createService("DEAD");
+    NimBLECharacteristic* pBeefCharacteristic =
+        pDeadService->createCharacteristic("BEEF",
+                                           NIMBLE_PROPERTY::READ | NIMBLE_PROPERTY::WRITE |
+                                               /** Require a secure connection for read and write access */
+                                               NIMBLE_PROPERTY::READ_ENC | // only allow reading if paired / encrypted
+                                               NIMBLE_PROPERTY::WRITE_ENC  // only allow writing if paired / encrypted
+        );
+
+    pBeefCharacteristic->setValue("Burger");
+    pBeefCharacteristic->setCallbacks(&chrCallbacks);
+
+    /**
+     *  2902 and 2904 descriptors are a special case, when createDescriptor is called with
+     *  either of those uuid's it will create the associated class with the correct properties
+     *  and sizes. However we must cast the returned reference to the correct type as the method
+     *  only returns a pointer to the base NimBLEDescriptor class.
+     */
+    NimBLE2904* pBeef2904 = pBeefCharacteristic->create2904();
+    pBeef2904->setFormat(NimBLE2904::FORMAT_UTF8);
+    pBeef2904->setCallbacks(&dscCallbacks);
+
+    NimBLEService*        pBaadService = pServer->createService("BAAD");
+    NimBLECharacteristic* pFoodCharacteristic =
+        pBaadService->createCharacteristic("F00D", NIMBLE_PROPERTY::READ | NIMBLE_PROPERTY::WRITE | NIMBLE_PROPERTY::NOTIFY);
+
+    pFoodCharacteristic->setValue("Fries");
+    pFoodCharacteristic->setCallbacks(&chrCallbacks);
+
+    /** Custom descriptor: Arguments are UUID, Properties, max length of the value in bytes */
+    NimBLEDescriptor* pC01Ddsc =
+        pFoodCharacteristic->createDescriptor("C01D",
+                                              NIMBLE_PROPERTY::READ | NIMBLE_PROPERTY::WRITE | NIMBLE_PROPERTY::WRITE_ENC,
+                                              20);
+    pC01Ddsc->setValue("Send it back!");
+    pC01Ddsc->setCallbacks(&dscCallbacks);
+
+    /** Start the services when finished creating all Characteristics and Descriptors */
+    pDeadService->start();
+    pBaadService->start();
+
+    /** Create an advertising instance and add the services to the advertised data */
+    NimBLEAdvertising* pAdvertising = NimBLEDevice::getAdvertising();
+    pAdvertising->setName("NimBLE-Server");
+    pAdvertising->addServiceUUID(pDeadService->getUUID());
+    pAdvertising->addServiceUUID(pBaadService->getUUID());
+    /**
+     *  If your device is battery powered you may consider setting scan response
+     *  to false as it will extend battery life at the expense of less data sent.
+     */
+    pAdvertising->enableScanResponse(true);
+    pAdvertising->start();
+
+    printf("Advertising Started\n");
+
+    /** Loop here and send notifications to connected peers */
+    for (;;) {
+        if (pServer->getConnectedCount()) {
+            NimBLEService* pSvc = pServer->getServiceByUUID("BAAD");
+            if (pSvc) {
+                NimBLECharacteristic* pChr = pSvc->getCharacteristic("F00D");
+                if (pChr) {
+                    pChr->notify();
+                }
+            }
+        }
+        vTaskDelay(2000 / portTICK_PERIOD_MS);
+    }
+}

examples/NimBLE_Server/sdkconfig.defaults

@@ -0,0 +1,12 @@
+# Override some defaults so BT stack is enabled
+# in this example
+
+#
+# BT config
+#
+CONFIG_BT_ENABLED=y
+CONFIG_BTDM_CTRL_MODE_BLE_ONLY=y
+CONFIG_BTDM_CTRL_MODE_BR_EDR_ONLY=n
+CONFIG_BTDM_CTRL_MODE_BTDM=n
+CONFIG_BT_BLUEDROID_ENABLED=n
+CONFIG_BT_NIMBLE_ENABLED=y

examples/basic/BLE_client/Makefile

@@ -1,3 +0,0 @@
-PROJECT_NAME := BLE_client
-
-include $(IDF_PATH)/make/project.mk

examples/basic/BLE_client/main/component.mk

@@ -1,4 +0,0 @@
-#
-# "main" pseudo-component makefile.
-#
-# (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.)

examples/basic/BLE_client/main/main.cpp

@@ -1,200 +0,0 @@
-/**
- * A BLE client example that is rich in capabilities.
- * There is a lot new capabilities implemented.
- * author unknown
- * updated by chegewara
- * updated for NimBLE by H2zero
- */
- 
-/** NimBLE differences highlighted in comment blocks **/
-
-/*******original********
-#include "BLEDevice.h"
-***********************/
-#include "NimBLEDevice.h"
-
-extern "C"{void app_main(void);}
- 
-// The remote service we wish to connect to.
-static BLEUUID serviceUUID("4fafc201-1fb5-459e-8fcc-c5c9c331914b");
-// The characteristic of the remote service we are interested in.
-static BLEUUID    charUUID("beb5483e-36e1-4688-b7f5-ea07361b26a8");
-
-static bool doConnect = false;
-static bool connected = false;
-static bool doScan = false;
-static BLERemoteCharacteristic* pRemoteCharacteristic;
-static BLEAdvertisedDevice* myDevice;
-
-static void notifyCallback(
-  BLERemoteCharacteristic* pBLERemoteCharacteristic,
-  uint8_t* pData,
-  size_t length,
-  bool isNotify) {
-    printf("Notify callback for characteristic %s of data length %d data: %s\n",
-           pBLERemoteCharacteristic->getUUID().toString().c_str(),
-           length,
-           (char*)pData);
-}
-
-/**  None of these are required as they will be handled by the library with defaults. **
- **                       Remove as you see fit for your needs                        */  
-class MyClientCallback : public BLEClientCallbacks {
-  void onConnect(BLEClient* pclient) {
-  }
-
-  void onDisconnect(BLEClient* pclient) {
-    connected = false;
-    printf("onDisconnect");
-  }
-/***************** New - Security handled here ********************
-****** Note: these are the same return values as defaults ********/
-  uint32_t onPassKeyRequest(){
-    printf("Client PassKeyRequest\n");
-    return 123456; 
-  }
-  bool onConfirmPIN(uint32_t pass_key){
-    printf("The passkey YES/NO number: %d\n", pass_key);
-    return true; 
-  }
-
-  void onAuthenticationComplete(ble_gap_conn_desc desc){
-    printf("Starting BLE work!\n");
-  }
-/*******************************************************************/
-};
-
-bool connectToServer() {
-    printf("Forming a connection to %s\n", myDevice->getAddress().toString().c_str());
-
-    BLEClient*  pClient  = BLEDevice::createClient();
-    printf(" - Created client\n");
-
-    pClient->setClientCallbacks(new MyClientCallback());
-
-    // Connect to the remove BLE Server.
-    pClient->connect(myDevice);  // if you pass BLEAdvertisedDevice instead of address, it will be recognized type of peer device address (public or private)
-    printf(" - Connected to server\n");
-
-    // Obtain a reference to the service we are after in the remote BLE server.
-    BLERemoteService* pRemoteService = pClient->getService(serviceUUID);
-    if (pRemoteService == nullptr) {
-      printf("Failed to find our service UUID: %s\n", serviceUUID.toString().c_str());
-      pClient->disconnect();
-      return false;
-    }
-    printf(" - Found our service\n");
-
-
-    // Obtain a reference to the characteristic in the service of the remote BLE server.
-    pRemoteCharacteristic = pRemoteService->getCharacteristic(charUUID);
-    if (pRemoteCharacteristic == nullptr) {
-      printf("Failed to find our characteristic UUID: %s\n", charUUID.toString().c_str());
-      pClient->disconnect();
-      return false;
-    }
-    printf(" - Found our characteristic\n");
-
-    // Read the value of the characteristic.
-    if(pRemoteCharacteristic->canRead()) {
-      std::string value = pRemoteCharacteristic->readValue();
-      printf("The characteristic value was: %s\n", value.c_str());
-      }
-    /** registerForNotify() has been deprecated and replaced with subscribe() / unsubscribe().
-     *  Subscribe parameter defaults are: notifications=true, notifyCallback=nullptr, response=false.
-     *  Unsubscribe parameter defaults are: response=false. 
-     */
-    if(pRemoteCharacteristic->canNotify()) {
-        //pRemoteCharacteristic->registerForNotify(notifyCallback);
-        pRemoteCharacteristic->subscribe(true, notifyCallback);
-    }
-
-    connected = true;
-    return true;
-}
-
-/**
- * Scan for BLE servers and find the first one that advertises the service we are looking for.
- */
-class MyAdvertisedDeviceCallbacks: public BLEAdvertisedDeviceCallbacks {
- /**
-   * Called for each advertising BLE server.
-   */
-   
-/*** Only a reference to the advertised device is passed now
-  void onResult(BLEAdvertisedDevice advertisedDevice) { **/     
-  void onResult(BLEAdvertisedDevice* advertisedDevice) {
-    printf("BLE Advertised Device found: %s\n", advertisedDevice->toString().c_str());
-
-    // We have found a device, let us now see if it contains the service we are looking for.
-/********************************************************************************
-    if (advertisedDevice.haveServiceUUID() && advertisedDevice.isAdvertisingService(serviceUUID)) {
-********************************************************************************/
-    if (advertisedDevice->haveServiceUUID() && advertisedDevice->isAdvertisingService(serviceUUID)) {
-
-      BLEDevice::getScan()->stop();
-/*******************************************************************
-      myDevice = new BLEAdvertisedDevice(advertisedDevice);
-*******************************************************************/
-      myDevice = advertisedDevice; /** Just save the reference now, no need to copy the object */
-      doConnect = true;
-      doScan = true;
-
-    } // Found our server
-  } // onResult
-}; // MyAdvertisedDeviceCallbacks
-
-
-// This is the Arduino main loop function.
-void connectTask (void * parameter){
-    for(;;) {
-      // If the flag "doConnect" is true then we have scanned for and found the desired
-      // BLE Server with which we wish to connect.  Now we connect to it.  Once we are 
-      // connected we set the connected flag to be true.
-      if (doConnect == true) {
-        if (connectToServer()) {
-          printf("We are now connected to the BLE Server.\n");
-        } else {
-          printf("We have failed to connect to the server; there is nothin more we will do.\n");
-        }
-        doConnect = false;
-      }
-
-      // If we are connected to a peer BLE Server, update the characteristic each time we are reached
-      // with the current time since boot.
-      if (connected) {
-        char buf[256];
-        snprintf(buf, 256, "Time since boot: %lu", (unsigned long)(esp_timer_get_time() / 1000000ULL));
-        printf("Setting new characteristic value to %s\n", buf);
-        
-        // Set the characteristic's value to be the array of bytes that is actually a string.
-        /*** Note: write value now returns true if successful, false otherwise - try again or disconnect ***/
-        pRemoteCharacteristic->writeValue((uint8_t*)buf, strlen(buf), false);
-      }else if(doScan){
-        BLEDevice::getScan()->start(0);  // this is just eample to start scan after disconnect, most likely there is better way to do it in arduino
-      }
-      
-      vTaskDelay(1000/portTICK_PERIOD_MS); // Delay a second between loops.
-    }
-    
-    vTaskDelete(NULL);
-} // End of loop
-
-
-void app_main(void) {
-  printf("Starting BLE Client application...\n");
-  BLEDevice::init("");
-
-  // Retrieve a Scanner and set the callback we want to use to be informed when we
-  // have detected a new device.  Specify that we want active scanning and start the
-  // scan to run for 5 seconds.
-  BLEScan* pBLEScan = BLEDevice::getScan();
-  pBLEScan->setAdvertisedDeviceCallbacks(new MyAdvertisedDeviceCallbacks());
-  pBLEScan->setInterval(1349);
-  pBLEScan->setWindow(449);
-  pBLEScan->setActiveScan(true);
-  
-  xTaskCreate(connectTask, "connectTask", 5000, NULL, 1, NULL);
-  pBLEScan->start(5, false);
-} // End of setup.
-

examples/basic/BLE_notify/CMakeLists.txt

@@ -1,7 +0,0 @@
-# The following lines of boilerplate have to be in your project's
-# CMakeLists in this exact order for cmake to work correctly
-cmake_minimum_required(VERSION 3.5)
-
-include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-set(SUPPORTED_TARGETS esp32)
-project(BLE_notify)

examples/basic/BLE_notify/Makefile

@@ -1,3 +0,0 @@
-PROJECT_NAME := BLE_notify
-
-include $(IDF_PATH)/make/project.mk

examples/basic/BLE_notify/main/component.mk

@@ -1,4 +0,0 @@
-#
-# "main" pseudo-component makefile.
-#
-# (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.)

examples/basic/BLE_notify/main/main.cpp

@@ -1,155 +0,0 @@
-/*
-    Video: https://www.youtube.com/watch?v=oCMOYS71NIU
-    Based on Neil Kolban example for IDF: https://github.com/nkolban/esp32-snippets/blob/master/cpp_utils/tests/BLE%20Tests/SampleNotify.cpp
-    Ported to Arduino ESP32 by Evandro Copercini
-    updated by chegewara
-    Refactored back to IDF by H2zero
-
-   Create a BLE server that, once we receive a connection, will send periodic notifications.
-   The service advertises itself as: 4fafc201-1fb5-459e-8fcc-c5c9c331914b
-   And has a characteristic of: beb5483e-36e1-4688-b7f5-ea07361b26a8
-
-   The design of creating the BLE server is:
-   1. Create a BLE Server
-   2. Create a BLE Service
-   3. Create a BLE Characteristic on the Service
-   4. Create a BLE Descriptor on the characteristic
-   5. Start the service.
-   6. Start advertising.
-
-   A connect hander associated with the server starts a background task that performs notification
-   every couple of seconds.
-*/
-
-/** NimBLE differences highlighted in comment blocks **/
-
-/*******original********
-#include <BLEDevice.h>
-#include <BLEServer.h>
-#include <BLEUtils.h>
-#include <BLE2902.h>
-***********************/
-#include <NimBLEDevice.h>
-
-extern "C" {void app_main(void);}
-
-BLEServer* pServer = NULL;
-BLECharacteristic* pCharacteristic = NULL;
-bool deviceConnected = false;
-bool oldDeviceConnected = false;
-uint32_t value = 0;
-
-// See the following for generating UUIDs:
-// https://www.uuidgenerator.net/
-
-#define SERVICE_UUID        "4fafc201-1fb5-459e-8fcc-c5c9c331914b"
-#define CHARACTERISTIC_UUID "beb5483e-36e1-4688-b7f5-ea07361b26a8"
-
-/**  None of these are required as they will be handled by the library with defaults. **
- **                       Remove as you see fit for your needs                        */  
-class MyServerCallbacks: public BLEServerCallbacks {
-    void onConnect(BLEServer* pServer) {
-      deviceConnected = true;
-    };
-
-    void onDisconnect(BLEServer* pServer) {
-      deviceConnected = false;
-    }
-/***************** New - Security handled here ********************
-****** Note: these are the same return values as defaults ********/
-  uint32_t onPassKeyRequest(){
-    printf("Server PassKeyRequest\n");
-    return 123456; 
-  }
-
-  bool onConfirmPIN(uint32_t pass_key){
-    printf("The passkey YES/NO number: %d\n", pass_key);
-    return true; 
-  }
-
-  void onAuthenticationComplete(ble_gap_conn_desc desc){
-    printf("Starting BLE work!\n");
-  }
-/*******************************************************************/
-};
-
-void connectedTask (void * parameter){
-    for(;;) {
-        // notify changed value
-        if (deviceConnected) {
-            pCharacteristic->setValue((uint8_t*)&value, 4);
-            pCharacteristic->notify();
-            value++;
-            vTaskDelay(100/portTICK_PERIOD_MS);  // bluetooth stack will go into congestion, if too many packets are sent
-        }
-        // disconnecting
-        if (!deviceConnected && oldDeviceConnected) {
-            vTaskDelay(500/portTICK_PERIOD_MS); // give the bluetooth stack the chance to get things ready
-            pServer->startAdvertising(); // restart advertising
-            printf("start advertising\n");
-            oldDeviceConnected = deviceConnected;
-        }
-        // connecting
-        if (deviceConnected && !oldDeviceConnected) {
-            // do stuff here on connecting
-            oldDeviceConnected = deviceConnected;
-        }
-        
-        vTaskDelay(10/portTICK_PERIOD_MS); // Delay between loops to reset watchdog timer
-    }
-    
-    vTaskDelete(NULL);
-}
-    
-void app_main(void) {
-  // Create the BLE Device
-  BLEDevice::init("ESP32");
-
-  // Create the BLE Server
-  pServer = BLEDevice::createServer();
-  pServer->setCallbacks(new MyServerCallbacks());
-
-  // Create the BLE Service
-  BLEService *pService = pServer->createService(SERVICE_UUID);
-
-  // Create a BLE Characteristic
-  pCharacteristic = pService->createCharacteristic(
-                      CHARACTERISTIC_UUID,
-                /******* Enum Type NIMBLE_PROPERTY now *******     
-                      BLECharacteristic::PROPERTY_READ   |
-                      BLECharacteristic::PROPERTY_WRITE  |
-                      BLECharacteristic::PROPERTY_NOTIFY |
-                      BLECharacteristic::PROPERTY_INDICATE
-                    );
-                **********************************************/    
-                      NIMBLE_PROPERTY::READ   |
-                      NIMBLE_PROPERTY::WRITE  |
-                      NIMBLE_PROPERTY::NOTIFY |
-                      NIMBLE_PROPERTY::INDICATE
-                    );
-
-  // https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.descriptor.gatt.client_characteristic_configuration.xml
-  // Create a BLE Descriptor
-  /***************************************************   
-   NOTE: DO NOT create a 2902 descriptor. 
-   it will be created automatically if notifications 
-   or indications are enabled on a characteristic.
-   
-   pCharacteristic->addDescriptor(new BLE2902());
-  ****************************************************/
-  // Start the service
-  pService->start();
-
-  // Start advertising
-  BLEAdvertising *pAdvertising = BLEDevice::getAdvertising();
-  pAdvertising->addServiceUUID(SERVICE_UUID);
-  pAdvertising->setScanResponse(false);
-  /** This method had been removed **
-  pAdvertising->setMinPreferred(0x0);  // set value to 0x00 to not advertise this parameter
-  **/
-  
-  xTaskCreate(connectedTask, "connectedTask", 5000, NULL, 1, NULL);
-  
-  BLEDevice::startAdvertising();
-  printf("Waiting a client connection to notify...\n");
-}

examples/basic/BLE_scan/Makefile

@@ -1,3 +0,0 @@
-PROJECT_NAME := BLE_scan
-
-include $(IDF_PATH)/make/project.mk

examples/basic/BLE_scan/main/component.mk

@@ -1,4 +0,0 @@
-#
-# "main" pseudo-component makefile.
-#
-# (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.)

examples/basic/BLE_scan/main/main.cpp

@@ -1,52 +0,0 @@
-/*
-   Based on Neil Kolban example for IDF: https://github.com/nkolban/esp32-snippets/blob/master/cpp_utils/tests/BLE%20Tests/SampleScan.cpp
-   Ported to Arduino ESP32 by Evandro Copercini
-   Refactored back to IDF by H2zero
-*/
-
-/** NimBLE differences highlighted in comment blocks **/
-
-/*******original********
-#include <BLEDevice.h>
-#include <BLEUtils.h>
-#include <BLEScan.h>
-#include <BLEAdvertisedDevice.h>
-***********************/
-
-#include <NimBLEDevice.h>
-
-extern "C"{void app_main(void);}
-
-int scanTime = 5; //In seconds
-BLEScan* pBLEScan;
-
-class MyAdvertisedDeviceCallbacks: public BLEAdvertisedDeviceCallbacks {
-    void onResult(BLEAdvertisedDevice* advertisedDevice) {
-      printf("Advertised Device: %s \n", advertisedDevice->toString().c_str());
-    }
-};
-
-void scanTask (void * parameter){
-    for(;;) {
-        // put your main code here, to run repeatedly:
-        BLEScanResults foundDevices = pBLEScan->start(scanTime, false);
-        printf("Devices found: %d\n", foundDevices.getCount());
-        printf("Scan done!\n");
-        pBLEScan->clearResults();   // delete results fromBLEScan buffer to release memory
-        vTaskDelay(2000/portTICK_PERIOD_MS); // Delay a second between loops.
-    }
-    
-    vTaskDelete(NULL);
-}
-
-void app_main(void) {
-  printf("Scanning...\n");
-
-  BLEDevice::init("");
-  pBLEScan = BLEDevice::getScan(); //create new scan
-  pBLEScan->setAdvertisedDeviceCallbacks(new MyAdvertisedDeviceCallbacks());
-  pBLEScan->setActiveScan(true); //active scan uses more power, but get results faster
-  pBLEScan->setInterval(100);
-  pBLEScan->setWindow(99);  // less or equal setInterval value
-  xTaskCreate(scanTask, "scanTask", 5000, NULL, 1, NULL);
-}

examples/basic/BLE_server/CMakeLists.txt

@@ -1,7 +0,0 @@
-# The following lines of boilerplate have to be in your project's
-# CMakeLists in this exact order for cmake to work correctly
-cmake_minimum_required(VERSION 3.5)
-
-include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-set(SUPPORTED_TARGETS esp32)
-project(BLE_server)

examples/basic/BLE_server/Makefile

@@ -1,3 +0,0 @@
-PROJECT_NAME := BLE_server
-
-include $(IDF_PATH)/make/project.mk

examples/basic/BLE_server/main/CMakeLists.txt

@@ -1,4 +0,0 @@
-set(COMPONENT_SRCS "main.cpp")
-set(COMPONENT_ADD_INCLUDEDIRS ".")
-
-register_component()

examples/basic/BLE_server/main/component.mk

@@ -1,4 +0,0 @@
-#
-# "main" pseudo-component makefile.
-#
-# (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.)

examples/basic/BLE_server/main/main.cpp

@@ -1,57 +0,0 @@
-/*
-    Based on Neil Kolban example for IDF: https://github.com/nkolban/esp32-snippets/blob/master/cpp_utils/tests/BLE%20Tests/SampleServer.cpp
-    Ported to Arduino ESP32 by Evandro Copercini
-    updates by chegewara
-    Refactored back to IDF by H2zero
-*/
-
-/** NimBLE differences highlighted in comment blocks **/
-
-/*******original********
-#include <BLEDevice.h>
-#include <BLEUtils.h>
-#include <BLEServer.h>
-***********************/
-
-#include <NimBLEDevice.h>
-
-extern "C"{void app_main(void);}
-
-// See the following for generating UUIDs:
-// https://www.uuidgenerator.net/
-
-#define SERVICE_UUID        "4fafc201-1fb5-459e-8fcc-c5c9c331914b"
-#define CHARACTERISTIC_UUID "beb5483e-36e1-4688-b7f5-ea07361b26a8"
-
-void app_main(void) {
-  printf("Starting BLE work!\n");
-
-  BLEDevice::init("Long name works now");
-  BLEServer *pServer = BLEDevice::createServer();
-  BLEService *pService = pServer->createService(SERVICE_UUID);
-  BLECharacteristic *pCharacteristic = pService->createCharacteristic(
-                                        CHARACTERISTIC_UUID,
-                                  /***** Enum Type NIMBLE_PROPERTY now *****      
-                                        BLECharacteristic::PROPERTY_READ   |
-                                        BLECharacteristic::PROPERTY_WRITE  
-                                        );
-                                  *****************************************/
-                                        NIMBLE_PROPERTY::READ |
-                                        NIMBLE_PROPERTY::WRITE 
-                                       );
-
-  pCharacteristic->setValue("Hello World says Neil");
-  pService->start();
-  // BLEAdvertising *pAdvertising = pServer->getAdvertising();  // this still is working for backward compatibility
-  BLEAdvertising *pAdvertising = BLEDevice::getAdvertising();
-  pAdvertising->addServiceUUID(SERVICE_UUID);
-  pAdvertising->setScanResponse(true);
-  
-  /** These methods have been removed **
-  pAdvertising->setMinPreferred(0x06);  // functions that help with iPhone connections issue
-  pAdvertising->setMinPreferred(0x12);
-  */
-  
-  BLEDevice::startAdvertising();
-  printf("Characteristic defined! Now you can read it in your phone!\n");
-}

examples/basic/BLE_uart/Makefile

@@ -1,3 +0,0 @@
-PROJECT_NAME := BLE_uart
-
-include $(IDF_PATH)/make/project.mk

examples/basic/BLE_uart/main/CMakeLists.txt

@@ -1,4 +0,0 @@
-set(COMPONENT_SRCS "main.cpp")
-set(COMPONENT_ADD_INCLUDEDIRS ".")
-
-register_component()

examples/basic/BLE_uart/main/component.mk

@@ -1,4 +0,0 @@
-#
-# "main" pseudo-component makefile.
-#
-# (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.)

examples/basic/BLE_uart/main/main.cpp

@@ -1,167 +0,0 @@
-/*
-    Video: https://www.youtube.com/watch?v=oCMOYS71NIU
-    Based on Neil Kolban example for IDF: https://github.com/nkolban/esp32-snippets/blob/master/cpp_utils/tests/BLE%20Tests/SampleNotify.cpp
-    Ported to Arduino ESP32 by Evandro Copercini
-    Refactored back to IDF by H2zero
-
-   Create a BLE server that, once we receive a connection, will send periodic notifications.
-   The service advertises itself as: 6E400001-B5A3-F393-E0A9-E50E24DCCA9E
-   Has a characteristic of: 6E400002-B5A3-F393-E0A9-E50E24DCCA9E - used for receiving data with "WRITE" 
-   Has a characteristic of: 6E400003-B5A3-F393-E0A9-E50E24DCCA9E - used to send data with  "NOTIFY"
-
-   The design of creating the BLE server is:
-   1. Create a BLE Server
-   2. Create a BLE Service
-   3. Create a BLE Characteristic on the Service
-   4. Create a BLE Descriptor on the characteristic
-   5. Start the service.
-   6. Start advertising.
-
-   In this example rxValue is the data received (only accessible inside that function).
-   And txValue is the data to be sent, in this example just a byte incremented every second. 
-*/
-
-/** NimBLE differences highlighted in comment blocks **/
-
-/*******original********
-#include <BLEDevice.h>
-#include <BLEServer.h>
-#include <BLEUtils.h>
-#include <BLE2902.h>
-***********************/
-#include <NimBLEDevice.h>
-
-extern "C"{void app_main(void);}
-
-BLEServer *pServer = NULL;
-BLECharacteristic * pTxCharacteristic;
-bool deviceConnected = false;
-bool oldDeviceConnected = false;
-uint8_t txValue = 0;
-
-// See the following for generating UUIDs:
-// https://www.uuidgenerator.net/
-
-#define SERVICE_UUID           "6E400001-B5A3-F393-E0A9-E50E24DCCA9E" // UART service UUID
-#define CHARACTERISTIC_UUID_RX "6E400002-B5A3-F393-E0A9-E50E24DCCA9E"
-#define CHARACTERISTIC_UUID_TX "6E400003-B5A3-F393-E0A9-E50E24DCCA9E"
-
-
-/**  None of these are required as they will be handled by the library with defaults. **
- **                       Remove as you see fit for your needs                        */  
-class MyServerCallbacks: public BLEServerCallbacks {
-    void onConnect(BLEServer* pServer) {
-      deviceConnected = true;
-    };
-
-    void onDisconnect(BLEServer* pServer) {
-      deviceConnected = false;
-    }
-  /***************** New - Security handled here ********************
-  ****** Note: these are the same return values as defaults ********/
-    uint32_t onPassKeyRequest(){
-      printf("Server PassKeyRequest\n");
-      return 123456; 
-    }
-
-    bool onConfirmPIN(uint32_t pass_key){
-      printf("The passkey YES/NO number: %d\n", pass_key);
-      return true; 
-    }
-
-    void onAuthenticationComplete(ble_gap_conn_desc desc){
-      printf("Starting BLE work!\n");
-    }
-  /*******************************************************************/
-};
-
-class MyCallbacks: public BLECharacteristicCallbacks {
-    void onWrite(BLECharacteristic *pCharacteristic) {
-      std::string rxValue = pCharacteristic->getValue();
-
-      if (rxValue.length() > 0) {
-        printf("*********\n");
-        printf("Received Value: ");
-        for (int i = 0; i < rxValue.length(); i++)
-          printf("%d", rxValue[i]);
-      
-        printf("\n*********\n");
-      }
-    }
-};
-
-void connectedTask (void * parameter){
-    for(;;) {
-        if (deviceConnected) {
-            pTxCharacteristic->setValue(&txValue, 1);
-            pTxCharacteristic->notify();
-            txValue++;
-        }
-
-        // disconnecting
-        if (!deviceConnected && oldDeviceConnected) {
-            pServer->startAdvertising(); // restart advertising
-            printf("start advertising\n");
-            oldDeviceConnected = deviceConnected;
-        }
-        // connecting
-        if (deviceConnected && !oldDeviceConnected) {
-            // do stuff here on connecting
-            oldDeviceConnected = deviceConnected;
-        }
-        
-        vTaskDelay(10/portTICK_PERIOD_MS); // Delay between loops to reset watchdog timer
-    }
-    
-    vTaskDelete(NULL);
-}
-
-void app_main(void) {
-  // Create the BLE Device
-  BLEDevice::init("UART Service");
-
-  // Create the BLE Server
-  pServer = BLEDevice::createServer();
-  pServer->setCallbacks(new MyServerCallbacks());
-
-  // Create the BLE Service
-  BLEService *pService = pServer->createService(SERVICE_UUID);
-
-  // Create a BLE Characteristic
-  pTxCharacteristic = pService->createCharacteristic(
-                                        CHARACTERISTIC_UUID_TX,
-                                    /******* Enum Type NIMBLE_PROPERTY now *******      
-                                        BLECharacteristic::PROPERTY_NOTIFY
-                                        );
-                                    **********************************************/  
-                                        NIMBLE_PROPERTY::NOTIFY
-                                       );
-                                    
-  /***************************************************   
-   NOTE: DO NOT create a 2902 descriptor 
-   it will be created automatically if notifications 
-   or indications are enabled on a characteristic.
-   
-   pCharacteristic->addDescriptor(new BLE2902());
-  ****************************************************/                  
-
-  BLECharacteristic * pRxCharacteristic = pService->createCharacteristic(
-                                            CHARACTERISTIC_UUID_RX,
-                                    /******* Enum Type NIMBLE_PROPERTY now *******       
-                                            BLECharacteristic::PROPERTY_WRITE
-                                            );
-                                    *********************************************/  
-                                            NIMBLE_PROPERTY::WRITE
-                                            );
-
-  pRxCharacteristic->setCallbacks(new MyCallbacks());
-
-  // Start the service
-  pService->start();
-
-  xTaskCreate(connectedTask, "connectedTask", 5000, NULL, 1, NULL);
-  
-  // Start advertising
-  pServer->getAdvertising()->start();
-  printf("Waiting a client connection to notify...\n");
-}

idf_component.yml

@@ -0,0 +1,16 @@
+## IDF Component Manager Manifest File
+dependencies:
+  espressif/esp_hosted:
+    version: "*"
+    rules:
+      - if: "target in [esp32p4]"
+  espressif/esp_wifi_remote:
+    version: "*"
+    rules:
+      - if: "target in [esp32p4]"
+
+  ## Required IDF version
+  idf:
+    version: ">=5.3.0"
+    rules:
+      - if: "target in [esp32p4]"

package.json

@@ -0,0 +1,17 @@
+{
+  "name": "esp-nimble-cpp",
+  "version": "1.5.0",
+  "description": "NimBLE, BLE stack for the Espressif ESP32, ESP32-S and ESP32-C series of SoCs",
+  "keywords": [
+    "BLE",
+    "espidf",
+    "arduino",
+    "espressif",
+    "esp32"
+  ],
+  "license": "LGPL-2.1-or-later",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/h2zero/esp-nimble-cpp"
+  }
+}

pkg.yml

@@ -0,0 +1,20 @@
+pkg.name: esp-nimble-cpp
+pkg.type: lib
+pkg.description: NimBLE CPP wrapper
+pkg.author: "Ryan Powell"
+pkg.homepage: "http://mynewt.apache.org/"
+pkg.keywords:
+
+pkg.deps:
+    - "@apache-mynewt-nimble/nimble"
+    - "@apache-mynewt-nimble/nimble/host"
+    - "@apache-mynewt-nimble/nimble/host/services/gap"
+    - "@apache-mynewt-nimble/nimble/host/services/gatt"
+    - "@apache-mynewt-nimble/nimble/host/store/config"
+    - "@apache-mynewt-nimble/nimble/host/util"
+
+pkg.source_dirs:
+    - src
+
+pkg.include_dirs:
+    - src

src/HIDTypes.h

@@ -25,9 +25,9 @@
 #define HID_VERSION_1_11    (0x0111)
 
 /* HID Class */
-#define HID_CLASS           (3)
-#define HID_SUBCLASS_NONE   (0)
-#define HID_PROTOCOL_NONE   (0)
+#define BLE_HID_CLASS           (3)
+#define BLE_HID_SUBCLASS_NONE   (0)
+#define BLE_HID_PROTOCOL_NONE   (0)
 
 /* Descriptors */
 #define HID_DESCRIPTOR          (33)

src/NimBLE2904.cpp

@@ -12,75 +12,60 @@
  *      Author: kolban
  */
 
-/*
- * See also:
- * https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml
- */
 #include "nimconfig.h"
 #if defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
 
-#include "NimBLE2904.h"
-
-
-NimBLE2904::NimBLE2904(NimBLECharacteristic* pCharacteristic)
-: NimBLEDescriptor(NimBLEUUID((uint16_t) 0x2904),
-                            BLE_GATT_CHR_F_READ,
-                            sizeof(BLE2904_Data),
-                            pCharacteristic)
-{
-    m_data.m_format      = 0;
-    m_data.m_exponent    = 0;
-    m_data.m_namespace   = 1;  // 1 = Bluetooth SIG Assigned Numbers
-    m_data.m_unit        = 0;
-    m_data.m_description = 0;
-    setValue((uint8_t*) &m_data, sizeof(m_data));
-} // BLE2904
+# include "NimBLE2904.h"
 
+NimBLE2904::NimBLE2904(NimBLECharacteristic* pChr)
+    : NimBLEDescriptor(NimBLEUUID((uint16_t)0x2904), BLE_GATT_CHR_F_READ, sizeof(NimBLE2904Data), pChr) {
+    setValue(m_data);
+} // NimBLE2904
 
 /**
  * @brief Set the description.
+ * @param [in] description The description value to set.
  */
 void NimBLE2904::setDescription(uint16_t description) {
     m_data.m_description = description;
-    setValue((uint8_t*) &m_data, sizeof(m_data));
-}
-
+    setValue(m_data);
+} // setDescription
 
 /**
  * @brief Set the exponent.
+ * @param [in] exponent The exponent value to set.
  */
 void NimBLE2904::setExponent(int8_t exponent) {
     m_data.m_exponent = exponent;
-    setValue((uint8_t*) &m_data, sizeof(m_data));
+    setValue(m_data);
 } // setExponent
 
-
 /**
  * @brief Set the format.
+ * @param [in] format The format value to set.
  */
 void NimBLE2904::setFormat(uint8_t format) {
     m_data.m_format = format;
-    setValue((uint8_t*) &m_data, sizeof(m_data));
+    setValue(m_data);
 } // setFormat
 
-
 /**
  * @brief Set the namespace.
+ * @param [in] namespace_value The namespace value toset.
  */
 void NimBLE2904::setNamespace(uint8_t namespace_value) {
     m_data.m_namespace = namespace_value;
-    setValue((uint8_t*) &m_data, sizeof(m_data));
+    setValue(m_data);
 } // setNamespace
 
-
 /**
- * @brief Set the units for this value.  It should be one of the encoded values defined here:
- * https://www.bluetooth.com/specifications/assigned-numbers/units
+ * @brief Set the units for this value.
  * @param [in] unit The type of units of this characteristic as defined by assigned numbers.
+ * @details See https://www.bluetooth.com/specifications/assigned-numbers/units
  */
 void NimBLE2904::setUnit(uint16_t unit) {
     m_data.m_unit = unit;
-    setValue((uint8_t*) &m_data, sizeof(m_data));
+    setValue(m_data);
 } // setUnit
 
 #endif /* CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_PERIPHERAL */

src/NimBLE2904.h

@@ -12,34 +12,30 @@
  *      Author: kolban
  */
 
-#ifndef MAIN_NIMBLE2904_H_
-#define MAIN_NIMBLE2904_H_
+#ifndef NIMBLE_CPP_2904_H_
+#define NIMBLE_CPP_2904_H_
+
 #include "nimconfig.h"
 #if defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
 
-#include "NimBLEDescriptor.h"
-
-struct BLE2904_Data {
-    uint8_t  m_format;
-    int8_t   m_exponent;
-    uint16_t m_unit;      // See https://www.bluetooth.com/specifications/assigned-numbers/units
-    uint8_t  m_namespace;
-    uint16_t m_description;
+# include "NimBLEDescriptor.h"
 
+struct NimBLE2904Data {
+    uint8_t  m_format{0};
+    int8_t   m_exponent{0};
+    uint16_t m_unit{0x2700}; // Unitless; See https://www.bluetooth.com/specifications/assigned-numbers/units
+    uint8_t  m_namespace{1}; // 1 = Bluetooth SIG Assigned Numbers
+    uint16_t m_description{0}; // unknown description
 } __attribute__((packed));
 
-
 /**
  * @brief Descriptor for Characteristic Presentation Format.
  *
  * This is a convenience descriptor for the Characteristic Presentation Format which has a UUID of 0x2904.
- *
- * See also:
- * https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml
  */
-class NimBLE2904: public NimBLEDescriptor {
-public:
-    NimBLE2904(NimBLECharacteristic* pCharacterisitic = nullptr);
+class NimBLE2904 : public NimBLEDescriptor {
+  public:
+    NimBLE2904(NimBLECharacteristic* pChr = nullptr);
     static const uint8_t FORMAT_BOOLEAN   = 1;
     static const uint8_t FORMAT_UINT2     = 2;
     static const uint8_t FORMAT_UINT4     = 3;
@@ -67,6 +63,7 @@ public:
     static const uint8_t FORMAT_UTF8      = 25;
     static const uint8_t FORMAT_UTF16     = 26;
     static const uint8_t FORMAT_OPAQUE    = 27;
+    static const uint8_t FORMAT_MEDASN1   = 28;
 
     void setDescription(uint16_t);
     void setExponent(int8_t exponent);
@@ -74,10 +71,10 @@ public:
     void setNamespace(uint8_t namespace_value);
     void setUnit(uint16_t unit);
 
-private:
+  private:
     friend class NimBLECharacteristic;
-    BLE2904_Data m_data;
-}; // BLE2904
+    NimBLE2904Data m_data{};
+}; // NimBLE2904
 
-#endif /* CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_PERIPHERAL */
-#endif /* MAIN_NIMBLE2904_H_ */
+#endif // CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_PERIPHERAL
+#endif // NIMBLE_CPP_2904_H_

src/NimBLEAddress.cpp

@@ -14,139 +14,151 @@
 #include "nimconfig.h"
 #if defined(CONFIG_BT_ENABLED)
 
-#include <algorithm>
+# include "NimBLEAddress.h"
+# include "NimBLELog.h"
 
-#include "NimBLEAddress.h"
-#include "NimBLEUtils.h"
-#include "NimBLELog.h"
+# include <algorithm>
 
 static const char* LOG_TAG = "NimBLEAddress";
 
 /*************************************************
  * NOTE: NimBLE address bytes are in INVERSE ORDER!
- * We will accomodate that fact in these methods.
-*************************************************/
+ * We will accommodate that fact in these methods.
+ *************************************************/
 
 /**
  * @brief Create an address from the native NimBLE representation.
  * @param [in] address The native NimBLE address.
  */
-NimBLEAddress::NimBLEAddress(ble_addr_t address) {
-    memcpy(m_address, address.val, 6);
-    m_addrType = address.type;
-} // NimBLEAddress
-
+NimBLEAddress::NimBLEAddress(ble_addr_t address) : ble_addr_t{address} {}
 
 /**
- * @brief Create a blank address, i.e. 00:00:00:00:00:00, type 0.
- */
-NimBLEAddress::NimBLEAddress() {
-    NimBLEAddress("");
-} // NimBLEAddress
-
-
-/**
- * @brief Create an address from a hex string
+ * @brief Create an address from a hex string.
  *
  * A hex string is of the format:
  * ```
  * 00:00:00:00:00:00
  * ```
  * which is 17 characters in length.
- *
- * @param [in] stringAddress The hex string representation of the address.
+ * @param [in] addr The hex string representation of the address.
  * @param [in] type The type of the address.
  */
-NimBLEAddress::NimBLEAddress(const std::string &stringAddress, uint8_t type) {
-    m_addrType = type;
+NimBLEAddress::NimBLEAddress(const std::string& addr, uint8_t type) {
+    this->type = type;
 
-    if (stringAddress.length() == 0) {
-        memset(m_address, 0, 6);
+    if (addr.length() == BLE_DEV_ADDR_LEN) {
+        std::reverse_copy(addr.data(), addr.data() + BLE_DEV_ADDR_LEN, this->val);
         return;
     }
 
-    if (stringAddress.length() == 6) {
-        std::reverse_copy(stringAddress.data(), stringAddress.data() + 6, m_address);
+    if (addr.length() == 17) {
+        std::string mac{addr};
+        mac.erase(std::remove(mac.begin(), mac.end(), ':'), mac.end());
+        uint64_t address = std::stoull(mac, nullptr, 16);
+        memcpy(this->val, &address, sizeof this->val);
         return;
     }
 
-    if (stringAddress.length() != 17) {
-        memset(m_address, 0, sizeof m_address); // "00:00:00:00:00:00" represents an invalid address
-        NIMBLE_LOGD(LOG_TAG, "Invalid address '%s'", stringAddress.c_str());
-        return;
-    }
-
-    int data[6];
-    if(sscanf(stringAddress.c_str(), "%x:%x:%x:%x:%x:%x", &data[5], &data[4], &data[3], &data[2], &data[1], &data[0]) != 6) {
-        memset(m_address, 0, sizeof m_address); // "00:00:00:00:00:00" represents an invalid address
-        NIMBLE_LOGD(LOG_TAG, "Invalid address '%s'", stringAddress.c_str());
-    }
-    for(size_t index = 0; index < sizeof m_address; index++) {
-        m_address[index] = data[index];
-    }
+    *this = NimBLEAddress{};
+    NIMBLE_LOGE(LOG_TAG, "Invalid address '%s'", addr.c_str());
 } // NimBLEAddress
 
-
 /**
  * @brief Constructor for compatibility with bluedroid esp library using native ESP representation.
  * @param [in] address A uint8_t[6] or esp_bd_addr_t containing the address.
  * @param [in] type The type of the address.
  */
-NimBLEAddress::NimBLEAddress(uint8_t address[6], uint8_t type) {
-    std::reverse_copy(address, address + sizeof m_address, m_address);
-    m_addrType = type;
+NimBLEAddress::NimBLEAddress(const uint8_t address[BLE_DEV_ADDR_LEN], uint8_t type) {
+    std::reverse_copy(address, address + BLE_DEV_ADDR_LEN, this->val);
+    this->type = type;
 } // NimBLEAddress
 
-
 /**
  * @brief Constructor for address using a hex value.\n
  * Use the same byte order, so use 0xa4c1385def16 for "a4:c1:38:5d:ef:16"
  * @param [in] address uint64_t containing the address.
  * @param [in] type The type of the address.
  */
-NimBLEAddress::NimBLEAddress(const uint64_t &address, uint8_t type) {
-    memcpy(m_address, &address, sizeof m_address);
-    m_addrType = type;
+NimBLEAddress::NimBLEAddress(const uint64_t& address, uint8_t type) {
+    memcpy(this->val, &address, sizeof this->val);
+    this->type = type;
 } // NimBLEAddress
 
-
 /**
  * @brief Determine if this address equals another.
  * @param [in] otherAddress The other address to compare against.
  * @return True if the addresses are equal.
  */
-bool NimBLEAddress::equals(const NimBLEAddress &otherAddress) const {
+bool NimBLEAddress::equals(const NimBLEAddress& otherAddress) const {
     return *this == otherAddress;
 } // equals
 
-
 /**
- * @brief Get the native representation of the address.
- * @return a pointer to the uint8_t[6] array of the address.
+ * @brief Get the NimBLE base struct of the address.
+ * @return A read only reference to the NimBLE base struct of the address.
  */
-const uint8_t *NimBLEAddress::getNative() const {
-    return m_address;
-} // getNative
-
+const ble_addr_t* NimBLEAddress::getBase() const {
+    return reinterpret_cast<const ble_addr_t*>(this);
+} // getBase
 
 /**
  * @brief Get the address type.
  * @return The address type.
  */
 uint8_t NimBLEAddress::getType() const {
-    return m_addrType;
+    return this->type;
 } // getType
 
+/**
+ * @brief Get the address value.
+ * @return A read only reference to the address value.
+ */
+const uint8_t* NimBLEAddress::getVal() const {
+    return this->val;
+} // getVal
+
+/**
+ * @brief Determine if this address is a Resolvable Private Address.
+ * @return True if the address is a RPA.
+ */
+bool NimBLEAddress::isRpa() const {
+    return BLE_ADDR_IS_RPA(this);
+} // isRpa
+
+/**
+ * @brief Determine if this address is a Non-Resolvable Private Address.
+ * @return True if the address is a NRPA.
+ */
+bool NimBLEAddress::isNrpa() const {
+    return BLE_ADDR_IS_NRPA(this);
+} // isNrpa
+
+/**
+ * @brief Determine if this address is a Static Address.
+ * @return True if the address is a Static Address.
+ */
+bool NimBLEAddress::isStatic() const {
+    return BLE_ADDR_IS_STATIC(this);
+} // isStatic
+
+/**
+ * @brief Determine if this address is a Public Address.
+ * @return True if the address is a Public Address.
+ */
+bool NimBLEAddress::isPublic() const {
+    return this->type == BLE_ADDR_PUBLIC;
+} // isPublic
+
+/**
+ * @brief Determine if this address is a NULL Address.
+ * @return True if the address is a NULL Address.
+ */
+bool NimBLEAddress::isNull() const {
+    return *this == NimBLEAddress{};
+} // isNull
 
 /**
  * @brief Convert a BLE address to a string.
- *
- * A string representation of an address is in the format:
- *
- * ```
- * xx:xx:xx:xx:xx:xx
- * ```
- *
  * @return The string representation of the address.
  * @deprecated Use std::string() operator instead.
  */
@@ -154,43 +166,57 @@ std::string NimBLEAddress::toString() const {
     return std::string(*this);
 } // toString
 
+/**
+ * @brief Reverse the byte order of the address.
+ * @return A reference to this address.
+ */
+const NimBLEAddress& NimBLEAddress::reverseByteOrder() {
+    std::reverse(this->val, this->val + BLE_DEV_ADDR_LEN);
+    return *this;
+} // reverseByteOrder
 
 /**
  * @brief Convenience operator to check if this address is equal to another.
  */
-bool NimBLEAddress::operator ==(const NimBLEAddress & rhs) const {
-    return memcmp(rhs.m_address, m_address, sizeof m_address) == 0;
-} // operator ==
+bool NimBLEAddress::operator==(const NimBLEAddress& rhs) const {
+    if (this->type != rhs.type) {
+        return false;
+    }
 
+    return memcmp(rhs.val, this->val, sizeof this->val) == 0;
+} // operator ==
 
 /**
  * @brief Convenience operator to check if this address is not equal to another.
  */
-bool NimBLEAddress::operator !=(const NimBLEAddress & rhs) const {
+bool NimBLEAddress::operator!=(const NimBLEAddress& rhs) const {
     return !this->operator==(rhs);
 } // operator !=
 
-
 /**
- * @brief Convienience operator to convert this address to string representation.
- * @details This allows passing NimBLEAddress to functions
- * that accept std::string and/or or it's methods as a parameter.
+ * @brief Convenience operator to convert this address to string representation.
+ * @details This allows passing NimBLEAddress to functions that accept std::string and/or it's methods as a parameter.
  */
 NimBLEAddress::operator std::string() const {
     char buffer[18];
-    snprintf(buffer, sizeof(buffer), "%02x:%02x:%02x:%02x:%02x:%02x",
-                                     m_address[5], m_address[4], m_address[3],
-                                     m_address[2], m_address[1], m_address[0]);
-    return std::string(buffer);
+    snprintf(buffer,
+             sizeof(buffer),
+             "%02x:%02x:%02x:%02x:%02x:%02x",
+             this->val[5],
+             this->val[4],
+             this->val[3],
+             this->val[2],
+             this->val[1],
+             this->val[0]);
+    return std::string{buffer};
 } // operator std::string
 
-
 /**
  * @brief Convenience operator to convert the native address representation to uint_64.
  */
 NimBLEAddress::operator uint64_t() const {
     uint64_t address = 0;
-    memcpy(&address, m_address, sizeof m_address);
+    memcpy(&address, this->val, sizeof this->val);
     return address;
 } // operator uint64_t
 

src/NimBLEAddress.h

@@ -12,51 +12,56 @@
  *      Author: kolban
  */
 
-#ifndef COMPONENTS_NIMBLEADDRESS_H_
-#define COMPONENTS_NIMBLEADDRESS_H_
+#ifndef NIMBLE_CPP_ADDRESS_H_
+#define NIMBLE_CPP_ADDRESS_H_
 #include "nimconfig.h"
 #if defined(CONFIG_BT_ENABLED)
 
-#if defined(CONFIG_NIMBLE_CPP_IDF)
-#include "nimble/ble.h"
-#else
-#include "nimble/nimble/include/nimble/ble.h"
-#endif
+# if defined(CONFIG_NIMBLE_CPP_IDF)
+#  include "nimble/ble.h"
+# else
+#  include "nimble/nimble/include/nimble/ble.h"
+# endif
 
 /****  FIX COMPILATION ****/
-#undef min
-#undef max
+# undef min
+# undef max
 /**************************/
 
-#include <string>
-#include <algorithm>
+# include <string>
 
 /**
  * @brief A %BLE device address.
  *
  * Every %BLE device has a unique address which can be used to identify it and form connections.
  */
-class NimBLEAddress {
-public:
-    NimBLEAddress();
-    NimBLEAddress(ble_addr_t address);
-    NimBLEAddress(uint8_t address[6], uint8_t type = BLE_ADDR_PUBLIC);
-    NimBLEAddress(const std::string &stringAddress, uint8_t type = BLE_ADDR_PUBLIC);
-    NimBLEAddress(const uint64_t &address, uint8_t type = BLE_ADDR_PUBLIC);
-    bool            equals(const NimBLEAddress &otherAddress) const;
-    const uint8_t*  getNative() const;
-    std::string     toString() const;
-    uint8_t         getType() const;
+class NimBLEAddress : private ble_addr_t {
+  public:
+    /**
+     * @brief Create a blank address, i.e. 00:00:00:00:00:00, type 0.
+     */
+    NimBLEAddress() = default;
+    NimBLEAddress(const ble_addr_t address);
+    NimBLEAddress(const uint8_t address[BLE_DEV_ADDR_LEN], uint8_t type = BLE_ADDR_PUBLIC);
+    NimBLEAddress(const std::string& stringAddress, uint8_t type = BLE_ADDR_PUBLIC);
+    NimBLEAddress(const uint64_t& address, uint8_t type = BLE_ADDR_PUBLIC);
 
-    bool operator   ==(const NimBLEAddress & rhs) const;
-    bool operator   !=(const NimBLEAddress & rhs) const;
-    operator        std::string() const;
-    operator        uint64_t() const;
-
-private:
-    uint8_t        m_address[6];
-    uint8_t        m_addrType;
+    bool                 isRpa() const;
+    bool                 isNrpa() const;
+    bool                 isStatic() const;
+    bool                 isPublic() const;
+    bool                 isNull() const;
+    bool                 equals(const NimBLEAddress& otherAddress) const;
+    const ble_addr_t*    getBase() const;
+    std::string          toString() const;
+    uint8_t              getType() const;
+    const uint8_t*       getVal() const;
+    const NimBLEAddress& reverseByteOrder();
+    bool                 operator==(const NimBLEAddress& rhs) const;
+    bool                 operator!=(const NimBLEAddress& rhs) const;
+                         operator std::string() const;
+                         operator uint64_t() const;
 };
 
 #endif /* CONFIG_BT_ENABLED */
-#endif /* COMPONENTS_NIMBLEADDRESS_H_ */
+#endif /* NIMBLE_CPP_ADDRESS_H_ */

src/NimBLEAdvertisedDevice.h

@@ -12,25 +12,25 @@
  *      Author: kolban
  */
 
-#ifndef COMPONENTS_NIMBLEADVERTISEDDEVICE_H_
-#define COMPONENTS_NIMBLEADVERTISEDDEVICE_H_
+#ifndef NIMBLE_CPP_ADVERTISED_DEVICE_H_
+#define NIMBLE_CPP_ADVERTISED_DEVICE_H_
+
 #include "nimconfig.h"
 #if defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)
 
-#include "NimBLEAddress.h"
-#include "NimBLEScan.h"
-#include "NimBLEUUID.h"
+# include "NimBLEAddress.h"
+# include "NimBLEScan.h"
+# include "NimBLEUUID.h"
 
-#if defined(CONFIG_NIMBLE_CPP_IDF)
-#include "host/ble_hs_adv.h"
-#else
-#include "nimble/nimble/host/include/host/ble_hs_adv.h"
-#endif
-
-#include <map>
-#include <vector>
-#include <time.h>
+# if defined(CONFIG_NIMBLE_CPP_IDF)
+#  include "host/ble_hs_adv.h"
+#  include "host/ble_gap.h"
+# else
+#  include "nimble/nimble/host/include/host/ble_hs_adv.h"
+#  include "nimble/nimble/host/include/host/ble_gap.h"
+# endif
 
+# include <vector>
 
 class NimBLEScan;
 /**
@@ -40,17 +40,60 @@ class NimBLEScan;
  * class provides a model of a detected device.
  */
 class NimBLEAdvertisedDevice {
-public:
-    NimBLEAdvertisedDevice();
+  public:
+    NimBLEAdvertisedDevice() = default;
 
-    NimBLEAddress   getAddress();
-    uint8_t         getAdvType();
-    uint16_t        getAppearance();
-    uint16_t        getAdvInterval();
-    uint16_t        getMinInterval();
-    uint16_t        getMaxInterval();
-    std::string     getManufacturerData();
-    std::string     getURI();
+    uint8_t              getAdvType() const;
+    uint8_t              getAdvFlags() const;
+    uint16_t             getAppearance() const;
+    uint16_t             getAdvInterval() const;
+    uint16_t             getMinInterval() const;
+    uint16_t             getMaxInterval() const;
+    uint8_t              getManufacturerDataCount() const;
+    const NimBLEAddress& getAddress() const;
+    std::string          getManufacturerData(uint8_t index = 0) const;
+    std::string          getURI() const;
+    std::string          getPayloadByType(uint16_t type, uint8_t index = 0) const;
+    std::string          getName() const;
+    int8_t               getRSSI() const;
+    NimBLEScan*          getScan() const;
+    uint8_t              getServiceDataCount() const;
+    std::string          getServiceData(uint8_t index = 0) const;
+    std::string          getServiceData(const NimBLEUUID& uuid) const;
+    NimBLEUUID           getServiceDataUUID(uint8_t index = 0) const;
+    NimBLEUUID           getServiceUUID(uint8_t index = 0) const;
+    uint8_t              getServiceUUIDCount() const;
+    NimBLEAddress        getTargetAddress(uint8_t index = 0) const;
+    uint8_t              getTargetAddressCount() const;
+    int8_t               getTXPower() const;
+    uint8_t              getAdvLength() const;
+    uint8_t              getAddressType() const;
+    bool                 isAdvertisingService(const NimBLEUUID& uuid) const;
+    bool                 haveAppearance() const;
+    bool                 haveManufacturerData() const;
+    bool                 haveName() const;
+    bool                 haveServiceData() const;
+    bool                 haveServiceUUID() const;
+    bool                 haveTXPower() const;
+    bool                 haveConnParams() const;
+    bool                 haveAdvInterval() const;
+    bool                 haveTargetAddress() const;
+    bool                 haveURI() const;
+    bool                 haveType(uint16_t type) const;
+    std::string          toString() const;
+    bool                 isConnectable() const;
+    bool                 isScannable() const;
+    bool                 isLegacyAdvertisement() const;
+# if CONFIG_BT_NIMBLE_EXT_ADV
+    uint8_t  getSetId() const;
+    uint8_t  getPrimaryPhy() const;
+    uint8_t  getSecondaryPhy() const;
+    uint16_t getPeriodicInterval() const;
+# endif
+
+    const std::vector<uint8_t>&                getPayload() const;
+    const std::vector<uint8_t>::const_iterator begin() const;
+    const std::vector<uint8_t>::const_iterator end() const;
 
     /**
      * @brief A template to convert the service data to <type\>.
@@ -60,21 +103,14 @@ public:
      * less than <tt>sizeof(<type\>)</tt>.
      * @details <b>Use:</b> <tt>getManufacturerData<type>(skipSizeCheck);</tt>
      */
-    template<typename T>
-    T       getManufacturerData(bool skipSizeCheck = false) {
+    template <typename T>
+    T getManufacturerData(bool skipSizeCheck = false) const {
         std::string data = getManufacturerData();
-        if(!skipSizeCheck && data.size() < sizeof(T)) return T();
-        const char *pData = data.data();
-        return *((T *)pData);
+        if (!skipSizeCheck && data.size() < sizeof(T)) return T();
+        const char* pData = data.data();
+        return *((T*)pData);
     }
 
-    std::string     getName();
-    int             getRSSI();
-    NimBLEScan*     getScan();
-    uint8_t         getServiceDataCount();
-    std::string     getServiceData(uint8_t index = 0);
-    std::string     getServiceData(const NimBLEUUID &uuid);
-
     /**
      * @brief A template to convert the service data to <tt><type\></tt>.
      * @tparam T The type to convert the data to.
@@ -84,12 +120,12 @@ public:
      * less than <tt>sizeof(<type\>)</tt>.
      * @details <b>Use:</b> <tt>getServiceData<type>(skipSizeCheck);</tt>
      */
-    template<typename T>
-    T       getServiceData(uint8_t index = 0, bool skipSizeCheck = false) {
+    template <typename T>
+    T getServiceData(uint8_t index = 0, bool skipSizeCheck = false) const {
         std::string data = getServiceData(index);
-        if(!skipSizeCheck && data.size() < sizeof(T)) return T();
-        const char *pData = data.data();
-        return *((T *)pData);
+        if (!skipSizeCheck && data.size() < sizeof(T)) return T();
+        const char* pData = data.data();
+        return *((T*)pData);
     }
 
     /**
@@ -101,98 +137,38 @@ public:
      * less than <tt>sizeof(<type\>)</tt>.
      * @details <b>Use:</b> <tt>getServiceData<type>(skipSizeCheck);</tt>
      */
-    template<typename T>
-    T       getServiceData(const NimBLEUUID &uuid, bool skipSizeCheck = false) {
+    template <typename T>
+    T getServiceData(const NimBLEUUID& uuid, bool skipSizeCheck = false) const {
         std::string data = getServiceData(uuid);
-        if(!skipSizeCheck && data.size() < sizeof(T)) return T();
-        const char *pData = data.data();
-        return *((T *)pData);
+        if (!skipSizeCheck && data.size() < sizeof(T)) return T();
+        const char* pData = data.data();
+        return *((T*)pData);
     }
 
-    NimBLEUUID      getServiceDataUUID(uint8_t index = 0);
-    NimBLEUUID      getServiceUUID(uint8_t index = 0);
-    uint8_t         getServiceUUIDCount();
-    NimBLEAddress   getTargetAddress(uint8_t index = 0);
-    uint8_t         getTargetAddressCount();
-    int8_t          getTXPower();
-    uint8_t*        getPayload();
-    uint8_t         getAdvLength();
-    size_t          getPayloadLength();
-    uint8_t         getAddressType();
-    time_t          getTimestamp();
-    bool            isAdvertisingService(const NimBLEUUID &uuid);
-    bool            haveAppearance();
-    bool            haveManufacturerData();
-    bool            haveName();
-    bool            haveRSSI();
-    bool            haveServiceData();
-    bool            haveServiceUUID();
-    bool            haveTXPower();
-    bool            haveConnParams();
-    bool            haveAdvInterval();
-    bool            haveTargetAddress();
-    bool            haveURI();
-    std::string     toString();
-    bool            isConnectable();
-    bool            isLegacyAdvertisement();
-#if CONFIG_BT_NIMBLE_EXT_ADV
-    uint8_t         getSetId();
-    uint8_t         getPrimaryPhy();
-    uint8_t         getSecondaryPhy();
-    uint16_t        getPeriodicInterval();
-#endif
-
-private:
+  private:
     friend class NimBLEScan;
 
-    void    setAddress(NimBLEAddress address);
-    void    setAdvType(uint8_t advType, bool isLegacyAdv);
-    void    setPayload(const uint8_t *payload, uint8_t length, bool append);
-    void    setRSSI(int rssi);
-#if CONFIG_BT_NIMBLE_EXT_ADV
-    void    setSetId(uint8_t sid)              { m_sid = sid; }
-    void    setPrimaryPhy(uint8_t phy)         { m_primPhy = phy; }
-    void    setSecondaryPhy(uint8_t phy)       { m_secPhy = phy; }
-    void    setPeriodicInterval(uint16_t itvl) { m_periodicItvl = itvl; }
-#endif
-    uint8_t findAdvField(uint8_t type, uint8_t index = 0, size_t * data_loc = nullptr);
-    size_t  findServiceData(uint8_t index, uint8_t* bytes);
+    NimBLEAdvertisedDevice(const ble_gap_event* event, uint8_t eventType);
+    void    update(const ble_gap_event* event, uint8_t eventType);
+    uint8_t findAdvField(uint8_t type, uint8_t index = 0, size_t* data_loc = nullptr) const;
+    size_t  findServiceData(uint8_t index, uint8_t* bytes) const;
 
-    NimBLEAddress   m_address = NimBLEAddress("");
-    uint8_t         m_advType;
-    int             m_rssi;
-    time_t          m_timestamp;
-    bool            m_callbackSent;
-    uint8_t         m_advLength;
-#if CONFIG_BT_NIMBLE_EXT_ADV
-    bool            m_isLegacyAdv;
-    uint8_t         m_sid;
-    uint8_t         m_primPhy;
-    uint8_t         m_secPhy;
-    uint16_t        m_periodicItvl;
-#endif
+    NimBLEAddress m_address{};
+    uint8_t       m_advType{};
+    int8_t        m_rssi{};
+    uint8_t       m_callbackSent{};
+    uint8_t       m_advLength{};
 
-    std::vector<uint8_t>    m_payload;
-};
+# if CONFIG_BT_NIMBLE_EXT_ADV
+    bool     m_isLegacyAdv{};
+    uint8_t  m_sid{};
+    uint8_t  m_primPhy{};
+    uint8_t  m_secPhy{};
+    uint16_t m_periodicItvl{};
+# endif
 
-/**
- * @brief A callback handler for callbacks associated device scanning.
- *
- * When we are performing a scan as a %BLE client, we may wish to know when a new device that is advertising
- * has been found.  This class can be sub-classed and registered such that when a scan is performed and
- * a new advertised device has been found, we will be called back to be notified.
- */
-class NimBLEAdvertisedDeviceCallbacks {
-public:
-    virtual ~NimBLEAdvertisedDeviceCallbacks() {}
-    /**
-     * @brief Called when a new scan result is detected.
-     *
-     * As we are scanning, we will find new devices.  When found, this call back is invoked with a reference to the
-     * device that was found.  During any individual scan, a device will only be detected one time.
-     */
-    virtual void onResult(NimBLEAdvertisedDevice* advertisedDevice) = 0;
+    std::vector<uint8_t> m_payload;
 };
 
 #endif /* CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_OBSERVER */
-#endif /* COMPONENTS_NIMBLEADVERTISEDDEVICE_H_ */
+#endif /* NIMBLE_CPP_ADVERTISED_DEVICE_H_ */

src/NimBLEAdvertisementData.cpp

@@ -0,0 +1,574 @@
+/*
+ * NimBLEAdvertisementData.cpp
+ *
+ *  Created: on November 24, 2024
+ *      Author H2zero
+ *
+ */
+
+#include "nimconfig.h"
+#if (defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER) && !CONFIG_BT_NIMBLE_EXT_ADV) || \
+    defined(_DOXYGEN_)
+
+# include "NimBLEAdvertisementData.h"
+# include "NimBLEDevice.h"
+# include "NimBLEUtils.h"
+# include "NimBLEUUID.h"
+# include "NimBLELog.h"
+
+# if defined(CONFIG_NIMBLE_CPP_IDF)
+#  include "host/ble_hs_adv.h"
+# else
+#  include "nimble/nimble/host/include/host/ble_hs_adv.h"
+# endif
+
+static const char* LOG_TAG = "NimBLEAdvertisementData";
+
+/**
+ * @brief Add data to the payload to be advertised.
+ * @param [in] data The data to be added to the payload.
+ * @param [in] length The size of data to be added to the payload.
+ */
+bool NimBLEAdvertisementData::addData(const uint8_t* data, size_t length) {
+    if ((m_payload.size() + length) > BLE_HS_ADV_MAX_SZ) {
+        NIMBLE_LOGE(LOG_TAG, "Data length exceeded");
+        return false;
+    }
+
+    m_payload.insert(m_payload.end(), data, data + length);
+    return true;
+} // addData
+
+/**
+ * @brief Add data to the payload to be advertised.
+ * @param [in] data The data to be added to the payload.
+ */
+bool NimBLEAdvertisementData::addData(const std::vector<uint8_t>& data) {
+    return addData(&data[0], data.size());
+} // addData
+
+/**
+ * @brief Set the appearance.
+ * @param [in] appearance The appearance code value.
+ * @return True if successful.
+ * @details If the appearance value is 0 then it will be removed from the advertisement if set previously.
+ */
+bool NimBLEAdvertisementData::setAppearance(uint16_t appearance) {
+    if (appearance == 0) {
+        return removeData(BLE_HS_ADV_TYPE_APPEARANCE);
+    }
+
+    uint8_t data[4];
+    data[0] = 3;
+    data[1] = BLE_HS_ADV_TYPE_APPEARANCE;
+    data[2] = appearance;
+    data[3] = (appearance >> 8) & 0xFF;
+    return addData(data, 4);
+} // setAppearance
+
+/**
+ * @brief Set the advertisement flags.
+ * @param [in] flag The flags to be set in the advertisement.
+ * * BLE_HS_ADV_F_DISC_LTD
+ * * BLE_HS_ADV_F_DISC_GEN
+ * * BLE_HS_ADV_F_BREDR_UNSUP - must always use with NimBLE
+ * A flag value of 0 will remove the flags from the advertisement.
+ */
+bool NimBLEAdvertisementData::setFlags(uint8_t flag) {
+    int dataLoc = getDataLocation(BLE_HS_ADV_TYPE_FLAGS);
+    if (dataLoc != -1) {
+        if (flag) {
+            m_payload[dataLoc + 2] = flag | BLE_HS_ADV_F_BREDR_UNSUP;
+            return true;
+        } else {
+            return removeData(BLE_HS_ADV_TYPE_FLAGS);
+        }
+    }
+
+    uint8_t data[3];
+    data[0] = 2;
+    data[1] = BLE_HS_ADV_TYPE_FLAGS;
+    data[2] = flag | BLE_HS_ADV_F_BREDR_UNSUP;
+    return addData(data, 3);
+} // setFlags
+
+/**
+ * @brief Adds Tx power level to the advertisement data.
+ * @return True if successful.
+ */
+bool NimBLEAdvertisementData::addTxPower() {
+    uint8_t data[3];
+    data[0] = BLE_HS_ADV_TX_PWR_LVL_LEN + 1;
+    data[1] = BLE_HS_ADV_TYPE_TX_PWR_LVL;
+# ifndef CONFIG_IDF_TARGET_ESP32P4
+    data[2] = NimBLEDevice::getPower();
+# else
+    data[2] = 0;
+# endif
+    return addData(data, 3);
+} // addTxPower
+
+/**
+ * @brief Set the preferred min and max connection intervals to advertise.
+ * @param [in] minInterval The minimum preferred connection interval.
+ * @param [in] maxInterval The Maximum preferred connection interval.
+ * @details  Range = 0x0006(7.5ms) to 0x0C80(4000ms), values not within the range will be limited to this range.
+ * @return True if successful.
+ */
+bool NimBLEAdvertisementData::setPreferredParams(uint16_t minInterval, uint16_t maxInterval) {
+    minInterval = std::max<uint16_t>(minInterval, 0x6);
+    minInterval = std::min<uint16_t>(minInterval, 0xC80);
+    maxInterval = std::max<uint16_t>(maxInterval, 0x6);
+    maxInterval = std::min<uint16_t>(maxInterval, 0xC80);
+    maxInterval = std::max<uint16_t>(maxInterval, minInterval); // Max must be greater than or equal to min.
+
+    uint8_t data[6];
+    data[0] = BLE_HS_ADV_SLAVE_ITVL_RANGE_LEN + 1;
+    data[1] = BLE_HS_ADV_TYPE_SLAVE_ITVL_RANGE;
+    data[2] = minInterval;
+    data[3] = minInterval >> 8;
+    data[4] = maxInterval;
+    data[5] = maxInterval >> 8;
+    return addData(data, 6);
+} // setPreferredParams
+
+/**
+ * @brief Add a service uuid to exposed list of services.
+ * @param [in] serviceUUID The UUID of the service to expose.
+ */
+bool NimBLEAdvertisementData::addServiceUUID(const NimBLEUUID& serviceUUID) {
+    uint8_t bytes = serviceUUID.bitSize() / 8;
+    int     type;
+    switch (bytes) {
+        case 2:
+            type = BLE_HS_ADV_TYPE_COMP_UUIDS16;
+            break;
+        case 4:
+            type = BLE_HS_ADV_TYPE_COMP_UUIDS32;
+            break;
+        case 16:
+            type = BLE_HS_ADV_TYPE_COMP_UUIDS128;
+            break;
+        default:
+            return false;
+    }
+
+    int     dataLoc = getDataLocation(type);
+    uint8_t length  = bytes;
+    if (dataLoc == -1) {
+        length += 2;
+    }
+
+    if (length + getPayload().size() > BLE_HS_ADV_MAX_SZ) {
+        return false;
+    }
+
+    uint8_t        data[31];
+    const uint8_t* uuid = serviceUUID.getValue();
+    if (dataLoc == -1) {
+        data[0] = 1 + bytes;
+        data[1] = type;
+        memcpy(&data[2], uuid, bytes);
+        return addData(data, length);
+    }
+
+    m_payload.insert(m_payload.begin() + dataLoc + m_payload[dataLoc] + 1, uuid, uuid + bytes);
+    m_payload[dataLoc] += bytes;
+    return true;
+} // addServiceUUID
+
+/**
+ * @brief Add a service uuid to exposed list of services.
+ * @param [in] serviceUUID The string representation of the service to expose.
+ * @return True if successful.
+ */
+bool NimBLEAdvertisementData::addServiceUUID(const char* serviceUUID) {
+    return addServiceUUID(NimBLEUUID(serviceUUID));
+} // addServiceUUID
+
+/**
+ * @brief Remove a service UUID from the advertisement.
+ * @param [in] serviceUUID The UUID of the service to remove.
+ * @return True if successful or uuid not found, false if uuid error or data could not be reset.
+ */
+bool NimBLEAdvertisementData::removeServiceUUID(const NimBLEUUID& serviceUUID) {
+    uint8_t bytes = serviceUUID.bitSize() / 8;
+    int     type;
+    switch (bytes) {
+        case 2:
+            type = BLE_HS_ADV_TYPE_COMP_UUIDS16;
+            break;
+        case 4:
+            type = BLE_HS_ADV_TYPE_COMP_UUIDS32;
+            break;
+        case 16:
+            type = BLE_HS_ADV_TYPE_COMP_UUIDS128;
+            break;
+        default:
+            return false;
+    }
+
+    int dataLoc = getDataLocation(type);
+    if (dataLoc == -1) {
+        return true;
+    }
+
+    int uuidLoc = -1;
+    for (size_t i = dataLoc + 2; i < m_payload.size(); i += bytes) {
+        if (memcmp(&m_payload[i], serviceUUID.getValue(), bytes) == 0) {
+            uuidLoc = i;
+            break;
+        }
+    }
+
+    if (uuidLoc == -1) {
+        return true;
+    }
+
+    if (m_payload[dataLoc] - bytes == 1) {
+        return removeData(type);
+    }
+
+    m_payload.erase(m_payload.begin() + uuidLoc, m_payload.begin() + uuidLoc + bytes);
+    m_payload[dataLoc] -= bytes;
+    return true;
+} // removeServiceUUID
+
+/**
+ * @brief Remove a service UUID from the advertisement.
+ * @param [in] serviceUUID The UUID of the service to remove.
+ * @return True if successful or uuid not found, false if uuid error or data could not be reset.
+ */
+bool NimBLEAdvertisementData::removeServiceUUID(const char* serviceUUID) {
+    return removeServiceUUID(NimBLEUUID(serviceUUID));
+} // removeServiceUUID
+
+/**
+ * @brief Remove all service UUIDs from the advertisement.
+ */
+bool NimBLEAdvertisementData::removeServices() {
+    return true;
+} // removeServices
+
+/**
+ * @brief Set manufacturer specific data.
+ * @param [in] data The manufacturer data to advertise.
+ * @param [in] length The length of the data.
+ * @return True if successful.
+ */
+bool NimBLEAdvertisementData::setManufacturerData(const uint8_t* data, size_t length) {
+    if (length > 29) {
+        NIMBLE_LOGE(LOG_TAG, "MFG data too long");
+        return false;
+    }
+
+    uint8_t mdata[31];
+    mdata[0] = length + 1;
+    mdata[1] = BLE_HS_ADV_TYPE_MFG_DATA;
+    memcpy(&mdata[2], data, length);
+    return addData(mdata, length + 2);
+} // setManufacturerData
+
+/**
+ * @brief Set manufacturer specific data.
+ * @param [in] data The manufacturer data to advertise.
+ * @return True if successful.
+ */
+bool NimBLEAdvertisementData::setManufacturerData(const std::string& data) {
+    return setManufacturerData(reinterpret_cast<const uint8_t*>(data.data()), data.length());
+} // setManufacturerData
+
+/**
+ * @brief Set manufacturer specific data.
+ * @param [in] data The manufacturer data to advertise.
+ * @return True if successful.
+ */
+bool NimBLEAdvertisementData::setManufacturerData(const std::vector<uint8_t>& data) {
+    return setManufacturerData(&data[0], data.size());
+} // setManufacturerData
+
+/**
+ * @brief Set the URI to advertise.
+ * @param [in] uri The uri to advertise.
+ * @return True if successful.
+ */
+bool NimBLEAdvertisementData::setURI(const std::string& uri) {
+    if (uri.length() > 29) {
+        NIMBLE_LOGE(LOG_TAG, "URI too long");
+        return false;
+    }
+
+    uint8_t data[31];
+    uint8_t length = 2 + uri.length();
+    data[0]        = length - 1;
+    data[1]        = BLE_HS_ADV_TYPE_URI;
+    memcpy(&data[2], uri.c_str(), uri.length());
+    return addData(data, length);
+} // setURI
+
+/**
+ * @brief Set the complete name of this device.
+ * @param [in] name The name to advertise.
+ * @param [in] isComplete If true the name is complete, which will set the data type accordingly.
+ * @details If the name is longer than 29 characters it will be truncated.
+ * and the data type will be set to incomplete name.
+ * @return True if successful.
+ */
+bool NimBLEAdvertisementData::setName(const std::string& name, bool isComplete) {
+    if (name.length() > 29) {
+        NIMBLE_LOGE(LOG_TAG, "Name too long - truncating");
+        isComplete = false;
+    }
+
+    uint8_t data[31];
+    uint8_t length = 2 + std::min<uint8_t>(name.length(), 29);
+    data[0]        = length - 1;
+    data[1]        = isComplete ? BLE_HS_ADV_TYPE_COMP_NAME : BLE_HS_ADV_TYPE_INCOMP_NAME;
+    memcpy(&data[2], name.c_str(), std::min<uint8_t>(name.length(), 29));
+    return addData(data, length);
+} // setName
+
+/**
+ * @brief Set the short name.
+ * @param [in] name The short name of the device.
+ * @return True if successful.
+ */
+bool NimBLEAdvertisementData::setShortName(const std::string& name) {
+    return setName(name, false);
+} // setShortName
+
+/**
+ * @brief Set a single service to advertise as a complete list of services.
+ * @param [in] uuid The service to advertise.
+ * @return True if successful.
+ */
+bool NimBLEAdvertisementData::setCompleteServices(const NimBLEUUID& uuid) {
+    return setServices(true, uuid.bitSize(), {uuid});
+} // setCompleteServices
+
+/**
+ * @brief Set the complete list of 16 bit services to advertise.
+ * @param [in] uuids A vector of 16 bit UUID's to advertise.
+ * @return True if successful.
+ */
+bool NimBLEAdvertisementData::setCompleteServices16(const std::vector<NimBLEUUID>& uuids) {
+    return setServices(true, 16, uuids);
+} // setCompleteServices16
+
+/**
+ * @brief Set the complete list of 32 bit services to advertise.
+ * @param [in] uuids A vector of 32 bit UUID's to advertise.
+ * @return True if successful.
+ */
+bool NimBLEAdvertisementData::setCompleteServices32(const std::vector<NimBLEUUID>& uuids) {
+    return setServices(true, 32, uuids);
+} // setCompleteServices32
+
+/**
+ * @brief Set a single service to advertise as a partial list of services.
+ * @param [in] uuid The service to advertise.
+ * @return True if successful.
+ */
+bool NimBLEAdvertisementData::setPartialServices(const NimBLEUUID& uuid) {
+    return setServices(false, uuid.bitSize(), {uuid});
+} // setPartialServices
+
+/**
+ * @brief Set the partial list of services to advertise.
+ * @param [in] uuids A vector of 16 bit UUID's to advertise.
+ * @return True if successful.
+ */
+bool NimBLEAdvertisementData::setPartialServices16(const std::vector<NimBLEUUID>& uuids) {
+    return setServices(false, 16, uuids);
+} // setPartialServices16
+
+/**
+ * @brief Set the partial list of services to advertise.
+ * @param [in] uuids A vector of 32 bit UUID's to advertise.
+ * @return True if successful.
+ */
+bool NimBLEAdvertisementData::setPartialServices32(const std::vector<NimBLEUUID>& uuids) {
+    return setServices(false, 32, uuids);
+} // setPartialServices32
+
+/**
+ * @brief Utility function to create the list of service UUID's from a vector.
+ * @param [in] complete If true the vector is the complete set of services.
+ * @param [in] size The bit size of the UUID's in the vector. (16, 32, or 128).
+ * @param [in] uuids The vector of service UUID's to advertise.
+ * @return True if successful.
+ * @details The number of services will be truncated if the total length exceeds 31 bytes.
+ */
+bool NimBLEAdvertisementData::setServices(bool complete, uint8_t size, const std::vector<NimBLEUUID>& uuids) {
+    uint8_t bytes  = size / 8;
+    uint8_t length = 2; // start with 2 for length + type bytes
+    uint8_t data[31];
+
+    for (const auto& uuid : uuids) {
+        if (uuid.bitSize() != size) {
+            NIMBLE_LOGE(LOG_TAG, "Service UUID(%d) invalid", size);
+            continue;
+        } else {
+            if (length + bytes >= 31) {
+                NIMBLE_LOGW(LOG_TAG, "Too many services - truncating");
+                complete = false;
+                break;
+            }
+            memcpy(&data[length], uuid.getValue(), bytes);
+            length += bytes;
+        }
+    }
+
+    data[0] = length - 1; // don't count the length byte as part of the AD length
+
+    switch (size) {
+        case 16:
+            data[1] = (complete ? BLE_HS_ADV_TYPE_COMP_UUIDS16 : BLE_HS_ADV_TYPE_INCOMP_UUIDS16);
+            break;
+        case 32:
+            data[1] = (complete ? BLE_HS_ADV_TYPE_COMP_UUIDS32 : BLE_HS_ADV_TYPE_INCOMP_UUIDS32);
+            break;
+        case 128:
+            data[1] = (complete ? BLE_HS_ADV_TYPE_COMP_UUIDS128 : BLE_HS_ADV_TYPE_INCOMP_UUIDS128);
+            break;
+        default:
+            return false;
+    }
+
+    return addData(data, length);
+} // setServices
+
+/**
+ * @brief Set the service data advertised for the UUID.
+ * @param [in] uuid The UUID the service data belongs to.
+ * @param [in] data The data to advertise.
+ * @param [in] length The length of the data.
+ * @note If data length is 0 the service data will not be advertised.
+ * @return True if successful, false if data length is too long or could not be set.
+ */
+bool NimBLEAdvertisementData::setServiceData(const NimBLEUUID& uuid, const uint8_t* data, size_t length) {
+    uint8_t uuidBytes = uuid.bitSize() / 8;
+    uint8_t sDataLen  = 2 + uuidBytes + length;
+    if (sDataLen > 31) {
+        NIMBLE_LOGE(LOG_TAG, "Service Data too long");
+        return false;
+    }
+
+    uint8_t type;
+    switch (uuidBytes) {
+        case 2:
+            type = BLE_HS_ADV_TYPE_SVC_DATA_UUID16;
+            break;
+        case 4:
+            type = BLE_HS_ADV_TYPE_SVC_DATA_UUID32;
+            break;
+        case 16:
+            type = BLE_HS_ADV_TYPE_SVC_DATA_UUID128;
+            break;
+        default:
+            return false;
+    }
+
+    if (length == 0) {
+        removeData(type);
+        return true;
+    }
+
+    uint8_t sData[31];
+    sData[0] = uuidBytes + length + 1;
+    sData[1] = type;
+    memcpy(&sData[2], uuid.getValue(), uuidBytes);
+    memcpy(&sData[2 + uuidBytes], data, length);
+    return addData(sData, sDataLen);
+} // setServiceData
+
+/**
+ * @brief Set the service data (UUID + data)
+ * @param [in] uuid The UUID to set with the service data.
+ * @param [in] data The data to be associated with the service data advertised.
+ * @return True if the service data was set successfully.
+ * @note If data length is 0 the service data will not be advertised.
+ */
+bool NimBLEAdvertisementData::setServiceData(const NimBLEUUID& uuid, const std::string& data) {
+    return setServiceData(uuid, reinterpret_cast<const uint8_t*>(data.data()), data.length());
+} // setServiceData
+
+/**
+ * @brief Set the service data advertised for the UUID.
+ * @param [in] uuid The UUID the service data belongs to.
+ * @param [in] data The data to advertise.
+ * @return True if the service data was set successfully.
+ * @note If data length is 0 the service data will not be advertised.
+ */
+bool NimBLEAdvertisementData::setServiceData(const NimBLEUUID& uuid, const std::vector<uint8_t>& data) {
+    return setServiceData(uuid, &data[0], data.size());
+} // setServiceData
+
+/**
+ * @brief Get the location of the data in the payload.
+ * @param [in] type The type of data to search for.
+ * @return -1 if the data is not found, otherwise the index of the data in the payload.
+ */
+int NimBLEAdvertisementData::getDataLocation(uint8_t type) const {
+    size_t index = 0;
+    while (index < m_payload.size()) {
+        if (m_payload[index + 1] == type) {
+            return index;
+        }
+        index += m_payload[index] + 1;
+    }
+    return -1;
+} // getDataLocation
+
+/**
+ * @brief Remove data from the advertisement data.
+ * @param [in] type The type of data to remove.
+ * @return True if successful, false if the data was not found.
+ */
+bool NimBLEAdvertisementData::removeData(uint8_t type) {
+    int dataLoc = getDataLocation(type);
+    if (dataLoc != -1) {
+        std::vector<uint8_t> swap(m_payload.begin(), m_payload.begin() + dataLoc);
+        int                  nextData = dataLoc + m_payload[dataLoc] + 1;
+        swap.insert(swap.end(), m_payload.begin() + nextData, m_payload.end());
+        swap.swap(m_payload);
+        return true;
+    }
+
+    return false;
+} // removeData
+
+/**
+ * @brief Retrieve the payload that is to be advertised.
+ * @return The payload of the advertisement data.
+ */
+std::vector<uint8_t> NimBLEAdvertisementData::getPayload() const {
+    return m_payload;
+} // getPayload
+
+/**
+ * @brief Clear the advertisement data for reuse.
+ */
+void NimBLEAdvertisementData::clearData() {
+    std::vector<uint8_t>().swap(m_payload);
+} // clearData
+
+/**
+ * @brief Get the string representation of the advertisement data.
+ * @return The string representation of the advertisement data.
+ */
+std::string NimBLEAdvertisementData::toString() const {
+    std::string hexStr = NimBLEUtils::dataToHexString(&m_payload[0], m_payload.size());
+    std::string str;
+    for (size_t i = 0; i < hexStr.length(); i += 2) {
+        str += hexStr[i];
+        str += hexStr[i + 1];
+        if (i + 2 < hexStr.length()) {
+            str += " ";
+        }
+    }
+
+    return str;
+} // toString
+
+#endif // CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_BROADCASTER && !CONFIG_BT_NIMBLE_EXT_ADV

src/NimBLEAdvertisementData.h

@@ -0,0 +1,70 @@
+/*
+ * NimBLEAdvertisementData.h
+ *
+ *  Created: on November 24, 2024
+ *      Author H2zero
+ *
+ */
+
+#ifndef NIMBLE_CPP_ADVERTISEMENT_DATA_H_
+#define NIMBLE_CPP_ADVERTISEMENT_DATA_H_
+
+#include "nimconfig.h"
+#if (defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER) && !CONFIG_BT_NIMBLE_EXT_ADV) || \
+    defined(_DOXYGEN_)
+
+#include <cstdint>
+#include <string>
+#include <vector>
+
+class NimBLEUUID;
+/**
+ * @brief Advertisement data set by the programmer to be published by the BLE server.
+ */
+class NimBLEAdvertisementData {
+    // Only a subset of the possible BLE architected advertisement fields are currently exposed.  Others will
+    // be exposed on demand/request or as time permits.
+    //
+  public:
+    bool addData(const uint8_t* data, size_t length);
+    bool addData(const std::vector<uint8_t>& data);
+    bool setAppearance(uint16_t appearance);
+    bool setFlags(uint8_t);
+    bool addTxPower();
+    bool setPreferredParams(uint16_t minInterval, uint16_t maxInterval);
+    bool addServiceUUID(const NimBLEUUID& serviceUUID);
+    bool addServiceUUID(const char* serviceUUID);
+    bool removeServiceUUID(const NimBLEUUID& serviceUUID);
+    bool removeServiceUUID(const char* serviceUUID);
+    bool removeServices();
+    bool setManufacturerData(const uint8_t* data, size_t length);
+    bool setManufacturerData(const std::string& data);
+    bool setManufacturerData(const std::vector<uint8_t>& data);
+    bool setURI(const std::string& uri);
+    bool setName(const std::string& name, bool isComplete = true);
+    bool setShortName(const std::string& name);
+    bool setCompleteServices(const NimBLEUUID& uuid);
+    bool setCompleteServices16(const std::vector<NimBLEUUID>& uuids);
+    bool setCompleteServices32(const std::vector<NimBLEUUID>& uuids);
+    bool setPartialServices(const NimBLEUUID& uuid);
+    bool setPartialServices16(const std::vector<NimBLEUUID>& uuids);
+    bool setPartialServices32(const std::vector<NimBLEUUID>& uuids);
+    bool setServiceData(const NimBLEUUID& uuid, const uint8_t* data, size_t length);
+    bool setServiceData(const NimBLEUUID& uuid, const std::string& data);
+    bool setServiceData(const NimBLEUUID& uuid, const std::vector<uint8_t>& data);
+    bool removeData(uint8_t type);
+    void clearData();
+    int  getDataLocation(uint8_t type) const;
+
+    std::string          toString() const;
+    std::vector<uint8_t> getPayload() const;
+
+  private:
+    friend class NimBLEAdvertising;
+
+    bool                 setServices(bool complete, uint8_t size, const std::vector<NimBLEUUID>& v_uuid);
+    std::vector<uint8_t> m_payload{};
+}; // NimBLEAdvertisementData
+
+#endif // CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_BROADCASTER && !CONFIG_BT_NIMBLE_EXT_ADV
+#endif // NIMBLE_CPP_ADVERTISEMENT_DATA_H_

src/NimBLEAdvertising.h

@@ -12,130 +12,96 @@
  *      Author: kolban
  */
 
-#ifndef MAIN_BLEADVERTISING_H_
-#define MAIN_BLEADVERTISING_H_
-#include "nimconfig.h"
-#if (defined(CONFIG_BT_ENABLED) && \
-    defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER) && \
-    !CONFIG_BT_NIMBLE_EXT_ADV) || defined(_DOXYGEN_)
+#ifndef NIMBLE_CPP_ADVERTISING_H_
+#define NIMBLE_CPP_ADVERTISING_H_
 
-#if defined(CONFIG_NIMBLE_CPP_IDF)
-#include "host/ble_gap.h"
-#else
-#include "nimble/nimble/host/include/host/ble_gap.h"
-#endif
+#include "nimconfig.h"
+#if (defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER) && !CONFIG_BT_NIMBLE_EXT_ADV) || \
+    defined(_DOXYGEN_)
+
+# 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
+# undef min
+# undef max
 /**************************/
 
-#include "NimBLEUUID.h"
+# include "NimBLEUUID.h"
+# include "NimBLEAddress.h"
+# include "NimBLEAdvertisementData.h"
 
-#include <vector>
-
-/* COMPATIBILITY - DO NOT USE */
-#define ESP_BLE_ADV_FLAG_LIMIT_DISC         (0x01 << 0)
-#define ESP_BLE_ADV_FLAG_GEN_DISC           (0x01 << 1)
-#define ESP_BLE_ADV_FLAG_BREDR_NOT_SPT      (0x01 << 2)
-#define ESP_BLE_ADV_FLAG_DMT_CONTROLLER_SPT (0x01 << 3)
-#define ESP_BLE_ADV_FLAG_DMT_HOST_SPT       (0x01 << 4)
-#define ESP_BLE_ADV_FLAG_NON_LIMIT_DISC     (0x00 )
- /* ************************* */
+# include <functional>
+# include <string>
+# include <vector>
 
+class NimBLEAdvertising;
+typedef std::function<void(NimBLEAdvertising*)> advCompleteCB_t;
 
 /**
- * @brief Advertisement data set by the programmer to be published by the %BLE server.
- */
-class NimBLEAdvertisementData {
-    // Only a subset of the possible BLE architected advertisement fields are currently exposed.  Others will
-    // be exposed on demand/request or as time permits.
-    //
-public:
-    void setAppearance(uint16_t appearance);
-    void setCompleteServices(const NimBLEUUID &uuid);
-    void setCompleteServices16(const std::vector<NimBLEUUID> &v_uuid);
-    void setCompleteServices32(const std::vector<NimBLEUUID> &v_uuid);
-    void setFlags(uint8_t);
-    void setManufacturerData(const std::string &data);
-    void setURI(const std::string &uri);
-    void setName(const std::string &name);
-    void setPartialServices(const NimBLEUUID &uuid);
-    void setPartialServices16(const std::vector<NimBLEUUID> &v_uuid);
-    void setPartialServices32(const std::vector<NimBLEUUID> &v_uuid);
-    void setServiceData(const NimBLEUUID &uuid, const std::string &data);
-    void setShortName(const std::string &name);
-    void addData(const std::string &data);  // Add data to the payload.
-    void addData(char * data, size_t length);
-    void addTxPower();
-    void setPreferredParams(uint16_t min, uint16_t max);
-    std::string getPayload();               // Retrieve the current advert payload.
-
-private:
-    friend class NimBLEAdvertising;
-    void setServices(const bool complete, const uint8_t size,
-                     const std::vector<NimBLEUUID> &v_uuid);
-    std::string m_payload;   // The payload of the advertisement.
-};   // NimBLEAdvertisementData
-
-
-/**
- * @brief Perform and manage %BLE advertising.
+ * @brief Perform and manage BLE advertising.
  *
- * A %BLE server will want to perform advertising in order to make itself known to %BLE clients.
+ * A BLE server will want to perform advertising in order to make itself known to BLE clients.
  */
 class NimBLEAdvertising {
-public:
+  public:
     NimBLEAdvertising();
-    void addServiceUUID(const NimBLEUUID &serviceUUID);
-    void addServiceUUID(const char* serviceUUID);
-    void removeServiceUUID(const NimBLEUUID &serviceUUID);
-    bool start(uint32_t duration = 0, void (*advCompleteCB)(NimBLEAdvertising *pAdv) = nullptr);
+    bool start(uint32_t duration = 0, const NimBLEAddress* dirAddr = nullptr);
+    void setAdvertisingCompleteCallback(advCompleteCB_t callback);
     bool stop();
-    void setAppearance(uint16_t appearance);
-    void setName(const std::string &name);
-    void setManufacturerData(const std::string &data);
-    void setURI(const std::string &uri);
-    void setServiceData(const NimBLEUUID &uuid, const std::string &data);
-    void setAdvertisementType(uint8_t adv_type);
-    void setMaxInterval(uint16_t maxinterval);
-    void setMinInterval(uint16_t mininterval);
-    void setAdvertisementData(NimBLEAdvertisementData& advertisementData);
-    void setScanFilter(bool scanRequestWhitelistOnly, bool connectWhitelistOnly);
-    void setScanResponseData(NimBLEAdvertisementData& advertisementData);
-    void setScanResponse(bool);
-    void setMinPreferred(uint16_t);
-    void setMaxPreferred(uint16_t);
-    void addTxPower();
-    void reset();
-    void advCompleteCB();
+    bool setConnectableMode(uint8_t mode);
+    bool setDiscoverableMode(uint8_t mode);
+    bool reset();
     bool isAdvertising();
+    void setScanFilter(bool scanRequestWhitelistOnly, bool connectWhitelistOnly);
+    void enableScanResponse(bool enable);
+    void setAdvertisingInterval(uint16_t interval);
+    void setMaxInterval(uint16_t maxInterval);
+    void setMinInterval(uint16_t minInterval);
 
-private:
+    bool                           setAdvertisementData(const NimBLEAdvertisementData& advertisementData);
+    bool                           setScanResponseData(const NimBLEAdvertisementData& advertisementData);
+    const NimBLEAdvertisementData& getAdvertisementData();
+    const NimBLEAdvertisementData& getScanData();
+    void                           clearData();
+    bool                           refreshAdvertisingData();
+
+    bool addServiceUUID(const NimBLEUUID& serviceUUID);
+    bool addServiceUUID(const char* serviceUUID);
+    bool removeServiceUUID(const NimBLEUUID& serviceUUID);
+    bool removeServiceUUID(const char* serviceUUID);
+    bool removeServices();
+    bool setAppearance(uint16_t appearance);
+    bool setPreferredParams(uint16_t minInterval, uint16_t maxInterval);
+    bool addTxPower();
+    bool setName(const std::string& name);
+    bool setManufacturerData(const uint8_t* data, size_t length);
+    bool setManufacturerData(const std::string& data);
+    bool setManufacturerData(const std::vector<uint8_t>& data);
+    bool setURI(const std::string& uri);
+    bool setServiceData(const NimBLEUUID& uuid, const uint8_t* data, size_t length);
+    bool setServiceData(const NimBLEUUID& uuid, const std::string& data);
+    bool setServiceData(const NimBLEUUID& uuid, const std::vector<uint8_t>& data);
+
+  private:
     friend class NimBLEDevice;
     friend class NimBLEServer;
 
-    void                    onHostSync();
-    static int              handleGapEvent(struct ble_gap_event *event, void *arg);
+    void       onHostSync();
+    static int handleGapEvent(ble_gap_event* event, void* arg);
 
-    ble_hs_adv_fields       m_advData;
-    ble_hs_adv_fields       m_scanData;
+    NimBLEAdvertisementData m_advData;
+    NimBLEAdvertisementData m_scanData;
     ble_gap_adv_params      m_advParams;
-    std::vector<NimBLEUUID> m_serviceUUIDs;
-    bool                    m_customAdvData;
-    bool                    m_customScanResponseData;
-    bool                    m_scanResp;
-    bool                    m_advDataSet;
-    void                    (*m_advCompCB)(NimBLEAdvertising *pAdv);
+    advCompleteCB_t         m_advCompCb;
     uint8_t                 m_slaveItvl[4];
     uint32_t                m_duration;
-    std::vector<uint8_t>    m_svcData16;
-    std::vector<uint8_t>    m_svcData32;
-    std::vector<uint8_t>    m_svcData128;
-    std::vector<uint8_t>    m_name;
-    std::vector<uint8_t>    m_mfgData;
-    std::vector<uint8_t>    m_uri;
+    bool                    m_scanResp : 1;
+    bool                    m_advDataSet : 1;
 };
 
 #endif /* CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_BROADCASTER  && !CONFIG_BT_NIMBLE_EXT_ADV */
-#endif /* MAIN_BLEADVERTISING_H_ */
+#endif /* NIMBLE_CPP_ADVERTISING_H_ */

src/NimBLEAttValue.cpp

@@ -0,0 +1,130 @@
+/*
+ * NimBLEAttValue.cpp
+ *
+ *  Created: on July 17, 2024
+ *      Author H2zero
+ *
+ */
+
+#include "nimconfig.h"
+#if defined(CONFIG_BT_ENABLED)
+
+# if defined(CONFIG_NIMBLE_CPP_IDF)
+#  include "nimble/nimble_npl.h"
+# else
+#  include "nimble/nimble/include/nimble/nimble_npl.h"
+# endif
+
+# include "NimBLEAttValue.h"
+
+// Default constructor implementation.
+NimBLEAttValue::NimBLEAttValue(uint16_t init_len, uint16_t max_len)
+    : m_attr_value{static_cast<uint8_t*>(calloc(init_len + 1, 1))},
+      m_attr_max_len{std::min<uint16_t>(BLE_ATT_ATTR_MAX_LEN, max_len)},
+      m_attr_len{},
+      m_capacity{init_len}
+# if CONFIG_NIMBLE_CPP_ATT_VALUE_TIMESTAMP_ENABLED
+      ,
+      m_timestamp{}
+# endif
+{
+    NIMBLE_CPP_DEBUG_ASSERT(m_attr_value);
+}
+
+// Value constructor implementation.
+NimBLEAttValue::NimBLEAttValue(const uint8_t *value, uint16_t len, uint16_t max_len)
+: NimBLEAttValue(len, max_len) {
+    memcpy(m_attr_value, value, len);
+    m_attr_value[len] = '\0';
+    m_attr_len        = len;
+}
+
+// Destructor implementation.
+NimBLEAttValue::~NimBLEAttValue() {
+    if (m_attr_value != nullptr) {
+        free(m_attr_value);
+    }
+}
+
+// Move assignment operator implementation.
+NimBLEAttValue& NimBLEAttValue::operator=(NimBLEAttValue&& source) {
+    if (this != &source) {
+        free(m_attr_value);
+        m_attr_value   = source.m_attr_value;
+        m_attr_max_len = source.m_attr_max_len;
+        m_attr_len     = source.m_attr_len;
+        m_capacity     = source.m_capacity;
+        setTimeStamp(source.getTimeStamp());
+        source.m_attr_value = nullptr;
+    }
+
+    return *this;
+}
+
+// Copy assignment implementation.
+NimBLEAttValue& NimBLEAttValue::operator=(const NimBLEAttValue& source) {
+    if (this != &source) {
+        deepCopy(source);
+    }
+    return *this;
+}
+
+// Copy all the data from the source object to this object, including allocated space.
+void NimBLEAttValue::deepCopy(const NimBLEAttValue& source) {
+    uint8_t* res = static_cast<uint8_t*>(realloc(m_attr_value, source.m_capacity + 1));
+    NIMBLE_CPP_DEBUG_ASSERT(res);
+
+    ble_npl_hw_enter_critical();
+    m_attr_value   = res;
+    m_attr_max_len = source.m_attr_max_len;
+    m_attr_len     = source.m_attr_len;
+    m_capacity     = source.m_capacity;
+    setTimeStamp(source.getTimeStamp());
+    memcpy(m_attr_value, source.m_attr_value, m_attr_len + 1);
+    ble_npl_hw_exit_critical(0);
+}
+
+// Set the value of the attribute.
+bool NimBLEAttValue::setValue(const uint8_t* value, uint16_t len) {
+    m_attr_len = 0; // Just set the value length to 0 and append instead of repeating code.
+    append(value, len);
+    return memcmp(m_attr_value, value, len) == 0 && m_attr_len == len;
+}
+
+// Append the new data, allocate as necessary.
+NimBLEAttValue& NimBLEAttValue::append(const uint8_t* value, uint16_t len) {
+    if (len == 0) {
+        return *this;
+    }
+
+    if ((m_attr_len + len) > m_attr_max_len) {
+        NIMBLE_LOGE("NimBLEAttValue", "val > max, len=%u, max=%u", len, m_attr_max_len);
+        return *this;
+    }
+
+    uint8_t* res     = m_attr_value;
+    uint16_t new_len = m_attr_len + len;
+    if (new_len > m_capacity) {
+        res        = static_cast<uint8_t*>(realloc(m_attr_value, (new_len + 1)));
+        m_capacity = new_len;
+    }
+    NIMBLE_CPP_DEBUG_ASSERT(res);
+
+# if CONFIG_NIMBLE_CPP_ATT_VALUE_TIMESTAMP_ENABLED
+    time_t t = time(nullptr);
+# else
+    time_t t = 0;
+# endif
+
+    ble_npl_hw_enter_critical();
+    memcpy(res + m_attr_len, value, len);
+    m_attr_value             = res;
+    m_attr_len               = new_len;
+    m_attr_value[m_attr_len] = '\0';
+    setTimeStamp(t);
+    ble_npl_hw_exit_critical(0);
+
+    return *this;
+}
+
+#endif // CONFIG_BT_ENABLED

src/NimBLEAttValue.h

@@ -6,50 +6,53 @@
  *
  */
 
-#ifndef MAIN_NIMBLEATTVALUE_H_
-#define MAIN_NIMBLEATTVALUE_H_
+#ifndef NIMBLE_CPP_ATTVALUE_H
+#define NIMBLE_CPP_ATTVALUE_H
 #include "nimconfig.h"
 #if defined(CONFIG_BT_ENABLED)
 
-#ifdef NIMBLE_CPP_ARDUINO_STRING_AVAILABLE
-#include <Arduino.h>
-#endif
+# ifdef NIMBLE_CPP_ARDUINO_STRING_AVAILABLE
+#  include <Arduino.h>
+# endif
 
-#include "NimBLELog.h"
+# include "NimBLELog.h"
+# include <string>
+# include <vector>
+# include <ctime>
+# include <cstring>
+# include <cstdint>
 
-/****  FIX COMPILATION ****/
-#undef min
-#undef max
-/**************************/
+# ifndef CONFIG_NIMBLE_CPP_ATT_VALUE_TIMESTAMP_ENABLED
+#  define CONFIG_NIMBLE_CPP_ATT_VALUE_TIMESTAMP_ENABLED 0
+# endif
 
-#include <string>
-#include <vector>
+# ifndef BLE_ATT_ATTR_MAX_LEN
+#  define BLE_ATT_ATTR_MAX_LEN 512
+# endif
 
-#ifndef CONFIG_NIMBLE_CPP_ATT_VALUE_TIMESTAMP_ENABLED
-#    define CONFIG_NIMBLE_CPP_ATT_VALUE_TIMESTAMP_ENABLED 0
-#endif
+# if !defined(CONFIG_NIMBLE_CPP_ATT_VALUE_INIT_LENGTH)
+#  define CONFIG_NIMBLE_CPP_ATT_VALUE_INIT_LENGTH 20
+# elif CONFIG_NIMBLE_CPP_ATT_VALUE_INIT_LENGTH > BLE_ATT_ATTR_MAX_LEN
+#  error CONFIG_NIMBLE_CPP_ATT_VALUE_INIT_LENGTH cannot be larger than 512 (BLE_ATT_ATTR_MAX_LEN)
+# elif CONFIG_NIMBLE_CPP_ATT_VALUE_INIT_LENGTH < 1
+#  error CONFIG_NIMBLE_CPP_ATT_VALUE_INIT_LENGTH cannot be less than 1; Range = 1 : 512
+# endif
 
-#if CONFIG_NIMBLE_CPP_ATT_VALUE_TIMESTAMP_ENABLED
-#    include <time.h>
-#endif
-
-#if !defined(CONFIG_NIMBLE_CPP_ATT_VALUE_INIT_LENGTH)
-#    define CONFIG_NIMBLE_CPP_ATT_VALUE_INIT_LENGTH 20
-#elif CONFIG_NIMBLE_CPP_ATT_VALUE_INIT_LENGTH > BLE_ATT_ATTR_MAX_LEN
-#    error CONFIG_NIMBLE_CPP_ATT_VALUE_INIT_LENGTH cannot be larger than 512 (BLE_ATT_ATTR_MAX_LEN)
-#elif CONFIG_NIMBLE_CPP_ATT_VALUE_INIT_LENGTH < 1
-#    error CONFIG_NIMBLE_CPP_ATT_VALUE_INIT_LENGTH cannot be less than 1; Range = 1 : 512
-#endif
+/* Used to determine if the type passed to a template has a data() and size() method. */
+template <typename T, typename = void, typename = void>
+struct Has_data_size : std::false_type {};
 
+template <typename T>
+struct Has_data_size<T, decltype(void(std::declval<T&>().data())), decltype(void(std::declval<T&>().size()))>
+    : std::true_type {};
 
 /* Used to determine if the type passed to a template has a c_str() and length() method. */
 template <typename T, typename = void, typename = void>
-struct Has_c_str_len : std::false_type {};
+struct Has_c_str_length : std::false_type {};
 
 template <typename T>
-struct Has_c_str_len<T, decltype(void(std::declval<T &>().c_str())),
-                     decltype(void(std::declval<T &>().length()))> : std::true_type {};
-
+struct Has_c_str_length<T, decltype(void(std::declval<T&>().c_str())), decltype(void(std::declval<T&>().length()))>
+    : std::true_type {};
 
 /**
  * @brief A specialized container class to hold BLE attribute values.
@@ -57,25 +60,23 @@ struct Has_c_str_len<T, decltype(void(std::declval<T &>().c_str())),
  * standard container types for value storage, while being convertible to\n
  * many different container classes.
  */
-class NimBLEAttValue
-{
-    uint8_t*     m_attr_value = nullptr;
-    uint16_t     m_attr_max_len = 0;
-    uint16_t     m_attr_len = 0;
-    uint16_t     m_capacity = 0;
-#if CONFIG_NIMBLE_CPP_ATT_VALUE_TIMESTAMP_ENABLED
-    time_t       m_timestamp = 0;
-#endif
-    void         deepCopy(const NimBLEAttValue & source);
+class NimBLEAttValue {
+    uint8_t* m_attr_value{};
+    uint16_t m_attr_max_len{};
+    uint16_t m_attr_len{};
+    uint16_t m_capacity{};
+# if CONFIG_NIMBLE_CPP_ATT_VALUE_TIMESTAMP_ENABLED
+    time_t m_timestamp{};
+# endif
+    void deepCopy(const NimBLEAttValue& source);
 
-public:
+  public:
     /**
      * @brief Default constructor.
      * @param[in] init_len The initial size in bytes.
      * @param[in] max_len The max size in bytes that the value can be.
      */
-    NimBLEAttValue(uint16_t init_len = CONFIG_NIMBLE_CPP_ATT_VALUE_INIT_LENGTH,
-                   uint16_t max_len = BLE_ATT_ATTR_MAX_LEN);
+    NimBLEAttValue(uint16_t init_len = CONFIG_NIMBLE_CPP_ATT_VALUE_INIT_LENGTH, uint16_t max_len = BLE_ATT_ATTR_MAX_LEN);
 
     /**
      * @brief Construct with an initial value from a buffer.
@@ -83,25 +84,23 @@ public:
      * @param[in] len The size in bytes of the value to set.
      * @param[in] max_len The max size in bytes that the value can be.
      */
-    NimBLEAttValue(const uint8_t *value, uint16_t len,
-                   uint16_t max_len = BLE_ATT_ATTR_MAX_LEN);
-
-    /**
-     * @brief Construct with an initializer list.
-     * @param list An initializer list containing the initial value to set.
-     * @param[in] max_len The max size in bytes that the value can be.
-     */
-    NimBLEAttValue(std::initializer_list<uint8_t> list,
-                   uint16_t max_len = BLE_ATT_ATTR_MAX_LEN)
-                   :NimBLEAttValue(list.begin(), (uint16_t)list.size(), max_len){}
+    NimBLEAttValue(const uint8_t* value, uint16_t len, uint16_t max_len = BLE_ATT_ATTR_MAX_LEN);
 
     /**
      * @brief Construct with an initial value from a const char string.
      * @param value A pointer to the initial value to set.
      * @param[in] max_len The max size in bytes that the value can be.
      */
-    NimBLEAttValue(const char *value, uint16_t max_len = BLE_ATT_ATTR_MAX_LEN)
-                   :NimBLEAttValue((uint8_t*)value, (uint16_t)strlen(value), max_len){}
+    NimBLEAttValue(const char* value, uint16_t max_len = BLE_ATT_ATTR_MAX_LEN)
+        : NimBLEAttValue((uint8_t*)value, (uint16_t)strlen(value), max_len) {}
+
+    /**
+     * @brief Construct with an initializer list.
+     * @param list An initializer list containing the initial value to set.
+     * @param[in] max_len The max size in bytes that the value can be.
+     */
+    NimBLEAttValue(std::initializer_list<uint8_t> list, uint16_t max_len = BLE_ATT_ATTR_MAX_LEN)
+        : NimBLEAttValue(list.begin(), list.size(), max_len) {}
 
     /**
      * @brief Construct with an initial value from a std::string.
@@ -109,7 +108,7 @@ public:
      * @param[in] max_len The max size in bytes that the value can be.
      */
     NimBLEAttValue(const std::string str, uint16_t max_len = BLE_ATT_ATTR_MAX_LEN)
-                   :NimBLEAttValue((uint8_t*)str.data(), (uint16_t)str.length(), max_len){}
+        : NimBLEAttValue(reinterpret_cast<const uint8_t*>(&str[0]), str.length(), max_len) {}
 
     /**
      * @brief Construct with an initial value from a std::vector<uint8_t>.
@@ -117,90 +116,99 @@ public:
      * @param[in] max_len The max size in bytes that the value can be.
      */
     NimBLEAttValue(const std::vector<uint8_t> vec, uint16_t max_len = BLE_ATT_ATTR_MAX_LEN)
-                   :NimBLEAttValue(&vec[0], (uint16_t)vec.size(), max_len){}
+        : NimBLEAttValue(&vec[0], vec.size(), max_len) {}
 
-#ifdef NIMBLE_CPP_ARDUINO_STRING_AVAILABLE
+# ifdef NIMBLE_CPP_ARDUINO_STRING_AVAILABLE
     /**
      * @brief Construct with an initial value from an Arduino String.
      * @param str An Arduino String containing to the initial value to set.
      * @param[in] max_len The max size in bytes that the value can be.
      */
     NimBLEAttValue(const String str, uint16_t max_len = BLE_ATT_ATTR_MAX_LEN)
-                   :NimBLEAttValue((uint8_t*)str.c_str(), str.length(), max_len){}
-#endif
+        : NimBLEAttValue(reinterpret_cast<const uint8_t*>(str.c_str()), str.length(), max_len) {}
+# endif
 
     /** @brief Copy constructor */
-    NimBLEAttValue(const NimBLEAttValue & source) { deepCopy(source); }
+    NimBLEAttValue(const NimBLEAttValue& source) { deepCopy(source); }
 
     /** @brief Move constructor */
-    NimBLEAttValue(NimBLEAttValue && source) { *this = std::move(source); }
+    NimBLEAttValue(NimBLEAttValue&& source) { *this = std::move(source); }
 
     /** @brief Destructor */
     ~NimBLEAttValue();
 
     /** @brief Returns the max size in bytes */
-    uint16_t        max_size()     const   { return m_attr_max_len; }
+    uint16_t max_size() const { return m_attr_max_len; }
 
     /** @brief Returns the currently allocated capacity in bytes */
-    uint16_t        capacity()     const   { return m_capacity; }
+    uint16_t capacity() const { return m_capacity; }
 
     /** @brief Returns the current length of the value in bytes */
-    uint16_t        length()       const   { return m_attr_len; }
+    uint16_t length() const { return m_attr_len; }
 
     /** @brief Returns the current size of the value in bytes */
-    uint16_t        size()         const   { return m_attr_len; }
+    uint16_t size() const { return m_attr_len; }
 
     /** @brief Returns a pointer to the internal buffer of the value */
-    const uint8_t*  data()         const   { return m_attr_value; }
+    const uint8_t* data() const { return m_attr_value; }
 
     /** @brief Returns a pointer to the internal buffer of the value as a const char* */
-    const char*     c_str()        const   { return (const char*)m_attr_value; }
+    const char* c_str() const { return reinterpret_cast<const char*>(m_attr_value); }
 
     /** @brief Iterator begin */
-    const uint8_t*  begin()        const   { return m_attr_value; }
+    const uint8_t* begin() const { return m_attr_value; }
 
     /** @brief Iterator end */
-    const uint8_t*  end()          const   { return m_attr_value + m_attr_len; }
+    const uint8_t* end() const { return m_attr_value + m_attr_len; }
 
-#if CONFIG_NIMBLE_CPP_ATT_VALUE_TIMESTAMP_ENABLED
+# if CONFIG_NIMBLE_CPP_ATT_VALUE_TIMESTAMP_ENABLED
     /** @brief Returns a timestamp of when the value was last updated */
-    time_t          getTimeStamp() const   { return m_timestamp; }
+    time_t getTimeStamp() const { return m_timestamp; }
 
     /** @brief Set the timestamp to the current time */
-    void            setTimeStamp()         { m_timestamp = time(nullptr); }
+    void setTimeStamp() { m_timestamp = time(nullptr); }
 
     /**
      * @brief Set the timestamp to the specified time
      * @param[in] t The timestamp value to set
      */
-    void            setTimeStamp(time_t t) { m_timestamp = t; }
-#else
-    time_t          getTimeStamp() const   { return 0; }
-    void            setTimeStamp()         { }
-    void            setTimeStamp(time_t t) { }
-#endif
+    void setTimeStamp(time_t t) { m_timestamp = t; }
+# else
+    time_t getTimeStamp() const { return 0; }
+    void   setTimeStamp() {}
+    void   setTimeStamp(time_t t) {}
+# endif
 
     /**
      * @brief Set the value from a buffer
-     * @param[in] value A ponter to a buffer containing the value.
+     * @param[in] value A pointer to a buffer containing the value.
      * @param[in] len The length of the value in bytes.
      * @returns True if successful.
      */
-    bool            setValue(const uint8_t *value, uint16_t len);
+    bool setValue(const uint8_t* value, uint16_t len);
 
     /**
      * @brief Set value to the value of const char*.
-     * @param [in] s A ponter to a const char value to set.
+     * @param [in] s A pointer to a const char value to set.
+     * @param [in] len The length of the value in bytes, defaults to strlen(s).
      */
-    bool            setValue(const char* s) {
-                         return setValue((uint8_t*)s, (uint16_t)strlen(s)); }
+    bool setValue(const char* s, uint16_t len = 0) {
+        if (len == 0) {
+            len = strlen(s);
+        }
+        return setValue(reinterpret_cast<const uint8_t*>(s), len);
+    }
 
-    /**
-     * @brief Get a pointer to the value buffer with timestamp.
-     * @param[in] timestamp A ponter to a time_t variable to store the timestamp.
-     * @returns A pointer to the internal value buffer.
-     */
-    const uint8_t*  getValue(time_t *timestamp);
+    const NimBLEAttValue& getValue(time_t* timestamp = nullptr) const {
+        if (timestamp != nullptr) {
+# if CONFIG_NIMBLE_CPP_ATT_VALUE_TIMESTAMP_ENABLED
+            *timestamp = m_timestamp;
+# else
+            *timestamp = 0;
+# endif
+        }
+        return *this;
+    }
 
     /**
      * @brief Append data to the value.
@@ -208,24 +216,25 @@ public:
      * @param[in] len The length of the value to append in bytes.
      * @returns A reference to the appended NimBLEAttValue.
      */
-    NimBLEAttValue& append(const uint8_t *value, uint16_t len);
-
+    NimBLEAttValue& append(const uint8_t* value, uint16_t len);
 
     /*********************** Template Functions ************************/
 
+# if __cplusplus < 201703L
     /**
      * @brief Template to set value to the value of <type\>val.
-     * @param [in] s The <type\>value to set.
-     * @details Only used for types without a `c_str()` method.
+     * @param [in] v The <type\>value to set.
+     * @details Only used for types without a `c_str()` and `length()` or `data()` and `size()` method.
+     * <type\> size must be evaluatable by `sizeof()`.
      */
-    template<typename T>
-#ifdef _DOXYGEN_
+    template <typename T>
+#  ifdef _DOXYGEN_
     bool
-#else
-    typename std::enable_if<!Has_c_str_len<T>::value, bool>::type
-#endif
-    setValue(const T &s) {
-        return setValue((uint8_t*)&s, sizeof(T));
+#  else
+    typename std::enable_if<!std::is_pointer<T>::value && !Has_c_str_length<T>::value && !Has_data_size<T>::value, bool>::type
+#  endif
+    setValue(const T& v) {
+        return setValue(reinterpret_cast<const uint8_t*>(&v), sizeof(T));
     }
 
     /**
@@ -233,16 +242,49 @@ public:
      * @param [in] s The <type\>value to set.
      * @details Only used if the <type\> has a `c_str()` method.
      */
-    template<typename T>
-#ifdef _DOXYGEN_
+    template <typename T>
+#  ifdef _DOXYGEN_
     bool
-#else
-    typename std::enable_if<Has_c_str_len<T>::value, bool>::type
-#endif
-    setValue(const T & s) {
-        return setValue((uint8_t*)s.c_str(), (uint16_t)s.length());
+#  else
+    typename std::enable_if<Has_c_str_length<T>::value && !Has_data_size<T>::value, bool>::type
+#  endif
+    setValue(const T& s) {
+        return setValue(reinterpret_cast<const uint8_t*>(s.c_str()), s.length());
     }
 
+    /**
+     * @brief Template to set value to the value of <type\>val.
+     * @param [in] v The <type\>value to set.
+     * @details Only used if the <type\> has a `data()` and `size()` method.
+     */
+    template <typename T>
+#  ifdef _DOXYGEN_
+    bool
+#  else
+    typename std::enable_if<Has_data_size<T>::value, bool>::type
+#  endif
+    setValue(const T& v) {
+        return setValue(reinterpret_cast<const uint8_t*>(v.data()), v.size());
+    }
+
+# else
+    /**
+     * @brief Template to set value to the value of <type\>val.
+     * @param [in] s The <type\>value to set.
+     * @note This function is only available if the type T is not a pointer.
+     */
+    template <typename T>
+    typename std::enable_if<!std::is_pointer<T>::value, bool>::type setValue(const T& s) {
+        if constexpr (Has_data_size<T>::value) {
+            return setValue(reinterpret_cast<const uint8_t*>(s.data()), s.size());
+        } else if constexpr (Has_c_str_length<T>::value) {
+            return setValue(reinterpret_cast<const uint8_t*>(s.c_str()), s.length());
+        } else {
+            return setValue(reinterpret_cast<const uint8_t*>(&s), sizeof(s));
+        }
+    }
+# endif
+
     /**
      * @brief Template to return the value as a <type\>.
      * @tparam T The type to convert the data to.
@@ -253,195 +295,67 @@ public:
      * less than <tt>sizeof(<type\>)</tt>.
      * @details <b>Use:</b> <tt>getValue<type>(&timestamp, skipSizeCheck);</tt>
      */
-    template<typename T>
-    T   getValue(time_t *timestamp = nullptr, bool skipSizeCheck = false) {
-            if(!skipSizeCheck && size() < sizeof(T)) {
-                return T();
-            }
-            return *((T *)getValue(timestamp));
-    }
+    template <typename T>
+    T getValue(time_t* timestamp = nullptr, bool skipSizeCheck = false) const {
+        if (!skipSizeCheck && size() < sizeof(T)) {
+            return T();
+        }
+        if (timestamp != nullptr) {
+# if CONFIG_NIMBLE_CPP_ATT_VALUE_TIMESTAMP_ENABLED
+            *timestamp = m_timestamp;
+# else
+            *timestamp = 0;
+# endif
+        }
 
+        return *(reinterpret_cast<const T*>(m_attr_value));
+    }
 
     /*********************** Operators ************************/
 
     /** @brief Subscript operator */
-    uint8_t operator [](int pos) const {
-        assert(pos < m_attr_len && "out of range"); return m_attr_value[pos]; }
+    uint8_t operator[](int pos) const {
+        NIMBLE_CPP_DEBUG_ASSERT(pos < m_attr_len);
+        return m_attr_value[pos];
+    }
 
     /** @brief Operator; Get the value as a std::vector<uint8_t>. */
-    operator std::vector<uint8_t>() const {
-        return std::vector<uint8_t>(m_attr_value, m_attr_value + m_attr_len); }
+    operator std::vector<uint8_t>() const { return std::vector<uint8_t>(m_attr_value, m_attr_value + m_attr_len); }
 
     /** @brief Operator; Get the value as a std::string. */
-    operator std::string() const {
-        return std::string((char*)m_attr_value, m_attr_len); }
+    operator std::string() const { return std::string(reinterpret_cast<char*>(m_attr_value), m_attr_len); }
 
     /** @brief Operator; Get the value as a const uint8_t*. */
     operator const uint8_t*() const { return m_attr_value; }
 
     /** @brief Operator; Append another NimBLEAttValue. */
-    NimBLEAttValue& operator  +=(const NimBLEAttValue & source) {
-        return append(source.data(), source.size()); }
+    NimBLEAttValue& operator+=(const NimBLEAttValue& source) { return append(source.data(), source.size()); }
 
     /** @brief Operator; Set the value from a std::string source. */
-    NimBLEAttValue& operator  =(const std::string & source) {
-        setValue((uint8_t*)source.data(), (uint16_t)source.size()); return *this; }
+    NimBLEAttValue& operator=(const std::string& source) {
+        setValue(reinterpret_cast<const uint8_t*>(&source[0]), source.size());
+        return *this;
+    }
 
     /** @brief Move assignment operator */
-    NimBLEAttValue& operator  =(NimBLEAttValue && source);
+    NimBLEAttValue& operator=(NimBLEAttValue&& source);
 
     /** @brief Copy assignment operator */
-    NimBLEAttValue& operator  =(const NimBLEAttValue & source);
+    NimBLEAttValue& operator=(const NimBLEAttValue& source);
 
     /** @brief Equality operator */
-    bool operator  ==(const NimBLEAttValue & source) {
-        return (m_attr_len == source.size()) ?
-                memcmp(m_attr_value, source.data(), m_attr_len) == 0 : false; }
+    bool operator==(const NimBLEAttValue& source) const {
+        return (m_attr_len == source.size()) ? memcmp(m_attr_value, source.data(), m_attr_len) == 0 : false;
+    }
 
     /** @brief Inequality operator */
-    bool operator  !=(const NimBLEAttValue & source){ return !(*this == source); }
+    bool operator!=(const NimBLEAttValue& source) const { return !(*this == source); }
 
-#ifdef NIMBLE_CPP_ARDUINO_STRING_AVAILABLE
+# ifdef NIMBLE_CPP_ARDUINO_STRING_AVAILABLE
     /** @brief Operator; Get the value as an Arduino String value. */
-    operator String() const { return String((char*)m_attr_value); }
-#endif
-
+    operator String() const { return String(reinterpret_cast<char*>(m_attr_value)); }
+# endif
 };
 
-
-inline NimBLEAttValue::NimBLEAttValue(uint16_t init_len, uint16_t max_len) {
-    m_attr_value   = (uint8_t*)calloc(init_len + 1, 1);
-    assert(m_attr_value && "No Mem");
-    m_attr_max_len = std::min(BLE_ATT_ATTR_MAX_LEN, (int)max_len);
-    m_attr_len     = 0;
-    m_capacity     = init_len;
-    setTimeStamp(0);
-}
-
-inline NimBLEAttValue::NimBLEAttValue(const uint8_t *value, uint16_t len, uint16_t max_len)
-: NimBLEAttValue(len, max_len) {
-    memcpy(m_attr_value, value, len);
-    m_attr_value[len] = '\0';
-    m_attr_len        = len;
-}
-
-inline NimBLEAttValue::~NimBLEAttValue() {
-    if(m_attr_value != nullptr) {
-        free(m_attr_value);
-    }
-}
-
-inline NimBLEAttValue& NimBLEAttValue::operator =(NimBLEAttValue && source) {
-    if (this != &source){
-        free(m_attr_value);
-
-        m_attr_value   = source.m_attr_value;
-        m_attr_max_len = source.m_attr_max_len;
-        m_attr_len     = source.m_attr_len;
-        m_capacity     = source.m_capacity;
-        setTimeStamp(source.getTimeStamp());
-        source.m_attr_value = nullptr;
-    }
-    return *this;
-}
-
-inline NimBLEAttValue& NimBLEAttValue::operator =(const NimBLEAttValue & source) {
-    if (this != &source) {
-        deepCopy(source);
-    }
-    return *this;
-}
-
-inline void NimBLEAttValue::deepCopy(const NimBLEAttValue & source) {
-    uint8_t* res = (uint8_t*)realloc( m_attr_value, source.m_capacity + 1);
-    assert(res && "deepCopy: realloc failed");
-
-    ble_npl_hw_enter_critical();
-    m_attr_value   = res;
-    m_attr_max_len = source.m_attr_max_len;
-    m_attr_len     = source.m_attr_len;
-    m_capacity     = source.m_capacity;
-    setTimeStamp(source.getTimeStamp());
-    memcpy(m_attr_value, source.m_attr_value, m_attr_len + 1);
-    ble_npl_hw_exit_critical(0);
-}
-
-inline const uint8_t*  NimBLEAttValue::getValue(time_t *timestamp) {
-    if(timestamp != nullptr) {
-#if CONFIG_NIMBLE_CPP_ATT_VALUE_TIMESTAMP_ENABLED
-        *timestamp = m_timestamp;
-#else
-        *timestamp = 0;
-#endif
-    }
-    return m_attr_value;
-}
-
-inline bool NimBLEAttValue::setValue(const uint8_t *value, uint16_t len) {
-    if (len > m_attr_max_len) {
-        NIMBLE_LOGE("NimBLEAttValue", "value exceeds max, len=%u, max=%u",
-                     len, m_attr_max_len);
-        return false;
-    }
-
-    uint8_t *res = m_attr_value;
-    if (len > m_capacity) {
-        res = (uint8_t*)realloc(m_attr_value, (len + 1));
-        m_capacity = len;
-    }
-    assert(res && "setValue: realloc failed");
-
-#if CONFIG_NIMBLE_CPP_ATT_VALUE_TIMESTAMP_ENABLED
-    time_t t = time(nullptr);
-#else
-    time_t t = 0;
-#endif
-
-    ble_npl_hw_enter_critical();
-    m_attr_value = res;
-    memcpy(m_attr_value, value, len);
-    m_attr_value[len] = '\0';
-    m_attr_len = len;
-    setTimeStamp(t);
-    ble_npl_hw_exit_critical(0);
-    return true;
-}
-
-inline NimBLEAttValue& NimBLEAttValue::append(const uint8_t *value, uint16_t len) {
-    if (len < 1) {
-        return *this;
-    }
-
-    if ((m_attr_len + len) > m_attr_max_len) {
-        NIMBLE_LOGE("NimBLEAttValue", "val > max, len=%u, max=%u",
-                    len, m_attr_max_len);
-        return *this;
-    }
-
-    uint8_t* res = m_attr_value;
-    uint16_t new_len = m_attr_len + len;
-    if (new_len > m_capacity) {
-        res = (uint8_t*)realloc(m_attr_value, (new_len + 1));
-        m_capacity = new_len;
-    }
-    assert(res && "append: realloc failed");
-
-#if CONFIG_NIMBLE_CPP_ATT_VALUE_TIMESTAMP_ENABLED
-    time_t t = time(nullptr);
-#else
-    time_t t = 0;
-#endif
-
-    ble_npl_hw_enter_critical();
-    m_attr_value = res;
-    memcpy(m_attr_value + m_attr_len, value, len);
-    m_attr_len = new_len;
-    m_attr_value[m_attr_len] = '\0';
-    setTimeStamp(t);
-    ble_npl_hw_exit_critical(0);
-
-    return *this;
-}
-
 #endif /*(CONFIG_BT_ENABLED) */
-#endif /* MAIN_NIMBLEATTVALUE_H_ */
+#endif /* NIMBLE_CPP_ATTVALUE_H_ */

src/NimBLEAttribute.h

@@ -0,0 +1,50 @@
+/*
+ * NimBLEAttribute.h
+ *
+ *  Created: on July 28 2024
+ *      Author H2zero
+ */
+
+#ifndef NIMBLE_CPP_ATTRIBUTE_H_
+#define NIMBLE_CPP_ATTRIBUTE_H_
+
+#include "nimconfig.h"
+#if defined(CONFIG_BT_ENABLED) && (defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL) || defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL))
+
+# include "NimBLEUUID.h"
+
+/**
+ * @brief A base class for BLE attributes.
+ */
+class NimBLEAttribute {
+  public:
+    /**
+     * @brief Get the UUID of the attribute.
+     * @return The UUID.
+     */
+    const NimBLEUUID& getUUID() const { return m_uuid; }
+
+    /**
+     * @brief Get the handle of the attribute.
+     */
+    uint16_t getHandle() const { return m_handle; };
+
+  protected:
+    /**
+     * @brief Construct a new NimBLEAttribute object.
+     * @param [in] handle The handle of the attribute.
+     * @param [in] uuid The UUID of the attribute.
+     */
+    NimBLEAttribute(const NimBLEUUID& uuid, uint16_t handle) : m_uuid{uuid}, m_handle{handle} {}
+
+    /**
+     * @brief Destroy the NimBLEAttribute object.
+     */
+    ~NimBLEAttribute() = default;
+
+    const NimBLEUUID m_uuid{};
+    uint16_t   m_handle{0};
+};
+
+#endif // CONFIG_BT_ENABLED && (CONFIG_BT_NIMBLE_ROLE_PERIPHERAL || CONFIG_BT_NIMBLE_ROLE_CENTRAL)
+#endif // NIMBLE_CPP_ATTRIBUTE_H_

src/NimBLEBeacon.cpp

@@ -1,5 +1,5 @@
 /*
- * NimBLEBeacon2.cpp
+ * NimBLEBeacon.cpp
  *
  *  Created: on March 15 2020
  *      Author H2zero
@@ -11,50 +11,33 @@
  *  Created on: Jan 4, 2018
  *      Author: kolban
  */
+
 #include "nimconfig.h"
-#if defined(CONFIG_BT_ENABLED)
+#if defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)
 
-#include <string.h>
-#include <algorithm>
-#include "NimBLEBeacon.h"
-#include "NimBLELog.h"
+# include "NimBLEBeacon.h"
+# include "NimBLEUUID.h"
+# include "NimBLELog.h"
 
-#define ENDIAN_CHANGE_U16(x) ((((x)&0xFF00)>>8) + (((x)&0xFF)<<8))
+# define ENDIAN_CHANGE_U16(x) ((((x) & 0xFF00) >> 8) + (((x) & 0xFF) << 8))
 
 static const char* LOG_TAG = "NimBLEBeacon";
 
-
-/**
- * @brief Construct a default beacon object.
- */
-NimBLEBeacon::NimBLEBeacon() {
-    m_beaconData.manufacturerId = 0x4c00;
-    m_beaconData.subType        = 0x02;
-    m_beaconData.subTypeLength  = 0x15;
-    m_beaconData.major          = 0;
-    m_beaconData.minor          = 0;
-    m_beaconData.signalPower    = 0;
-    memset(m_beaconData.proximityUUID, 0, sizeof(m_beaconData.proximityUUID));
-} // NimBLEBeacon
-
-
 /**
  * @brief Retrieve the data that is being advertised.
  * @return The advertised data.
  */
-std::string NimBLEBeacon::getData() {
-    return std::string((char*) &m_beaconData, sizeof(m_beaconData));
+const NimBLEBeacon::BeaconData& NimBLEBeacon::getData() {
+    return m_beaconData;
 } // getData
 
-
 /**
  * @brief Get the major value being advertised.
  * @return The major value advertised.
  */
 uint16_t NimBLEBeacon::getMajor() {
     return m_beaconData.major;
-}
-
+} // getMajor
 
 /**
  * @brief Get the manufacturer ID being advertised.
@@ -62,8 +45,7 @@ uint16_t NimBLEBeacon::getMajor() {
  */
 uint16_t NimBLEBeacon::getManufacturerId() {
     return m_beaconData.manufacturerId;
-}
-
+} // getManufacturerId
 
 /**
  * @brief Get the minor value being advertised.
@@ -71,17 +53,15 @@ uint16_t NimBLEBeacon::getManufacturerId() {
  */
 uint16_t NimBLEBeacon::getMinor() {
     return m_beaconData.minor;
-}
-
+} // getMinor
 
 /**
  * @brief Get the proximity UUID being advertised.
  * @return The UUID advertised.
  */
 NimBLEUUID NimBLEBeacon::getProximityUUID() {
-    return NimBLEUUID(m_beaconData.proximityUUID, 16, true);
-}
-
+    return NimBLEUUID(m_beaconData.proximityUUID, 16).reverseByteOrder();
+} // getProximityUUID
 
 /**
  * @brief Get the signal power being advertised.
@@ -89,22 +69,28 @@ NimBLEUUID NimBLEBeacon::getProximityUUID() {
  */
 int8_t NimBLEBeacon::getSignalPower() {
     return m_beaconData.signalPower;
-}
-
+} // getSignalPower
 
 /**
- * @brief Set the raw data for the beacon record.
- * @param [in] data The raw beacon data.
+ * @brief Set the beacon data.
+ * @param [in] data A pointer to the raw data that the beacon should advertise.
+ * @param [in] length The length of the data.
  */
-void NimBLEBeacon::setData(const std::string &data) {
-    if (data.length() != sizeof(m_beaconData)) {
-        NIMBLE_LOGE(LOG_TAG, "Unable to set the data ... length passed in was %d and expected %d",
-                                                        data.length(), sizeof(m_beaconData));
+void NimBLEBeacon::setData(const uint8_t* data, uint8_t length) {
+    if (length != sizeof(BeaconData)) {
+        NIMBLE_LOGE(LOG_TAG, "Data length must be %d bytes, sent: %d", sizeof(BeaconData), length);
         return;
     }
-    memcpy(&m_beaconData, data.data(), sizeof(m_beaconData));
+    memcpy(&m_beaconData, data, length);
 } // setData
 
+/**
+ * @brief Set the beacon data.
+ * @param [in] data The data that the beacon should advertise.
+ */
+void NimBLEBeacon::setData(const NimBLEBeacon::BeaconData& data) {
+    m_beaconData = data;
+} // setData
 
 /**
  * @brief Set the major value.
@@ -114,7 +100,6 @@ void NimBLEBeacon::setMajor(uint16_t major) {
     m_beaconData.major = ENDIAN_CHANGE_U16(major);
 } // setMajor
 
-
 /**
  * @brief Set the manufacturer ID.
  * @param [in] manufacturerId The manufacturer ID value.
@@ -123,7 +108,6 @@ void NimBLEBeacon::setManufacturerId(uint16_t manufacturerId) {
     m_beaconData.manufacturerId = ENDIAN_CHANGE_U16(manufacturerId);
 } // setManufacturerId
 
-
 /**
  * @brief Set the minor value.
  * @param [in] minor The minor value.
@@ -132,20 +116,17 @@ void NimBLEBeacon::setMinor(uint16_t minor) {
     m_beaconData.minor = ENDIAN_CHANGE_U16(minor);
 } // setMinor
 
-
 /**
  * @brief Set the proximity UUID.
  * @param [in] uuid The proximity UUID.
  */
-void NimBLEBeacon::setProximityUUID(const NimBLEUUID &uuid) {
+void NimBLEBeacon::setProximityUUID(const NimBLEUUID& uuid) {
     NimBLEUUID temp_uuid = uuid;
     temp_uuid.to128();
-    std::reverse_copy(temp_uuid.getNative()->u128.value,
-                      temp_uuid.getNative()->u128.value + 16,
-                      m_beaconData.proximityUUID);
+    temp_uuid.reverseByteOrder();
+    memcpy(m_beaconData.proximityUUID, temp_uuid.getValue(), 16);
 } // setProximityUUID
 
-
 /**
  * @brief Set the signal power.
  * @param [in] signalPower The signal power value.
@@ -154,4 +135,4 @@ void NimBLEBeacon::setSignalPower(int8_t signalPower) {
     m_beaconData.signalPower = signalPower;
 } // setSignalPower
 
-#endif
+#endif // CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_BROADCASTER

src/NimBLEBeacon.h

@@ -1,51 +1,61 @@
 /*
- * NimBLEBeacon2.h
+ * NimBLEBeacon.h
  *
  *  Created: on March 15 2020
  *      Author H2zero
  *
  * Originally:
  *
- * BLEBeacon2.h
+ * BLEBeacon.h
  *
  *  Created on: Jan 4, 2018
  *      Author: kolban
  */
 
-#ifndef MAIN_NIMBLEBEACON_H_
-#define MAIN_NIMBLEBEACON_H_
+#ifndef NIMBLE_CPP_BEACON_H_
+#define NIMBLE_CPP_BEACON_H_
+
+#include "nimconfig.h"
+#if defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)
+
+class NimBLEUUID;
+
+# include <cstdint>
 
-#include "NimBLEUUID.h"
 /**
  * @brief Representation of a beacon.
  * See:
  * * https://en.wikipedia.org/wiki/IBeacon
  */
 class NimBLEBeacon {
-private:
-    struct {
-        uint16_t manufacturerId;
-        uint8_t  subType;
-        uint8_t  subTypeLength;
-        uint8_t  proximityUUID[16];
-        uint16_t major;
-        uint16_t minor;
-        int8_t   signalPower;
-    } __attribute__((packed)) m_beaconData;
-public:
-    NimBLEBeacon();
-    std::string getData();
-    uint16_t    getMajor();
-    uint16_t    getMinor();
-    uint16_t    getManufacturerId();
-    NimBLEUUID     getProximityUUID();
-    int8_t      getSignalPower();
-    void        setData(const std::string &data);
-    void        setMajor(uint16_t major);
-    void        setMinor(uint16_t minor);
-    void        setManufacturerId(uint16_t manufacturerId);
-    void        setProximityUUID(const NimBLEUUID &uuid);
-    void        setSignalPower(int8_t signalPower);
+  public:
+    struct BeaconData {
+        uint16_t manufacturerId{0x4c00};
+        uint8_t  subType{0x02};
+        uint8_t  subTypeLength{0x15};
+        uint8_t  proximityUUID[16]{};
+        uint16_t major{};
+        uint16_t minor{};
+        int8_t   signalPower{};
+    } __attribute__((packed));
+
+    const BeaconData& getData();
+    uint16_t          getMajor();
+    uint16_t          getMinor();
+    uint16_t          getManufacturerId();
+    NimBLEUUID        getProximityUUID();
+    int8_t            getSignalPower();
+    void              setData(const uint8_t* data, uint8_t length);
+    void              setData(const BeaconData& data);
+    void              setMajor(uint16_t major);
+    void              setMinor(uint16_t minor);
+    void              setManufacturerId(uint16_t manufacturerId);
+    void              setProximityUUID(const NimBLEUUID& uuid);
+    void              setSignalPower(int8_t signalPower);
+
+  private:
+    BeaconData m_beaconData;
 }; // NimBLEBeacon
 
-#endif /* MAIN_NIMBLEBEACON_H_ */
+#endif // NIMBLE_CPP_BEACON_H_
+#endif // CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_PERIPHERAL

src/NimBLECharacteristic.cpp

@@ -13,133 +13,132 @@
 #include "nimconfig.h"
 #if defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
 
-#include "NimBLECharacteristic.h"
-#include "NimBLE2904.h"
-#include "NimBLEDevice.h"
-#include "NimBLELog.h"
-
-#define NULL_HANDLE (0xffff)
-#define NIMBLE_SUB_NOTIFY   0x0001
-#define NIMBLE_SUB_INDICATE 0x0002
+# include "NimBLECharacteristic.h"
+# include "NimBLE2904.h"
+# include "NimBLEDevice.h"
+# include "NimBLELog.h"
 
 static NimBLECharacteristicCallbacks defaultCallback;
-static const char* LOG_TAG = "NimBLECharacteristic";
-
+static const char*                   LOG_TAG = "NimBLECharacteristic";
 
 /**
  * @brief Construct a characteristic
  * @param [in] uuid - UUID (const char*) for the characteristic.
  * @param [in] properties - Properties for the characteristic.
- * @param [in] max_len - The maximum length in bytes that the characteristic value can hold. (Default: 512 bytes for esp32, 20 for all others).
+ * @param [in] maxLen - The maximum length in bytes that the characteristic value can hold. (Default: 512 bytes for esp32, 20 for all others).
  * @param [in] pService - pointer to the service instance this characteristic belongs to.
  */
-NimBLECharacteristic::NimBLECharacteristic(const char* uuid, uint16_t properties,
-                                           uint16_t max_len, NimBLEService* pService)
-: NimBLECharacteristic(NimBLEUUID(uuid), properties, max_len, pService) {
-}
+NimBLECharacteristic::NimBLECharacteristic(const char* uuid, uint16_t properties, uint16_t maxLen, NimBLEService* pService)
+    : NimBLECharacteristic(NimBLEUUID(uuid), properties, maxLen, pService) {}
 
 /**
  * @brief Construct a characteristic
  * @param [in] uuid - UUID for the characteristic.
  * @param [in] properties - Properties for the characteristic.
- * @param [in] max_len - The maximum length in bytes that the characteristic value can hold. (Default: 512 bytes for esp32, 20 for all others).
+ * @param [in] maxLen - The maximum length in bytes that the characteristic value can hold. (Default: 512 bytes for esp32, 20 for all others).
  * @param [in] pService - pointer to the service instance this characteristic belongs to.
  */
-NimBLECharacteristic::NimBLECharacteristic(const NimBLEUUID &uuid, uint16_t properties,
-                                           uint16_t max_len, NimBLEService* pService)
-:   m_value(std::min(CONFIG_NIMBLE_CPP_ATT_VALUE_INIT_LENGTH , (int)max_len), max_len) {
-    m_uuid        = uuid;
-    m_handle      = NULL_HANDLE;
-    m_properties  = properties;
-    m_pCallbacks  = &defaultCallback;
-    m_pService    = pService;
-    m_removed     = 0;
+NimBLECharacteristic::NimBLECharacteristic(const NimBLEUUID& uuid, uint16_t properties, uint16_t maxLen, NimBLEService* pService)
+    : NimBLELocalValueAttribute{uuid, 0, maxLen}, m_pCallbacks{&defaultCallback}, m_pService{pService} {
+    setProperties(properties);
 } // NimBLECharacteristic
 
 /**
  * @brief Destructor.
  */
 NimBLECharacteristic::~NimBLECharacteristic() {
-    for(auto &it : m_dscVec) {
-        delete it;
+    for (const auto& dsc : m_vDescriptors) {
+        delete dsc;
     }
 } // ~NimBLECharacteristic
 
-
 /**
  * @brief Create a new BLE Descriptor associated with this characteristic.
  * @param [in] uuid - The UUID of the descriptor.
  * @param [in] properties - The properties of the descriptor.
- * @param [in] max_len - The max length in bytes of the descriptor value.
+ * @param [in] maxLen - The max length in bytes of the descriptor value.
  * @return The new BLE descriptor.
  */
-NimBLEDescriptor* NimBLECharacteristic::createDescriptor(const char* uuid, uint32_t properties, uint16_t max_len) {
-    return createDescriptor(NimBLEUUID(uuid), properties, max_len);
+NimBLEDescriptor* NimBLECharacteristic::createDescriptor(const char* uuid, uint32_t properties, uint16_t maxLen) {
+    return createDescriptor(NimBLEUUID(uuid), properties, maxLen);
 }
 
-
 /**
  * @brief Create a new BLE Descriptor associated with this characteristic.
  * @param [in] uuid - The UUID of the descriptor.
  * @param [in] properties - The properties of the descriptor.
- * @param [in] max_len - The max length in bytes of the descriptor value.
+ * @param [in] maxLen - The max length in bytes of the descriptor value.
  * @return The new BLE descriptor.
  */
-NimBLEDescriptor* NimBLECharacteristic::createDescriptor(const NimBLEUUID &uuid, uint32_t properties, uint16_t max_len) {
+NimBLEDescriptor* NimBLECharacteristic::createDescriptor(const NimBLEUUID& uuid, uint32_t properties, uint16_t maxLen) {
     NimBLEDescriptor* pDescriptor = nullptr;
-    if(uuid == NimBLEUUID(uint16_t(0x2902))) {
-        assert(0 && "0x2902 descriptors cannot be manually created");
-    } else if (uuid == NimBLEUUID(uint16_t(0x2904))) {
-        pDescriptor = new NimBLE2904(this);
+    if (uuid == NimBLEUUID(static_cast<uint16_t>(0x2904))) {
+        NIMBLE_LOGW(LOG_TAG, "0x2904 descriptor should be created with create2904()");
+        pDescriptor = create2904();
     } else {
-        pDescriptor = new NimBLEDescriptor(uuid, properties, max_len, this);
+        pDescriptor = new NimBLEDescriptor(uuid, properties, maxLen, this);
     }
 
     addDescriptor(pDescriptor);
     return pDescriptor;
 } // createDescriptor
 
+/**
+ * @brief Create a Characteristic Presentation Format Descriptor for this characteristic.
+ * @return A pointer to a NimBLE2904 descriptor.
+ */
+NimBLE2904* NimBLECharacteristic::create2904() {
+    NimBLE2904* pDescriptor = new NimBLE2904(this);
+    addDescriptor(pDescriptor);
+    return pDescriptor;
+} // create2904
 
 /**
  * @brief Add a descriptor to the characteristic.
  * @param [in] pDescriptor A pointer to the descriptor to add.
  */
-void NimBLECharacteristic::addDescriptor(NimBLEDescriptor *pDescriptor) {
+void NimBLECharacteristic::addDescriptor(NimBLEDescriptor* pDescriptor) {
     bool foundRemoved = false;
-
-    if(pDescriptor->m_removed > 0) {
-        for(auto& it : m_dscVec) {
-            if(it == pDescriptor) {
+    if (pDescriptor->getRemoved() > 0) {
+        for (const auto& dsc : m_vDescriptors) {
+            if (dsc == pDescriptor) {
                 foundRemoved = true;
-                pDescriptor->m_removed = 0;
+                pDescriptor->setRemoved(0);
             }
         }
     }
 
-    if(!foundRemoved) {
-        m_dscVec.push_back(pDescriptor);
+    // Check if the descriptor is already in the vector and if so, return.
+    for (const auto& dsc : m_vDescriptors) {
+        if (dsc == pDescriptor) {
+            pDescriptor->setCharacteristic(this); // Update the characteristic pointer in the descriptor.
+            return;
+        }
+    }
+
+    if (!foundRemoved) {
+        m_vDescriptors.push_back(pDescriptor);
     }
 
     pDescriptor->setCharacteristic(this);
     NimBLEDevice::getServer()->serviceChanged();
 }
 
-
 /**
  * @brief Remove a descriptor from the characteristic.
  * @param[in] pDescriptor A pointer to the descriptor instance to remove from the characteristic.
  * @param[in] deleteDsc If true it will delete the descriptor instance and free it's resources.
  */
-void NimBLECharacteristic::removeDescriptor(NimBLEDescriptor *pDescriptor, bool deleteDsc) {
+void NimBLECharacteristic::removeDescriptor(NimBLEDescriptor* pDescriptor, bool deleteDsc) {
     // Check if the descriptor was already removed and if so, check if this
     // is being called to delete the object and do so if requested.
     // Otherwise, ignore the call and return.
-    if(pDescriptor->m_removed > 0) {
-        if(deleteDsc) {
-            for(auto it = m_dscVec.begin(); it != m_dscVec.end(); ++it) {
+    if (pDescriptor->getRemoved() > 0) {
+        if (deleteDsc) {
+            for (auto it = m_vDescriptors.begin(); it != m_vDescriptors.end(); ++it) {
                 if ((*it) == pDescriptor) {
-                    delete *it;
-                    m_dscVec.erase(it);
+                    delete (*it);
+                    m_vDescriptors.erase(it);
                     break;
                 }
             }
@@ -148,30 +147,28 @@ void NimBLECharacteristic::removeDescriptor(NimBLEDescriptor *pDescriptor, bool
         return;
     }
 
-    pDescriptor->m_removed = deleteDsc ? NIMBLE_ATT_REMOVE_DELETE : NIMBLE_ATT_REMOVE_HIDE;
+    pDescriptor->setRemoved(deleteDsc ? NIMBLE_ATT_REMOVE_DELETE : NIMBLE_ATT_REMOVE_HIDE);
     NimBLEDevice::getServer()->serviceChanged();
 } // removeDescriptor
 
-
 /**
  * @brief Return the BLE Descriptor for the given UUID.
  * @param [in] uuid The UUID of the descriptor.
  * @return A pointer to the descriptor object or nullptr if not found.
  */
-NimBLEDescriptor* NimBLECharacteristic::getDescriptorByUUID(const char* uuid) {
+NimBLEDescriptor* NimBLECharacteristic::getDescriptorByUUID(const char* uuid) const {
     return getDescriptorByUUID(NimBLEUUID(uuid));
 } // getDescriptorByUUID
 
-
 /**
  * @brief Return the BLE Descriptor for the given UUID.
  * @param [in] uuid The UUID of the descriptor.
  * @return A pointer to the descriptor object or nullptr if not found.
  */
-NimBLEDescriptor* NimBLECharacteristic::getDescriptorByUUID(const NimBLEUUID &uuid) {
-    for (auto &it : m_dscVec) {
-        if (it->getUUID() == uuid) {
-            return it;
+NimBLEDescriptor* NimBLECharacteristic::getDescriptorByUUID(const NimBLEUUID& uuid) const {
+    for (const auto& dsc : m_vDescriptors) {
+        if (dsc->getUUID() == uuid) {
+            return dsc;
         }
     }
     return nullptr;
@@ -182,339 +179,136 @@ NimBLEDescriptor* NimBLECharacteristic::getDescriptorByUUID(const NimBLEUUID &uu
  * @param [in] handle The handle of the descriptor.
  * @return A pointer to the descriptor object or nullptr if not found.
  */
-NimBLEDescriptor *NimBLECharacteristic::getDescriptorByHandle(uint16_t handle) {
-    for (auto &it : m_dscVec) {
-        if (it->getHandle() == handle) {
-            return it;
+NimBLEDescriptor* NimBLECharacteristic::getDescriptorByHandle(uint16_t handle) const {
+    for (const auto& dsc : m_vDescriptors) {
+        if (dsc->getHandle() == handle) {
+            return dsc;
         }
     }
     return nullptr;
-}
-
-
-/**
- * @brief Get the handle of the characteristic.
- * @return The handle of the characteristic.
- */
-uint16_t NimBLECharacteristic::getHandle() {
-    return m_handle;
-} // getHandle
-
+} // getDescriptorByHandle
 
 /**
  * @brief Get the properties of the characteristic.
  * @return The properties of the characteristic.
  */
-uint16_t NimBLECharacteristic::getProperties() {
+uint16_t NimBLECharacteristic::getProperties() const {
     return m_properties;
 } // getProperties
 
-
 /**
- * @brief Get the service associated with this characteristic.
+ * @brief Get the service that owns this characteristic.
  */
-NimBLEService* NimBLECharacteristic::getService() {
+NimBLEService* NimBLECharacteristic::getService() const {
     return m_pService;
 } // getService
 
-
-void NimBLECharacteristic::setService(NimBLEService *pService) {
+void NimBLECharacteristic::setService(NimBLEService* pService) {
     m_pService = pService;
-}
-
-
-/**
- * @brief Get the UUID of the characteristic.
- * @return The UUID of the characteristic.
- */
-NimBLEUUID NimBLECharacteristic::getUUID() {
-    return m_uuid;
-} // getUUID
-
-
-/**
- * @brief Retrieve the current value of the characteristic.
- * @return The NimBLEAttValue containing the current characteristic value.
- */
-NimBLEAttValue NimBLECharacteristic::getValue(time_t *timestamp) {
-    if(timestamp != nullptr) {
-        m_value.getValue(timestamp);
-    }
-
-    return m_value;
-} // getValue
-
-
-/**
- * @brief Retrieve the the current data length of the characteristic.
- * @return The length of the current characteristic data.
- */
-size_t NimBLECharacteristic::getDataLength() {
-    return m_value.size();
-}
-
-
-/**
- * @brief STATIC callback to handle events from the NimBLE stack.
- */
-int NimBLECharacteristic::handleGapEvent(uint16_t conn_handle, uint16_t attr_handle,
-                             struct ble_gatt_access_ctxt *ctxt,
-                             void *arg)
-{
-    const ble_uuid_t *uuid;
-    int rc;
-    struct ble_gap_conn_desc desc;
-    NimBLECharacteristic* pCharacteristic = (NimBLECharacteristic*)arg;
-
-    NIMBLE_LOGD(LOG_TAG, "Characteristic %s %s event", pCharacteristic->getUUID().toString().c_str(),
-                                    ctxt->op == BLE_GATT_ACCESS_OP_READ_CHR ? "Read" : "Write");
-
-    uuid = ctxt->chr->uuid;
-    if(ble_uuid_cmp(uuid, &pCharacteristic->getUUID().getNative()->u) == 0){
-        switch(ctxt->op) {
-            case BLE_GATT_ACCESS_OP_READ_CHR: {
-                rc = ble_gap_conn_find(conn_handle, &desc);
-                assert(rc == 0);
-
-                 // If the packet header is only 8 bytes this is a follow up of a long read
-                 // so we don't want to call the onRead() callback again.
-                if(ctxt->om->om_pkthdr_len > 8 ||
-                   pCharacteristic->m_value.size() <= (ble_att_mtu(desc.conn_handle) - 3)) {
-                    pCharacteristic->m_pCallbacks->onRead(pCharacteristic);
-                    pCharacteristic->m_pCallbacks->onRead(pCharacteristic, &desc);
-                }
-
-                ble_npl_hw_enter_critical();
-                rc = os_mbuf_append(ctxt->om, pCharacteristic->m_value.data(), pCharacteristic->m_value.size());
-                ble_npl_hw_exit_critical(0);
-                return rc == 0 ? 0 : BLE_ATT_ERR_INSUFFICIENT_RES;
-            }
-
-            case BLE_GATT_ACCESS_OP_WRITE_CHR: {
-                uint16_t att_max_len = pCharacteristic->m_value.max_size();
-
-                if (ctxt->om->om_len > att_max_len) {
-                    return BLE_ATT_ERR_INVALID_ATTR_VALUE_LEN;
-                }
-
-                uint8_t buf[att_max_len];
-                size_t len = ctxt->om->om_len;
-                memcpy(buf, ctxt->om->om_data,len);
-
-                os_mbuf *next;
-                next = SLIST_NEXT(ctxt->om, om_next);
-                while(next != NULL){
-                    if((len + next->om_len) > att_max_len) {
-                        return BLE_ATT_ERR_INVALID_ATTR_VALUE_LEN;
-                    }
-                    memcpy(&buf[len], next->om_data, next->om_len);
-                    len += next->om_len;
-                    next = SLIST_NEXT(next, om_next);
-                }
-                rc = ble_gap_conn_find(conn_handle, &desc);
-                assert(rc == 0);
-                pCharacteristic->setValue(buf, len);
-                pCharacteristic->m_pCallbacks->onWrite(pCharacteristic);
-                pCharacteristic->m_pCallbacks->onWrite(pCharacteristic, &desc);
-                return 0;
-            }
-            default:
-                break;
-        }
-    }
-
-    return BLE_ATT_ERR_UNLIKELY;
-}
-
-
-/**
- * @brief Get the number of clients subscribed to the characteristic.
- * @returns Number of clients subscribed to notifications / indications.
- */
-size_t NimBLECharacteristic::getSubscribedCount() {
-    return m_subscribedVec.size();
-}
-
-
-/**
- * @brief Set the subscribe status for this characteristic.\n
- * This will maintain a vector of subscribed clients and their indicate/notify status.
- */
-void NimBLECharacteristic::setSubscribe(struct ble_gap_event *event) {
-    ble_gap_conn_desc desc;
-    if(ble_gap_conn_find(event->subscribe.conn_handle, &desc) != 0) {
-        return;
-    }
-
-    uint16_t subVal = 0;
-    if(event->subscribe.cur_notify > 0 && (m_properties & NIMBLE_PROPERTY::NOTIFY)) {
-        subVal |= NIMBLE_SUB_NOTIFY;
-    }
-    if(event->subscribe.cur_indicate && (m_properties & NIMBLE_PROPERTY::INDICATE)) {
-        subVal |= NIMBLE_SUB_INDICATE;
-    }
-
-    NIMBLE_LOGI(LOG_TAG, "New subscribe value for conn: %d val: %d",
-                          event->subscribe.conn_handle, subVal);
-
-    if(!event->subscribe.cur_indicate && event->subscribe.prev_indicate) {
-       NimBLEDevice::getServer()->clearIndicateWait(event->subscribe.conn_handle);
-    }
-
-
-    auto it = m_subscribedVec.begin();
-    for(;it != m_subscribedVec.end(); ++it) {
-        if((*it).first == event->subscribe.conn_handle) {
-            break;
-        }
-    }
-
-    if(subVal > 0) {
-        if(it == m_subscribedVec.end()) {
-            m_subscribedVec.push_back({event->subscribe.conn_handle, subVal});
-        } else {
-            (*it).second = subVal;
-        }
-    } else if(it != m_subscribedVec.end()) {
-        m_subscribedVec.erase(it);
-    }
-
-    m_pCallbacks->onSubscribe(this, &desc, subVal);
-}
-
+} // setService
 
 /**
  * @brief Send an indication.
+ * @param[in] connHandle Connection handle to send an individual indication, or BLE_HS_CONN_HANDLE_NONE to send
+ * the indication to all subscribed clients.
+ * @return True if the indication was sent successfully, false otherwise.
  */
-void NimBLECharacteristic::indicate() {
-    notify(false);
+bool NimBLECharacteristic::indicate(uint16_t connHandle) const {
+    return sendValue(nullptr, 0, false, connHandle);
 } // indicate
 
-
 /**
  * @brief Send an indication.
  * @param[in] value A pointer to the data to send.
  * @param[in] length The length of the data to send.
+ * @param[in] connHandle Connection handle to send an individual indication, or BLE_HS_CONN_HANDLE_NONE to send
+ * the indication to all subscribed clients.
+ * @return True if the indication was sent successfully, false otherwise.
  */
-void NimBLECharacteristic::indicate(const uint8_t* value, size_t length) {
-    notify(value, length, false);
+bool NimBLECharacteristic::indicate(const uint8_t* value, size_t length, uint16_t connHandle) const {
+    return sendValue(value, length, false, connHandle);
 } // indicate
 
-
 /**
- * @brief Send an indication.
- * @param[in] value A std::vector<uint8_t> containing the value to send as the notification value.
+ * @brief Send a notification.
+ * @param[in] connHandle Connection handle to send an individual notification, or BLE_HS_CONN_HANDLE_NONE to send
+ * the notification to all subscribed clients.
+ * @return True if the notification was sent successfully, false otherwise.
  */
-void NimBLECharacteristic::indicate(const std::vector<uint8_t>& value) {
-    notify(value.data(), value.size(), false);
-} // indicate
-
-
-/**
- * @brief Send a notification or indication.
- * @param[in] is_notification if true sends a notification, false sends an indication.
- */
-void NimBLECharacteristic::notify(bool is_notification) {
-    notify(m_value.data(), m_value.length(), is_notification);
+bool NimBLECharacteristic::notify(uint16_t connHandle) const {
+    return sendValue(nullptr, 0, true, connHandle);
 } // notify
 
-
 /**
- * @brief Send a notification or indication.
- * @param[in] value A std::vector<uint8_t> containing the value to send as the notification value.
- * @param[in] is_notification if true sends a notification, false sends an indication.
- */
-void NimBLECharacteristic::notify(const std::vector<uint8_t>& value, bool is_notification) {
-    notify(value.data(), value.size(), is_notification);
-} // notify
-
-
-/**
- * @brief Send a notification or indication.
+ * @brief Send a notification.
  * @param[in] value A pointer to the data to send.
  * @param[in] length The length of the data to send.
- * @param[in] is_notification if true sends a notification, false sends an indication.
+ * @param[in] connHandle Connection handle to send an individual notification, or BLE_HS_CONN_HANDLE_NONE to send
+ * the notification to all subscribed clients.
+ * @return True if the notification was sent successfully, false otherwise.
  */
-void NimBLECharacteristic::notify(const uint8_t* value, size_t length, bool is_notification) {
-    NIMBLE_LOGD(LOG_TAG, ">> notify: length: %d", length);
+bool NimBLECharacteristic::notify(const uint8_t* value, size_t length, uint16_t connHandle) const {
+    return sendValue(value, length, true, connHandle);
+} // indicate
 
-    if(!(m_properties & NIMBLE_PROPERTY::NOTIFY) &&
-       !(m_properties & NIMBLE_PROPERTY::INDICATE))
-    {
-        NIMBLE_LOGE(LOG_TAG,
-                    "<< notify-Error; Notify/indicate not enabled for characteristic: %s",
-                    std::string(getUUID()).c_str());
-    }
-
-    if (m_subscribedVec.size() == 0) {
-        NIMBLE_LOGD(LOG_TAG, "<< notify: No clients subscribed.");
-        return;
-    }
-
-    m_pCallbacks->onNotify(this);
-
-    bool reqSec = (m_properties & BLE_GATT_CHR_F_READ_AUTHEN) ||
-                  (m_properties & BLE_GATT_CHR_F_READ_AUTHOR) ||
-                  (m_properties & BLE_GATT_CHR_F_READ_ENC);
+/**
+ * @brief Sends a notification or indication.
+ * @param[in] value A pointer to the data to send.
+ * @param[in] length The length of the data to send.
+ * @param[in] isNotification if true sends a notification, false sends an indication.
+ * @param[in] connHandle Connection handle to send to a specific peer.
+ * @return True if the value was sent successfully, false otherwise.
+ */
+bool NimBLECharacteristic::sendValue(const uint8_t* value, size_t length, bool isNotification, uint16_t connHandle) const {
     int rc = 0;
 
-    for (auto &it : m_subscribedVec) {
-        uint16_t _mtu = getService()->getServer()->getPeerMTU(it.first) - 3;
-
-        // check if connected and subscribed
-        if(_mtu == 0 || it.second == 0) {
-            continue;
-        }
-
-        // check if security requirements are satisfied
-        if(reqSec) {
-            struct ble_gap_conn_desc desc;
-            rc = ble_gap_conn_find(it.first, &desc);
-            if(rc != 0 || !desc.sec_state.encrypted) {
-                continue;
-            }
-        }
-
-        if (length > _mtu) {
-            NIMBLE_LOGW(LOG_TAG, "- Truncating to %d bytes (maximum notify size)", _mtu);
-        }
-
-        if(is_notification && (!(it.second & NIMBLE_SUB_NOTIFY))) {
-            NIMBLE_LOGW(LOG_TAG,
-            "Sending notification to client subscribed to indications, sending indication instead");
-            is_notification = false;
-        }
-
-        if(!is_notification && (!(it.second & NIMBLE_SUB_INDICATE))) {
-            NIMBLE_LOGW(LOG_TAG,
-            "Sending indication to client subscribed to notification, sending notification instead");
-            is_notification = true;
-        }
-
-        // don't create the m_buf until we are sure to send the data or else
-        // we could be allocating a buffer that doesn't get released.
-        // We also must create it in each loop iteration because it is consumed with each host call.
-        os_mbuf *om = ble_hs_mbuf_from_flat(value, length);
-
-        if(!is_notification && (m_properties & NIMBLE_PROPERTY::INDICATE)) {
-            if(!NimBLEDevice::getServer()->setIndicateWait(it.first)) {
-               NIMBLE_LOGE(LOG_TAG, "prior Indication in progress");
-               os_mbuf_free_chain(om);
-               return;
+    if (value != nullptr && length > 0) { // custom notification value
+        // Notify all connected peers unless a specific handle is provided
+        for (const auto& ch : NimBLEDevice::getServer()->getPeerDevices()) {
+            if (connHandle != BLE_HS_CONN_HANDLE_NONE && ch != connHandle) {
+                continue; // only send to the specific handle, minor inefficiency but saves code.
             }
 
-            rc = ble_gattc_indicate_custom(it.first, m_handle, om);
-            if(rc != 0){
-                NimBLEDevice::getServer()->clearIndicateWait(it.first);
+            // Must re-create the data buffer on each iteration because it is freed by the calls bellow.
+            os_mbuf* om = ble_hs_mbuf_from_flat(value, length);
+            if (!om) {
+                NIMBLE_LOGE(LOG_TAG, "<< sendValue: failed to allocate mbuf");
+                return false;
             }
+
+            if (isNotification) {
+                rc = ble_gattc_notify_custom(ch, m_handle, om);
+            } else {
+                rc = ble_gattc_indicate_custom(ch, m_handle, om);
+            }
+
+            if (rc != 0) {
+                NIMBLE_LOGE(LOG_TAG, "<< sendValue: failed to send value, rc=%d %s", rc, NimBLEUtils::returnCodeToString(rc));
+                break;
+            }
+        }
+    } else if (connHandle != BLE_HS_CONN_HANDLE_NONE) { // only sending to specific peer
+        // Null buffer will read the value from the characteristic
+        if (isNotification) {
+            rc = ble_gattc_notify_custom(connHandle, m_handle, NULL);
         } else {
-            ble_gattc_notify_custom(it.first, m_handle, om);
+            rc = ble_gattc_indicate_custom(connHandle, m_handle, NULL);
         }
+    } else { // Notify or indicate to all connected peers the characteristic value
+        ble_gatts_chr_updated(m_handle);
     }
 
-    NIMBLE_LOGD(LOG_TAG, "<< notify");
-} // Notify
+    return rc == 0;
+} // sendValue
 
+void NimBLECharacteristic::readEvent(NimBLEConnInfo& connInfo) {
+    m_pCallbacks->onRead(this, connInfo);
+} // readEvent
+
+void NimBLECharacteristic::writeEvent(const uint8_t* val, uint16_t len, NimBLEConnInfo& connInfo) {
+    setValue(val, len);
+    m_pCallbacks->onWrite(this, connInfo);
+} // writeEvent
 
 /**
  * @brief Set the callback handlers for this characteristic.
@@ -522,7 +316,7 @@ void NimBLECharacteristic::notify(const uint8_t* value, size_t length, bool is_n
  * used to define any callbacks for the characteristic.
  */
 void NimBLECharacteristic::setCallbacks(NimBLECharacteristicCallbacks* pCallbacks) {
-    if (pCallbacks != nullptr){
+    if (pCallbacks != nullptr) {
         m_pCallbacks = pCallbacks;
     } else {
         m_pCallbacks = &defaultCallback;
@@ -532,49 +326,21 @@ void NimBLECharacteristic::setCallbacks(NimBLECharacteristicCallbacks* pCallback
 /**
  * @brief Get the callback handlers for this characteristic.
  */
-NimBLECharacteristicCallbacks* NimBLECharacteristic::getCallbacks() {
+NimBLECharacteristicCallbacks* NimBLECharacteristic::getCallbacks() const {
     return m_pCallbacks;
-} //getCallbacks
-
-
-/**
- * @brief Set the value of the characteristic from a data buffer .
- * @param [in] data The data buffer to set for the characteristic.
- * @param [in] length The number of bytes in the data buffer.
- */
-void NimBLECharacteristic::setValue(const uint8_t* data, size_t length) {
-#if CONFIG_NIMBLE_CPP_LOG_LEVEL >= 4
-    char* pHex = NimBLEUtils::buildHexData(nullptr, data, length);
-    NIMBLE_LOGD(LOG_TAG, ">> setValue: length=%d, data=%s, characteristic UUID=%s",
-                length, pHex, getUUID().toString().c_str());
-    free(pHex);
-#endif
-
-    m_value.setValue(data, length);
-    NIMBLE_LOGD(LOG_TAG, "<< setValue");
-} // setValue
-
-
-/**
- * @brief Set the value of the characteristic from a `std::vector<uint8_t>`.\n
- * @param [in] vec The std::vector<uint8_t> reference to set the characteristic value from.
- */
-void NimBLECharacteristic::setValue(const std::vector<uint8_t>& vec) {
-    return setValue((uint8_t*)&vec[0], vec.size());
-}// setValue
-
+} // getCallbacks
 
 /**
  * @brief Return a string representation of the characteristic.
  * @return A string representation of the characteristic.
  */
-std::string NimBLECharacteristic::toString() {
+std::string NimBLECharacteristic::toString() const {
     std::string res = "UUID: " + m_uuid.toString() + ", handle : 0x";
-    char hex[5];
-    snprintf(hex, sizeof(hex), "%04x", m_handle);
+    char        hex[5];
+    snprintf(hex, sizeof(hex), "%04x", getHandle());
     res += hex;
     res += " ";
-    if (m_properties & BLE_GATT_CHR_PROP_READ ) res += "Read ";
+    if (m_properties & BLE_GATT_CHR_PROP_READ) res += "Read ";
     if (m_properties & BLE_GATT_CHR_PROP_WRITE) res += "Write ";
     if (m_properties & BLE_GATT_CHR_PROP_WRITE_NO_RSP) res += "WriteNoResponse ";
     if (m_properties & BLE_GATT_CHR_PROP_BROADCAST) res += "Broadcast ";
@@ -583,68 +349,39 @@ std::string NimBLECharacteristic::toString() {
     return res;
 } // toString
 
-
-NimBLECharacteristicCallbacks::~NimBLECharacteristicCallbacks() {}
-
-
 /**
  * @brief Callback function to support a read request.
  * @param [in] pCharacteristic The characteristic that is the source of the event.
+ * @param [in] connInfo A reference to a NimBLEConnInfo instance containing the peer info.
  */
-void NimBLECharacteristicCallbacks::onRead(NimBLECharacteristic* pCharacteristic) {
-    NIMBLE_LOGD("NimBLECharacteristicCallbacks", "onRead: default");
-} // onRead
-
-/**
- * @brief Callback function to support a read request.
- * @param [in] pCharacteristic The characteristic that is the source of the event.
- * @param [in] desc The connection description struct that is associated with the peer that performed the read.
- */
-void NimBLECharacteristicCallbacks::onRead(NimBLECharacteristic* pCharacteristic, ble_gap_conn_desc* desc) {
+void NimBLECharacteristicCallbacks::onRead(NimBLECharacteristic* pCharacteristic, NimBLEConnInfo& connInfo) {
     NIMBLE_LOGD("NimBLECharacteristicCallbacks", "onRead: default");
 } // onRead
 
 /**
  * @brief Callback function to support a write request.
  * @param [in] pCharacteristic The characteristic that is the source of the event.
+ * @param [in] connInfo A reference to a NimBLEConnInfo instance containing the peer info.
  */
-void NimBLECharacteristicCallbacks::onWrite(NimBLECharacteristic* pCharacteristic) {
+void NimBLECharacteristicCallbacks::onWrite(NimBLECharacteristic* pCharacteristic, NimBLEConnInfo& connInfo) {
     NIMBLE_LOGD("NimBLECharacteristicCallbacks", "onWrite: default");
 } // onWrite
 
-/**
- * @brief Callback function to support a write request.
- * @param [in] pCharacteristic The characteristic that is the source of the event.
- * @param [in] desc The connection description struct that is associated with the peer that performed the write.
- */
-void NimBLECharacteristicCallbacks::onWrite(NimBLECharacteristic* pCharacteristic, ble_gap_conn_desc* desc) {
-    NIMBLE_LOGD("NimBLECharacteristicCallbacks", "onWrite: default");
-} // onWrite
-
-/**
- * @brief Callback function to support a Notify request.
- * @param [in] pCharacteristic The characteristic that is the source of the event.
- */
-void NimBLECharacteristicCallbacks::onNotify(NimBLECharacteristic* pCharacteristic) {
-    NIMBLE_LOGD("NimBLECharacteristicCallbacks", "onNotify: default");
-} // onNotify
-
-
 /**
  * @brief Callback function to support a Notify/Indicate Status report.
  * @param [in] pCharacteristic The characteristic that is the source of the event.
- * @param [in] s Status of the notification/indication.
- * @param [in] code Additional return code from the NimBLE stack.
+ * @param [in] code Status return code from the NimBLE stack.
+ * @details The status code for success is 0 for notifications and BLE_HS_EDONE for indications,
+ * any other value is an error.
  */
-void NimBLECharacteristicCallbacks::onStatus(NimBLECharacteristic* pCharacteristic, Status s, int code) {
+void NimBLECharacteristicCallbacks::onStatus(NimBLECharacteristic* pCharacteristic, int code) {
     NIMBLE_LOGD("NimBLECharacteristicCallbacks", "onStatus: default");
 } // onStatus
 
-
 /**
  * @brief Callback function called when a client changes subscription status.
  * @param [in] pCharacteristic The characteristic that is the source of the event.
- * @param [in] desc The connection description struct that is associated with the client.
+ * @param [in] connInfo A reference to a NimBLEConnInfo instance containing the peer info.
  * @param [in] subValue The subscription status:
  * * 0 = Un-Subscribed
  * * 1 = Notifications
@@ -652,9 +389,8 @@ void NimBLECharacteristicCallbacks::onStatus(NimBLECharacteristic* pCharacterist
  * * 3 = Notifications and Indications
  */
 void NimBLECharacteristicCallbacks::onSubscribe(NimBLECharacteristic* pCharacteristic,
-                                                ble_gap_conn_desc* desc,
-                                                uint16_t subValue)
-{
+                                                NimBLEConnInfo&       connInfo,
+                                                uint16_t              subValue) {
     NIMBLE_LOGD("NimBLECharacteristicCallbacks", "onSubscribe: default");
 }
 

src/NimBLECharacteristic.h

@@ -11,186 +11,224 @@
  *      Author: kolban
  */
 
-#ifndef MAIN_NIMBLECHARACTERISTIC_H_
-#define MAIN_NIMBLECHARACTERISTIC_H_
+#ifndef NIMBLE_CPP_CHARACTERISTIC_H_
+#define NIMBLE_CPP_CHARACTERISTIC_H_
 #include "nimconfig.h"
 #if defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
 
-#if defined(CONFIG_NIMBLE_CPP_IDF)
-#include "host/ble_hs.h"
-#else
-#include "nimble/nimble/host/include/host/ble_hs.h"
-#endif
-
-/****  FIX COMPILATION ****/
-#undef min
-#undef max
-/**************************/
-
-typedef enum {
-    READ         =  BLE_GATT_CHR_F_READ,
-    READ_ENC     =  BLE_GATT_CHR_F_READ_ENC,
-    READ_AUTHEN  =  BLE_GATT_CHR_F_READ_AUTHEN,
-    READ_AUTHOR  =  BLE_GATT_CHR_F_READ_AUTHOR,
-    WRITE        =  BLE_GATT_CHR_F_WRITE,
-    WRITE_NR     =  BLE_GATT_CHR_F_WRITE_NO_RSP,
-    WRITE_ENC    =  BLE_GATT_CHR_F_WRITE_ENC,
-    WRITE_AUTHEN =  BLE_GATT_CHR_F_WRITE_AUTHEN,
-    WRITE_AUTHOR =  BLE_GATT_CHR_F_WRITE_AUTHOR,
-    BROADCAST    =  BLE_GATT_CHR_F_BROADCAST,
-    NOTIFY       =  BLE_GATT_CHR_F_NOTIFY,
-    INDICATE     =  BLE_GATT_CHR_F_INDICATE
-} NIMBLE_PROPERTY;
-
-#include "NimBLEService.h"
-#include "NimBLEDescriptor.h"
-#include "NimBLEAttValue.h"
-
-#include <string>
-#include <vector>
-
-class NimBLEService;
-class NimBLEDescriptor;
 class NimBLECharacteristicCallbacks;
+class NimBLEService;
+class NimBLECharacteristic;
+class NimBLEDescriptor;
+class NimBLE2904;
 
+# include "NimBLELocalValueAttribute.h"
+
+# include <string>
+# include <vector>
 
 /**
- * @brief The model of a %BLE Characteristic.
+ * @brief The model of a BLE Characteristic.
  *
- * A BLE Characteristic is an identified value container that manages a value. It is exposed by a BLE server and
- * can be read and written to by a %BLE client.
+ * A BLE Characteristic is an identified value container that manages a value. It is exposed by a BLE service and
+ * can be read and written to by a BLE client.
  */
-class NimBLECharacteristic {
-public:
-    NimBLECharacteristic(const char* uuid,
-                         uint16_t properties =
-                         NIMBLE_PROPERTY::READ |
-                         NIMBLE_PROPERTY::WRITE,
-                         uint16_t max_len = BLE_ATT_ATTR_MAX_LEN,
-                         NimBLEService* pService = nullptr);
-    NimBLECharacteristic(const NimBLEUUID &uuid,
-                         uint16_t properties =
-                         NIMBLE_PROPERTY::READ |
-                         NIMBLE_PROPERTY::WRITE,
-                         uint16_t max_len = BLE_ATT_ATTR_MAX_LEN,
-                         NimBLEService* pService = nullptr);
+class NimBLECharacteristic : public NimBLELocalValueAttribute {
+  public:
+    NimBLECharacteristic(const char*    uuid,
+                         uint16_t       properties = NIMBLE_PROPERTY::READ | NIMBLE_PROPERTY::WRITE,
+                         uint16_t       maxLen     = BLE_ATT_ATTR_MAX_LEN,
+                         NimBLEService* pService   = nullptr);
+    NimBLECharacteristic(const NimBLEUUID& uuid,
+                         uint16_t          properties = NIMBLE_PROPERTY::READ | NIMBLE_PROPERTY::WRITE,
+                         uint16_t          maxLen     = BLE_ATT_ATTR_MAX_LEN,
+                         NimBLEService*    pService   = nullptr);
 
     ~NimBLECharacteristic();
 
-    uint16_t          getHandle();
-    NimBLEUUID        getUUID();
-    std::string       toString();
-    void              indicate();
-    void              indicate(const uint8_t* value, size_t length);
-    void              indicate(const std::vector<uint8_t>& value);
-    void              notify(bool is_notification = true);
-    void              notify(const uint8_t* value, size_t length, bool is_notification = true);
-    void              notify(const std::vector<uint8_t>& value, bool is_notification = true);
-    size_t            getSubscribedCount();
-    void              addDescriptor(NimBLEDescriptor *pDescriptor);
-    NimBLEDescriptor* getDescriptorByUUID(const char* uuid);
-    NimBLEDescriptor* getDescriptorByUUID(const NimBLEUUID &uuid);
-    NimBLEDescriptor* getDescriptorByHandle(uint16_t handle);
-    void              removeDescriptor(NimBLEDescriptor *pDescriptor, bool deleteDsc = false);
-    NimBLEService*    getService();
-    uint16_t          getProperties();
-    NimBLEAttValue    getValue(time_t *timestamp = nullptr);
-    size_t            getDataLength();
-    void              setValue(const uint8_t* data, size_t size);
-    void              setValue(const std::vector<uint8_t>& vec);
-    void              setCallbacks(NimBLECharacteristicCallbacks* pCallbacks);
+    std::string toString() const;
+    void        addDescriptor(NimBLEDescriptor* pDescriptor);
+    void        removeDescriptor(NimBLEDescriptor* pDescriptor, bool deleteDsc = false);
+    uint16_t    getProperties() const;
+    void        setCallbacks(NimBLECharacteristicCallbacks* pCallbacks);
+    bool        indicate(uint16_t connHandle = BLE_HS_CONN_HANDLE_NONE) const;
+    bool        indicate(const uint8_t* value, size_t length, uint16_t connHandle = BLE_HS_CONN_HANDLE_NONE) const;
+    bool        notify(uint16_t connHandle = BLE_HS_CONN_HANDLE_NONE) const;
+    bool        notify(const uint8_t* value, size_t length, uint16_t connHandle = BLE_HS_CONN_HANDLE_NONE) const;
+
     NimBLEDescriptor* createDescriptor(const char* uuid,
-                                       uint32_t properties =
-                                       NIMBLE_PROPERTY::READ |
-                                       NIMBLE_PROPERTY::WRITE,
-                                       uint16_t max_len = BLE_ATT_ATTR_MAX_LEN);;
-    NimBLEDescriptor* createDescriptor(const NimBLEUUID &uuid,
-                                       uint32_t properties =
-                                       NIMBLE_PROPERTY::READ |
-                                       NIMBLE_PROPERTY::WRITE,
-                                       uint16_t max_len = BLE_ATT_ATTR_MAX_LEN);
-
-    NimBLECharacteristicCallbacks* getCallbacks();
+                                       uint32_t    properties = NIMBLE_PROPERTY::READ | NIMBLE_PROPERTY::WRITE,
+                                       uint16_t    maxLen     = BLE_ATT_ATTR_MAX_LEN);
+    NimBLEDescriptor* createDescriptor(const NimBLEUUID& uuid,
+                                       uint32_t          properties = NIMBLE_PROPERTY::READ | NIMBLE_PROPERTY::WRITE,
+                                       uint16_t          maxLen     = BLE_ATT_ATTR_MAX_LEN);
+    NimBLE2904*       create2904();
+    NimBLEDescriptor* getDescriptorByUUID(const char* uuid) const;
+    NimBLEDescriptor* getDescriptorByUUID(const NimBLEUUID& uuid) const;
+    NimBLEDescriptor* getDescriptorByHandle(uint16_t handle) const;
+    NimBLEService*    getService() const;
 
+    NimBLECharacteristicCallbacks* getCallbacks() const;
 
     /*********************** Template Functions ************************/
 
+# if __cplusplus < 201703L
     /**
-     * @brief Template to set the characteristic value to <type\>val.
-     * @param [in] s The value to set.
+     * @brief Template to send a notification with a value from a struct or array.
+     * @param [in] v The value to send.
+     * @param [in] connHandle Optional, a connection handle to send the notification to.
+     * @details <type\> size must be evaluatable by `sizeof()`.
      */
-    template<typename T>
-    void              setValue(const T &s) { m_value.setValue<T>(s); }
-
-    /**
-     * @brief Template to convert the characteristic data to <type\>.
-     * @tparam T The type to convert the data to.
-     * @param [in] timestamp (Optional) A pointer to a time_t struct to store the time the value was read.
-     * @param [in] skipSizeCheck (Optional) If true it will skip checking if the data size is less than <tt>sizeof(<type\>)</tt>.
-     * @return The data converted to <type\> or NULL if skipSizeCheck is false and the data is less than <tt>sizeof(<type\>)</tt>.
-     * @details <b>Use:</b> <tt>getValue<type>(&timestamp, skipSizeCheck);</tt>
-     */
-    template<typename T>
-    T   getValue(time_t *timestamp = nullptr, bool skipSizeCheck = false) {
-        return m_value.getValue<T>(timestamp, skipSizeCheck);
+    template <typename T>
+#  ifdef _DOXYGEN_
+    bool
+#  else
+    typename std::enable_if<!std::is_pointer<T>::value && !Has_c_str_length<T>::value && !Has_data_size<T>::value, bool>::type
+#  endif
+    notify(const T& v, uint16_t connHandle = BLE_HS_CONN_HANDLE_NONE) const {
+        return notify(reinterpret_cast<const uint8_t*>(&v), sizeof(T), connHandle);
     }
 
     /**
-     * @brief Template to send a notification from a class type that has a c_str() and length() method.
+     * @brief Template to send a notification with a value from a class that has a c_str() and length() method.
+     * @param [in] s The value to send.
+     * @param [in] connHandle Optional, a connection handle to send the notification to.
+     */
+    template <typename T>
+#  ifdef _DOXYGEN_
+    bool
+#  else
+    typename std::enable_if<Has_c_str_length<T>::value && !Has_data_size<T>::value, bool>::type
+#  endif
+    notify(const T& s, uint16_t connHandle = BLE_HS_CONN_HANDLE_NONE) const {
+        return notify(reinterpret_cast<const uint8_t*>(s.c_str()), s.length(), connHandle);
+    }
+
+    /**
+     * @brief Template to send a notification with a value from a class that has a data() and size() method.
+     * @param [in] v The value to send.
+     * @param [in] connHandle Optional, a connection handle to send the notification to.
+     */
+    template <typename T>
+#  ifdef _DOXYGEN_
+    bool
+#  else
+    typename std::enable_if<Has_data_size<T>::value, bool>::type
+#  endif
+    notify(const T& v, uint16_t connHandle = BLE_HS_CONN_HANDLE_NONE) const {
+        return notify(reinterpret_cast<const uint8_t*>(v.data()), v.size(), connHandle);
+    }
+
+    /**
+     * @brief Template to send an indication with a value from a struct or array.
+     * @param [in] v The value to send.
+     * @param [in] connHandle Optional, a connection handle to send the notification to.
+     * @details <type\> size must be evaluatable by `sizeof()`.
+     */
+    template <typename T>
+#  ifdef _DOXYGEN_
+    bool
+#  else
+    typename std::enable_if<!std::is_pointer<T>::value && !Has_c_str_length<T>::value && !Has_data_size<T>::value, bool>::type
+#  endif
+    indicate(const T& v, uint16_t connHandle = BLE_HS_CONN_HANDLE_NONE) const {
+        return indicate(reinterpret_cast<const uint8_t*>(&v), sizeof(T), connHandle);
+    }
+
+    /**
+     * @brief Template to send a indication with a value from a class that has a c_str() and length() method.
+     * @param [in] s The value to send.
+     * @param [in] connHandle Optional, a connection handle to send the notification to.
+     */
+    template <typename T>
+#  ifdef _DOXYGEN_
+    bool
+#  else
+    typename std::enable_if<Has_c_str_length<T>::value && !Has_data_size<T>::value, bool>::type
+#  endif
+    indicate(const T& s, uint16_t connHandle = BLE_HS_CONN_HANDLE_NONE) const {
+        return indicate(reinterpret_cast<const uint8_t*>(s.c_str()), s.length(), connHandle);
+    }
+
+    /**
+     * @brief Template to send a indication with a value from a class that has a data() and size() method.
+     * @param [in] v The value to send.
+     * @param [in] connHandle Optional, a connection handle to send the notification to.
+     */
+    template <typename T>
+#  ifdef _DOXYGEN_
+    bool
+#  else
+    typename std::enable_if<Has_data_size<T>::value, bool>::type
+#  endif
+    indicate(const T& v, uint16_t connHandle = BLE_HS_CONN_HANDLE_NONE) const {
+        return indicate(reinterpret_cast<const uint8_t*>(v.data()), v.size(), connHandle);
+    }
+
+# else
+
+    /**
+     * @brief Template to send a notification for classes which may have
+     *        data()/size() or c_str()/length() methods. Falls back to sending
+     *        the data by casting the first element of the array to a uint8_t
+     *        pointer and getting the length of the array using sizeof.
      * @tparam T The a reference to a class containing the data to send.
      * @param[in] value The <type\>value to set.
-     * @param[in] is_notification if true sends a notification, false sends an indication.
-     * @details Only used if the <type\> has a `c_str()` method.
+     * @param[in] connHandle The connection handle to send the notification to.
+     * @note This function is only available if the type T is not a pointer.
      */
-    template<typename T>
-#ifdef _DOXYGEN_
-    void
-#else
-    typename std::enable_if<Has_c_str_len<T>::value, void>::type
-#endif
-    notify(const T& value, bool is_notification = true) {
-        notify((uint8_t*)value.c_str(), value.length(), is_notification);
+    template <typename T>
+    typename std::enable_if<!std::is_pointer<T>::value, bool>::type notify(const T& value,
+                                                                           uint16_t connHandle = BLE_HS_CONN_HANDLE_NONE) const {
+        if constexpr (Has_data_size<T>::value) {
+            return notify(reinterpret_cast<const uint8_t*>(value.data()), value.size(), connHandle);
+        } else if constexpr (Has_c_str_length<T>::value) {
+            return notify(reinterpret_cast<const uint8_t*>(value.c_str()), value.length(), connHandle);
+        } else {
+            return notify(reinterpret_cast<const uint8_t*>(&value), sizeof(value), connHandle);
+        }
     }
 
     /**
-     * @brief Template to send an indication from a class type that has a c_str() and length() method.
+     * @brief Template to send an indication for classes which may have
+     *       data()/size() or c_str()/length() methods. Falls back to sending
+     *       the data by casting the first element of the array to a uint8_t
+     *       pointer and getting the length of the array using sizeof.
      * @tparam T The a reference to a class containing the data to send.
      * @param[in] value The <type\>value to set.
-     * @details Only used if the <type\> has a `c_str()` method.
+     * @param[in] connHandle The connection handle to send the indication to.
+     * @note This function is only available if the type T is not a pointer.
      */
-    template<typename T>
-#ifdef _DOXYGEN_
-    void
-#else
-    typename std::enable_if<Has_c_str_len<T>::value, void>::type
-#endif
-    indicate(const T& value) {
-        indicate((uint8_t*)value.c_str(), value.length());
+    template <typename T>
+    typename std::enable_if<!std::is_pointer<T>::value, bool>::type indicate(
+        const T& value, uint16_t connHandle = BLE_HS_CONN_HANDLE_NONE) const {
+        if constexpr (Has_data_size<T>::value) {
+            return indicate(reinterpret_cast<const uint8_t*>(value.data()), value.size(), connHandle);
+        } else if constexpr (Has_c_str_length<T>::value) {
+            return indicate(reinterpret_cast<const uint8_t*>(value.c_str()), value.length(), connHandle);
+        } else {
+            return indicate(reinterpret_cast<const uint8_t*>(&value), sizeof(value), connHandle);
+        }
     }
+# endif
 
-private:
+  private:
+    friend class NimBLEServer;
+    friend class NimBLEService;
 
-    friend class    NimBLEServer;
-    friend class    NimBLEService;
+    void setService(NimBLEService* pService);
+    void readEvent(NimBLEConnInfo& connInfo) override;
+    void writeEvent(const uint8_t* val, uint16_t len, NimBLEConnInfo& connInfo) override;
+    bool sendValue(const uint8_t* value,
+                   size_t         length,
+                   bool           is_notification = true,
+                   uint16_t       connHandle      = BLE_HS_CONN_HANDLE_NONE) const;
 
-    void            setService(NimBLEService *pService);
-    void            setSubscribe(struct ble_gap_event *event);
-    static int      handleGapEvent(uint16_t conn_handle, uint16_t attr_handle,
-                                   struct ble_gatt_access_ctxt *ctxt, void *arg);
-
-    NimBLEUUID                     m_uuid;
-    uint16_t                       m_handle;
-    uint16_t                       m_properties;
-    NimBLECharacteristicCallbacks* m_pCallbacks;
-    NimBLEService*                 m_pService;
-    NimBLEAttValue                 m_value;
-    std::vector<NimBLEDescriptor*> m_dscVec;
-    uint8_t                        m_removed;
-
-    std::vector<std::pair<uint16_t, uint16_t>>  m_subscribedVec;
+    NimBLECharacteristicCallbacks* m_pCallbacks{nullptr};
+    NimBLEService*                 m_pService{nullptr};
+    std::vector<NimBLEDescriptor*> m_vDescriptors{};
 }; // NimBLECharacteristic
 
-
 /**
  * @brief Callbacks that can be associated with a %BLE characteristic to inform of events.
  *
@@ -199,33 +237,13 @@ private:
  * sub-classed instance of this class and will be notified when such an event happens.
  */
 class NimBLECharacteristicCallbacks {
-public:
-
-/**
- * @brief An enum to provide the callback the status of the
- * notification/indication, implemented for backward compatibility.
- * @deprecated To be removed in the future as the NimBLE stack return code is also provided.
- */
-    typedef enum {
-        SUCCESS_INDICATE,
-        SUCCESS_NOTIFY,
-        ERROR_INDICATE_DISABLED,
-        ERROR_NOTIFY_DISABLED,
-        ERROR_GATT,
-        ERROR_NO_CLIENT,
-        ERROR_INDICATE_TIMEOUT,
-        ERROR_INDICATE_FAILURE
-    }Status;
-
-    virtual      ~NimBLECharacteristicCallbacks();
-    virtual void onRead(NimBLECharacteristic* pCharacteristic);
-    virtual void onRead(NimBLECharacteristic* pCharacteristic, ble_gap_conn_desc* desc);
-    virtual void onWrite(NimBLECharacteristic* pCharacteristic);
-    virtual void onWrite(NimBLECharacteristic* pCharacteristic, ble_gap_conn_desc* desc);
-    virtual void onNotify(NimBLECharacteristic* pCharacteristic);
-    virtual void onStatus(NimBLECharacteristic* pCharacteristic, Status s, int code);
-    virtual void onSubscribe(NimBLECharacteristic* pCharacteristic, ble_gap_conn_desc* desc, uint16_t subValue);
+  public:
+    virtual ~NimBLECharacteristicCallbacks() {}
+    virtual void onRead(NimBLECharacteristic* pCharacteristic, NimBLEConnInfo& connInfo);
+    virtual void onWrite(NimBLECharacteristic* pCharacteristic, NimBLEConnInfo& connInfo);
+    virtual void onStatus(NimBLECharacteristic* pCharacteristic, int code);
+    virtual void onSubscribe(NimBLECharacteristic* pCharacteristic, NimBLEConnInfo& connInfo, uint16_t subValue);
 };
 
 #endif /* CONFIG_BT_ENABLED  && CONFIG_BT_NIMBLE_ROLE_PERIPHERAL */
-#endif /*MAIN_NIMBLECHARACTERISTIC_H_*/
+#endif /*NIMBLE_CPP_CHARACTERISTIC_H_*/

src/NimBLEClient.h

@@ -11,127 +11,161 @@
  *      Author: kolban
  */
 
-#ifndef MAIN_NIMBLECLIENT_H_
-#define MAIN_NIMBLECLIENT_H_
+#ifndef NIMBLE_CPP_CLIENT_H_
+#define NIMBLE_CPP_CLIENT_H_
 
 #include "nimconfig.h"
 #if defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL)
 
-#include "NimBLEAddress.h"
-#include "NimBLEUUID.h"
-#include "NimBLEUtils.h"
-#include "NimBLEConnInfo.h"
-#include "NimBLEAttValue.h"
-#include "NimBLEAdvertisedDevice.h"
-#include "NimBLERemoteService.h"
+# if defined(CONFIG_NIMBLE_CPP_IDF)
+#  include "host/ble_gap.h"
+# else
+#  include "nimble/nimble/host/include/host/ble_gap.h"
+# endif
 
-#include <vector>
-#include <string>
+# include "NimBLEAddress.h"
 
+# include <stdint.h>
+# include <vector>
+# include <string>
+
+class NimBLEAddress;
+class NimBLEUUID;
 class NimBLERemoteService;
 class NimBLERemoteCharacteristic;
-class NimBLEClientCallbacks;
 class NimBLEAdvertisedDevice;
+class NimBLEAttValue;
+class NimBLEClientCallbacks;
+class NimBLEConnInfo;
+struct NimBLETaskData;
 
 /**
- * @brief A model of a %BLE client.
+ * @brief A model of a BLE client.
  */
 class NimBLEClient {
-public:
-    bool                                        connect(NimBLEAdvertisedDevice* device, bool deleteAttributes = true);
-    bool                                        connect(const NimBLEAddress &address, bool deleteAttributes = true);
-    bool                                        connect(bool deleteAttributes = true);
-    int                                         disconnect(uint8_t reason = BLE_ERR_REM_USER_CONN_TERM);
-    NimBLEAddress                               getPeerAddress();
-    void                                        setPeerAddress(const NimBLEAddress &address);
-    int                                         getRssi();
-    std::vector<NimBLERemoteService*>*          getServices(bool refresh = false);
+  public:
+    bool connect(const NimBLEAdvertisedDevice* device,
+                 bool                          deleteAttributes = true,
+                 bool                          asyncConnect     = false,
+                 bool                          exchangeMTU      = true);
+    bool connect(const NimBLEAddress& address, bool deleteAttributes = true, bool asyncConnect = false, bool exchangeMTU = true);
+    bool           connect(bool deleteAttributes = true, bool asyncConnect = false, bool exchangeMTU = true);
+    bool           disconnect(uint8_t reason = BLE_ERR_REM_USER_CONN_TERM);
+    bool           cancelConnect() const;
+    void           setSelfDelete(bool deleteOnDisconnect, bool deleteOnConnectFail);
+    NimBLEAddress  getPeerAddress() const;
+    bool           setPeerAddress(const NimBLEAddress& address);
+    int            getRssi() const;
+    bool           isConnected() const;
+    void           setClientCallbacks(NimBLEClientCallbacks* pClientCallbacks, bool deleteCallbacks = true);
+    std::string    toString() const;
+    uint16_t       getConnHandle() const;
+    uint16_t       getMTU() const;
+    bool           exchangeMTU();
+    bool           secureConnection(bool async = false) const;
+    void           setConnectTimeout(uint32_t timeout);
+    bool           setDataLen(uint16_t txOctets);
+    bool           discoverAttributes();
+    NimBLEConnInfo getConnInfo() const;
+    int            getLastError() const;
+    bool           updateConnParams(uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout);
+    void           setConnectionParams(uint16_t minInterval,
+                                       uint16_t maxInterval,
+                                       uint16_t latency,
+                                       uint16_t timeout,
+                                       uint16_t scanInterval = 16,
+                                       uint16_t scanWindow   = 16);
+    const std::vector<NimBLERemoteService*>&    getServices(bool refresh = false);
     std::vector<NimBLERemoteService*>::iterator begin();
     std::vector<NimBLERemoteService*>::iterator end();
+    NimBLERemoteCharacteristic*                 getCharacteristic(uint16_t handle);
     NimBLERemoteService*                        getService(const char* uuid);
-    NimBLERemoteService*                        getService(const NimBLEUUID &uuid);
+    NimBLERemoteService*                        getService(const NimBLEUUID& uuid);
     void                                        deleteServices();
-    size_t                                      deleteService(const NimBLEUUID &uuid);
-    NimBLEAttValue                              getValue(const NimBLEUUID &serviceUUID, const NimBLEUUID &characteristicUUID);
-    bool                                        setValue(const NimBLEUUID &serviceUUID, const NimBLEUUID &characteristicUUID,
-                                                         const NimBLEAttValue &value, bool response = false);
-    NimBLERemoteCharacteristic*                 getCharacteristic(const uint16_t handle);
-    bool                                        isConnected();
-    void                                        setClientCallbacks(NimBLEClientCallbacks *pClientCallbacks,
-                                                                   bool deleteCallbacks = true);
-    std::string                                 toString();
-    uint16_t                                    getConnId();
-    uint16_t                                    getMTU();
-    bool                                        secureConnection();
-    void                                        setConnectTimeout(uint8_t timeout);
-    void                                        setConnectionParams(uint16_t minInterval, uint16_t maxInterval,
-                                                                    uint16_t latency, uint16_t timeout,
-                                                                    uint16_t scanInterval=16, uint16_t scanWindow=16);
-    void                                        updateConnParams(uint16_t minInterval, uint16_t maxInterval,
-                                                                 uint16_t latency, uint16_t timeout);
-    void                                        setDataLen(uint16_t tx_octets);
-    bool                                        discoverAttributes();
-    NimBLEConnInfo                              getConnInfo();
-    int                                         getLastError();
-#if CONFIG_BT_NIMBLE_EXT_ADV
-    void                                        setConnectPhy(uint8_t mask);
-#endif
+    size_t                                      deleteService(const NimBLEUUID& uuid);
+    NimBLEAttValue getValue(const NimBLEUUID& serviceUUID, const NimBLEUUID& characteristicUUID);
+    bool           setValue(const NimBLEUUID&     serviceUUID,
+                            const NimBLEUUID&     characteristicUUID,
+                            const NimBLEAttValue& value,
+                            bool                  response = false);
 
-private:
-    NimBLEClient(const NimBLEAddress &peerAddress);
+# if CONFIG_BT_NIMBLE_EXT_ADV
+    void setConnectPhy(uint8_t phyMask);
+    bool updatePhy(uint8_t txPhysMask, uint8_t rxPhysMask, uint16_t phyOptions = 0);
+    bool getPhy(uint8_t* txPhy, uint8_t* rxPhy);
+# endif
+
+    struct Config {
+        uint8_t deleteCallbacks : 1;     // Delete the callback object when the client is deleted.
+        uint8_t deleteOnDisconnect : 1;  // Delete the client when disconnected.
+        uint8_t deleteOnConnectFail : 1; // Delete the client when a connection attempt fails.
+        uint8_t asyncConnect : 1;        // Connect asynchronously.
+        uint8_t exchangeMTU : 1;         // Exchange MTU after connection.
+    };
+
+    Config getConfig() const;
+    void   setConfig(Config config);
+
+  private:
+    NimBLEClient(const NimBLEAddress& peerAddress);
     ~NimBLEClient();
+    NimBLEClient(const NimBLEClient&)            = delete;
+    NimBLEClient& operator=(const NimBLEClient&) = delete;
 
-    friend class            NimBLEDevice;
-    friend class            NimBLERemoteService;
+    bool       retrieveServices(const NimBLEUUID* uuidFilter = nullptr);
+    static int handleGapEvent(struct ble_gap_event* event, void* arg);
+    static int exchangeMTUCb(uint16_t conn_handle, const ble_gatt_error* error, uint16_t mtu, void* arg);
+    static int serviceDiscoveredCB(uint16_t                     connHandle,
+                                   const struct ble_gatt_error* error,
+                                   const struct ble_gatt_svc*   service,
+                                   void*                        arg);
 
-    static int              handleGapEvent(struct ble_gap_event *event, void *arg);
-    static int              serviceDiscoveredCB(uint16_t conn_handle,
-                                                const struct ble_gatt_error *error,
-                                                const struct ble_gatt_svc *service,
-                                                void *arg);
-    static void             dcTimerCb(ble_npl_event *event);
-    bool                    retrieveServices(const NimBLEUUID *uuid_filter = nullptr);
+    NimBLEAddress                     m_peerAddress;
+    mutable int                       m_lastErr;
+    int32_t                           m_connectTimeout;
+    mutable NimBLETaskData*           m_pTaskData;
+    std::vector<NimBLERemoteService*> m_svcVec;
+    NimBLEClientCallbacks*            m_pClientCallbacks;
+    uint16_t                          m_connHandle;
+    uint8_t                           m_terminateFailCount;
+    mutable uint8_t                   m_asyncSecureAttempt;
+    Config                            m_config;
 
-    NimBLEAddress           m_peerAddress;
-    int                     m_lastErr;
-    uint16_t                m_conn_id;
-    bool                    m_connEstablished;
-    bool                    m_deleteCallbacks;
-    int32_t                 m_connectTimeout;
-    NimBLEClientCallbacks*  m_pClientCallbacks;
-    ble_task_data_t*        m_pTaskData;
-    ble_npl_callout         m_dcTimer;
-#if CONFIG_BT_NIMBLE_EXT_ADV
-    uint8_t                 m_phyMask;
-#endif
-
-    std::vector<NimBLERemoteService*> m_servicesVector;
-
-private:
-    friend class NimBLEClientCallbacks;
-    ble_gap_conn_params m_pConnParams;
+# if CONFIG_BT_NIMBLE_EXT_ADV
+    uint8_t m_phyMask;
+# endif
+    ble_gap_conn_params m_connParams;
 
+    friend class NimBLEDevice;
+    friend class NimBLEServer;
 }; // class NimBLEClient
 
-
 /**
  * @brief Callbacks associated with a %BLE client.
  */
 class NimBLEClientCallbacks {
-public:
+  public:
     virtual ~NimBLEClientCallbacks() {};
 
     /**
      * @brief Called after client connects.
-     * @param [in] pClient A pointer to the calling client object.
+     * @param [in] pClient A pointer to the connecting client object.
      */
     virtual void onConnect(NimBLEClient* pClient);
 
+    /**
+     * @brief Called when a connection attempt fails.
+     * @param [in] pClient A pointer to the connecting client object.
+     * @param [in] reason Contains the reason code for the connection failure.
+     */
+    virtual void onConnectFail(NimBLEClient* pClient, int reason);
+
     /**
      * @brief Called when disconnected from the server.
      * @param [in] pClient A pointer to the calling client object.
+     * @param [in] reason Contains the reason code for the disconnection.
      */
-    virtual void onDisconnect(NimBLEClient* pClient);
+    virtual void onDisconnect(NimBLEClient* pClient, int reason);
 
     /**
      * @brief Called when server requests to update the connection parameters.
@@ -143,27 +177,53 @@ public:
 
     /**
      * @brief Called when server requests a passkey for pairing.
-     * @return The passkey to be sent to the server.
+     * @param [in] connInfo A reference to a NimBLEConnInfo instance containing the peer info.
      */
-    virtual uint32_t onPassKeyRequest();
-
-    /*virtual void onPassKeyNotify(uint32_t pass_key);
-    virtual bool onSecurityRequest();*/
+    virtual void onPassKeyEntry(NimBLEConnInfo& connInfo);
 
     /**
      * @brief Called when the pairing procedure is complete.
-     * @param [in] desc A pointer to the struct containing the connection information.\n
+     * @param [in] connInfo A reference to a NimBLEConnInfo instance containing the peer info.\n
      * This can be used to check the status of the connection encryption/pairing.
      */
-    virtual void onAuthenticationComplete(ble_gap_conn_desc* desc);
+    virtual void onAuthenticationComplete(NimBLEConnInfo& connInfo);
 
     /**
      * @brief Called when using numeric comparision for pairing.
+     * @param [in] connInfo A reference to a NimBLEConnInfo instance containing the peer info.
      * @param [in] pin The pin to compare with the server.
-     * @return True to accept the pin.
      */
-    virtual bool onConfirmPIN(uint32_t pin);
+    virtual void onConfirmPasskey(NimBLEConnInfo& connInfo, uint32_t pin);
+
+    /**
+     * @brief Called when the peer identity address is resolved.
+     * @param [in] connInfo A reference to a NimBLEConnInfo instance with information
+     */
+    virtual void onIdentity(NimBLEConnInfo& connInfo);
+
+    /**
+     * @brief Called when the connection MTU changes.
+     * @param [in] pClient A pointer to the client that the MTU change is associated with.
+     * @param [in] MTU The new MTU value.
+     * about the peer connection parameters.
+     */
+    virtual void onMTUChange(NimBLEClient* pClient, uint16_t MTU);
+
+# if CONFIG_BT_NIMBLE_EXT_ADV
+    /**
+     * @brief Called when the PHY update procedure is complete.
+     * @param [in] pClient A pointer to the client whose PHY was updated.
+     * about the peer connection parameters.
+     * @param [in] txPhy The transmit PHY.
+     * @param [in] rxPhy The receive PHY.
+     * Possible values:
+     * * BLE_GAP_LE_PHY_1M
+     * * BLE_GAP_LE_PHY_2M
+     * * BLE_GAP_LE_PHY_CODED
+     */
+    virtual void onPhyUpdate(NimBLEClient* pClient, uint8_t txPhy, uint8_t rxPhy);
+# endif
 };
 
 #endif /* CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_CENTRAL */
-#endif /* MAIN_NIMBLECLIENT_H_ */
+#endif /* NIMBLE_CPP_CLIENT_H_ */

src/NimBLEConnInfo.h

@@ -1,55 +1,66 @@
 #ifndef NIMBLECONNINFO_H_
 #define NIMBLECONNINFO_H_
 
+#if defined(CONFIG_NIMBLE_CPP_IDF)
+# include "host/ble_gap.h"
+#else
+# include "nimble/nimble/host/include/host/ble_gap.h"
+#endif
+
 #include "NimBLEAddress.h"
 
 /**
  * @brief Connection information.
  */
 class NimBLEConnInfo {
-friend class NimBLEServer;
-friend class NimBLEClient;
-    ble_gap_conn_desc m_desc;
-    NimBLEConnInfo()                       { m_desc = {}; }
-    NimBLEConnInfo(ble_gap_conn_desc desc) { m_desc = desc; }
-public:
+  public:
     /** @brief Gets the over-the-air address of the connected peer */
-    NimBLEAddress    getAddress()          { return NimBLEAddress(m_desc.peer_ota_addr); }
+    NimBLEAddress getAddress() const { return NimBLEAddress(m_desc.peer_ota_addr); }
 
     /** @brief Gets the ID address of the connected peer */
-    NimBLEAddress    getIdAddress()        { return NimBLEAddress(m_desc.peer_id_addr); }
+    NimBLEAddress getIdAddress() const { return NimBLEAddress(m_desc.peer_id_addr); }
 
-    /** @brief Gets the connection handle of the connected peer */
-    uint16_t         getConnHandle()       { return m_desc.conn_handle; }
+    /** @brief Gets the connection handle (also known as the connection id) of the connected peer */
+    uint16_t getConnHandle() const { return m_desc.conn_handle; }
 
     /** @brief Gets the connection interval for this connection (in 1.25ms units) */
-    uint16_t         getConnInterval()     { return m_desc.conn_itvl; }
+    uint16_t getConnInterval() const { return m_desc.conn_itvl; }
 
     /** @brief Gets the supervision timeout for this connection (in 10ms units) */
-    uint16_t         getConnTimeout()      { return m_desc.supervision_timeout; }
+    uint16_t getConnTimeout() const { return m_desc.supervision_timeout; }
 
     /** @brief Gets the allowable latency for this connection (unit = number of intervals) */
-    uint16_t         getConnLatency()      { return m_desc.conn_latency; }
+    uint16_t getConnLatency() const { return m_desc.conn_latency; }
 
     /** @brief Gets the maximum transmission unit size for this connection (in bytes) */
-    uint16_t         getMTU()              { return ble_att_mtu(m_desc.conn_handle); }
+    uint16_t getMTU() const { return ble_att_mtu(m_desc.conn_handle); }
 
     /** @brief Check if we are in the master role in this connection */
-    bool             isMaster()            { return (m_desc.role == BLE_GAP_ROLE_MASTER); }
+    bool isMaster() const { return (m_desc.role == BLE_GAP_ROLE_MASTER); }
 
     /** @brief Check if we are in the slave role in this connection */
-    bool             isSlave()             { return (m_desc.role == BLE_GAP_ROLE_SLAVE); }
+    bool isSlave() const { return (m_desc.role == BLE_GAP_ROLE_SLAVE); }
 
     /** @brief Check if we are connected to a bonded peer */
-    bool             isBonded()            { return (m_desc.sec_state.bonded == 1); }
+    bool isBonded() const { return (m_desc.sec_state.bonded == 1); }
 
     /** @brief Check if the connection in encrypted */
-    bool             isEncrypted()         { return (m_desc.sec_state.encrypted == 1); }
+    bool isEncrypted() const { return (m_desc.sec_state.encrypted == 1); }
 
     /** @brief Check if the the connection has been authenticated */
-    bool             isAuthenticated()     { return (m_desc.sec_state.authenticated == 1); }
+    bool isAuthenticated() const { return (m_desc.sec_state.authenticated == 1); }
 
     /** @brief Gets the key size used to encrypt the connection */
-    uint8_t          getSecKeySize()       { return m_desc.sec_state.key_size; }
+    uint8_t getSecKeySize() const { return m_desc.sec_state.key_size; }
+
+  private:
+    friend class NimBLEServer;
+    friend class NimBLEClient;
+    friend class NimBLECharacteristic;
+    friend class NimBLEDescriptor;
+
+    ble_gap_conn_desc m_desc{};
+    NimBLEConnInfo(){};
+    NimBLEConnInfo(ble_gap_conn_desc desc) { m_desc = desc; }
 };
 #endif

src/NimBLEDescriptor.cpp

@@ -15,17 +15,24 @@
 #include "nimconfig.h"
 #if defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
 
-#include "NimBLEService.h"
-#include "NimBLEDescriptor.h"
-#include "NimBLELog.h"
+# include "NimBLEService.h"
+# include "NimBLEDescriptor.h"
+# include "NimBLELog.h"
 
-#include <string>
+# include <string>
 
-#define NULL_HANDLE (0xffff)
-
-static const char* LOG_TAG = "NimBLEDescriptor";
+static const char*               LOG_TAG = "NimBLEDescriptor";
 static NimBLEDescriptorCallbacks defaultCallbacks;
 
+/**
+ * @brief Construct a descriptor
+ * @param [in] uuid - UUID (const char*) for the descriptor.
+ * @param [in] properties - Properties for the descriptor.
+ * @param [in] max_len - The maximum length in bytes that the descriptor value can hold. (Default: 512 bytes for esp32, 20 for all others).
+ * @param [in] pCharacteristic - pointer to the characteristic instance this descriptor belongs to.
+ */
+NimBLEDescriptor::NimBLEDescriptor(const char* uuid, uint16_t properties, uint16_t max_len, NimBLECharacteristic* pCharacteristic)
+    : NimBLEDescriptor(NimBLEUUID(uuid), properties, max_len, pCharacteristic) {}
 
 /**
  * @brief Construct a descriptor
@@ -34,231 +41,64 @@ static NimBLEDescriptorCallbacks defaultCallbacks;
  * @param [in] max_len - The maximum length in bytes that the descriptor value can hold. (Default: 512 bytes for esp32, 20 for all others).
  * @param [in] pCharacteristic - pointer to the characteristic instance this descriptor belongs to.
  */
-NimBLEDescriptor::NimBLEDescriptor(const char* uuid, uint16_t properties, uint16_t max_len,
-                                   NimBLECharacteristic* pCharacteristic)
-: NimBLEDescriptor(NimBLEUUID(uuid), properties, max_len, pCharacteristic) {
-}
-
-
-/**
- * @brief Construct a descriptor
- * @param [in] uuid - UUID (const char*) for the descriptor.
- * @param [in] properties - Properties for the descriptor.
- * @param [in] max_len - The maximum length in bytes that the descriptor value can hold. (Default: 512 bytes for esp32, 20 for all others).
- * @param [in] pCharacteristic - pointer to the characteristic instance this descriptor belongs to.
- */
-NimBLEDescriptor::NimBLEDescriptor(NimBLEUUID uuid, uint16_t properties, uint16_t max_len,
-                                    NimBLECharacteristic* pCharacteristic)
-:   m_value(std::min(CONFIG_NIMBLE_CPP_ATT_VALUE_INIT_LENGTH , (int)max_len), max_len) {
-    m_uuid               = uuid;
-    m_handle             = NULL_HANDLE;                 // Handle is initially unknown.
-    m_pCharacteristic    = pCharacteristic;
-    m_pCallbacks         = &defaultCallbacks;           // No initial callback.
-    m_properties         = 0;
-    m_removed            = 0;
-
-    if (properties & BLE_GATT_CHR_F_READ) {             // convert uint16_t properties to uint8_t
-        m_properties |= BLE_ATT_F_READ;
-    }
-    if (properties & (BLE_GATT_CHR_F_WRITE_NO_RSP | BLE_GATT_CHR_F_WRITE)) {
-        m_properties |= BLE_ATT_F_WRITE;
-    }
-    if (properties & BLE_GATT_CHR_F_READ_ENC) {
-        m_properties |= BLE_ATT_F_READ_ENC;
-    }
-    if (properties & BLE_GATT_CHR_F_READ_AUTHEN) {
-        m_properties |= BLE_ATT_F_READ_AUTHEN;
-    }
-    if (properties & BLE_GATT_CHR_F_READ_AUTHOR) {
-        m_properties |= BLE_ATT_F_READ_AUTHOR;
-    }
-    if (properties & BLE_GATT_CHR_F_WRITE_ENC) {
-        m_properties |= BLE_ATT_F_WRITE_ENC;
-    }
-    if (properties & BLE_GATT_CHR_F_WRITE_AUTHEN) {
-        m_properties |= BLE_ATT_F_WRITE_AUTHEN;
-    }
-    if (properties & BLE_GATT_CHR_F_WRITE_AUTHOR) {
-        m_properties |= BLE_ATT_F_WRITE_AUTHOR;
+NimBLEDescriptor::NimBLEDescriptor(const NimBLEUUID& uuid, uint16_t properties, uint16_t max_len, NimBLECharacteristic* pCharacteristic)
+    : NimBLELocalValueAttribute{uuid, 0, max_len}, m_pCallbacks{&defaultCallbacks}, m_pCharacteristic{pCharacteristic} {
+    // Check if this is the client configuration descriptor and set to removed if true.
+    if (uuid == NimBLEUUID((uint16_t)0x2902)) {
+        NIMBLE_LOGW(LOG_TAG, "Manually created 2902 descriptor has no functionality; please remove.");
+        setRemoved(NIMBLE_ATT_REMOVE_HIDE);
     }
 
+    // convert uint16_t properties to uint8_t for descriptor properties
+    uint8_t descProperties = 0;
+    if (properties & NIMBLE_PROPERTY::READ) {
+        descProperties |= BLE_ATT_F_READ;
+    }
+    if (properties & (NIMBLE_PROPERTY::WRITE_NR | NIMBLE_PROPERTY::WRITE)) {
+        descProperties |= BLE_ATT_F_WRITE;
+    }
+    if (properties & NIMBLE_PROPERTY::READ_ENC) {
+        descProperties |= BLE_ATT_F_READ_ENC;
+    }
+    if (properties & NIMBLE_PROPERTY::READ_AUTHEN) {
+        descProperties |= BLE_ATT_F_READ_AUTHEN;
+    }
+    if (properties & NIMBLE_PROPERTY::READ_AUTHOR) {
+        descProperties |= BLE_ATT_F_READ_AUTHOR;
+    }
+    if (properties & NIMBLE_PROPERTY::WRITE_ENC) {
+        descProperties |= BLE_ATT_F_WRITE_ENC;
+    }
+    if (properties & NIMBLE_PROPERTY::WRITE_AUTHEN) {
+        descProperties |= BLE_ATT_F_WRITE_AUTHEN;
+    }
+    if (properties & NIMBLE_PROPERTY::WRITE_AUTHOR) {
+        descProperties |= BLE_ATT_F_WRITE_AUTHOR;
+    }
+
+    setProperties(descProperties);
 } // NimBLEDescriptor
 
-
-/**
- * @brief NimBLEDescriptor destructor.
- */
-NimBLEDescriptor::~NimBLEDescriptor() {
-} // ~NimBLEDescriptor
-
-/**
- * @brief Get the BLE handle for this descriptor.
- * @return The handle for this descriptor.
- */
-uint16_t NimBLEDescriptor::getHandle() {
-    return m_handle;
-} // getHandle
-
-
-/**
- * @brief Get the length of the value of this descriptor.
- * @return The length (in bytes) of the value of this descriptor.
- */
-size_t NimBLEDescriptor::getLength() {
-    return m_value.size();
-} // getLength
-
-
-/**
- * @brief Get the UUID of the descriptor.
- */
-NimBLEUUID NimBLEDescriptor::getUUID() {
-    return m_uuid;
-} // getUUID
-
-
-/**
- * @brief Get the value of this descriptor.
- * @return The NimBLEAttValue of this descriptor.
- */
-NimBLEAttValue NimBLEDescriptor::getValue(time_t *timestamp) {
-    if (timestamp != nullptr) {
-        m_value.getValue(timestamp);
-    }
-
-    return m_value;
-} // getValue
-
-
-/**
- * @brief Get the value of this descriptor as a string.
- * @return A std::string instance containing a copy of the descriptor's value.
- */
-std::string NimBLEDescriptor::getStringValue() {
-    return std::string(m_value);
-}
-
-
 /**
  * @brief Get the characteristic this descriptor belongs to.
  * @return A pointer to the characteristic this descriptor belongs to.
  */
-NimBLECharacteristic* NimBLEDescriptor::getCharacteristic() {
+NimBLECharacteristic* NimBLEDescriptor::getCharacteristic() const {
     return m_pCharacteristic;
 } // getCharacteristic
 
-
-int NimBLEDescriptor::handleGapEvent(uint16_t conn_handle, uint16_t attr_handle,
-                                     struct ble_gatt_access_ctxt *ctxt, void *arg) {
-    (void)conn_handle;
-    (void)attr_handle;
-
-    const ble_uuid_t *uuid;
-    int rc;
-    struct ble_gap_conn_desc desc;
-    NimBLEDescriptor* pDescriptor = (NimBLEDescriptor*)arg;
-
-    NIMBLE_LOGD(LOG_TAG, "Descriptor %s %s event", pDescriptor->getUUID().toString().c_str(),
-                                    ctxt->op == BLE_GATT_ACCESS_OP_READ_DSC ? "Read" : "Write");
-
-    uuid = ctxt->chr->uuid;
-    if(ble_uuid_cmp(uuid, &pDescriptor->getUUID().getNative()->u) == 0){
-        switch(ctxt->op) {
-            case BLE_GATT_ACCESS_OP_READ_DSC: {
-                rc = ble_gap_conn_find(conn_handle, &desc);
-                assert(rc == 0);
-
-                 // If the packet header is only 8 bytes this is a follow up of a long read
-                 // so we don't want to call the onRead() callback again.
-                if(ctxt->om->om_pkthdr_len > 8 ||
-                   pDescriptor->m_value.size() <= (ble_att_mtu(desc.conn_handle) - 3)) {
-                    pDescriptor->m_pCallbacks->onRead(pDescriptor);
-                }
-
-                ble_npl_hw_enter_critical();
-                rc = os_mbuf_append(ctxt->om, pDescriptor->m_value.data(), pDescriptor->m_value.size());
-                ble_npl_hw_exit_critical(0);
-                return rc == 0 ? 0 : BLE_ATT_ERR_INSUFFICIENT_RES;
-            }
-
-            case BLE_GATT_ACCESS_OP_WRITE_DSC: {
-                uint16_t att_max_len = pDescriptor->m_value.max_size();
-
-                if (ctxt->om->om_len > att_max_len) {
-                    return BLE_ATT_ERR_INVALID_ATTR_VALUE_LEN;
-                }
-
-                uint8_t buf[att_max_len];
-                size_t len = ctxt->om->om_len;
-                memcpy(buf, ctxt->om->om_data,len);
-                os_mbuf *next;
-                next = SLIST_NEXT(ctxt->om, om_next);
-                while(next != NULL){
-                    if((len + next->om_len) > att_max_len) {
-                        return BLE_ATT_ERR_INVALID_ATTR_VALUE_LEN;
-                    }
-                    memcpy(&buf[len], next->om_data, next->om_len);
-                    len += next->om_len;
-                    next = SLIST_NEXT(next, om_next);
-                }
-
-                pDescriptor->setValue(buf, len);
-                pDescriptor->m_pCallbacks->onWrite(pDescriptor);
-                return 0;
-            }
-            default:
-                break;
-        }
-    }
-
-    return BLE_ATT_ERR_UNLIKELY;
-}
-
 /**
  * @brief Set the callback handlers for this descriptor.
  * @param [in] pCallbacks An instance of a callback structure used to define any callbacks for the descriptor.
  */
 void NimBLEDescriptor::setCallbacks(NimBLEDescriptorCallbacks* pCallbacks) {
-    if (pCallbacks != nullptr){
+    if (pCallbacks != nullptr) {
         m_pCallbacks = pCallbacks;
     } else {
         m_pCallbacks = &defaultCallbacks;
     }
 } // setCallbacks
 
-
-/**
- * @brief Set the handle of this descriptor.
- * Set the handle of this descriptor to be the supplied value.
- * @param [in] handle The handle to be associated with this descriptor.
- * @return N/A.
- */
-void NimBLEDescriptor::setHandle(uint16_t handle) {
-    NIMBLE_LOGD(LOG_TAG, ">> setHandle(0x%.2x): Setting descriptor handle to be 0x%.2x", handle, handle);
-    m_handle = handle;
-    NIMBLE_LOGD(LOG_TAG, "<< setHandle()");
-} // setHandle
-
-
-/**
- * @brief Set the value of the descriptor.
- * @param [in] data The data to set for the descriptor.
- * @param [in] length The length of the data in bytes.
- */
-void NimBLEDescriptor::setValue(const uint8_t* data, size_t length) {
-    m_value.setValue(data, length);
-} // setValue
-
-
-/**
- * @brief Set the value of the descriptor from a `std::vector<uint8_t>`.\n
- * @param [in] vec The std::vector<uint8_t> reference to set the descriptor value from.
- */
-void NimBLEDescriptor::setValue(const std::vector<uint8_t>& vec) {
-    return setValue((uint8_t*)&vec[0], vec.size());
-} // setValue
-
-
 /**
  * @brief Set the characteristic this descriptor belongs to.
  * @param [in] pChar A pointer to the characteristic this descriptor belongs to.
@@ -267,37 +107,41 @@ void NimBLEDescriptor::setCharacteristic(NimBLECharacteristic* pChar) {
     m_pCharacteristic = pChar;
 } // setCharacteristic
 
-
 /**
  * @brief Return a string representation of the descriptor.
  * @return A string representation of the descriptor.
  */
-std::string NimBLEDescriptor::toString() {
+std::string NimBLEDescriptor::toString() const {
     char hex[5];
-    snprintf(hex, sizeof(hex), "%04x", m_handle);
+    snprintf(hex, sizeof(hex), "%04x", getHandle());
     std::string res = "UUID: " + m_uuid.toString() + ", handle: 0x" + hex;
     return res;
 } // toString
 
+void NimBLEDescriptor::readEvent(NimBLEConnInfo& connInfo) {
+    m_pCallbacks->onRead(this, connInfo);
+} // readEvent
 
-NimBLEDescriptorCallbacks::~NimBLEDescriptorCallbacks() {}
+void NimBLEDescriptor::writeEvent(const uint8_t* val, uint16_t len, NimBLEConnInfo& connInfo) {
+    setValue(val, len);
+    m_pCallbacks->onWrite(this, connInfo);
+} // writeEvent
 
 /**
  * @brief Callback function to support a read request.
  * @param [in] pDescriptor The descriptor that is the source of the event.
+ * @param [in] connInfo A reference to a NimBLEConnInfo instance containing the peer info.
  */
-void NimBLEDescriptorCallbacks::onRead(NimBLEDescriptor* pDescriptor) {
-    (void)pDescriptor;
+void NimBLEDescriptorCallbacks::onRead(NimBLEDescriptor* pDescriptor, NimBLEConnInfo& connInfo) {
     NIMBLE_LOGD("NimBLEDescriptorCallbacks", "onRead: default");
 } // onRead
 
-
 /**
  * @brief Callback function to support a write request.
  * @param [in] pDescriptor The descriptor that is the source of the event.
+ * @param [in] connInfo A reference to a NimBLEConnInfo instance containing the peer info.
  */
-void NimBLEDescriptorCallbacks::onWrite(NimBLEDescriptor* pDescriptor) {
-    (void)pDescriptor;
+void NimBLEDescriptorCallbacks::onWrite(NimBLEDescriptor* pDescriptor, NimBLEConnInfo& connInfo) {
     NIMBLE_LOGD("NimBLEDescriptorCallbacks", "onWrite: default");
 } // onWrite
 

src/NimBLEDescriptor.h

@@ -12,93 +12,52 @@
  *      Author: kolban
  */
 
-#ifndef MAIN_NIMBLEDESCRIPTOR_H_
-#define MAIN_NIMBLEDESCRIPTOR_H_
+#ifndef NIMBLE_CPP_DESCRIPTOR_H_
+#define NIMBLE_CPP_DESCRIPTOR_H_
 
 #include "nimconfig.h"
 #if defined(CONFIG_BT_ENABLED) && defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
 
-#include "NimBLECharacteristic.h"
-#include "NimBLEUUID.h"
-#include "NimBLEAttValue.h"
-
-#include <string>
-
-class NimBLEService;
-class NimBLECharacteristic;
+class NimBLEDescriptor;
 class NimBLEDescriptorCallbacks;
 
+# include "NimBLELocalValueAttribute.h"
+# include "NimBLECharacteristic.h"
+# include "NimBLEUUID.h"
+# include "NimBLEAttValue.h"
+# include "NimBLEConnInfo.h"
+
+# include <string>
 
 /**
- * @brief A model of a %BLE descriptor.
+ * @brief A model of a BLE descriptor.
  */
-class NimBLEDescriptor {
-public:
-    NimBLEDescriptor(const char* uuid, uint16_t properties,
-                     uint16_t max_len,
+class NimBLEDescriptor : public NimBLELocalValueAttribute {
+  public:
+    NimBLEDescriptor(const char* uuid, uint16_t properties, uint16_t maxLen, NimBLECharacteristic* pCharacteristic = nullptr);
+
+    NimBLEDescriptor(const NimBLEUUID&     uuid,
+                     uint16_t              properties,
+                     uint16_t              maxLen,
                      NimBLECharacteristic* pCharacteristic = nullptr);
+    ~NimBLEDescriptor() = default;
 
-    NimBLEDescriptor(NimBLEUUID uuid, uint16_t properties,
-                     uint16_t max_len,
-                     NimBLECharacteristic* pCharacteristic = nullptr);
-
-    ~NimBLEDescriptor();
-
-    uint16_t              getHandle();
-    NimBLEUUID            getUUID();
-    std::string           toString();
+    std::string           toString() const;
     void                  setCallbacks(NimBLEDescriptorCallbacks* pCallbacks);
-    NimBLECharacteristic* getCharacteristic();
+    NimBLECharacteristic* getCharacteristic() const;
 
-    size_t                getLength();
-    NimBLEAttValue        getValue(time_t *timestamp = nullptr);
-    std::string           getStringValue();
-
-    void                  setValue(const uint8_t* data, size_t size);
-    void                  setValue(const std::vector<uint8_t>& vec);
-
-    /*********************** Template Functions ************************/
-
-    /**
-     * @brief Template to set the characteristic value to <type\>val.
-     * @param [in] s The value to set.
-     */
-    template<typename T>
-    void setValue(const T &s) { m_value.setValue<T>(s); }
-
-    /**
-     * @brief Template to convert the descriptor data to <type\>.
-     * @tparam T The type to convert the data to.
-     * @param [in] timestamp (Optional) A pointer to a time_t struct to store the time the value was read.
-     * @param [in] skipSizeCheck (Optional) If true it will skip checking if the data size is less than <tt>sizeof(<type\>)</tt>.
-     * @return The data converted to <type\> or NULL if skipSizeCheck is false and the data is less than <tt>sizeof(<type\>)</tt>.
-     * @details <b>Use:</b> <tt>getValue<type>(&timestamp, skipSizeCheck);</tt>
-     */
-    template<typename T>
-    T getValue(time_t *timestamp = nullptr, bool skipSizeCheck = false) {
-        return m_value.getValue<T>(timestamp, skipSizeCheck);
-    }
-
-private:
+  private:
     friend class NimBLECharacteristic;
     friend class NimBLEService;
-    friend class NimBLE2904;
 
-    static int handleGapEvent(uint16_t conn_handle, uint16_t attr_handle,
-                              struct ble_gatt_access_ctxt *ctxt, void *arg);
-    void       setHandle(uint16_t handle);
-    void       setCharacteristic(NimBLECharacteristic* pChar);
+    void setCharacteristic(NimBLECharacteristic* pChar);
+    void readEvent(NimBLEConnInfo& connInfo) override;
+    void writeEvent(const uint8_t* val, uint16_t len, NimBLEConnInfo& connInfo) override;
 
-    NimBLEUUID                 m_uuid;
-    uint16_t                   m_handle;
-    NimBLEDescriptorCallbacks* m_pCallbacks;
-    NimBLECharacteristic*      m_pCharacteristic;
-    uint8_t                    m_properties;
-    NimBLEAttValue             m_value;
-    uint8_t                    m_removed;
+    NimBLEDescriptorCallbacks* m_pCallbacks{nullptr};
+    NimBLECharacteristic*      m_pCharacteristic{nullptr};
 }; // NimBLEDescriptor
 
-
 /**
  * @brief Callbacks that can be associated with a %BLE descriptors to inform of events.
  *
@@ -107,13 +66,13 @@ private:
  * sub-classed instance of this class and will be notified when such an event happens.
  */
 class NimBLEDescriptorCallbacks {
-public:
-    virtual ~NimBLEDescriptorCallbacks();
-    virtual void onRead(NimBLEDescriptor* pDescriptor);
-    virtual void onWrite(NimBLEDescriptor* pDescriptor);
+  public:
+    virtual ~NimBLEDescriptorCallbacks() = default;
+    virtual void onRead(NimBLEDescriptor* pDescriptor, NimBLEConnInfo& connInfo);
+    virtual void onWrite(NimBLEDescriptor* pDescriptor, NimBLEConnInfo& connInfo);
 };
 
-#include "NimBLE2904.h"
+# include "NimBLE2904.h"
 
 #endif /* CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_PERIPHERAL */
-#endif /* MAIN_NIMBLEDESCRIPTOR_H_ */
+#endif /* NIMBLE_CPP_DESCRIPTOR_H_ */

src/NimBLEDevice.h

@@ -12,228 +12,272 @@
  *      Author: kolban
  */
 
-#ifndef MAIN_NIMBLEDEVICE_H_
-#define MAIN_NIMBLEDEVICE_H_
+#ifndef NIMBLE_CPP_DEVICE_H_
+#define NIMBLE_CPP_DEVICE_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"
+# ifdef ESP_PLATFORM
+#  ifndef CONFIG_IDF_TARGET_ESP32P4
+#   include <esp_bt.h>
 #  endif
-#endif
+# endif
 
-#if defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL)
-#include "NimBLEClient.h"
-#endif
+# if defined(CONFIG_NIMBLE_CPP_IDF)
+#  include <host/ble_gap.h>
+# else
+#  include <nimble/nimble/host/include/host/ble_gap.h>
+# endif
 
-#if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
-#include "NimBLEServer.h"
-#endif
+/****  FIX COMPILATION ****/
+# undef min
+# undef max
+/**************************/
 
-#include "NimBLEUtils.h"
-#include "NimBLESecurity.h"
-#include "NimBLEAddress.h"
+# include <string>
+# include <vector>
 
-#ifdef ESP_PLATFORM
-#  include "esp_bt.h"
-#endif
+# if defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL)
+#  include <array>
+class NimBLEClient;
+# endif
 
-#include <map>
-#include <string>
-#include <list>
+# if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)
+class NimBLEScan;
+# endif
 
-#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
+# if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)
+#  if CONFIG_BT_NIMBLE_EXT_ADV
+class NimBLEExtAdvertising;
+#  else
+class NimBLEAdvertising;
+#  endif
+# endif
 
-#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
+# if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
+class NimBLEServer;
+# endif
 
-typedef int (*gap_event_handler)(ble_gap_event *event, void *arg);
+# if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL) || defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL)
+class NimBLEConnInfo;
+# endif
 
-extern "C" void ble_store_config_init(void);
+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);
 
 /**
- * @brief A model of a %BLE Device from which all the BLE roles are created.
+ * @brief A model of a BLE Device from which all the BLE roles are created.
  */
 class NimBLEDevice {
-public:
-    static void             init(const std::string &deviceName);
-    static void             deinit(bool clearAll = false);
-    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);
+  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);
+    static bool          setOwnAddr(const NimBLEAddress& addr);
+    static bool          setOwnAddr(const uint8_t* addr);
+    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();
+    static bool          startSecurity(uint16_t connHandle, int* rcPtr = nullptr);
+    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);
+    static int           getPower();
+    static bool          setPower(int8_t dbm);
 
-#if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)
-    static NimBLEScan*      getScan();
-#endif
+# ifdef ESP_PLATFORM
+#  ifndef CONFIG_IDF_TARGET_ESP32P4
+    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);
+#  endif
+# endif
 
-#if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
-    static NimBLEServer*    createServer();
-    static NimBLEServer*    getServer();
-#endif
+# if CONFIG_BT_NIMBLE_EXT_ADV
+    static bool setDefaultPhy(uint8_t txPhyMask, uint8_t rxPhyMask);
+# 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
+# if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)
+    static NimBLEScan* getScan();
+# 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_PERIPHERAL)
+    static NimBLEServer* createServer();
+    static NimBLEServer* getServer();
+# endif
 
-#if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)
+# 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)
 #  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();
-#  else
-    static NimBLEAdvertising*    getAdvertising();
-    static bool                  startAdvertising();
+    static bool                  startAdvertising(uint8_t instId, int duration = 0, int maxEvents = 0);
+    static bool                  stopAdvertising(uint8_t instId);
     static bool                  stopAdvertising();
 #  endif
-#endif
+#  if !CONFIG_BT_NIMBLE_EXT_ADV || defined(_DOXYGEN_)
+    static NimBLEAdvertising* getAdvertising();
+    static bool               startAdvertising(uint32_t duration = 0);
+    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)
+    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();
+# 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
+# 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:
-#if defined( CONFIG_BT_NIMBLE_ROLE_CENTRAL)
+  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)
     friend class NimBLEClient;
-#endif
+# endif
 
-#if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)
+# if defined(CONFIG_BT_NIMBLE_ROLE_OBSERVER)
     friend class NimBLEScan;
-#endif
+# endif
 
-#if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
+# if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
     friend class NimBLEServer;
     friend class NimBLECharacteristic;
-#endif
+# endif
 
-#if defined(CONFIG_BT_NIMBLE_ROLE_BROADCASTER)
+# 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
 };
 
+# 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)
+#  if CONFIG_BT_NIMBLE_EXT_ADV
+#   include "NimBLEExtAdvertising.h"
+#  else
+#   include "NimBLEAdvertising.h"
+#  endif
+# endif
 
 #endif // CONFIG_BT_ENABLED
-#endif // MAIN_NIMBLEDEVICE_H_
+#endif // NIMBLE_CPP_DEVICE_H_