Merge branch 'h2zero:master' into master

Author: DTTerastar

CHANGELOG.md

@@ -2,6 +2,39 @@
 
 All notable changes to this project will be documented in this file.
 
+## [Unreleased]
+
+### Fixed
+- Fixed missing data from long notification values.
+
+### Changed
+- Updated NimBLE core to use the v1.4.0 branch of esp-nimble
+
+### Added
+- Preliminary support for non-esp devices, NRF51 and NRF52 devices supported with [n-able arduino core](https://github.com/h2zero/n-able)
+- Alias added for  `NimBLEServerCallbacks::onMTUChange` to `onMtuChanged` in order to support porting code from original library.
+- `NimBLEAttValue` Class added to reduce and control RAM footprint of characteristic/descriptor values and support conversions from Arduio Strings and many other data types.
+- Bluetooth 5 extended advertising support for capable devices. CODED Phy, 2M Phy, extended advertising data, and multi-advertising are supported, periodic advertising will be implemented in the future.
+
+## [1.3.8] - 2022-04-27
+
+### Fixed
+- Fix compile error with ESP32S3.
+- Prevent a potential crash when retrieving characteristics from a service if the result was successful but no characteristics found.
+
+### Changed
+- Save resources when retrieving descriptors if the characteristic handle is the same as the end handle (no descriptors).
+- Subscribing to characteristic notifications/indications will now always use write with response, as per BLE specifications.
+- `NimBLEClient::discoverAttributes` now returns a bool value to indicate success/failure
+
+## [1.3.7] - 2022-02-15
+
+### Fixed
+
+- Crash when retrieving an attribute that does not exist on the peer.
+- Memory leak when deleting client instances.
+- Compilation errors for esp32s3
+
 ## [1.3.6] - 2022-01-18
 
 ### Changed
@@ -97,7 +130,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)`
@@ -141,10 +174,10 @@ Overloads to get a vector containing pointers to all the characteristics in a se
 
 - `NimBLEAdvertising` Custom scan response data can now be used without custom advertisment.
 
-- `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.
@@ -153,84 +186,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 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.  
+- 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.
+
+- 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.
 
-- 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.  
+- 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.  
-  
-- 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.
 
-- 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.  
+- `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.  
+- 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.  
+- Advertisement type now correctly set when using non-connectable (advertiser only) mode.
 
-- Advertising payload length correction, now accounts for appearance.  
+- Advertising payload length correction, now accounts for appearance.
 
-- (Arduino) Ensure controller mode is set to BLE Only.  
+- (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  
+- `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  
+- (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.
 
 

README.md

@@ -57,7 +57,7 @@ If you are familiar with the original library, see: [The migration guide](docs/M
 
 Also see [Improvements_and_updates](docs/Improvements_and_updates.md) for information about non-breaking changes.
 
-[Full API documentation and class list can be found here.](https://h2zero.github.io/esp-nimble-cpp/)  
+[Full API documentation and class list can be found here.](https://h2zero.github.io/NimBLE-Arduino/)  
 
 For added performance and optimizations see [Usage tips](docs/Usage_tips.md).
 
@@ -72,9 +72,9 @@ such as increasing max connections, default is 3, absolute maximum connections i
 <br/>
 
 # Development Status
-This Library is tracking the esp-nimble repo, nimble-1.3.0-idf master branch, currently [@5bb7b40.](https://github.com/espressif/esp-nimble)  
+This Library is tracking the esp-nimble repo, nimble-1.4.0-idf branch, currently [@3c2e1d4.](https://github.com/espressif/esp-nimble)  
 
-Also tracking the NimBLE related changes in ESP-IDF, master branch, currently [@639e7ad.](https://github.com/espressif/esp-idf/tree/master/components/bt/host/nimble) 
+Also tracking the NimBLE related changes in ESP-IDF, master branch, currently [@95db4bb.](https://github.com/espressif/esp-idf/tree/master/components/bt/host/nimble) 
 <br/>
 
 # Acknowledgments

docs/Bluetooth 5 features.md

@@ -0,0 +1,28 @@
+# Bluetooth 5.x features
+
+## About extended advertising
+Extended advertising allows for much more capability and flexibility.
+
+* Allows for 251 bytes of advertisement data and up to 1650 bytes when chained (configuration dependant) vs 31.
+
+* New PHY's (physical layers) that allow for faster data rate (2M PHY) or long range/slower data rates (CODED PHY) as well as the original 1M PHY.
+
+* New periodic advertising, allowing the scanning device to sync with the advertisements of a beacon. This allows for the scanning device to sleep or perform other tasks before the next expected advertisement is sent, preserving cpu cycles and power (To be implemented).  
+<br/>
+
+## Enabling extended advertising
+Extended advertising is supported when enabled with the config option `CONFIG_BT_NIMBLE_EXT_ADV` set to a value of 1. This is done in menuconfig under `Component config > Bluetooth > NimBLE options > Enable extended advertising`, or set in `nimconfig.h` for Arduino, or in `build_flags` in PlatformIO.
+
+When enabled the following will occur:
+* `NimBLEScan::start` method will scan on both the 1M PHY and the coded PHY standards automatically.
+
+* `NimBLEClient::connect` will use the primary PHY the device is listening on, unless specified (see below).
+
+* `NimBLEClient::setConnectPhy` becomes available to specify the PHY's to connect with (default is all).
+
+* `NimBLEAdvertising` is no longer available for use and is replaced by `NimBLEExtAdvertising`. `NimBLEDevice::getAdvertising` will now return an instance of `NimBLEExtAdvertising`.
+
+* `NimBLEAdvertisementData` is no longer available for use and is replaced by `NimBLEExtAdvertisement`. This new class is where everything about the advertisement is configured, including the advertisement intervals and advertisement ended callback.
+
+
+

docs/Command_line_config.md

@@ -23,7 +23,7 @@ characteristic or descriptor is constructed before a value is read/notifed.
 Increasing this will reduce reallocations but increase memory footprint.  
 Default value is 20. Range: 1 : 512 (BLE_ATT_ATTR_MAX_LEN)  
  <br/>
-
+ 
 `CONFIG_BT_NIMBLE_ATT_PREFERRED_MTU`  
 
 Sets the default MTU size.  
@@ -140,3 +140,41 @@ Set the task stack size for the NimBLE core.
 - Default is 4096  
 <br/>
 
+`CONFIG_NIMBLE_STACK_USE_MEM_POOLS`
+
+ Enable the use of memory pools for stack operations. This will use slightly more RAM but may provide more stability.
+ 
+- Options: 0 or 1, default is disabled (0)  
+<br/>
+
+### Extended advertising settings, For use with ESP32C3, ESP32S3, ESP32H2 ONLY!
+ 
+`CONFIG_BT_NIMBLE_EXT_ADV`
+
+Set to 1 to enable extended advertising features.
+<br/>
+
+`CONFIG_BT_NIMBLE_MAX_EXT_ADV_INSTANCES`
+
+Sets the max number of extended advertising instances 
+- Range: 0 - 4
+- Default is 1
+<br/>
+
+`CONFIG_BT_NIMBLE_MAX_EXT_ADV_DATA_LEN`
+
+Set the max extended advertising data size,
+- Range: 31 - 1650
+- Default is 255
+<br/>
+
+`CONFIG_BT_NIMBLE_ENABLE_PERIODIC_ADV`
+
+Set to 1 to enable periodic advertising.
+<br/>
+
+`CONFIG_BT_NIMBLE_MAX_PERIODIC_SYNCS`
+
+Set the maximum number of periodically synced devices.
+- Range: 1 - 8
+- Default is 1