ScStw/esp-nimble-cpp
2
0
Fork 0
mirror of https://github.com/h2zero/esp-nimble-cpp.git synced 2024-11-21 20:50:55 +01:00
Code Issues Projects Releases Packages Wiki Activity
esp-nimble-cpp/CHANGELOG.md
h2zero 26ab9760da Update changelog.
2021-01-14 11:40:27 -07:00

5.2 KiB
Raw Blame History

Changelog

All notable changes to this project will be documented in this file.

[Unreleased]

Added

  • 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.

  • NimBLEAdvertiseing::SetMinPreferred and NimBLEAdvertiseing::SetMinPreferred re-added.

  • 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::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.

  • 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.

Changed

  • 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.

  • 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.

  • 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.

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.

  • 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.

  • 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.

  • 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.

  • 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).

  • (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
    a task running on core 0 (same as the controller) has been implemented. This improves response times and reliability for all BLE functions.

[1.0.1] - 2020-09-02

Added

  • Empty NimBLEAddress constructor: NimBLEAddress() produces an address of 00:00:00:00:00:00 type 0.
  • Documentation of the difference of NimBLEAddress::getNative vs the original bluedroid library.

Changed

  • notify_callback typedef is now defined as std::function to enable the use of std::bind to call a class member function.

Fixed

  • Fix advertising start delay when first called.

[1.0.0] - 2020-08-22

First stable release.

All the original library functionality is complete and many extras added with full documentation.