Rename LED_PIN to LED_POWER, move handling out of main to dedicated module (#9512)

* Rename LED_PIN to LED_POWER, move handling out of main to dedicated module

* Misc

* Remove errant endif

src/Led.cpp

@@ -1,66 +0,0 @@
-#include "Led.h"
-#include "PowerMon.h"
-#include "main.h"
-#include "power.h"
-
-GpioVirtPin ledForceOn, ledBlink;
-
-#if defined(LED_PIN)
-// Most boards have a GPIO for LED control
-static GpioHwPin ledRawHwPin(LED_PIN);
-#else
-static GpioVirtPin ledRawHwPin; // Dummy pin for no hardware
-#endif
-
-#if LED_STATE_ON == 0
-static GpioVirtPin ledHwPin;
-static GpioNotTransformer ledInverter(&ledHwPin, &ledRawHwPin);
-#else
-static GpioPin &ledHwPin = ledRawHwPin;
-#endif
-
-#if defined(HAS_PMU)
-/**
- * A GPIO controlled by the PMU
- */
-class GpioPmuPin : public GpioPin
-{
-  public:
-    void set(bool value)
-    {
-        if (pmu_found && PMU) {
-            // blink the axp led
-            PMU->setChargingLedMode(value ? XPOWERS_CHG_LED_ON : XPOWERS_CHG_LED_OFF);
-        }
-    }
-} ledPmuHwPin;
-
-// In some cases we need to drive a PMU LED and a normal LED
-static GpioSplitter ledFinalPin(&ledHwPin, &ledPmuHwPin);
-#else
-static GpioPin &ledFinalPin = ledHwPin;
-#endif
-
-#ifdef USE_POWERMON
-/**
- * We monitor changes to the LED drive output because we use that as a sanity test in our power monitor stuff.
- */
-class MonitoredLedPin : public GpioPin
-{
-  public:
-    void set(bool value)
-    {
-        if (powerMon) {
-            if (value)
-                powerMon->setState(meshtastic_PowerMon_State_LED_On);
-            else
-                powerMon->clearState(meshtastic_PowerMon_State_LED_On);
-        }
-        ledFinalPin.set(value);
-    }
-} monitoredLedPin;
-#else
-static GpioPin &monitoredLedPin = ledFinalPin;
-#endif
-
-static GpioBinaryTransformer ledForcer(&ledForceOn, &ledBlink, &monitoredLedPin, GpioBinaryTransformer::Or);

src/Led.h

@@ -1,7 +0,0 @@
-#include "GpioLogic.h"
-#include "configuration.h"
-
-/**
- * ledForceOn and ledForceOff both override the normal ledBlinker behavior (which is controlled by main)
- */
-extern GpioVirtPin ledForceOn, ledBlink;

src/PowerFSM.cpp

@@ -9,13 +9,13 @@
  */
 #include "PowerFSM.h"
 #include "Default.h"
-#include "Led.h"
 #include "MeshService.h"
 #include "NodeDB.h"
 #include "PowerMon.h"
 #include "configuration.h"
 #include "graphics/Screen.h"
 #include "main.h"
+#include "modules/StatusLEDModule.h"
 #include "sleep.h"
 #include "target_specific.h"
 
@@ -103,7 +103,7 @@ static void lsIdle()
             uint32_t sleepTime = SLEEP_TIME;
 
             powerMon->setState(meshtastic_PowerMon_State_CPU_LightSleep);
-            ledBlink.set(false); // Never leave led on while in light sleep
+            statusLEDModule->setPowerLED(false);
             esp_sleep_source_t wakeCause2 = doLightSleep(sleepTime * 1000LL);
             powerMon->clearState(meshtastic_PowerMon_State_CPU_LightSleep);
 
@@ -111,7 +111,7 @@ static void lsIdle()
             case ESP_SLEEP_WAKEUP_TIMER:
                 // Normal case: timer expired, we should just go back to sleep ASAP
 
-                ledBlink.set(true);             // briefly turn on led
+                statusLEDModule->setPowerLED(true);
                 wakeCause2 = doLightSleep(100); // leave led on for 1ms
 
                 secsSlept += sleepTime;
@@ -146,7 +146,7 @@ static void lsIdle()
         }
     } else {
         // Time to stop sleeping!
-        ledBlink.set(false);
+        statusLEDModule->setPowerLED(false);
         LOG_INFO("Reached ls_secs, service loop()");
         powerFSM.trigger(EVENT_WAKE_TIMER);
     }

src/main.cpp

@@ -14,7 +14,6 @@
 #include "power/PowerHAL.h"
 
 #include "FSCommon.h"
-#include "Led.h"
 #include "RTC.h"
 #include "SPILock.h"
 #include "Throttle.h"
@@ -245,26 +244,8 @@ const char *getDeviceName()
     return name;
 }
 
-// TODO remove from main.cpp
-static int32_t ledBlinker()
-{
-    // Still set up the blinking (heartbeat) interval but skip code path below, so LED will blink if
-    // config.device.led_heartbeat_disabled is changed
-    if (config.device.led_heartbeat_disabled)
-        return 1000;
-
-    static bool ledOn;
-    ledOn ^= 1;
-
-    ledBlink.set(ledOn);
-
-    // have a very sparse duty cycle of LED being on, unless charging, then blink 0.5Hz square wave rate to indicate that
-    return powerStatus->getIsCharging() ? 1000 : (ledOn ? 1 : 1000);
-}
-
 uint32_t timeLastPowered = 0;
 
-static Periodic *ledPeriodic;
 static OSThread *powerFSMthread;
 static OSThread *ambientLightingThread;
 
@@ -302,21 +283,16 @@ void earlyInitVariant() {}
 // blink user led in 3 flashes sequence to indicate what is happening
 void waitUntilPowerLevelSafe()
 {
-
-#ifdef LED_PIN
-    pinMode(LED_PIN, OUTPUT);
-#endif
-
     while (powerHAL_isPowerLevelSafe() == false) {
 
-#ifdef LED_PIN
+#ifdef LED_POWER
 
         // 3x: blink for 300 ms, pause for 300 ms
 
         for (int i = 0; i < 3; i++) {
-            digitalWrite(LED_PIN, LED_STATE_ON);
+            digitalWrite(LED_POWER, LED_STATE_ON);
             delay(300);
-            digitalWrite(LED_PIN, LED_STATE_OFF);
+            digitalWrite(LED_POWER, LED_STATE_OFF);
             delay(300);
         }
 #endif
@@ -340,6 +316,11 @@ void setup()
     // initialize power HAL layer as early as possible
     powerHAL_init();
 
+#ifdef LED_POWER
+    pinMode(LED_POWER, OUTPUT);
+    digitalWrite(LED_POWER, LED_STATE_ON);
+#endif
+
     // prevent booting if device is in power failure mode
     // boot sequence will follow when battery level raises to safe mode
     waitUntilPowerLevelSafe();
@@ -352,11 +333,6 @@ void setup()
     digitalWrite(PIN_POWER_EN, HIGH);
 #endif
 
-#ifdef LED_POWER
-    pinMode(LED_POWER, OUTPUT);
-    digitalWrite(LED_POWER, LED_STATE_ON);
-#endif
-
 #ifdef LED_NOTIFICATION
     pinMode(LED_NOTIFICATION, OUTPUT);
     digitalWrite(LED_NOTIFICATION, HIGH ^ LED_STATE_ON);
@@ -487,16 +463,6 @@ void setup()
 
     OSThread::setup();
 
-    // TODO make this ifdef based on defined pins and move from main.cpp
-#if defined(ELECROW_ThinkNode_M1) || defined(ELECROW_ThinkNode_M2)
-    // The ThinkNodes have their own blink logic
-    // ledPeriodic = new Periodic("Blink", elecrowLedBlinker);
-#else
-
-    ledPeriodic = new Periodic("Blink", ledBlinker);
-
-#endif
-
     fsInit();
 
 #if !MESHTASTIC_EXCLUDE_I2C
@@ -721,13 +687,6 @@ void setup()
     setupSDCard();
 #endif
 
-    // LED init
-
-#ifdef LED_PIN
-    pinMode(LED_PIN, OUTPUT);
-    digitalWrite(LED_PIN, LED_STATE_ON); // turn on for now
-#endif
-
     // Hello
     printInfo();
 #ifdef BUILD_EPOCH
@@ -961,12 +920,6 @@ void setup()
     setupNicheGraphics();
 #endif
 
-#ifdef LED_PIN
-    // Turn LED off after boot, if heartbeat by config
-    if (config.device.led_heartbeat_disabled)
-        digitalWrite(LED_PIN, HIGH ^ LED_STATE_ON);
-#endif
-
 // Do this after service.init (because that clears error_code)
 #ifdef HAS_PMU
     if (!pmu_found)

src/mesh/http/ContentHandler.cpp

@@ -9,7 +9,6 @@
 #if HAS_WIFI
 #include "mesh/wifi/WiFiAPClient.h"
 #endif
-#include "Led.h"
 #include "SPILock.h"
 #include "power.h"
 #include "serialization/JSON.h"
@@ -92,7 +91,6 @@ void registerHandlers(HTTPServer *insecureServer, HTTPSServer *secureServer)
     ResourceNode *nodeFormUpload = new ResourceNode("/upload", "POST", &handleFormUpload);
 
     ResourceNode *nodeJsonScanNetworks = new ResourceNode("/json/scanNetworks", "GET", &handleScanNetworks);
-    ResourceNode *nodeJsonBlinkLED = new ResourceNode("/json/blink", "POST", &handleBlinkLED);
     ResourceNode *nodeJsonReport = new ResourceNode("/json/report", "GET", &handleReport);
     ResourceNode *nodeJsonNodes = new ResourceNode("/json/nodes", "GET", &handleNodes);
     ResourceNode *nodeJsonFsBrowseStatic = new ResourceNode("/json/fs/browse/static", "GET", &handleFsBrowseStatic);
@@ -110,7 +108,6 @@ void registerHandlers(HTTPServer *insecureServer, HTTPSServer *secureServer)
     secureServer->registerNode(nodeRestart);
     secureServer->registerNode(nodeFormUpload);
     secureServer->registerNode(nodeJsonScanNetworks);
-    secureServer->registerNode(nodeJsonBlinkLED);
     secureServer->registerNode(nodeJsonFsBrowseStatic);
     secureServer->registerNode(nodeJsonDelete);
     secureServer->registerNode(nodeJsonReport);
@@ -133,7 +130,6 @@ void registerHandlers(HTTPServer *insecureServer, HTTPSServer *secureServer)
     insecureServer->registerNode(nodeRestart);
     insecureServer->registerNode(nodeFormUpload);
     insecureServer->registerNode(nodeJsonScanNetworks);
-    insecureServer->registerNode(nodeJsonBlinkLED);
     insecureServer->registerNode(nodeJsonFsBrowseStatic);
     insecureServer->registerNode(nodeJsonDelete);
     insecureServer->registerNode(nodeJsonReport);
@@ -904,45 +900,6 @@ void handleRestart(HTTPRequest *req, HTTPResponse *res)
     webServerThread->requestRestart = (millis() / 1000) + 5;
 }
 
-void handleBlinkLED(HTTPRequest *req, HTTPResponse *res)
-{
-    res->setHeader("Content-Type", "application/json");
-    res->setHeader("Access-Control-Allow-Origin", "*");
-    res->setHeader("Access-Control-Allow-Methods", "POST");
-
-    ResourceParameters *params = req->getParams();
-    std::string blink_target;
-
-    if (!params->getQueryParameter("blink_target", blink_target)) {
-        // if no blink_target was supplied in the URL parameters of the
-        // POST request, then assume we should blink the LED
-        blink_target = "LED";
-    }
-
-    if (blink_target == "LED") {
-        uint8_t count = 10;
-        while (count > 0) {
-            ledBlink.set(true);
-            delay(50);
-            ledBlink.set(false);
-            delay(50);
-            count = count - 1;
-        }
-    } else {
-#if HAS_SCREEN
-        if (screen)
-            screen->blink();
-#endif
-    }
-
-    JSONObject jsonObjOuter;
-    jsonObjOuter["status"] = new JSONValue("ok");
-    JSONValue *value = new JSONValue(jsonObjOuter);
-    std::string jsonString = value->Stringify();
-    res->print(jsonString.c_str());
-    delete value;
-}
-
 void handleScanNetworks(HTTPRequest *req, HTTPResponse *res)
 {
     res->setHeader("Content-Type", "application/json");

src/mesh/http/ContentHandler.h

@@ -11,7 +11,6 @@ void handleFormUpload(HTTPRequest *req, HTTPResponse *res);
 void handleScanNetworks(HTTPRequest *req, HTTPResponse *res);
 void handleFsBrowseStatic(HTTPRequest *req, HTTPResponse *res);
 void handleFsDeleteStatic(HTTPRequest *req, HTTPResponse *res);
-void handleBlinkLED(HTTPRequest *req, HTTPResponse *res);
 void handleReport(HTTPRequest *req, HTTPResponse *res);
 void handleNodes(HTTPRequest *req, HTTPResponse *res);
 void handleUpdateFs(HTTPRequest *req, HTTPResponse *res);

src/modules/AdminModule.cpp

@@ -643,12 +643,6 @@ void AdminModule::handleSetConfig(const meshtastic_Config &c)
             accelerometerThread->enabled = true;
             accelerometerThread->start();
         }
-#endif
-#ifdef LED_PIN
-        // Turn LED off if heartbeat by config
-        if (c.payload_variant.device.led_heartbeat_disabled) {
-            digitalWrite(LED_PIN, HIGH ^ LED_STATE_ON);
-        }
 #endif
         if (config.device.button_gpio == c.payload_variant.device.button_gpio &&
             config.device.buzzer_gpio == c.payload_variant.device.buzzer_gpio &&

src/modules/Modules.cpp

@@ -1,9 +1,9 @@
 #include "configuration.h"
 #if !MESHTASTIC_EXCLUDE_INPUTBROKER
 #include "buzz/BuzzerFeedbackThread.h"
-#include "modules/StatusLEDModule.h"
 #include "modules/SystemCommandsModule.h"
 #endif
+#include "modules/StatusLEDModule.h"
 #if !MESHTASTIC_EXCLUDE_REPLYBOT
 #include "ReplyBotModule.h"
 #endif
@@ -112,9 +112,7 @@ void setupModules()
         buzzerFeedbackThread = new BuzzerFeedbackThread();
     }
 #endif
-#if defined(LED_CHARGE) || defined(LED_PAIRING)
     statusLEDModule = new StatusLEDModule();
-#endif
 #if !MESHTASTIC_EXCLUDE_REPLYBOT
     new ReplyBotModule();
 #endif

src/modules/PowerStressModule.cpp

@@ -1,5 +1,4 @@
 #include "PowerStressModule.h"
-#include "Led.h"
 #include "MeshService.h"
 #include "NodeDB.h"
 #include "PowerMon.h"
@@ -78,10 +77,12 @@ int32_t PowerStressModule::runOnce()
 
             switch (p.cmd) {
             case meshtastic_PowerStressMessage_Opcode_LED_ON:
-                ledForceOn.set(true);
+                // FIXME - implement
+                // ledForceOn.set(true);
                 break;
             case meshtastic_PowerStressMessage_Opcode_LED_OFF:
-                ledForceOn.set(false);
+                // FIXME - implement
+                // ledForceOn.set(false);
                 break;
             case meshtastic_PowerStressMessage_Opcode_GPS_ON:
                 // FIXME - implement

src/modules/StatusLEDModule.cpp

@@ -13,8 +13,10 @@ StatusLEDModule::StatusLEDModule() : concurrency::OSThread("StatusLEDModule")
 {
     bluetoothStatusObserver.observe(&bluetoothStatus->onNewStatus);
     powerStatusObserver.observe(&powerStatus->onNewStatus);
+#if !MESHTASTIC_EXCLUDE_INPUTBROKER
     if (inputBroker)
         inputObserver.observe(inputBroker);
+#endif
 }
 
 int StatusLEDModule::handleStatusUpdate(const meshtastic::Status *arg)
@@ -62,19 +64,22 @@ int StatusLEDModule::handleStatusUpdate(const meshtastic::Status *arg)
     }
     return 0;
 };
-
+#if !MESHTASTIC_EXCLUDE_INPUTBROKER
 int StatusLEDModule::handleInputEvent(const InputEvent *event)
 {
     lastUserbuttonTime = millis();
     return 0;
 }
+#endif
 
 int32_t StatusLEDModule::runOnce()
 {
     my_interval = 1000;
 
     if (power_state == charging) {
+#ifndef POWER_LED_HARDWARE_BLINKS_WHILE_CHARGING
         CHARGE_LED_state = !CHARGE_LED_state;
+#endif
     } else if (power_state == charged) {
         CHARGE_LED_state = LED_STATE_ON;
     } else if (power_state == critical) {
@@ -94,7 +99,15 @@ int32_t StatusLEDModule::runOnce()
         }
 
     } else {
-        CHARGE_LED_state = LED_STATE_OFF;
+        if (doing_fast_blink) {
+            CHARGE_LED_state = LED_STATE_OFF;
+            doing_fast_blink = false;
+            my_interval = 999;
+        } else {
+            CHARGE_LED_state = LED_STATE_ON;
+            doing_fast_blink = true;
+            my_interval = 1;
+        }
     }
 
     if (!config.bluetooth.enabled || PAIRING_LED_starttime + 30 * 1000 < millis() || doing_fast_blink) {
@@ -112,6 +125,11 @@ int32_t StatusLEDModule::runOnce()
         PAIRING_LED_state = LED_STATE_ON;
     }
 
+    // Override if disabled in config
+    if (config.device.led_heartbeat_disabled) {
+        CHARGE_LED_state = LED_STATE_OFF;
+    }
+#ifdef Battery_LED_1
     bool chargeIndicatorLED1 = LED_STATE_OFF;
     bool chargeIndicatorLED2 = LED_STATE_OFF;
     bool chargeIndicatorLED3 = LED_STATE_OFF;
@@ -126,9 +144,23 @@ int32_t StatusLEDModule::runOnce()
         if (powerStatus && powerStatus->getBatteryChargePercent() >= 75)
             chargeIndicatorLED4 = LED_STATE_ON;
     }
+#endif
 
-#ifdef LED_CHARGE
-    digitalWrite(LED_CHARGE, CHARGE_LED_state);
+#if defined(HAS_PMU)
+    if (pmu_found && PMU) {
+        // blink the axp led
+        PMU->setChargingLedMode(CHARGE_LED_state ? XPOWERS_CHG_LED_ON : XPOWERS_CHG_LED_OFF);
+    }
+#endif
+
+#ifdef PCA_LED_POWER
+    io.digitalWrite(PCA_LED_POWER, CHARGE_LED_state);
+#endif
+#ifdef PCA_LED_ENABLE
+    io.digitalWrite(PCA_LED_ENABLE, CHARGE_LED_state);
+#endif
+#ifdef LED_POWER
+    digitalWrite(LED_POWER, CHARGE_LED_state);
 #endif
 #ifdef LED_PAIRING
     digitalWrite(LED_PAIRING, PAIRING_LED_state);
@@ -149,3 +181,43 @@ int32_t StatusLEDModule::runOnce()
 
     return (my_interval);
 }
+
+void StatusLEDModule::setPowerLED(bool LEDon)
+{
+
+#if defined(HAS_PMU)
+    if (pmu_found && PMU) {
+        // blink the axp led
+        PMU->setChargingLedMode(LEDon ? XPOWERS_CHG_LED_ON : XPOWERS_CHG_LED_OFF);
+    }
+#endif
+    if (LEDon)
+        LEDon = LED_STATE_ON;
+    else
+        LEDon = LED_STATE_OFF;
+#ifdef PCA_LED_POWER
+    io.digitalWrite(PCA_LED_POWER, LEDon);
+#endif
+#ifdef PCA_LED_ENABLE
+    io.digitalWrite(PCA_LED_ENABLE, LEDon);
+#endif
+#ifdef LED_POWER
+    digitalWrite(LED_POWER, LEDon);
+#endif
+#ifdef LED_PAIRING
+    digitalWrite(LED_PAIRING, LEDon);
+#endif
+
+#ifdef Battery_LED_1
+    digitalWrite(Battery_LED_1, LEDon);
+#endif
+#ifdef Battery_LED_2
+    digitalWrite(Battery_LED_2, LEDon);
+#endif
+#ifdef Battery_LED_3
+    digitalWrite(Battery_LED_3, LEDon);
+#endif
+#ifdef Battery_LED_4
+    digitalWrite(Battery_LED_4, LEDon);
+#endif
+}

src/modules/StatusLEDModule.h

@@ -5,10 +5,14 @@
 #include "PowerStatus.h"
 #include "concurrency/OSThread.h"
 #include "configuration.h"
-#include "input/InputBroker.h"
+#include "main.h"
 #include <Arduino.h>
 #include <functional>
 
+#if !MESHTASTIC_EXCLUDE_INPUTBROKER
+#include "input/InputBroker.h"
+#endif
+
 class StatusLEDModule : private concurrency::OSThread
 {
     bool slowTrack = false;
@@ -17,8 +21,11 @@ class StatusLEDModule : private concurrency::OSThread
     StatusLEDModule();
 
     int handleStatusUpdate(const meshtastic::Status *);
-
+#if !MESHTASTIC_EXCLUDE_INPUTBROKER
     int handleInputEvent(const InputEvent *arg);
+#endif
+
+    void setPowerLED(bool);
 
   protected:
     unsigned int my_interval = 1000; // interval in millisconds
@@ -28,8 +35,10 @@ class StatusLEDModule : private concurrency::OSThread
         CallbackObserver<StatusLEDModule, const meshtastic::Status *>(this, &StatusLEDModule::handleStatusUpdate);
     CallbackObserver<StatusLEDModule, const meshtastic::Status *> powerStatusObserver =
         CallbackObserver<StatusLEDModule, const meshtastic::Status *>(this, &StatusLEDModule::handleStatusUpdate);
+#if !MESHTASTIC_EXCLUDE_INPUTBROKER
     CallbackObserver<StatusLEDModule, const InputEvent *> inputObserver =
         CallbackObserver<StatusLEDModule, const InputEvent *>(this, &StatusLEDModule::handleInputEvent);
+#endif
 
   private:
     bool CHARGE_LED_state = LED_STATE_OFF;

src/platform/nrf52/architecture.h

@@ -158,7 +158,7 @@
 #endif
 
 #ifdef PIN_LED1
-#define LED_PIN PIN_LED1 // LED1 on nrf52840-DK
+#define LED_POWER PIN_LED1 // LED1 on nrf52840-DK
 #endif
 
 #ifdef PIN_BUTTON1

src/sleep.cpp

@@ -5,7 +5,6 @@
 #endif
 
 #include "Default.h"
-#include "Led.h"
 #include "MeshRadio.h"
 #include "MeshService.h"
 #include "NodeDB.h"
@@ -13,6 +12,7 @@
 #include "detect/LoRaRadioType.h"
 #include "error.h"
 #include "main.h"
+#include "modules/StatusLEDModule.h"
 #include "sleep.h"
 #include "target_specific.h"
 
@@ -268,8 +268,7 @@ void doDeepSleep(uint32_t msecToWake, bool skipPreflight = false, bool skipSaveN
     digitalWrite(PIN_WD_EN, LOW);
 #endif
 #endif
-    ledBlink.set(false);
-
+    statusLEDModule->setPowerLED(false);
 #ifdef RESET_OLED
     digitalWrite(RESET_OLED, 1); // put the display in reset before killing its power
 #endif