Merge remote-tracking branch 'review/PowerSaving-v16' into keymindCascade

# Conflicts:
#	build-iotthinks.sh
#	examples/simple_repeater/MyMesh.cpp
#	examples/simple_room_server/MyMesh.cpp
#	examples/simple_sensor/SensorMesh.cpp
#	src/helpers/CommonCLI.cpp
#	src/helpers/radiolib/CustomSX1262.h
#	src/helpers/sensors/EnvironmentSensorManager.cpp
#	variants/heltec_v4/platformio.ini
#	variants/heltec_v4_r8/HeltecV4R8Board.cpp
#	variants/heltec_v4_r8/HeltecV4R8Board.h
#	variants/heltec_v4_r8/platformio.ini
This commit is contained in:
mikecarper committed 2026-08-14 08:22:26 -07:00
commit f0fe67df30
13 files changed
+198 -29

No files matched your search

+46 -14
View File
@@ -4,12 +4,13 @@ export FIRMWARE_VERSION="PowerSaving17"
############# Repeaters #############
# Commonly-used boards
## ESP32 - 17 boards
## ESP32 - 19 boards
./build.sh build-firmware \
Heltec_ct62_repeater \
Heltec_E290_repeater \
Heltec_v3_repeater \
heltec_v4_repeater \
heltec_v4_r8_repeater \
heltec_tracker_v2_repeater \
Heltec_Wireless_Paper_repeater \
Heltec_Wireless_Tracker_repeater \
@@ -19,22 +20,24 @@ LilyGo_TBeam_1W_repeater \
Station_G2_repeater \
T_Beam_S3_Supreme_SX1262_repeater \
Tbeam_SX1262_repeater \
ThinkNode_M5_Repeater \
Xiao_C3_repeater \
Xiao_C6_repeater_ \
Xiao_S3_repeater \
Xiao_S3_WIO_repeater
## NRF52 - 21 boards
## NRF52 - 22 boards
./build.sh build-firmware \
GAT562_30S_Mesh_Kit_repeater \
GAT562_Mesh_Tracker_Pro_repeater \
Heltec_mesh_solar_repeater \
Heltec_t096_repeater \
Heltec_t1_repeater \
Heltec_t114_repeater \
Heltec_t1_repeater \
ikoka_nano_nrf_22dbm_repeater \
ikoka_nano_nrf_30dbm_repeater \
ikoka_nano_nrf_33dbm_repeater \
LilyGo_T-Echo_Card_repeater \
LilyGo_T-Echo_repeater \
ProMicro_repeater \
RAK_3401_repeater \
@@ -55,10 +58,11 @@ LilyGo_TLora_V2_1_1_6_repeater \
Tbeam_SX1276_repeater
############# Room Server #############
# ESP32 - 7 boards
# ESP32 - 8 boards
./build.sh build-firmware \
Heltec_v3_room_server \
heltec_v4_room_server \
heltec_v4_r8_room_server \
heltec_tracker_v2_room_server \
Heltec_Wireless_Paper_room_server \
Heltec_WSL3_room_server \
@@ -76,13 +80,15 @@ WioTrackerL1_room_server \
Xiao_nrf52_room_server
############# Companions BLE #############
# NRF52 - 15 boards
# NRF52 - 17 boards
./build.sh build-firmware \
Heltec_t096_companion_radio_ble_femon \
Heltec_t096_companion_radio_ble_femoff \
Heltec_t1_companion_radio_ble \
Heltec_t114_companion_radio_ble \
LilyGo_T-Echo_Card_companion_radio_ble \
LilyGo_T-Echo_companion_radio_ble \
ProMicro_companion_radio_ble \
RAK_3401_companion_radio_ble \
RAK_4631_companion_radio_ble \
RAK_WisMesh_Tag_companion_radio_ble \
@@ -95,17 +101,18 @@ WioTrackerL1_companion_radio_ble \
Xiao_nrf52_companion_radio_ble
############# Companions BLE PS #############
# ESP32 - 21 builds
# ESP32 - 23 builds
./build.sh build-firmware \
Heltec_ct62_companion_radio_ble_ps \
heltec_tracker_v2_companion_radio_ble_femon \
heltec_tracker_v2_companion_radio_ble_femoff \
Heltec_v2_companion_radio_ble_ps \
Heltec_v3_companion_radio_ble_ps \
heltec_v4_3_companion_radio_ble_femoff \
heltec_v4_companion_radio_ble_femon \
heltec_v4_expansionkit_tft_companion_radio_ble_femon \
heltec_v4_3_companion_radio_ble_ps_femoff \
heltec_v4_companion_radio_ble_ps_femon \
heltec_v4_expansionkit_tft_companion_radio_ble_ps \
heltec_v4_3_expansionkit_tft_companion_radio_ble_femoff \
heltec_v4_r8_companion_radio_ble_ps \
Heltec_Wireless_Paper_companion_radio_ble_ps \
Heltec_Wireless_Tracker_companion_radio_ble_ps \
Heltec_WSL3_companion_radio_ble_ps \
@@ -115,29 +122,54 @@ LilyGo_TLora_V2_1_1_6_companion_radio_ble_ps \
T_Beam_S3_Supreme_SX1262_companion_radio_ble_ps \
Tbeam_SX1262_companion_radio_ble_ps \
Tbeam_SX1276_companion_radio_ble_ps \
ThinkNode_M5_companion_radio_ble_ps \
Xiao_C3_companion_radio_ble_ps \
Xiao_S3_companion_radio_ble_ps \
Xiao_S3_WIO_companion_radio_ble_ps
############# Companions USB #############
# ESP32 and NRF52 - 5 builds
./build.sh build-firmware \
Heltec_t096_companion_radio_usb_femon \
Heltec_t096_companion_radio_usb_femoff
Heltec_t096_companion_radio_usb_femoff \
heltec_v4_companion_radio_usb \
heltec_v4_companion_radio_usb_ps_femoff \
heltec_v4_companion_radio_usb_ps_femon
############# Sample builds #############
# 14 boards
# 27 boards
./build.sh build-firmware \
Heltec_t096_companion_radio_ble_femon \
Heltec_t096_companion_radio_ble_femoff \
Heltec_t096_companion_radio_usb_femon \
Heltec_t096_companion_radio_usb_femoff \
Heltec_t096_repeater \
Heltec_t114_companion_radio_ble \
Heltec_t114_repeater \
Heltec_v3_companion_radio_ble_ps \
Heltec_v3_repeater \
heltec_v4_3_companion_radio_ble_femoff \
heltec_v4_companion_radio_ble_femon \
heltec_v4_3_companion_radio_ble_ps_femoff \
heltec_v4_companion_radio_ble_ps_femon \
heltec_v4_repeater \
heltec_v4_r8_companion_radio_ble_ps \
RAK_3401_companion_radio_ble \
RAK_3401_repeater \
RAK_4631_companion_radio_ble \
RAK_4631_repeater \
SenseCap_Solar_companion_radio_ble \
SenseCap_Solar_repeater \
WioTrackerL1_companion_radio_ble \
WioTrackerL1_repeater \
Xiao_C3_companion_radio_ble_ps \
Xiao_C3_repeater \
Xiao_C6_companion_radio_ble_ \
Xiao_C6_repeater_
Xiao_C6_repeater_ \
Xiao_nrf52_companion_radio_ble \
Xiao_nrf52_repeater
# Heltec v4 USB power-saving variants
./build.sh build-firmware \
heltec_v4_companion_radio_ble_ps_femon \
heltec_v4_companion_radio_usb \
heltec_v4_companion_radio_usb_ps_femoff \
heltec_v4_companion_radio_usb_ps_femon
+6
View File
@@ -620,7 +620,9 @@ Station G2/G3 targets default to `off`.
#### View or change RX duty-cycle power saving
**Usage:**
- `get radio.rxps`
- `get radio.rxps.rfrx_disabled`
- `get rxps.wd`
- `set radio.rxps.rfrx_disabled <state>`
- `set radio.rxps off`
- `set radio.rxps on`
- `set radio.rxps conservative`
@@ -634,9 +636,13 @@ Station G2/G3 targets default to `off`.
- `rx_us`, `sleep_us`: Receive and sleep durations in microseconds (`1000`-`30000000`).
- `level`: A power-saving level from `1` (most conservative) to `10` (least power saving).
- `preamble`: LoRa preamble length in symbols; `16` or `32`.
- `state`: `on` or `off`.
**Notes:**
- `get rxps.wd` reports the RXPS watchdog's soft and hard recovery counts.
- `radio.rxps.rfrx_disabled` is a runtime-only diagnostic setting and resets to `off` after reboot.
- Its default `off` state keeps the host-controlled SX1262 receive path enabled during RX duty-cycle mode. Setting it to `on` reproduces the old missing-RF_RX behavior and can significantly reduce receive sensitivity, making remote commands harder to receive.
- `radio.rxps.rfrx_disabled` is supported only on SX1262 targets with a host-controlled RX enable pin.
- `on` and `conservative` select level `1` with a 16-symbol preamble; `balanced` selects level `5` with a 16-symbol preamble.
- Level-based settings automatically recalculate their timings when the spreading factor or bandwidth changes. Custom `<rx_us> <sleep_us>` timings remain fixed.
- The selected mode is applied immediately, persisted, and restored after reboot.
+16
View File
@@ -4268,6 +4268,22 @@ bool MyMesh::setRxPowerSaving(bool enable, uint32_t rx_us, uint32_t sleep_us) {
return ok;
}
bool MyMesh::supportsRxPowerSavingRfRxDisable() const {
return radio_driver.supportsRxPowerSavingRfRxDisable();
}
bool MyMesh::setRxPowerSavingRfRxDisabled(bool disabled) {
bool ok = radio_driver.setRxPowerSavingRfRxDisabled(disabled);
MESH_DEBUG_PRINTLN("RX Power Saving RF_RX control: %s, %s",
disabled ? "disabled" : "enabled",
ok ? "accepted" : "unsupported");
return ok;
}
bool MyMesh::isRxPowerSavingRfRxDisabled() const {
return radio_driver.isRxPowerSavingRfRxDisabled();
}
void MyMesh::getRxPsWatchdogCounts(uint32_t* soft, uint32_t* hard) {
*soft = radio_driver.getRxPsWatchdogSoftCount();
*hard = radio_driver.getRxPsWatchdogHardCount();
+3
View File
@@ -876,6 +876,9 @@ public:
void dumpLogFile() override;
void setTxPower(int8_t power_dbm) override;
bool setRxPowerSaving(bool enable, uint32_t rx_us, uint32_t sleep_us) override;
bool supportsRxPowerSavingRfRxDisable() const override;
bool setRxPowerSavingRfRxDisabled(bool disabled) override;
bool isRxPowerSavingRfRxDisabled() const override;
void getRxPsWatchdogCounts(uint32_t* soft, uint32_t* hard) override;
void formatNeighborsReply(char *reply) override;
void removeNeighbor(const uint8_t* pubkey, int key_len) override;
+23
View File
@@ -3555,6 +3555,23 @@ void CommonCLI::handleSetCmd(uint32_t sender_timestamp, char* command, char* rep
} else {
strcpy(reply, "Error: state must be on or off");
}
} else if (strncmp(config, "radio.rxps.rfrx_disabled ", 25) == 0) {
const char* value = &config[25];
bool disabled;
if (strcmp(value, "on") == 0) {
disabled = true;
} else if (strcmp(value, "off") == 0) {
disabled = false;
} else {
strcpy(reply, "Error: state must be on or off");
return;
}
if (!_callbacks->setRxPowerSavingRfRxDisabled(disabled)) {
strcpy(reply, "Error: unsupported");
} else {
sprintf(reply, "OK - radio.rxps.rfrx_disabled %s", disabled ? "on" : "off");
}
} else if (memcmp(config, "radio.rxps ", 11) == 0) { // RX PowerSaving
const char* value = &config[11];
uint8_t enable = _prefs->rx_powersaving_enabled;
@@ -4423,6 +4440,12 @@ void CommonCLI::handleGetCmd(uint32_t sender_timestamp, char* command, char* rep
_callbacks->formatScheduledRadioParams(true, skipSpacesConst(&config[11]), reply);
} else if (memcmp(config, "radioat", 7) == 0 && (config[7] == 0 || config[7] == ' ')) {
_callbacks->formatScheduledRadioParams(false, skipSpacesConst(&config[7]), reply);
} else if (strcmp(config, "radio.rxps.rfrx_disabled") == 0) {
if (!_callbacks->supportsRxPowerSavingRfRxDisable()) {
strcpy(reply, "Error: unsupported");
} else {
sprintf(reply, "> %s", _callbacks->isRxPowerSavingRfRxDisabled() ? "on" : "off");
}
} else if (memcmp(config, "radio.rxps", 10) == 0) { // RX PowerSaving
ensureRxPowerSavingDefaults(&_prefs->rx_ps_rx_us, &_prefs->rx_ps_sleep_us);
sprintf(reply, "> %s,%lu,%lu", _prefs->rx_powersaving_enabled ? "on" : "off",
+7
View File
@@ -475,6 +475,13 @@ public:
return !enable;
};
virtual bool supportsRxPowerSavingRfRxDisable() const { return false; }
virtual bool setRxPowerSavingRfRxDisabled(bool disabled) {
(void)disabled;
return false;
}
virtual bool isRxPowerSavingRfRxDisabled() const { return false; }
virtual void getRxPsWatchdogCounts(uint32_t* soft, uint32_t* hard) {
*soft = 0; *hard = 0;
};
+22
View File
@@ -12,6 +12,7 @@ class CustomSX1262 : public SX1262 {
uint32_t _maxPayloadMillis = 3934;
uint32_t _activityAt = 0;
bool _headerSeen = false;
bool _rx_ps_rf_rx_disabled = false;
public:
CustomSX1262(Module *mod) : SX1262(mod) { }
@@ -134,6 +135,27 @@ class CustomSX1262 : public SX1262 {
return true; // success
}
int16_t startReceiveDutyCycle(uint32_t rxPeriod, uint32_t sleepPeriod,
RadioLibIrqFlags_t irqFlags = RADIOLIB_IRQ_RX_DEFAULT_FLAGS,
RadioLibIrqFlags_t irqMask = RADIOLIB_IRQ_RX_DEFAULT_MASK) {
int16_t state = SX1262::startReceiveDutyCycle(rxPeriod, sleepPeriod, irqFlags, irqMask);
if (state == RADIOLIB_ERR_NONE && !_rx_ps_rf_rx_disabled) {
// RadioLib stages RX duty-cycle through standby, which leaves a
// host-controlled RXEN switch in IDLE. Keep the receive path enabled
// while the SX1262 alternates between its RX and sleep windows.
this->mod->setRfSwitchState(Module::MODE_RX);
}
return state;
}
void setRxPowerSavingRfRxDisabled(bool disabled) {
_rx_ps_rf_rx_disabled = disabled;
}
bool isRxPowerSavingRfRxDisabled() const {
return _rx_ps_rf_rx_disabled;
}
// BUSY high means the chip is asleep (RX duty-cycle sleep window) or mid
// command; any SPI access would stall until the chip's next listen window.
bool isChipBusy() {
@@ -55,6 +55,29 @@ public:
bool supportsRxPowerSaving() const override { return true; }
void onReceiveProcessed() override { finishReceiveProcessing(); }
bool supportsRxPowerSavingRfRxDisable() const override {
#if defined(SX126X_RXEN)
return SX126X_RXEN != RADIOLIB_NC;
#else
return false;
#endif
}
bool setRxPowerSavingRfRxDisabled(bool disabled) override {
if (!supportsRxPowerSavingRfRxDisable()) return false;
if (_rx_ps_armed) stopReceiveDutyCycle();
((CustomSX1262 *)_radio)->setRxPowerSavingRfRxDisabled(disabled);
// Re-arm the configured receive mode immediately without disturbing an
// unread RX interrupt or an in-flight transmission.
return setRxPowerSaving(_rx_ps_enabled, _rx_ps_rx_us, _rx_ps_sleep_us);
}
bool isRxPowerSavingRfRxDisabled() const override {
return ((CustomSX1262 *)_radio)->isRxPowerSavingRfRxDisabled();
}
protected:
int startReceiveMode() override {
if (_rx_ps_armed) {
+3
View File
@@ -140,6 +140,9 @@ public:
void onSendFinished() override;
bool isInRecvMode() const override;
bool setRxPowerSaving(bool enabled, uint32_t rx_us, uint32_t sleep_us) override;
virtual bool supportsRxPowerSavingRfRxDisable() const { return false; }
virtual bool setRxPowerSavingRfRxDisabled(bool) { return false; }
virtual bool isRxPowerSavingRfRxDisabled() const { return false; }
bool isChannelActive();
bool isReceiving() override {
@@ -217,23 +217,23 @@ public:
void begin() override { }
void stop() override { }
void loop() override {
if (ublox_GNSS.getGnssFixOk(8)) {
_fix = true;
_lat = ublox_GNSS.getLatitude(2) / 10;
_lng = ublox_GNSS.getLongitude(2) / 10;
_alt = ublox_GNSS.getAltitude(2);
_sats = ublox_GNSS.getSIV(2);
} else {
_fix = false;
}
bool date_valid = ublox_GNSS.getDateValid(2);
bool time_valid = ublox_GNSS.getTimeValid(2);
_epoch = ublox_GNSS.getUnixEpoch(2);
unsigned long now = millis();
if ((long)(now - _next_time_check) >= 0) {
if ((int32_t)(now - _next_time_check) >= 0) {
_next_time_check = now + 1000;
if (ublox_GNSS.getGnssFixOk(8)) {
_fix = true;
_lat = ublox_GNSS.getLatitude(2) / 10;
_lng = ublox_GNSS.getLongitude(2) / 10;
_alt = ublox_GNSS.getAltitude(2);
_sats = ublox_GNSS.getSIV(2);
} else {
_fix = false;
}
bool date_valid = ublox_GNSS.getDateValid(2);
bool time_valid = ublox_GNSS.getTimeValid(2);
_epoch = ublox_GNSS.getUnixEpoch(2);
if (_fix && _sats >= 5 && date_valid && time_valid && _epoch > 0) {
if (_valid_time_samples < 0xFF) _valid_time_samples++;
} else {
@@ -953,8 +953,14 @@ void EnvironmentSensorManager::start_gps() {
if (gps_active) return;
gps_active = true;
#ifdef RAK_WISBLOCK_GPS
#ifdef FORCE_GPS_ALIVE
// The UART L76K has no power-save command. Keep the shared rail enabled;
// an I2C u-blox receiver can also be explicitly returned to full power.
if (i2cGPSFlag) ublox_GNSS.powerSaveMode(false);
#else
pinMode(gpsResetPin, OUTPUT);
digitalWrite(gpsResetPin, HIGH); // WB_IO2 is the shared sensor power rail
#endif
#else
_location->begin();
_location->reset();
@@ -978,7 +984,10 @@ void EnvironmentSensorManager::stop_gps() {
}
#ifdef RAK_WISBLOCK_GPS
#ifndef FORCE_GPS_ALIVE
#ifdef FORCE_GPS_ALIVE
// Keep the shared rail alive. The UART L76K cannot be put to sleep here.
if (i2cGPSFlag) ublox_GNSS.powerSaveMode(false);
#else
pinMode(gpsResetPin, OUTPUT);
digitalWrite(gpsResetPin, LOW); // WB_IO2
#endif
+21
View File
@@ -447,6 +447,15 @@ build_flags =
${env:heltec_v4_companion_radio_usb_femon.build_flags}
-D RADIO_FEM_RXGAIN=0 ; undefined (default on), 1=on, 0=off
[env:heltec_v4_companion_radio_usb]
extends = env:heltec_v4_companion_radio_usb_femon
[env:heltec_v4_companion_radio_usb_ps_femon]
extends = env:heltec_v4_companion_radio_usb_femon
[env:heltec_v4_companion_radio_usb_ps_femoff]
extends = env:heltec_v4_3_companion_radio_usb_femoff
[env:heltec_v4_companion_radio_ble_femon]
extends = heltec_v4_oled
build_flags =
@@ -477,6 +486,15 @@ build_flags =
${env:heltec_v4_companion_radio_ble_femon.build_flags}
-D RADIO_FEM_RXGAIN=0 ; undefined (default on), 1=on, 0=off
[env:heltec_v4_companion_radio_ble]
extends = env:heltec_v4_companion_radio_ble_femon
[env:heltec_v4_companion_radio_ble_ps_femon]
extends = env:heltec_v4_companion_radio_ble_femon
[env:heltec_v4_3_companion_radio_ble_ps_femoff]
extends = env:heltec_v4_3_companion_radio_ble_femoff
[env:heltec_v4_companion_radio_wifi_femon]
extends = heltec_v4_oled
build_flags =
@@ -705,6 +723,9 @@ build_flags =
${env:heltec_v4_expansionkit_tft_companion_radio_ble_femon.build_flags}
-D RADIO_FEM_RXGAIN=0 ; undefined (default on), 1=on, 0=off
[env:heltec_v4_expansionkit_tft_companion_radio_ble_ps]
extends = env:heltec_v4_expansionkit_tft_companion_radio_ble_femon
[env:heltec_v4_tft_companion_radio_wifi_femon]
extends = heltec_v4_tft
build_flags =
+3
View File
@@ -170,6 +170,9 @@ lib_deps =
${heltec_v4_r8_oled.lib_deps}
densaugeo/base64 @ ~1.4.0
[env:heltec_v4_r8_companion_radio_ble_ps]
extends = env:heltec_v4_r8_companion_radio_ble
[env:heltec_v4_r8_companion_radio_wifi]
extends = heltec_v4_r8_oled
build_flags =
+1
View File
@@ -15,6 +15,7 @@ build_flags = ${nrf52_base.build_flags}
-D MOTA_HW_ID='"RAK4631"' ; OTA hardware tag (apply refuses a .mota for different hw)
-D PIN_BOARD_SCL=14
-D PIN_BOARD_SDA=13
; -D FORCE_GPS_ALIVE // Do not off WB_IO2 if we want to keep other sensor / IO slots on
-D PIN_GPS_EN=-1
-D PIN_OLED_RESET=-1
-D USE_SX1262