Skip to content

Commit 7caf2a2

Browse files
committed
Update documentation.
1 parent c6d6e4f commit 7caf2a2

File tree

3 files changed

+34
-9
lines changed

3 files changed

+34
-9
lines changed

CHANGELOG.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,39 @@
22

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

5+
## Unreleased changes
6+
7+
### Added
8+
- Whitelist API:
9+
- `NimBLEDevice::whiteListAdd`: Add a device to the whitelist.
10+
- `NimBLEDevice::whiteListRemove`: Remove a device from the whitelist.
11+
- `NimBLEDevice::onWhiteList`: Check if the device is on the whitelist.
12+
- `NimBLEDevice::getWhiteListCount`: Gets the size of the whitelist
13+
- `NimBLEDevice::getWhiteListAddress`: Get the address of a device on the whitelist by index value.
14+
15+
- Bond management API:
16+
- `NimBLEDevice::getNumBonds`: Gets the number of bonds stored.
17+
- `NimBLEDevice::isBonded`: Checks if the device is bonded.
18+
- `NimBLEDevice::deleteAllBonds`: Deletes all bonds.
19+
- `NimBLEDevice::getBondedAddress`: Gets the address of a bonded device by the index value.
20+
21+
- `NimBLECharacteristic::getCallbacks` to retrieve the current callback handler.
22+
- Connection Information class: `NimBLEConnInfo`.
23+
- `NimBLEScan::clearDuplicateCache`: This can be used to reset the cache of advertised devices so they will be immediately discovered again.
24+
25+
### Changed
26+
- FreeRTOS files have been removed as they are not used by the library.
27+
- Services, characteristics and descriptors can now be created statically and added after.
28+
- Excess logging and some asserts removed.
29+
30+
### Fixed
31+
- `NimBLECharacteristicCallbacks::onSubscribe` Is now called after the connection is added to the vector.
32+
- Corrected bonding failure when reinitializing the BLE stack.
33+
- Writing to a characterisic with a std::string value now correctly writes values with null characters.
34+
- Retrieving remote descriptors now uses the characterisic end handle correctly.
35+
- Missing data in long writes to remote descriptors.
36+
- Hanging on task notification when sending an indication from the characteristic callback.
37+
538
## [1.2.0] - 2021-02-08
639

740
### Added

README.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,4 @@ Also tracking the NimBLE related changes in ESP-IDF, master branch, currently [@
8282
* [beegee-tokyo](https://github.com/beegee-tokyo) for contributing your time to test/debug and contributing the beacon examples.
8383
* [Jeroen88](https://github.com/Jeroen88) for the amazing help debugging and improving the client code.
8484
<br/>
85-
86-
# Todo
87-
- Improve host reset handler
88-
- Implement random address handling
89-
- Implement bond management
90-
- Add Bluetooth Mesh
91-
<br/>
85+

docs/Migration_guide.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,6 @@ For example `BLEServer::createService(SERVICE_UUID)` will work just as it did be
6969

7070
<a name="characteristics"></a>
7171
### Characteristics
72-
The constructor for `(Nim)BLECharacteristic` is now private, so if you currently subclass it to add logic you should switch to use `NimBLEService::createCharacteristic` instead. Any custom processing logic previously in a `BLECharacteristic` subclass should be moved to a `NimBLECharacteristicCallbacks` subclass instead, and passed into `NimBLECharacteristic::setCallbacks`.
73-
7472
`BLEService::createCharacteristic` (`NimBLEService::createCharacteristic`) is used the same way as originally except the properties parameter has changed.
7573

7674
When creating a characteristic the properties are now set with `NIMBLE_PROPERTY::XXXX` instead of `BLECharacteristic::XXXX`.

0 commit comments

Comments
 (0)