Clean up SerilaiInputHandler (#281)

* Clean up SerialInputHandler

* Pass isAutomated to command handlers

* Ignore non-printable characters in command

* Implement custom SerialBuffer instead of std::string

* Update formatting

.clang-format

@@ -71,7 +71,7 @@ AllowAllParametersOfDeclarationOnNextLine: false
 AllowShortBlocksOnASingleLine: Always
 AllowShortCaseLabelsOnASingleLine: false
 AllowShortEnumsOnASingleLine: false
-AllowShortFunctionsOnASingleLine: Inline
+AllowShortFunctionsOnASingleLine: InlineOnly
 AllowShortIfStatementsOnASingleLine: WithoutElse
 AllowShortLambdasOnASingleLine: Inline
 AllowShortLoopsOnASingleLine: true
@@ -97,7 +97,7 @@ BraceWrapping:
   BeforeLambdaBody: false
   BeforeWhile: false
   IndentBraces: false
-  SplitEmptyFunction: false
+  SplitEmptyFunction: true
   SplitEmptyRecord: true
   SplitEmptyNamespace: true
 BreakAfterAttributes: Never
@@ -137,7 +137,7 @@ LambdaBodyIndentation: OuterScope
 MaxEmptyLinesToKeep: 1
 NamespaceIndentation: All
 PPIndentWidth: -1
-PackConstructorInitializers: NextLine
+PackConstructorInitializers: Never
 
 PointerAlignment: Left
 ReferenceAlignment: Left

include/serial/SerialInputHandler.h

@@ -6,6 +6,9 @@ namespace OpenShock::SerialInputHandler {
   [[nodiscard]] bool Init();
   void Update();
 
+  bool SerialEchoEnabled();
+  void SetSerialEchoEnabled(bool enabled);
+
   void PrintWelcomeHeader();
   void PrintVersionInfo();
 }  // namespace OpenShock::SerialInputHandler

include/serial/command_handlers/CommandEntry.h

@@ -0,0 +1,55 @@
+#pragma once
+
+#include <string_view>
+#include <vector>
+
+namespace OpenShock::Serial {
+  typedef void (*CommandHandler)(std::string_view arg, bool isAutomated);
+
+  class CommandArgument {
+  public:
+    std::string_view name;
+    std::string_view constraint;
+    std::string_view exampleValue;
+    std::vector<std::string_view> constraintExtensions;
+  };
+
+  class CommandEntry {
+  public:
+    CommandEntry(std::string_view description, CommandHandler commandHandler);
+    CommandEntry(std::string_view name, std::string_view description, CommandHandler commandHandler);
+
+    inline std::string_view name() const { return m_name; }
+    inline std::string_view description() const { return m_description; }
+    inline const std::vector<CommandArgument>& arguments() const { return m_arguments; }
+    inline const CommandHandler commandHandler() const { return m_commandHandler; }
+
+    CommandArgument& addArgument(std::string_view name, std::string_view constraint, std::string_view exampleValue, std::vector<std::string_view> constraintExtensions = {});
+
+  private:
+    std::string_view m_name;
+    std::string_view m_description;
+    std::vector<CommandArgument> m_arguments;
+    CommandHandler m_commandHandler;
+  };
+
+  class CommandGroup {
+  public:
+    CommandGroup() = default;
+    CommandGroup(std::string_view name);
+    CommandGroup(CommandGroup&& other)                 = default;
+    CommandGroup(const CommandGroup& other)            = default;
+    CommandGroup& operator=(CommandGroup&& other)      = default;
+    CommandGroup& operator=(const CommandGroup& other) = default;
+
+    inline std::string_view name() const { return m_name; }
+    inline const std::vector<CommandEntry>& commands() const { return m_commands; }
+
+    CommandEntry& addCommand(std::string_view description, CommandHandler commandHandler);
+    CommandEntry& addCommand(std::string_view name, std::string_view description, CommandHandler commandHandler);
+
+  private:
+    std::string_view m_name;
+    std::vector<CommandEntry> m_commands;
+  };
+}  // namespace OpenShock::Serial

include/serial/command_handlers/common.h

@@ -0,0 +1,14 @@
+#pragma once
+
+#include "serial/command_handlers/index.h"
+
+#include "Logging.h"
+
+#include <Arduino.h>
+
+#define SERPR_SYS(format, ...)      ::Serial.printf("$SYS$|" format "\n", ##__VA_ARGS__)
+#define SERPR_RESPONSE(format, ...) SERPR_SYS("Response|" format, ##__VA_ARGS__)
+#define SERPR_SUCCESS(format, ...)  SERPR_SYS("Success|" format, ##__VA_ARGS__)
+#define SERPR_ERROR(format, ...)    SERPR_SYS("Error|" format, ##__VA_ARGS__)
+
+using namespace std::string_view_literals;

include/serial/command_handlers/index.h

@@ -0,0 +1,47 @@
+#pragma once
+
+#include "serial/command_handlers/CommandEntry.h"
+
+#include <vector>
+
+namespace OpenShock::Serial::CommandHandlers {
+  OpenShock::Serial::CommandGroup VersionHandler();
+  OpenShock::Serial::CommandGroup RestartHandler();
+  OpenShock::Serial::CommandGroup SysInfoHandler();
+  OpenShock::Serial::CommandGroup EchoHandler();
+  OpenShock::Serial::CommandGroup ValidGpiosHandler();
+  OpenShock::Serial::CommandGroup RfTxPinHandler();
+  OpenShock::Serial::CommandGroup ESStopPinHandler();
+  OpenShock::Serial::CommandGroup DomainHandler();
+  OpenShock::Serial::CommandGroup AuthTokenHandler();
+  OpenShock::Serial::CommandGroup LcgOverrideHandler();
+  OpenShock::Serial::CommandGroup HostnameHandler();
+  OpenShock::Serial::CommandGroup NetworksHandler();
+  OpenShock::Serial::CommandGroup KeepAliveHandler();
+  OpenShock::Serial::CommandGroup JsonConfigHandler();
+  OpenShock::Serial::CommandGroup RawConfigHandler();
+  OpenShock::Serial::CommandGroup RfTransmitHandler();
+  OpenShock::Serial::CommandGroup FactoryResetHandler();
+
+  inline std::vector<OpenShock::Serial::CommandGroup> AllCommandHandlers() {
+    return {
+      VersionHandler(),
+      RestartHandler(),
+      SysInfoHandler(),
+      EchoHandler(),
+      ValidGpiosHandler(),
+      RfTxPinHandler(),
+      ESStopPinHandler(),
+      DomainHandler(),
+      AuthTokenHandler(),
+      LcgOverrideHandler(),
+      HostnameHandler(),
+      NetworksHandler(),
+      KeepAliveHandler(),
+      JsonConfigHandler(),
+      RawConfigHandler(),
+      RfTransmitHandler(),
+      FactoryResetHandler(),
+    };
+  }
+}  // namespace OpenShock::Serial::CommandHandlers

src/main.cpp

@@ -83,7 +83,7 @@ void appSetup() {
 
 // Arduino setup function
 void setup() {
-  Serial.begin(115'200);
+  ::Serial.begin(115'200);
 
   OpenShock::Config::Init();
   OpenShock::OtaUpdateManager::Init();