(#206): API version is now printed out, leveraged const for methods

Author: TheBakedPotato

Firmware/GPAD_API/GPAD_API/GPAD_HAL.cpp

@@ -28,8 +28,6 @@
 
 using namespace gpad_hal;
 
-GPAD_HAL gpadHal(SemanticVersion(0, 1, 0));
-
 extern IPAddress myIP;
 
 // Use Serial1 for UART communication
@@ -481,7 +479,8 @@ void interpretBuffer(char *buf, int rlen, Stream *serialport, PubSubClient *clie
     onInfoMsg[0] = '\0';
 
     // Report API version
-    strcat(onInfoMsg, gpadHal.getVersion().toString().c_str());
+    strcat(onInfoMsg, "GPAD API Version: ");
+    strcat(onInfoMsg, gpadApi.getVersion().toString().c_str());
     client->publish(publish_Ack_Topic, onInfoMsg);
     serialport->println(onInfoMsg);
     onInfoMsg[0] = '\0';
@@ -760,12 +759,12 @@ void annunciateAlarmLevel(Stream *serialport)
   }
 }
 
-GPAD_HAL::GPAD_HAL(SemanticVersion version)
+GPAD_API::GPAD_API(SemanticVersion version)
     : version(version)
 {
 }
 
-SemanticVersion &GPAD_HAL::getVersion()
+const SemanticVersion &GPAD_API::getVersion() const
 {
   return this->version;
 }
@@ -777,11 +776,13 @@ SemanticVersion::SemanticVersion(uint8_t major, uint8_t minor, uint8_t patch)
 {
 }
 
-std::string SemanticVersion::toString()
+std::string SemanticVersion::toString() const
 {
-  std::string versionString;
-
-  versionString.append("0.0.0");
+  std::string versionString = std::to_string(this->major);
+  versionString.push_back('.');
+  versionString.append(std::to_string(this->minor));
+  versionString.push_back('.');
+  versionString.append(std::to_string(this->patch));
 
   return versionString;
 }

Firmware/GPAD_API/GPAD_API/GPAD_HAL.h

@@ -124,6 +124,11 @@ extern HardwareSerial uartSerial1;
 
 namespace gpad_hal
 {
+
+  static const uint8_t API_MAJOR_VERSION = 0;
+  static const uint8_t API_MINOR_VERSION = 1;
+  static const uint8_t API_PATCH_VERSION = 0;
+
   enum class Command : char
   {
     MUTE = 's',
@@ -133,30 +138,42 @@ namespace gpad_hal
     INFO = 'i',
   };
 
+  /**
+   * SemanticVersion stores a version following the "semantic versioning" convention
+   * defined here: https://semver.org/
+   *
+   * In summary:
+   *  - Major version defines breaking an incompatible changes with different versions
+   *  - Minor version adds new functionality in a backwards capability
+   *    ie v2.4.1 and v2.5.1 are still compatible but v2.5.1 may have additional functionality
+   *  - Patch version simply addresses bugs with no new features again in a backwards
+   *    compatible way
+   */
   class SemanticVersion
   {
   public:
     SemanticVersion(uint8_t major, uint8_t minor, uint8_t patch);
 
-    std::string toString();
+    std::string toString() const;
 
   private:
     uint8_t major;
     uint8_t minor;
     uint8_t patch;
   };
 
-  class GPAD_HAL
+  class GPAD_API
   {
   public:
-    GPAD_HAL(SemanticVersion version);
+    GPAD_API(SemanticVersion version);
 
-    SemanticVersion &getVersion();
+    const SemanticVersion &getVersion() const;
 
   private:
-    SemanticVersion version;
+    const SemanticVersion version;
   };
 
+  const GPAD_API gpadApi = GPAD_API(SemanticVersion(API_MAJOR_VERSION, API_MINOR_VERSION, API_PATCH_VERSION));
 }
 
 // SPI Functions....