Refactor OTA Update Manager

include/Common.h

@@ -21,6 +21,16 @@
 #endif
 
 #define OPENSHOCK_FW_CDN_URL(path) "https://" OPENSHOCK_FW_CDN_DOMAIN path
+#define OPENSHOCK_FW_CDN_CHANNEL_URL(ch) OPENSHOCK_FW_CDN_URL("/version-" ch ".txt")
+#define OPENSHOCK_FW_CDN_STABLE_URL  OPENSHOCK_FW_CDN_CHANNEL_URL("stable")
+#define OPENSHOCK_FW_CDN_BETA_URL    OPENSHOCK_FW_CDN_CHANNEL_URL("beta")
+#define OPENSHOCK_FW_CDN_DEVELOP_URL OPENSHOCK_FW_CDN_CHANNEL_URL("develop")
+#define OPENSHOCK_FW_CDN_BOARDS_BASE_URL_FORMAT  OPENSHOCK_FW_CDN_URL("/%s")
+#define OPENSHOCK_FW_CDN_BOARDS_INDEX_URL_FORMAT OPENSHOCK_FW_CDN_BOARDS_BASE_URL_FORMAT "/boards.txt"
+#define OPENSHOCK_FW_CDN_VERSION_BASE_URL_FORMAT OPENSHOCK_FW_CDN_BOARDS_BASE_URL_FORMAT "/" OPENSHOCK_FW_BOARD
+#define OPENSHOCK_FW_CDN_APP_URL_FORMAT           OPENSHOCK_FW_CDN_VERSION_BASE_URL_FORMAT "/app.bin"
+#define OPENSHOCK_FW_CDN_FILESYSTEM_URL_FORMAT    OPENSHOCK_FW_CDN_VERSION_BASE_URL_FORMAT "/staticfs.bin"
+#define OPENSHOCK_FW_CDN_SHA256_HASHES_URL_FORMAT OPENSHOCK_FW_CDN_VERSION_BASE_URL_FORMAT "/hashes.sha256.txt"
 
 #define OPENSHOCK_GPIO_INVALID -1
 

include/config/OtaUpdateConfig.h

@@ -2,8 +2,8 @@
 
 #include "config/ConfigBase.h"
 #include "FirmwareBootType.h"
-#include "OtaUpdateChannel.h"
-#include "OtaUpdateStep.h"
+#include "ota/OtaUpdateChannel.h"
+#include "ota/OtaUpdateStep.h"
 
 #include <string>
 

include/http/FirmwareCDN.h

@@ -0,0 +1,28 @@
+#pragma once
+
+#include "http/HTTPRequestManager.h"
+#include "ota/FirmwareBinaryHash.h"
+#include "ota/OtaUpdateChannel.h"
+#include "SemVer.h"
+
+#include <string_view>
+
+namespace OpenShock::HTTP::FirmwareCDN {
+  /// @brief Fetches the firmware version for the given channel from the firmware CDN.
+  /// Valid response codes: 200, 304
+  /// @param channel The channel to fetch the firmware version for.
+  /// @return The firmware version or an error response.
+  HTTP::Response<OpenShock::SemVer> GetFirmwareVersion(OtaUpdateChannel channel);
+
+  /// @brief Fetches the list of available boards for the given firmware version from the firmware CDN.
+  /// Valid response codes: 200, 304
+  /// @param version The firmware version to fetch the boards for.
+  /// @return The list of available boards or an error response.
+  HTTP::Response<std::vector<std::string>> GetFirmwareBoards(const OpenShock::SemVer& version);
+
+  /// @brief Fetches the binary hashes for the given firmware version from the firmware CDN.
+  /// Valid response codes: 200, 304
+  /// @param version The firmware version to fetch the binary hashes for.
+  /// @return The binary hashes or an error response.
+  HTTP::Response<std::vector<FirmwareBinaryHash>> GetFirmwareBinaryHashes(const OpenShock::SemVer& version);
+}  // namespace OpenShock::HTTP::FirmwareCDN

include/ota/FirmwareBinaryHash.h

@@ -0,0 +1,13 @@
+#pragma once
+
+#include <cstdint>
+#include <string>
+
+namespace OpenShock
+{
+  struct FirmwareBinaryHash
+  {
+    std::string name;
+    uint8_t hash[32];
+  };
+} // namespace OpenShock

include/ota/FirmwareReleaseInfo.h

@@ -0,0 +1,14 @@
+#pragma once
+
+#include <cstdint>
+#include <string>
+
+namespace OpenShock
+{
+  struct FirmwareReleaseInfo {
+    std::string appBinaryUrl;
+    uint8_t appBinaryHash[32];
+    std::string filesystemBinaryUrl;
+    uint8_t filesystemBinaryHash[32];
+  };
+} // namespace OpenShock

include/ota/OtaUpdateClient.h

@@ -0,0 +1,20 @@
+#pragma once
+
+#include "SemVer.h"
+
+#include <freertos/task.h>
+
+namespace OpenShock {
+  class OtaUpdateClient {
+  public:
+    OtaUpdateClient(const OpenShock::SemVer& version);
+    ~OtaUpdateClient();
+
+    bool Start();
+  private:
+    void _task();
+
+    OpenShock::SemVer m_version;
+    TaskHandle_t m_taskHandle;
+  };
+}

include/OtaUpdateManager.h → include/ota/OtaUpdateManager.h

@@ -1,6 +1,7 @@
 #pragma once
 
 #include "FirmwareBootType.h"
+#include "FirmwareReleaseInfo.h"
 #include "OtaUpdateChannel.h"
 #include "SemVer.h"
 
@@ -12,16 +13,7 @@
 namespace OpenShock::OtaUpdateManager {
   [[nodiscard]] bool Init();
 
-  struct FirmwareRelease {
-    std::string appBinaryUrl;
-    uint8_t appBinaryHash[32];
-    std::string filesystemBinaryUrl;
-    uint8_t filesystemBinaryHash[32];
-  };
-
-  bool TryGetFirmwareVersion(OtaUpdateChannel channel, OpenShock::SemVer& version);
-  bool TryGetFirmwareBoards(const OpenShock::SemVer& version, std::vector<std::string>& boards);
-  bool TryGetFirmwareRelease(const OpenShock::SemVer& version, FirmwareRelease& release);
+  bool TryGetFirmwareRelease(const OpenShock::SemVer& version, FirmwareReleaseInfo& release);
 
   bool TryStartFirmwareInstallation(const OpenShock::SemVer& version);
 

src/GatewayClient.cpp

@@ -6,7 +6,7 @@ const char* const TAG = "GatewayClient";
 #include "config/Config.h"
 #include "event_handlers/WebSocket.h"
 #include "Logging.h"
-#include "OtaUpdateManager.h"
+#include "ota/OtaUpdateManager.h"
 #include "serialization/WSGateway.h"
 #include "Time.h"
 #include "util/CertificateUtils.h"