Cleaned up some code

Author: hjd1964

SmartHandController.ino

@@ -115,33 +115,32 @@ void setup(void) {
   #if DEBUG == PROFILER
     tasks.add(142, 0, true, 7, profiler, "Profilr");
   #endif
-  
-    // start any plugins
-#if PLUGIN1 != OFF
-  PLUGIN1.init();
-#endif
-#if PLUGIN2 != OFF
-  PLUGIN2.init();
-#endif
-#if PLUGIN3 != OFF
-  PLUGIN3.init();
-#endif
-#if PLUGIN4 != OFF
-  PLUGIN4.init();
-#endif
-#if PLUGIN5 != OFF
-  PLUGIN5.init();
-#endif
-#if PLUGIN6 != OFF
-  PLUGIN6.init();
-#endif
-#if PLUGIN7 != OFF
-  PLUGIN7.init();
-#endif
-#if PLUGIN8 != OFF
-  PLUGIN8.init();
-#endif
 
+  // start any plugins
+  #if PLUGIN1 != OFF
+    PLUGIN1.init();
+  #endif
+  #if PLUGIN2 != OFF
+    PLUGIN2.init();
+  #endif
+  #if PLUGIN3 != OFF
+    PLUGIN3.init();
+  #endif
+  #if PLUGIN4 != OFF
+    PLUGIN4.init();
+  #endif
+  #if PLUGIN5 != OFF
+    PLUGIN5.init();
+  #endif
+  #if PLUGIN6 != OFF
+    PLUGIN6.init();
+  #endif
+  #if PLUGIN7 != OFF
+    PLUGIN7.init();
+  #endif
+  #if PLUGIN8 != OFF
+    PLUGIN8.init();
+  #endif
 
   VLF("MSG: Starting UI loop");
 }

src/plugins/Plugins.config.h

@@ -1,49 +1,41 @@
 /* ---------------------------------------------------------------------------------------------------------------------------------
- * User plugins for OnStepX
+ * User plugins for the SmartHandController (OnStep) project.
  *
  * For each entery below one must specify the class instance name and #include the class header file.
  *
  * Each plugin should have a directory that contains all of its files, which gets dropped into to the /src/plugins directory.
  * The plugin main class instance name should match the directory name.
- * The plugin main class must have a "void init();" method for OnStepX to call when it starts up.
+ * The plugin main class must have a "void init();" method for the SmartHandController to call when it starts up.
  * 
  * ---------------------------------------------------------------------------------------------------------------------------------
 */
 
 // =================================================================================================================================
 
+#define PLUGIN1                       OFF //    OFF, Specify the class instance (same as plugin directory name) to enable.    Option
+//#include "plugin1/Name.h"               //         Specify the header file to include the class.
+
 // *** Comment out PLUGIN1 above AND uncomment the following two lines to enable the sample plugin ***
 //#define PLUGIN1                    sample //    OFF, Specify the class instance (same as plugin directory name) to enable.    Option
 //#include "sample/Sample.h"                //         Specify the header file to include the class.
 
-#define PLUGIN1                       OFF //    OFF, Specify the class instance (same as plugin directory name) to enable.    Option
-//#include "website/Website.h"            //         Specify the header file to include the class.
-#define PLUGIN1_COMMAND_PROCESSING    OFF //    OFF, Set to ON for plugins that allow command processing
-
 #define PLUGIN2                       OFF //    OFF, Specify the class instance (same as plugin directory name) to enable.    Option
-//#include "power/Power.h"                //         Specify the header file to include the class.
-#define PLUGIN2_COMMAND_PROCESSING    OFF //    OFF, Set to ON for plugins that allow command processing
+//#include "plugin2/Name.h"               //         Specify the header file to include the class.
 
 #define PLUGIN3                       OFF //    OFF, Specify the class instance (same as plugin directory name) to enable.    Option
 //#include "plugin3/Name.h"               //         Specify the header file to include the class.
-#define PLUGIN3_COMMAND_PROCESSING    OFF //    OFF, Set to ON for plugins that allow command processing
 
 #define PLUGIN4                       OFF //    OFF, Specify the class instance (same as plugin directory name) to enable.    Option
 //#include "plugin4/Name.h"               //         Specify the header file to include the class.
-#define PLUGIN4_COMMAND_PROCESSING    OFF //    OFF, Set to ON for plugins that allow command processing
 
 #define PLUGIN5                       OFF //    OFF, Specify the class instance (same as plugin directory name) to enable.    Option
 //#include "plugin5/Name.h"               //         Specify the header file to include the class.
-#define PLUGIN5_COMMAND_PROCESSING    OFF //    OFF, Set to ON for plugins that allow command processing
 
 #define PLUGIN6                       OFF //    OFF, Specify the class instance (same as plugin directory name) to enable.    Option
 //#include "plugin6/Name.h"               //         Specify the header file to include the class.
-#define PLUGIN6_COMMAND_PROCESSING    OFF //    OFF, Set to ON for plugins that allow command processing
 
 #define PLUGIN7                       OFF //    OFF, Specify the class instance (same as plugin directory name) to enable.    Option
 //#include "plugin7/Name.h"               //         Specify the header file to include the class.
-#define PLUGIN7_COMMAND_PROCESSING    OFF //    OFF, Set to ON for plugins that allow command processing
 
 #define PLUGIN8                       OFF //    OFF, Specify the class instance (same as plugin directory name) to enable.    Option
 //#include "plugin8/Name.h"               //         Specify the header file to include the class.
-#define PLUGIN8_COMMAND_PROCESSING    OFF //    OFF, Set to ON for plugins that allow command processing

src/plugins/Sample/Sample.cpp

@@ -0,0 +1,21 @@
+// Sample plugin
+
+#include "Sample.h"
+#include "../../Common.h"
+#include "../../lib/tasks/OnTask.h"
+
+void sampleWrapper() { sample.loop(); }
+
+void Sample::init() {
+  VLF("MSG: Plugins, starting: sample");
+
+  // start a task that runs twice a second, run at priority level 7 so we can block
+  // using tasks.yield(); fairly aggressively without significant impact on operation
+  tasks.add(2000, 0, true, 7, sampleWrapper);
+}
+
+void Sample::loop() {
+  Serial.println("Hello from the sample plugin!");
+}
+
+Sample sample;

src/plugins/Sample/Sample.h

@@ -0,0 +1,15 @@
+// Sample plugin
+#pragma once
+
+class Sample {
+public:
+  // the initialization method must be present and named: void init();
+  void init();
+
+  void loop();
+
+private:
+
+};
+
+extern Sample sample;