From 2272e3c4a7b756679e6d6463823fd8b78c04aa20 Mon Sep 17 00:00:00 2001 From: h2zero Date: Wed, 11 Jun 2025 08:37:30 -0600 Subject: [PATCH] Update docs --- docs/1.x_to2.x_migration_guide.md | 2 ++ docs/Migration_guide.md | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/1.x_to2.x_migration_guide.md b/docs/1.x_to2.x_migration_guide.md index a352559..4dba88d 100644 --- a/docs/1.x_to2.x_migration_guide.md +++ b/docs/1.x_to2.x_migration_guide.md @@ -43,6 +43,7 @@ The changes listed here are only the required changes that must be made, and a s Note: If setting a custom address, it should be set with `NimBLEDevice::setOwnAddr` first before calling `NimBLEDevice::setOwnAddrType`. - `NimBLEDevice::getClientListSize` replaced with `NimBLEDevice::getCreatedClientCount`. - `NimBLEDevice::getClientList` was removed and `NimBLEDevice::getConnectedClients` can be used instead which returns a `std::vector` of pointers to the connected client instances. This was done because internally the clients are managed in a `std::array` which replaced the 'std::list`. +- `NimBLEDevice::getClientByID(uint16_t conn_id);` has been changed to `NimBLEDevice::getClientByHandle(uint16_t connHandle)`
## BLE Addresses @@ -133,6 +134,7 @@ Have been removed, instead the application should use `NimBLERemoteCharacteristi - - `NimBLEScanCallbacks::onResult`, functions the same as the old `NimBLEAdvertisedDeviceCallbacks::onResult` but now takes aa `const NimBLEAdvertisedDevice*` instead of non-const. - - `NimBLEScanCallbacks::onScanEnd`, replaces the scanEnded callback passed to `NimBLEScan::start` and now takes a `const NimBLEScanResults&` and `int reason` parameter. - - `NimBLEScanCallbacks::onDiscovered`, This is called immediately when a device is first scanned, before any scan response data is available and takes a `const NimBLEAdvertisedDevice*` parameter. +- `NimBLEScan::setAdvertisedDeviceCallbacks(NimBLEAdvertisedDeviceCallbacks* callbacks, bool wantDuplicates)` has been changed to `NimBLEScan::setScanCallbacks(NimBLEScanCallbacks* callbacks, bool wantDuplicates);`
### Advertised Device diff --git a/docs/Migration_guide.md b/docs/Migration_guide.md index 3b82921..04184b6 100644 --- a/docs/Migration_guide.md +++ b/docs/Migration_guide.md @@ -234,7 +234,7 @@ This can be changed to use passkey authentication or numeric comparison. See [Se Advertising works the same as the original API except: Calling `NimBLEAdvertising::setAdvertisementData` will entirely replace any data set with `NimBLEAdvertising::addServiceUUID`, or -`NimBLEAdvertising::setAppearance` or similar methods. You should set all the data you wish to advertise within the `NimBLEAdvertisementData` instead. +`NimBLEAdvertising::setAppearance` or similar methods. You should set all the data you wish to advertise within the `NimBLEAdvertisementData` instead if calling `NimBLEAdvertising::setAdvertisementData`.
> BLEAdvertising::start (NimBLEAdvertising::start)