Tweak interface

include/serial/SerialInputHandler.h

@@ -8,6 +8,6 @@ namespace OpenShock::SerialInputHandler {
   bool SerialEchoEnabled();
   void SetSerialEchoEnabled(bool enabled);
 
-  void PrintWelcomeHeader();
+  void PrintBootInfo();
   void PrintVersionInfo();
 }  // namespace OpenShock::SerialInputHandler

src/serial/SerialInputHandler.cpp

@@ -59,6 +59,22 @@ using namespace std::string_view_literals;
 
 using namespace OpenShock;
 
+#define OPENSHOCK_WELCOME_HEADER_STR \
+  "\n\
+============== OPENSHOCK ==============\n\
+  Contribute @ github.com/OpenShock\n\
+  Discuss    @ discord.gg/OpenShock\n\
+  Type 'help' for available commands\n\
+=======================================\n"
+
+#define OPENSHOCK_VERSION_INFO_STR \
+  "\
+  Version:  " OPENSHOCK_FW_VERSION "\n\
+    Build:  " OPENSHOCK_FW_MODE "\n\
+   Commit:  " OPENSHOCK_FW_GIT_COMMIT "\n\
+    Board:  " OPENSHOCK_FW_BOARD "\n\
+     Chip:  " OPENSHOCK_FW_CHIP "\n"
+
 const int64_t PASTE_INTERVAL_THRESHOLD_MS       = 20;
 const std::size_t SERIAL_BUFFER_CLEAR_THRESHOLD = 512;
 
@@ -121,7 +137,7 @@ static void printCommandsHelp()
     }
   }
 
-  SerialInputHandler::PrintWelcomeHeader();
+  SerialInputHandler::PrintBootInfo();
   ::Serial.print(buffer.data());
 }
 
@@ -586,9 +602,7 @@ bool SerialInputHandler::Init()
     registerCommandHandler(handler);
   }
 
-  SerialInputHandler::PrintWelcomeHeader();
-  SerialInputHandler::PrintVersionInfo();
-  ::Serial.println();
+  SerialInputHandler::PrintBootInfo();
 
   if (!Config::GetSerialInputConfigEchoEnabled(s_echoEnabled)) {
     OS_LOGE(TAG, "Failed to get serial echo status from config");
@@ -612,24 +626,12 @@ void SerialInputHandler::SetSerialEchoEnabled(bool enabled)
   s_echoEnabled = enabled;
 }
 
-void SerialInputHandler::PrintWelcomeHeader()
+void SerialInputHandler::PrintBootInfo()
 {
-  ::Serial.print(R"(
-============== OPENSHOCK ==============
-  Contribute @ github.com/OpenShock
-  Discuss    @ discord.gg/OpenShock
-  Type 'help' for available commands
-=======================================
-)");
+  ::Serial.print(OpenShock::StringToArduinoString(OPENSHOCK_WELCOME_HEADER_STR OPENSHOCK_VERSION_INFO_STR "\n"sv));
 }
 
 void SerialInputHandler::PrintVersionInfo()
 {
-  ::Serial.print("\
-  Version:  " OPENSHOCK_FW_VERSION "\n\
-    Build:  " OPENSHOCK_FW_MODE "\n\
-   Commit:  " OPENSHOCK_FW_GIT_COMMIT "\n\
-    Board:  " OPENSHOCK_FW_BOARD "\n\
-     Chip:  " OPENSHOCK_FW_CHIP "\n\
-");
+  ::Serial.print(OpenShock::StringToArduinoString("\n" OPENSHOCK_VERSION_INFO_STR ""sv));
 }

src/serial/command_handlers/domain.cpp

@@ -75,7 +75,7 @@ OpenShock::Serial::CommandGroup OpenShock::Serial::CommandHandlers::DomainHandle
 {
   auto group = OpenShock::Serial::CommandGroup("domain"sv);
 
-  auto& getCommand = group.addCommand("get"sv, "Get the backend domain."sv, handleGet);
+  auto& getCommand = group.addCommand("Get the backend domain."sv, handleGet);
 
   auto& setCommand = group.addCommand("set"sv, "Set the backend domain."sv, handleSet);
   setCommand.addArgument("domain"sv, "must be a string"sv, "api.openshock.app"sv);

src/serial/command_handlers/echo.cpp

@@ -39,7 +39,7 @@ OpenShock::Serial::CommandGroup OpenShock::Serial::CommandHandlers::EchoHandler(
 {
   auto group = OpenShock::Serial::CommandGroup("echo"sv);
 
-  auto& getCommand = group.addCommand("get"sv, "Get the serial echo status"sv, handleGet);
+  auto& getCommand = group.addCommand("Get the serial echo status"sv, handleGet);
 
   auto& setCommand = group.addCommand("set"sv, "Enable/disable serial echo"sv, handleSet);
   setCommand.addArgument("enabled"sv, "must be a boolean"sv, "true"sv);

src/serial/command_handlers/hostname.cpp

@@ -37,7 +37,7 @@ OpenShock::Serial::CommandGroup OpenShock::Serial::CommandHandlers::HostnameHand
 {
   auto group = OpenShock::Serial::CommandGroup("hostname"sv);
 
-  auto& getCommand = group.addCommand("get"sv, "Get the network hostname."sv, handeGet);
+  auto& getCommand = group.addCommand("Get the network hostname."sv, handeGet);
 
   auto& setCommand = group.addCommand("set"sv, "Set the network hostname."sv, handleSet);
   setCommand.addArgument("hostname"sv, "must be a string"sv, "OpenShock"sv);

src/serial/command_handlers/jsonconfig.cpp

@@ -31,7 +31,7 @@ OpenShock::Serial::CommandGroup OpenShock::Serial::CommandHandlers::JsonConfigHa
 {
   auto group = OpenShock::Serial::CommandGroup("jsonconfig"sv);
 
-  auto& getCommand = group.addCommand("get"sv, "Get the configuration as JSON"sv, handleGet);
+  auto& getCommand = group.addCommand("Get the configuration as JSON"sv, handleGet);
 
   auto& setCommand = group.addCommand("set"sv, "Set the configuration from JSON, and restart"sv, handleSet);
   setCommand.addArgument("json"sv, "must be a valid JSON object"sv, "{ ... }"sv);

src/serial/command_handlers/keepalive.cpp

@@ -42,7 +42,7 @@ OpenShock::Serial::CommandGroup OpenShock::Serial::CommandHandlers::KeepAliveHan
 {
   auto group = OpenShock::Serial::CommandGroup("keepalive"sv);
 
-  auto& getCommand = group.addCommand("get"sv, "Get the shocker keep-alive status"sv, handleGet);
+  auto& getCommand = group.addCommand("Get the shocker keep-alive status"sv, handleGet);
 
   auto& setCommand = group.addCommand("set"sv, "Enable/disable shocker keep-alive"sv, handleSet);
   setCommand.addArgument("enabled"sv, "must be a boolean"sv, "true"sv);

src/serial/command_handlers/lcgoverride.cpp

@@ -90,7 +90,7 @@ OpenShock::Serial::CommandGroup OpenShock::Serial::CommandHandlers::LcgOverrideH
 {
   auto group = OpenShock::Serial::CommandGroup("lcgoverride"sv);
 
-  auto& getCommand = group.addCommand("Get the domain overridden for LCG endpoint (if any)."sv, handleGet);
+  auto& getCommand = group.addCommand("get"sv, "Get the domain overridden for LCG endpoint (if any)."sv, handleGet);
 
   auto& setCommand = group.addCommand("set"sv, "Set a domain to override the LCG endpoint."sv, handleSet);
   setCommand.addArgument("domain"sv, "must be a string"sv, "eu1-gateway.shocklink.net"sv);

src/serial/command_handlers/networks.cpp

@@ -82,7 +82,7 @@ OpenShock::Serial::CommandGroup OpenShock::Serial::CommandHandlers::NetworksHand
 {
   auto group = OpenShock::Serial::CommandGroup("networks"sv);
 
-  auto& getCommand = group.addCommand("get"sv, "Get all saved networks."sv, handleGet);
+  auto& getCommand = group.addCommand("Get all saved networks."sv, handleGet);
 
   auto& setCommand = group.addCommand("set"sv, "Set all saved networks."sv, handleSet);
   setCommand.addArgument(

src/serial/command_handlers/rawconfig.cpp

@@ -44,7 +44,7 @@ OpenShock::Serial::CommandGroup OpenShock::Serial::CommandHandlers::RawConfigHan
 {
   auto group = OpenShock::Serial::CommandGroup("rawconfig"sv);
 
-  auto& getCommand = group.addCommand("get"sv, "Get the raw binary config"sv, handleGet);
+  auto& getCommand = group.addCommand("Get the raw binary config"sv, handleGet);
 
   auto& setCommand = group.addCommand("set"sv, "Set the raw binary config, and restart"sv, handleSet);
   setCommand.addArgument("base64"sv, "must be a base64 encoded string"sv, "(base64 encoded binary data)"sv);

src/serial/command_handlers/rftxpin.cpp

@@ -49,7 +49,7 @@ OpenShock::Serial::CommandGroup OpenShock::Serial::CommandHandlers::RfTxPinHandl
 {
   auto group = OpenShock::Serial::CommandGroup("rftxpin"sv);
 
-  auto& getCommand = group.addCommand("get"sv, "Get the GPIO pin used for the radio transmitter"sv, handleGet);
+  auto& getCommand = group.addCommand("Get the GPIO pin used for the radio transmitter"sv, handleGet);
 
   auto& setCommand = group.addCommand("set"sv, "Set the GPIO pin used for the radio transmitter"sv, handleSet);
   setCommand.addArgument("pin"sv, "must be a number"sv, "15"sv);

src/serial/command_handlers/version.cpp

@@ -11,7 +11,6 @@ static void handleVersion(std::string_view arg, bool isAutomated)
     return;
   }
 
-  ::Serial.print("\n");
   OpenShock::SerialInputHandler::PrintVersionInfo();
 }