Skip to content

Commit

Permalink
Release 1.0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
h2zero committed Sep 14, 2020
1 parent 91b5916 commit d9e11ee
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 1 deletion.
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@

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

## [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
Expand Down
2 changes: 1 addition & 1 deletion docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ PROJECT_NAME = "esp-nimble-cpp / NimBLE-Arduino"
# could be handy for archiving the generated documentation or if some version
# control system is used.

PROJECT_NUMBER = 1.0.0
PROJECT_NUMBER = 1.0.2

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
Expand Down
11 changes: 11 additions & 0 deletions docs/Improvements_and_updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Many improvements have been made to this library vs the original, this is a brie
Refer to the [class documentation](https://h2zero.github.io/esp-nimble-cpp/annotated.html) for futher information on class specifics.

* [Server](#server)
* [Advertising](#advertising)
* [Client](#client)
* [General](#general)
<br/>
Expand Down Expand Up @@ -60,6 +61,16 @@ it's characteristics / descriptors will remain valid and the service can be re-a
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 advertsing ends and takes a pointer to a `NimBLEAdvertising` object (similar to the `NimBLEScan::start` API).

This provides an opportunity to update the advertisment data if desired.
<br/>

<a name="client"></a>
# Client

Expand Down
8 changes: 8 additions & 0 deletions docs/Migration_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,14 @@ Calling `NimBLEAdvertising::setScanResponseData` without also calling `NimBLEAdv
When using custom scan response data you must also use custom advertisement data.
<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 advertsing ends and takes a pointer to a `NimBLEAdvertising` object (similar to the `NimBLEScan::start` API).

This provides an opportunity to update the advertisment data if desired.
<br/>

<a name="client-api"></a>
## Client API

Expand Down

0 comments on commit d9e11ee

Please sign in to comment.