Add generic thread module (#5484)

* compiling, untested

* use INCLUDE not EXLUDE for option to include module

* protobuf update

* working genericthread module

Update protobufs

* use EXCLUDE style instead of INCLUDE

* Update Modules.cpp

---------

Co-authored-by: Ben Meadors <benmmeadors@gmail.com>

platformio.ini

@@ -50,6 +50,7 @@ build_flags = -Wno-missing-field-initializers
 	-DMESHTASTIC_EXCLUDE_REMOTEHARDWARE=1
 	-DMESHTASTIC_EXCLUDE_HEALTH_TELEMETRY=1
   	-DMESHTASTIC_EXCLUDE_POWERSTRESS=1 ; exclude power stress test module from main firmware
+	-DMESHTASTIC_EXCLUDE_GENERIC_THREAD_MODULE=1
         #-DBUILD_EPOCH=$UNIX_TIME
         #-D OLED_PL=1
 

src/modules/GenericThreadModule.cpp

@@ -0,0 +1,28 @@
+#include "GenericThreadModule.h"
+#include "MeshService.h"
+#include "configuration.h"
+#include <Arduino.h>
+
+/*
+Generic Thread Module allows for the execution of custom code at a set interval.
+*/
+GenericThreadModule *genericThreadModule;
+
+GenericThreadModule::GenericThreadModule() : concurrency::OSThread("GenericThreadModule") {}
+
+int32_t GenericThreadModule::runOnce()
+{
+
+    bool enabled = true;
+    if (!enabled)
+        return disable();
+
+    if (firstTime) {
+        // do something the first time we run
+        firstTime = 0;
+        LOG_INFO("first time GenericThread running");
+    }
+
+    LOG_INFO("GenericThread executing");
+    return (my_interval);
+}

src/modules/GenericThreadModule.h

@@ -0,0 +1,21 @@
+#pragma once
+
+#include "MeshModule.h"
+#include "concurrency/OSThread.h"
+#include "configuration.h"
+#include <Arduino.h>
+#include <functional>
+
+class GenericThreadModule : private concurrency::OSThread
+{
+    bool firstTime = 1;
+
+  public:
+    GenericThreadModule();
+
+  protected:
+    unsigned int my_interval = 10000; // interval in millisconds
+    virtual int32_t runOnce() override;
+};
+
+extern GenericThreadModule *genericThreadModule;

src/modules/Modules.cpp

@@ -65,6 +65,10 @@
 #if HAS_TELEMETRY && !MESHTASTIC_EXCLUDE_POWER_TELEMETRY
 #include "modules/Telemetry/PowerTelemetry.h"
 #endif
+#if !MESHTASTIC_EXCLUDE_GENERIC_THREAD_MODULE
+#include "modules/GenericThreadModule.h"
+#endif
+
 #ifdef ARCH_ESP32
 #if defined(USE_SX1280) && !MESHTASTIC_EXCLUDE_AUDIO
 #include "modules/esp32/AudioModule.h"
@@ -131,6 +135,9 @@ void setupModules()
 
 #if !MESHTASTIC_EXCLUDE_DROPZONE
         dropzoneModule = new DropzoneModule();
+#endif
+#if !MESHTASTIC_EXCLUDE_GENERIC_THREAD_MODULE
+        new GenericThreadModule();
 #endif
         // Note: if the rest of meshtastic doesn't need to explicitly use your module, you do not need to assign the instance
         // to a global variable.
@@ -249,4 +256,4 @@ void setupModules()
     // NOTE! This module must be added LAST because it likes to check for replies from other modules and avoid sending extra
     // acks
     routingModule = new RoutingModule();
-}
+}