Skip to content

Commit f909c2b

Browse files
committed
[BREAKING]- Refactor client
* General code cleanup and rename variables to use a consistent style. * Removes the disconnect timer and will use the BLE_GAP_EVENT_TERM_FAILURE event to handle failed disconnects. * `NimBLEClient::getConnId` has been renamed to `getConnHandle` to be consistent with bluetooth terminology. * `NimBLEClient::disconnect` now returns a `bool = true on success` instead of an int to be consistent with the rest of the library. * `NimBLEClient::setPeerAddress` now returns a bool, true on success. * `NimBLEClientCallbacks::onConfirmPIN` renamed to `NimBLEClientCallbacks::onConfirmPasskey` to be consistent with bluetooth terminology. * `NimBLEClient::setDataLen` now returns bool, true if successful. * `NimBLEClient::updateConnParams` now returns bool, true if successful. * `NimBLEClient::getServices` now returns a const reference to std::vector<NimBLERemoteService*> instead of a pointer to the internal vector.
1 parent 68b9e26 commit f909c2b

File tree

19 files changed

+539
-674
lines changed

19 files changed

+539
-674
lines changed

docs/Migration_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ The security callback methods are now incorporated in the `NimBLEServerCallbacks
383383

384384
The callback methods are:
385385

386-
> `bool onConfirmPIN(NimBLEConnInfo& connInfo, uint32_t pin)`
386+
> `bool onConfirmPasskey(NimBLEConnInfo& connInfo, uint32_t pin)`
387387
388388
Receives the pin when using numeric comparison authentication.
389389
Call `NimBLEDevice::injectConfirmPasskey(connInfo, true);` to accept or `NimBLEDevice::injectConfirmPasskey(connInfo, false);` to reject.

examples/NimBLE_Client/NimBLE_Client.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ class ClientCallbacks : public NimBLEClientCallbacks {
6464
NimBLEDevice::injectPassKey(connInfo, 123456);
6565
};
6666

67-
void onConfirmPIN(NimBLEConnInfo& connInfo, uint32_t pass_key){
67+
void onConfirmPasskey(NimBLEConnInfo& connInfo, uint32_t pass_key){
6868
Serial.print("The passkey YES/NO number: ");Serial.println(pass_key);
6969
/** Inject false if passkeys don't match. */
7070
NimBLEDevice::injectConfirmPasskey(connInfo, true);

examples/NimBLE_Server/NimBLE_Server.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ class ServerCallbacks: public NimBLEServerCallbacks {
4545
return 123456;
4646
};
4747

48-
void onConfirmPIN(NimBLEConnInfo& connInfo, uint32_t pass_key) {
48+
void onConfirmPasskey(NimBLEConnInfo& connInfo, uint32_t pass_key) {
4949
Serial.print("The passkey YES/NO number: ");Serial.println(pass_key);
5050
/** Inject false if passkeys don't match. */
5151
NimBLEDevice::injectConfirmPasskey(connInfo, true);

examples/Refactored_original_examples/BLE_client/BLE_client.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ class MyClientCallback : public BLEClientCallbacks {
5656
NimBLEDevice::injectPassKey(connInfo, 123456);
5757
}
5858

59-
void onConfirmPIN(const BLEConnInfo& connInfo, uint32_t pass_key) {
59+
void onConfirmPasskey(const BLEConnInfo& connInfo, uint32_t pass_key) {
6060
Serial.print("The passkey YES/NO number: ");Serial.println(pass_key);
6161
NimBLEDevice::injectConfirmPasskey(connInfo, true);
6262
}

examples/Refactored_original_examples/BLE_notify/BLE_notify.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ class MyServerCallbacks: public BLEServerCallbacks {
6262
return 123456;
6363
}
6464

65-
void onConfirmPIN(const BLEConnInfo& connInfo, uint32_t pass_key) {
65+
void onConfirmPasskey(const BLEConnInfo& connInfo, uint32_t pass_key) {
6666
Serial.print("The passkey YES/NO number: ");Serial.println(pass_key);
6767
/** Inject false if passkeys don't match. */
6868
NimBLEDevice::injectConfirmPasskey(connInfo, true);

examples/Refactored_original_examples/BLE_uart/BLE_uart.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ class MyServerCallbacks: public BLEServerCallbacks {
6464
return 123456;
6565
}
6666

67-
void onConfirmPIN(const BLEConnInfo& connInfo, uint32_t pass_key) {
67+
void onConfirmPasskey(const BLEConnInfo& connInfo, uint32_t pass_key) {
6868
Serial.print("The passkey YES/NO number: ");Serial.println(pass_key);
6969
/** Inject false if passkeys don't match. */
7070
NimBLEDevice::injectConfirmPasskey(connInfo, true);

0 commit comments

Comments
 (0)