Release 1.4.0

* Fix typos

Author: h2zero

.gitignore

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

CHANGELOG.md

@@ -2,18 +2,20 @@
 
 All notable changes to this project will be documented in this file.
 
-## [Unreleased]
+## [1.4.0] - 2022-07-10
 
 ### Fixed
 - Fixed missing data from long notification values.
+- Fixed NimbleCharacteristicCallbacks::onRead not being called when a non-long read command is received.
 
 ### Changed
-- Updated NimBLE core to use the v1.4.0 branch of esp-nimble
+- Updated NimBLE core to use the v1.4.0 branch of esp-nimble.
+- AD flags are no longer set in the advertisements of non-connectable beacons, freeing up 3 bytes of advertisement room.
 
 ### Added
-- Preliminary support for non-esp devices, NRF51 and NRF52 devices supported with [n-able arduino core](https://github.com/h2zero/n-able)
+- Preliminary support for non-esp devices, NRF51 and NRF52 devices supported with [n-able arduino core](https://github.com/h2zero/n-able-Arduino)
 - 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.
+- `NimBLEAttValue` Class added to reduce and control RAM footprint of characteristic/descriptor values and support conversions from Arduino 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
@@ -44,7 +46,7 @@ All notable changes to this project will be documented in this file.
 - Memory leak when services are changed on server devices.
 - Rare crashing that occurs when BLE commands are sent from ISR context using IPC.
 - Crashing caused by uninitialized disconnect timer in client.
-- Potential crash due to unintialized advertising callback pointer.
+- Potential crash due to uninitialized advertising callback pointer.
 
 ## [1.3.5] - 2022-01-14
 
@@ -81,7 +83,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
@@ -112,12 +114,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
 
@@ -172,7 +174,7 @@ 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.
 
@@ -214,7 +216,7 @@ to obtain information about the disconnected client.
 - 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.
 
@@ -225,7 +227,7 @@ this allows the starting of a new scan from the callback function.
 - 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
+- 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
@@ -242,7 +244,7 @@ and would be unable to reconnect. A timer has been added to reset the host/contr
 - 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 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.
 
@@ -258,7 +260,7 @@ advertised them as 16/32bit but resolved them to 128bits. Both are now checked.
 ### 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).
+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.

README.md

@@ -1,85 +1,72 @@
 [Latest release ![Release Version](https://img.shields.io/github/release/h2zero/NimBLE-Arduino.svg?style=plastic)
-![Release Date](https://img.shields.io/github/release-date/h2zero/NimBLE-Arduino.svg?style=plastic)](https://github.com/h2zero/NimBLE-Arduino/releases/latest/)  
+![Release Date](https://img.shields.io/github/release-date/h2zero/NimBLE-Arduino.svg?style=plastic)](https://github.com/h2zero/NimBLE-Arduino/releases/latest/)
 
-Need help? Have questions or suggestions? Join the [![Gitter](https://badges.gitter.im/NimBLE-Arduino/community.svg)](https://gitter.im/NimBLE-Arduino/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)  
+Need help? Have questions or suggestions? Join the [![Gitter](https://badges.gitter.im/NimBLE-Arduino/community.svg)](https://gitter.im/NimBLE-Arduino/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 <br/>
 
 # NimBLE-Arduino
-A fork of the NimBLE stack restructured for compilation in the Ardruino IDE with a CPP library for use with ESP32.  
+A fork of the NimBLE stack refactored for compilation in the Ardruino IDE.
 
-**Note for IDF users: This repo will not compile correctly in ESP-IDF. An ESP-IDF component version of this library can be [found here.](https://github.com/h2zero/esp-nimble-cpp)**
+**As of release 1.4.0 Nordic Semiconductor nRF51 and nRF52 series devices are now supported**
 
-This library **significantly** reduces resource usage and improves performance for ESP32 BLE applications as compared    
-with the bluedroid based library. The goal is to maintain, as much as reasonable, compatibility with the original   
-library but refactored to use the NimBLE stack. In addition, this library will be more actively developed and maintained   
-to provide improved capabilites and stability over the original.  
-<br/>
-
-## Resource use improvement
-
-### (Original) BLE_client example comparison (Debug):
-#### Arduino BLE Library   
-Sketch uses **1216377** bytes (58%) of program storage space.   
-Memory after connection: Free Heap: **171548**  
-
-#### NimBLE-Arduino library
-Sketch uses **617256** bytes (29%) of program storage space.   
-Memory after connection: Free Heap: **270336**   
-***
-### (Original) BLE_notify example comparison (Debug):   
-#### Arduino BLE Library
-Sketch uses **1208409** bytes (57%) of program storage space.   
-Memory after connection: Free Heap: **173300**   
+## Supported MCU's
+ - Espressif: ESP32, ESP32C3, ESP32S3
+ - Nordic: nRF51, nRF52 series (**Requires** using [n-able arduino core](https://github.com/h2zero/n-able-Arduino))
 
-#### NimBLE-Arduino library   
-Sketch uses **603432** bytes (28%) of program storage space.   
-Memory after connection: Free Heap: **269792**  
+**Note for ESP-IDF users: This repo will not compile correctly in ESP-IDF. An ESP-IDF component version of this library can be [found here.](https://github.com/h2zero/esp-nimble-cpp)**
 
-**As shown: there is nearly a 50% reduction in flash use and approx. 100kB less ram consumed!**  
+This library **significantly** reduces resource usage and improves performance for ESP32 BLE applications as compared with the bluedroid based library. The goal is to maintain, as much as reasonable, compatibility with the original library but refactored to use the NimBLE stack. In addition, this library will be more actively developed and maintained to provide improved capabilities and stability over the original.
 <br/>
 
-# Installation
-**Arduino Library manager:** Go to `sketch` -> `Include Library` -> `Manage Libraries` and search for NimBLE and install.  
+For Nordic devices, this library provides access to a completely open source and configurable BLE stack. No softdevice to work around, allowing for full debugging and resource management, continuous updates, with a cross platform API.
+
+# Arduino installation
+**Arduino Library manager:** Go to `sketch` -> `Include Library` -> `Manage Libraries`, search for NimBLE and install.
 
 **Alternatively:** Download as .zip and extract to Arduino/libraries folder, or in Arduino IDE from Sketch menu -> Include library -> Add .Zip library.
 
 `#include "NimBLEDevice.h"` at the beginning of your sketch.
 
-Tested and working with esp32-arduino in Arduino IDE and platform IO.  
-<br/>
+# Platformio installation
+* Open platformio.ini, a project configuration file located in the root of PlatformIO project.  
+* Add the following line to the lib_deps option of [env:] section:
+```
+h2zero/NimBLE-Arduino@^1.4.0
+```
+* Build a project, PlatformIO will automatically install dependencies.
 
 # Using
-This library is intended to be compatible with the original ESP32 BLE functions and types with minor changes.  
+This library is intended to be compatible with the original ESP32 BLE functions and types with minor changes.
 
-If you have not used the original Bluedroid library please refer to the [New user guide](docs/New_user_guide.md).  
+If you have not used the original Bluedroid library please refer to the [New user guide](docs/New_user_guide.md).
 
-If you are familiar with the original library, see: [The migration guide](docs/Migration_guide.md) for details about breaking changes and migration.  
+If you are familiar with the original library, see: [The migration guide](docs/Migration_guide.md) for details about breaking changes and migration.
 
 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/NimBLE-Arduino/)  
+[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).
 
 Check the Refactored_original_examples in the examples folder for highlights of the differences with the original library.
 
 More advanced examples highlighting many available features are in examples/ NimBLE_Server, NimBLE_Client.
 
-Beacon examples provided by @beegee-tokyo are in examples/ BLE_Beacon_Scanner, BLE_EddystoneTLM_Beacon, BLE_EddystoneURL_Beacon.   
+Beacon examples provided by @beegee-tokyo are in examples/ BLE_Beacon_Scanner, BLE_EddystoneTLM_Beacon, BLE_EddystoneURL_Beacon.
 
-Change the settings in the `src/nimconfig.h` file to customize NimBLE to your project,  
-such as increasing max connections, default is 3, absolute maximum connections is 9.  
+Change the settings in the `src/nimconfig.h` file to customize NimBLE to your project,
+such as increasing max connections, default is 3, absolute maximum connections is 9.
 <br/>
 
 # Development Status
-This Library is tracking the esp-nimble repo, nimble-1.4.0-idf branch, currently [@3c2e1d4.](https://github.com/espressif/esp-nimble)  
+This Library is tracking the esp-nimble repo, nimble-1.4.0-idf branch, currently [@3df0d20.](https://github.com/espressif/esp-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) 
+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
 * [nkolban](https://github.com/nkolban) and [chegewara](https://github.com/chegewara) for the [original esp32 BLE library](https://github.com/nkolban/esp32-snippets/tree/master/cpp_utils) this project was derived from.
 * [beegee-tokyo](https://github.com/beegee-tokyo) for contributing your time to test/debug and contributing the beacon examples.
-* [Jeroen88](https://github.com/Jeroen88) for the amazing help debugging and improving the client code.  
-<br/>  
-  
+* [Jeroen88](https://github.com/Jeroen88) for the amazing help debugging and improving the client code.
+<br/>
+