Skip to content

NimBLEDevice::get/setPower support full power range. #229

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
merged 6 commits into from
Dec 2, 2024
Merged

NimBLEDevice::get/setPower support full power range. #229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
18f6fb9
NimBLEDevice::get/setPower support full power range.
thekurtovic Nov 15, 2024
d3c363c
Account for differences in IDF version.
thekurtovic Nov 15, 2024
5182ca1
Re: Account for differences in IDF version.
thekurtovic Nov 15, 2024
4541337
Calculate power level instead of using conditional checks.
h2zero Dec 2, 2024
b35ee17
Remove ESP_PWR_LVL_INVALID check
h2zero Dec 2, 2024
9f3b0e9
Fixup/cleanup
h2zero Dec 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
98 changes: 46 additions & 52 deletions src/NimBLEDevice.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,47 +421,51 @@ std::vector<NimBLEClient*> NimBLEDevice::getConnectedClients() {
/* TRANSMIT POWER */
/* -------------------------------------------------------------------------- */

# ifdef ESP_PLATFORM
/**
* @brief Get the transmission power.
* @return The power level currently used in esp_power_level_t.
*/
esp_power_level_t NimBLEDevice::getPowerLevel(esp_ble_power_type_t powerType) {
# ifdef CONFIG_IDF_TARGET_ESP32P4
return 0xFF; // CONFIG_IDF_TARGET_ESP32P4 does not support esp_ble_tx_power_get
# else
return esp_ble_tx_power_get(powerType);
# endif
} // getPowerLevel

/**
* @brief Set the transmission power.
* @param [in] dbm The power level to set in dBm.
* @param [in] powerLevel The power level to set in esp_power_level_t.
* @return True if the power level was set successfully.
*/
bool NimBLEDevice::setPower(int8_t dbm) {
NIMBLE_LOGD(LOG_TAG, ">> setPower: %d", dbm);
# ifdef ESP_PLATFORM
# ifndef CONFIG_IDF_TARGET_ESP32P4
if (dbm >= 9) {
dbm = ESP_PWR_LVL_P9;
} else if (dbm >= 6) {
dbm = ESP_PWR_LVL_P6;
} else if (dbm >= 3) {
dbm = ESP_PWR_LVL_P3;
} else if (dbm >= 0) {
dbm = ESP_PWR_LVL_N0;
} else if (dbm >= -3) {
dbm = ESP_PWR_LVL_N3;
} else if (dbm >= -6) {
dbm = ESP_PWR_LVL_N6;
} else if (dbm >= -9) {
dbm = ESP_PWR_LVL_N9;
} else if (dbm >= -12) {
dbm = ESP_PWR_LVL_N12;
} else {
NIMBLE_LOGE(LOG_TAG, "Unsupported power level");
return false;
}

esp_err_t errRc = esp_ble_tx_power_set(ESP_BLE_PWR_TYPE_DEFAULT, (esp_power_level_t)dbm);
bool NimBLEDevice::setPowerLevel(esp_power_level_t powerLevel, esp_ble_power_type_t powerType) {
# ifdef CONFIG_IDF_TARGET_ESP32P4
return false; // CONFIG_IDF_TARGET_ESP32P4 does not support esp_ble_tx_power_set
# else
esp_err_t errRc = esp_ble_tx_power_set(powerType, powerLevel);
if (errRc != ESP_OK) {
NIMBLE_LOGE(LOG_TAG, "esp_ble_tx_power_set: rc=%d", errRc);
}

return errRc == ESP_OK;
# else
return 0xFF; // CONFIG_IDF_TARGET_ESP32P4
# endif
} // setPowerLevel

# endif
/**
* @brief Set the transmission power.
* @param [in] dbm The power level to set in dBm.
* @return True if the power level was set successfully.
*/
bool NimBLEDevice::setPower(int8_t dbm) {
# ifdef ESP_PLATFORM
if (dbm % 3 == 2) {
dbm++; // round up to the next multiple of 3 to be able to target 20dbm
}
return setPowerLevel(static_cast<esp_power_level_t>(dbm / 3 + ESP_PWR_LVL_N0));
# else
NIMBLE_LOGD(LOG_TAG, ">> setPower: %d", dbm);
ble_hci_vs_set_tx_pwr_cp cmd{dbm};
ble_hci_vs_set_tx_pwr_rp rsp{0};
int rc = ble_hs_hci_send_vs_cmd(BLE_HCI_OCF_VS_SET_TX_PWR, &cmd, sizeof(cmd), &rsp, sizeof(rsp));
Expand All @@ -478,34 +482,24 @@ bool NimBLEDevice::setPower(int8_t dbm) {
/**
* @brief Get the transmission power.
* @return The power level currently used in dbm.
* @note ESP32S3 only returns 0xFF as of IDF 5, so this function will return 20dbm.
*/
int NimBLEDevice::getPower() {
# ifdef ESP_PLATFORM
# ifndef CONFIG_IDF_TARGET_ESP32P4
switch (esp_ble_tx_power_get(ESP_BLE_PWR_TYPE_DEFAULT)) {
case ESP_PWR_LVL_N12:
return -12;
case ESP_PWR_LVL_N9:
return -9;
case ESP_PWR_LVL_N6:
return -6;
case ESP_PWR_LVL_N3:
return -3;
case ESP_PWR_LVL_N0:
return 0;
case ESP_PWR_LVL_P3:
return 3;
case ESP_PWR_LVL_P6:
return 6;
case ESP_PWR_LVL_P9:
return 9;
default:
return 0xFF;
}
# else
# ifdef CONFIG_IDF_TARGET_ESP32P4
return 0xFF; // CONFIG_IDF_TARGET_ESP32P4 does not support esp_ble_tx_power_get
# endif
# else
int pwr = esp_ble_tx_power_get(ESP_BLE_PWR_TYPE_DEFAULT);
Copy link
Collaborator Author

@thekurtovic thekurtovic Dec 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should check if power is invalid here, otherwise a large value like 741 will be returned when equal to ESP_PWR_LVL_INVALID.
Would it make sense to return -127 in this case?

Copy link
Owner

@h2zero h2zero Dec 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In theory the current power level should never be invalid I though think, also ESP_PWR_LVL_INVALID isn't defined for all chips/idf versions.

if (pwr < ESP_PWR_LVL_N0) {
return -3 * (ESP_PWR_LVL_N0 - pwr);
}

if (pwr > ESP_PWR_LVL_N0) {
return std::min<int>((pwr - ESP_PWR_LVL_N0) * 3, 20);
}

return 0;
# endif
# else
return ble_phy_txpwr_get();
# endif
Expand Down
9 changes: 7 additions & 2 deletions src/NimBLEDevice.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,6 @@ class NimBLEDevice {
static bool onWhiteList(const NimBLEAddress& address);
static size_t getWhiteListCount();
static NimBLEAddress getWhiteListAddress(size_t index);
static bool setPower(int8_t dbm);
static int getPower();
static bool setOwnAddrType(uint8_t type);
static bool setOwnAddr(const NimBLEAddress& addr);
static bool setOwnAddr(const uint8_t* addr);
Expand All @@ -135,6 +133,13 @@ class NimBLEDevice {
static void onReset(int reason);
static void onSync(void);
static void host_task(void* param);
static int getPower();
static bool setPower(int8_t dbm);

# if defined(ESP_PLATFORM)
static esp_power_level_t getPowerLevel(esp_ble_power_type_t powerType = ESP_BLE_PWR_TYPE_DEFAULT);
static bool setPowerLevel(esp_power_level_t powerLevel, esp_ble_power_type_t powerType = ESP_BLE_PWR_TYPE_DEFAULT);
# endif

# if CONFIG_BT_NIMBLE_EXT_ADV
static bool setDefaultPhy(uint8_t txPhyMask, uint8_t rxPhyMask);
Expand Down
Loading