Skip to content

[BREAKING] Refactor NimBLEDevice #738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
h2zero merged 2 commits into from
Nov 3, 2024
Merged

[BREAKING] Refactor NimBLEDevice #738

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d836b2c
[BREAKING] Refactor NimBLEDevice
h2zero Sep 29, 2024
69617bd
Add NimBLEDevice::setOwnAddr and NimBLEUtils::generateAddr functions.
h2zero Nov 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Migration_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ The callback methods are:
> `bool onConfirmPIN(NimBLEConnInfo& connInfo, uint32_t pin)`

Receives the pin when using numeric comparison authentication.
Call `NimBLEDevice::injectConfirmPIN(connInfo, true);` to accept or `NimBLEDevice::injectConfirmPIN(connInfo, false);` to reject.
Call `NimBLEDevice::injectConfirmPasskey(connInfo, true);` to accept or `NimBLEDevice::injectConfirmPasskey(connInfo, false);` to reject.
<br/>

> `void onPassKeyEntry(NimBLEConnInfo& connInfo)`
Expand Down
4 changes: 2 additions & 2 deletions examples/NimBLE_Client/NimBLE_Client.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,15 +67,15 @@ class ClientCallbacks : public NimBLEClientCallbacks {
void onConfirmPIN(NimBLEConnInfo& connInfo, uint32_t pass_key){
Serial.print("The passkey YES/NO number: ");Serial.println(pass_key);
/** Inject false if passkeys don't match. */
NimBLEDevice::injectConfirmPIN(connInfo, true);
NimBLEDevice::injectConfirmPasskey(connInfo, true);
};

/** Pairing process complete, we can check the results in connInfo */
void onAuthenticationComplete(NimBLEConnInfo& connInfo){
if(!connInfo.isEncrypted()) {
Serial.println("Encrypt connection failed - disconnecting");
/** Find the client with the connection handle provided in desc */
NimBLEDevice::getClientByID(connInfo.getConnHandle())->disconnect();
NimBLEDevice::getClientByHandle(connInfo.getConnHandle())->disconnect();
return;
}
}
Expand Down
2 changes: 1 addition & 1 deletion examples/NimBLE_Server/NimBLE_Server.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ class ServerCallbacks: public NimBLEServerCallbacks {
void onConfirmPIN(NimBLEConnInfo& connInfo, uint32_t pass_key) {
Serial.print("The passkey YES/NO number: ");Serial.println(pass_key);
/** Inject false if passkeys don't match. */
NimBLEDevice::injectConfirmPIN(connInfo, true);
NimBLEDevice::injectConfirmPasskey(connInfo, true);
};

void onAuthenticationComplete(NimBLEConnInfo& connInfo) {
Expand Down
2 changes: 1 addition & 1 deletion examples/Refactored_original_examples/BLE_client/BLE_client.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ class MyClientCallback : public BLEClientCallbacks {

void onConfirmPIN(const BLEConnInfo& connInfo, uint32_t pass_key) {
Serial.print("The passkey YES/NO number: ");Serial.println(pass_key);
NimBLEDevice::injectConfirmPIN(connInfo, true);
NimBLEDevice::injectConfirmPasskey(connInfo, true);
}

void onAuthenticationComplete(const BLEConnInfo& connInfo){
Expand Down
2 changes: 1 addition & 1 deletion examples/Refactored_original_examples/BLE_notify/BLE_notify.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ class MyServerCallbacks: public BLEServerCallbacks {
void onConfirmPIN(const BLEConnInfo& connInfo, uint32_t pass_key) {
Serial.print("The passkey YES/NO number: ");Serial.println(pass_key);
/** Inject false if passkeys don't match. */
NimBLEDevice::injectConfirmPIN(connInfo, true);
NimBLEDevice::injectConfirmPasskey(connInfo, true);
}

void onAuthenticationComplete(const BLEConnInfo& connInfo) {
Expand Down
2 changes: 1 addition & 1 deletion examples/Refactored_original_examples/BLE_server_multiconnect/BLE_server_multiconnect.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ class MyServerCallbacks: public BLEServerCallbacks {
void onConfirmPIN(const BLEConnInfo& connInfo, uint32_t pass_key) {
Serial.print("The passkey YES/NO number: ");Serial.println(pass_key);
/** Inject false if passkeys don't match. */
NimBLEDevice::injectConfirmPIN(connInfo, true);
NimBLEDevice::injectConfirmPasskey(connInfo, true);
}

void onAuthenticationComplete(const BLEConnInfo& connInfo) {
Expand Down
2 changes: 1 addition & 1 deletion examples/Refactored_original_examples/BLE_uart/BLE_uart.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ class MyServerCallbacks: public BLEServerCallbacks {
void onConfirmPIN(const BLEConnInfo& connInfo, uint32_t pass_key) {
Serial.print("The passkey YES/NO number: ");Serial.println(pass_key);
/** Inject false if passkeys don't match. */
NimBLEDevice::injectConfirmPIN(connInfo, true);
NimBLEDevice::injectConfirmPasskey(connInfo, true);
}

void onAuthenticationComplete(const BLEConnInfo& connInfo) {
Expand Down
14 changes: 11 additions & 3 deletions src/NimBLEAdvertising.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ NimBLEAdvertising::NimBLEAdvertising() {
* @brief Stops the current advertising and resets the advertising data to the default values.
*/
void NimBLEAdvertising::reset() {
if(NimBLEDevice::getInitialized() && isAdvertising()) {
if(NimBLEDevice::isInitialized() && isAdvertising()) {
stop();
}
memset(&m_advData, 0, sizeof m_advData);
Expand All @@ -56,7 +56,11 @@ void NimBLEAdvertising::reset() {
m_advData.name = (uint8_t *)name;
m_advData.name_len = strlen(name);
m_advData.name_is_complete = 1;
#ifndef CONFIG_IDF_TARGET_ESP32P4
m_advData.tx_pwr_lvl = NimBLEDevice::getPower();
#else
m_advData.tx_pwr_lvl = 0;
#endif
m_advData.flags = (BLE_HS_ADV_F_DISC_GEN | BLE_HS_ADV_F_BREDR_UNSUP);

#if !defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
Expand Down Expand Up @@ -639,15 +643,15 @@ bool NimBLEAdvertising::start(uint32_t duration, advCompleteCB_t advCompleteCB,
}

#if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)
rc = ble_gap_adv_start(NimBLEDevice::m_own_addr_type,
rc = ble_gap_adv_start(NimBLEDevice::m_ownAddrType,
(dirAddr != nullptr) ? dirAddr->getBase() : NULL,
duration,
&m_advParams,
(pServer != nullptr) ? NimBLEServer::handleGapEvent :
NimBLEAdvertising::handleGapEvent,
(void*)this);
#else
rc = ble_gap_adv_start(NimBLEDevice::m_own_addr_type,
rc = ble_gap_adv_start(NimBLEDevice::m_ownAddrType,
(dirAddr != nullptr) ? &peerAddr : NULL,
duration,
&m_advParams,
Expand Down Expand Up @@ -1018,7 +1022,11 @@ void NimBLEAdvertisementData::addTxPower() {
char cdata[3];
cdata[0] = BLE_HS_ADV_TX_PWR_LVL_LEN + 1;
cdata[1] = BLE_HS_ADV_TYPE_TX_PWR_LVL;
#ifndef CONFIG_IDF_TARGET_ESP32P4
cdata[2] = NimBLEDevice::getPower();
#else
cdata[2] = 0;
#endif
addData(cdata, 3);
} // addTxPower

Expand Down
6 changes: 3 additions & 3 deletions src/NimBLEClient.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ bool NimBLEClient::connect(const NimBLEAddress &address, bool deleteAttributes)
*/
do {
#if CONFIG_BT_NIMBLE_EXT_ADV
rc = ble_gap_ext_connect(NimBLEDevice::m_own_addr_type,
rc = ble_gap_ext_connect(NimBLEDevice::m_ownAddrType,
peerAddr,
m_connectTimeout,
m_phyMask,
Expand All @@ -237,7 +237,7 @@ bool NimBLEClient::connect(const NimBLEAddress &address, bool deleteAttributes)
this);

#else
rc = ble_gap_connect(NimBLEDevice::m_own_addr_type, peerAddr,
rc = ble_gap_connect(NimBLEDevice::m_ownAddrType, peerAddr,
m_connectTimeout, &m_pConnParams,
NimBLEClient::handleGapEvent, this);
#endif
Expand Down Expand Up @@ -1342,7 +1342,7 @@ void NimBLEClientCallbacks::onIdentity(NimBLEConnInfo& connInfo){

void NimBLEClientCallbacks::onConfirmPIN(NimBLEConnInfo& connInfo, uint32_t pin){
NIMBLE_LOGD("NimBLEClientCallbacks", "onConfirmPIN: default: true");
NimBLEDevice::injectConfirmPIN(connInfo, true);
NimBLEDevice::injectConfirmPasskey(connInfo, true);
}

#endif /* CONFIG_BT_ENABLED && CONFIG_BT_NIMBLE_ROLE_CENTRAL */
Loading
Loading