Rework WiFi AP network configuration

Author: dshil

components/ocs_pipeline/CMakeLists.txt

@@ -35,6 +35,7 @@ idf_component_register(
     "network/local_network_json_pipeline.cpp"
 
     "config/mdns_config.cpp"
+    "config/ap_network_config.cpp"
 
     REQUIRES
     "spiffs"

components/ocs_pipeline/config/ap_network_config.cpp

@@ -0,0 +1,71 @@
+/*
+ * Copyright (c) 2025, Open Control Systems authors
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+#include <cstring>
+
+#include "ocs_algo/storage_ops.h"
+#include "ocs_core/log.h"
+#include "ocs_pipeline/config/ap_network_config.h"
+#include "ocs_status/code_to_str.h"
+
+namespace ocs {
+namespace pipeline {
+namespace config {
+
+namespace {
+
+const char* log_tag = "ap_network_config";
+
+} // namespace
+
+ApNetworkConfig::ApNetworkConfig(storage::IStorage& storage,
+                                 const system::DeviceInfo& device_info) {
+    memset(ssid_, 0, sizeof(ssid_));
+    memset(password_, 0, sizeof(password_));
+
+    std::string builtin_ssid = device_info.get_fw_name();
+    builtin_ssid += "-";
+    builtin_ssid += device_info.get_device_id();
+
+    strncpy(ssid_, builtin_ssid.c_str(), sizeof(ssid_));
+
+    const auto code = algo::StorageOps::prob_read(storage, password_key_, password_,
+                                                  max_password_size_);
+    if (code != status::StatusCode::OK) {
+        if (code != status::StatusCode::NoData) {
+            ocs_loge(log_tag, "failed to read WiFi AP password from storage: %s",
+                     status::code_to_str(code));
+        }
+
+        std::string builtin_password = device_info.get_fw_name();
+        builtin_password += "-";
+        builtin_password += std::string(device_info.get_device_id(), 7);
+
+        strncpy(password_, builtin_password.c_str(), sizeof(password_));
+    }
+}
+
+const char* ApNetworkConfig::get_ssid() const {
+    return ssid_;
+}
+
+const char* ApNetworkConfig::get_password() const {
+    return password_;
+}
+
+uint8_t ApNetworkConfig::get_channel() const {
+    return CONFIG_OCS_NETWORK_WIFI_AP_CHANNEL;
+}
+
+uint8_t ApNetworkConfig::get_max_conn() const {
+    return CONFIG_OCS_NETWORK_WIFI_AP_MAX_CONN;
+}
+
+} // namespace config
+} // namespace pipeline
+} // namespace ocs

components/ocs_pipeline/config/ap_network_config.h

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2025, Open Control Systems authors
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+#pragma once
+
+#include "ocs_core/noncopyable.h"
+#include "ocs_storage/istorage.h"
+#include "ocs_system/device_info.h"
+
+namespace ocs {
+namespace pipeline {
+namespace config {
+
+class ApNetworkConfig : public core::NonCopyable<> {
+public:
+    //! Initialize.
+    //!
+    //! @params
+    //!  - @p storage to persist WiFi AP configuration.
+    //!  - @p device_info to use as a fallback for WiFi AP configuration.
+    ApNetworkConfig(storage::IStorage& storage, const system::DeviceInfo& device_info);
+
+    //! Return WiFi AP SSID.
+    const char* get_ssid() const;
+
+    //! Return WiFi AP password.
+    const char* get_password() const;
+
+    //! Return WiFi AP channel.
+    uint8_t get_channel() const;
+
+    //! Return the maximum number of simultaneous WiFi STA connections to WiFi AP.
+    uint8_t get_max_conn() const;
+
+private:
+    static constexpr const char* password_key_ = "net_ap_pswd";
+
+    static const unsigned max_ssid_size_ = 31;
+    static const unsigned max_password_size_ = 63;
+
+    char ssid_[max_ssid_size_ + 1];
+    char password_[max_password_size_ + 1];
+};
+
+} // namespace config
+} // namespace pipeline
+} // namespace ocs

components/ocs_pipeline/network/local_network_json_pipeline.cpp

@@ -16,12 +16,10 @@ namespace pipeline {
 namespace network {
 
 LocalNetworkJsonPipeline::LocalNetworkJsonPipeline(
-    storage::StorageBuilder& storage_builder,
     net::INetworkHandler& handler,
     fmt::json::FanoutFormatter& registraton_formatter,
-    const system::DeviceInfo& device_info) {
-    network_pipeline_.reset(
-        new (std::nothrow) LocalNetworkPipeline(storage_builder, handler, device_info));
+    const config::ApNetworkConfig& config) {
+    network_pipeline_.reset(new (std::nothrow) LocalNetworkPipeline(handler, config));
     configASSERT(network_pipeline_);
 
     network_formatter_.reset(

components/ocs_pipeline/network/local_network_json_pipeline.h

@@ -12,9 +12,9 @@
 
 #include "ocs_core/noncopyable.h"
 #include "ocs_fmt/json/fanout_formatter.h"
+#include "ocs_pipeline/config/ap_network_config.h"
 #include "ocs_pipeline/network/local_network_pipeline.h"
 #include "ocs_status/code.h"
-#include "ocs_storage/storage_builder.h"
 #include "ocs_system/device_info.h"
 
 namespace ocs {
@@ -26,14 +26,12 @@ class LocalNetworkJsonPipeline : public core::NonCopyable<> {
     //! Initialize.
     //!
     //! @params
-    //!  - @p storage_builder to register storages for WiFi AP.
     //!  - @p handler to notify about network connection status.
     //!  - @p registraton_formatter to format network characteristics.
-    //!  - @p device_info to create a unique SSID for WiFi AP.
-    LocalNetworkJsonPipeline(storage::StorageBuilder& storage_builder,
-                             net::INetworkHandler& handler,
+    //!  - @p config to read network settings.
+    LocalNetworkJsonPipeline(net::INetworkHandler& handler,
                              fmt::json::FanoutFormatter& registraton_formatter,
-                             const system::DeviceInfo& device_info);
+                             const config::ApNetworkConfig& config);
 
     LocalNetworkPipeline& get_network_pipeline();
 

components/ocs_pipeline/network/local_network_pipeline.cpp

@@ -9,8 +9,6 @@
 #include <cstring>
 #include <string>
 
-#include "freertos/FreeRTOSConfig.h"
-
 #include "ocs_algo/storage_ops.h"
 #include "ocs_core/log.h"
 #include "ocs_net/ap_network.h"
@@ -28,13 +26,16 @@ const char* log_tag = "local_network_pipeline";
 
 } // namespace
 
-LocalNetworkPipeline::LocalNetworkPipeline(storage::StorageBuilder& storage_builder,
-                                           net::INetworkHandler& handler,
-                                           const system::DeviceInfo& device_info) {
-    storage_ = storage_builder.make("net_local_wifi");
-    configASSERT(storage_);
-
-    initialize_network_(handler, device_info);
+LocalNetworkPipeline::LocalNetworkPipeline(net::INetworkHandler& handler,
+                                           const config::ApNetworkConfig& config) {
+    network_.reset(new (std::nothrow)
+                       net::ApNetwork(handler,
+                                      net::ApNetwork::Params {
+                                          .ssid = config.get_ssid(),
+                                          .password = config.get_password(),
+                                          .channel = config.get_channel(),
+                                          .max_connection = config.get_max_conn(),
+                                      }));
 }
 
 net::IApNetwork& LocalNetworkPipeline::get_network() {
@@ -53,45 +54,6 @@ status::StatusCode LocalNetworkPipeline::start() {
     return code;
 }
 
-void LocalNetworkPipeline::initialize_network_(net::INetworkHandler& handler,
-                                               const system::DeviceInfo& device_info) {
-    char ssid[max_ssid_size_ + 1];
-    memset(ssid, 0, sizeof(ssid));
-
-    std::string builtin_ssid = device_info.get_fw_name();
-    builtin_ssid += "-";
-    builtin_ssid += device_info.get_device_id();
-
-    strncpy(ssid, builtin_ssid.c_str(), sizeof(ssid));
-
-    char password[max_password_size_ + 1];
-    memset(password, 0, sizeof(password));
-
-    const auto code = algo::StorageOps::prob_read(*storage_, "net_ap_pswd", password,
-                                                  max_password_size_);
-    if (code != status::StatusCode::OK) {
-        if (code != status::StatusCode::NoData) {
-            ocs_loge(log_tag, "failed to read WiFi AP password from storage: %s",
-                     status::code_to_str(code));
-        }
-
-        std::string builtin_password = device_info.get_fw_name();
-        builtin_password += "-";
-        builtin_password += std::string(device_info.get_device_id(), 7);
-
-        strncpy(password, builtin_password.c_str(), sizeof(password));
-    }
-
-    network_.reset(new (std::nothrow) net::ApNetwork(
-        handler,
-        net::ApNetwork::Params {
-            .ssid = ssid,
-            .password = password,
-            .channel = CONFIG_OCS_NETWORK_WIFI_AP_CHANNEL,
-            .max_connection = CONFIG_OCS_NETWORK_WIFI_AP_MAX_CONN,
-        }));
-}
-
 status::StatusCode LocalNetworkPipeline::start_() {
     auto code = network_->start();
     if (code != status::StatusCode::OK) {

components/ocs_pipeline/network/local_network_pipeline.h

@@ -13,8 +13,7 @@
 #include "ocs_core/noncopyable.h"
 #include "ocs_net/ap_network.h"
 #include "ocs_net/inetwork_handler.h"
-#include "ocs_storage/storage_builder.h"
-#include "ocs_system/device_info.h"
+#include "ocs_pipeline/config/ap_network_config.h"
 
 namespace ocs {
 namespace pipeline {
@@ -26,31 +25,21 @@ class LocalNetworkPipeline : public core::NonCopyable<> {
     //! Initialize.
     //!
     //! @params
-    //!  - @p storage_builder to create storages for network configuration.
     //!  - @p handler to notify about network connection status.
-    //!  - @p device_info to create a unique access point SSID.
-    LocalNetworkPipeline(storage::StorageBuilder& storage_builder,
-                         net::INetworkHandler& handler,
-                         const system::DeviceInfo& device_info);
+    //!  - @p config to read network settings.
+    LocalNetworkPipeline(net::INetworkHandler& handler,
+                         const config::ApNetworkConfig& config);
 
     net::IApNetwork& get_network();
 
     //! Start the WiFi network.
     status::StatusCode start();
 
 private:
-    void initialize_network_(net::INetworkHandler& handler,
-                             const system::DeviceInfo& device_info);
-
     status::StatusCode start_();
 
-    static const unsigned max_ssid_size_ = 31;
-    static const unsigned max_password_size_ = 63;
-
     static const TickType_t wait_start_interval_ = pdMS_TO_TICKS(1000 * 60 * 10);
 
-    storage::StorageBuilder::IStoragePtr storage_;
-
     std::unique_ptr<net::ApNetwork> network_;
 };