Merge develop into main (#167)

- WiFi Connect app is now hidden by default, but accessible at the bottom of the WiFi Manage app when WiFi is turned on.
- WiFi service now turns on WiFi when calling connect() and WiFi is not on.
- Removed `blocking` option for `service::loader::startApp()`. This feature was unused and complex.
- Various apps: Moved private headers into Private/ folder.
- Various apps: created start() function for easy starting.
- Added documentation to all TactilityC APIs
- Refactored various `enum` into `class enum`
- Refactor M5Stack `initBoot()` (but VBus is still 0V for some reason)

Tactility/Source/app/wificonnect/Bindings.h

@@ -1,14 +0,0 @@
-#pragma once
-
-#include "service/wifi/WifiSettings.h"
-
-namespace tt::app::wificonnect {
-
-typedef void (*OnConnectSsid)(const service::wifi::settings::WifiApSettings* settings, bool store, void* context);
-
-typedef struct {
-    OnConnectSsid onConnectSsid;
-    void* onConnectSsidContext;
-} Bindings;
-
-} // namespace

Tactility/Source/app/wificonnect/Parameters.h

@@ -1,4 +0,0 @@
-#pragma once
-
-#define WIFI_CONNECT_PARAM_SSID "ssid" // String
-#define WIFI_CONNECT_PARAM_PASSWORD "password" // String

Tactility/Source/app/wificonnect/State.cpp

@@ -1,4 +1,4 @@
-#include "State.h"
+#include "app/wificonnect/State.h"
 #include "Check.h"
 #include <cstring>
 

Tactility/Source/app/wificonnect/State.h

@@ -1,32 +0,0 @@
-#pragma once
-
-#include "Mutex.h"
-#include "service/wifi/Wifi.h"
-#include "service/wifi/WifiSettings.h"
-
-namespace tt::app::wificonnect {
-
-class State {
-    Mutex lock;
-    service::wifi::settings::WifiApSettings apSettings = {
-        .ssid = { 0 },
-        .password = { 0 },
-        .auto_connect = false
-    };
-    bool connectionError = false;
-    bool connecting = false;
-public:
-
-    void setConnectionError(bool error);
-    bool hasConnectionError() const;
-
-    const service::wifi::settings::WifiApSettings& lockApSettings();
-    void unlockApSettings();
-
-    void setApSettings(const service::wifi::settings::WifiApSettings* newSettings);
-
-    void setConnecting(bool isConnecting);
-    bool isConnecting() const;
-};
-
-} // namespace

Tactility/Source/app/wificonnect/View.cpp

@@ -1,6 +1,5 @@
-#include "View.h"
-#include "State.h"
-#include "Parameters.h"
+#include "app/wificonnect/View.h"
+#include "app/wificonnect/WifiConnectPrivate.h"
 #include "WifiConnect.h"
 
 #include "lvgl.h"
@@ -186,19 +185,19 @@ void View::init(AppContext& app, lv_obj_t* parent) {
     createBottomButtons(wrapper);
 
     // Keyboard bindings
-        service::gui::keyboardAddTextArea(ssid_textarea);
-        service::gui::keyboardAddTextArea(password_textarea);
+    service::gui::keyboardAddTextArea(ssid_textarea);
+    service::gui::keyboardAddTextArea(password_textarea);
 
     // Init from app parameters
     auto bundle = app.getParameters();
     if (bundle != nullptr) {
         std::string ssid;
-        if (bundle->optString(WIFI_CONNECT_PARAM_SSID, ssid)) {
+        if (optSsidParameter(bundle, ssid)) {
             lv_textarea_set_text(ssid_textarea, ssid.c_str());
         }
 
         std::string password;
-        if (bundle->optString(WIFI_CONNECT_PARAM_PASSWORD, password)) {
+        if (optPasswordParameter(bundle, ssid)) {
             lv_textarea_set_text(password_textarea, password.c_str());
         }
     }

Tactility/Source/app/wificonnect/View.h

@@ -1,46 +0,0 @@
-#pragma once
-
-#include "Bindings.h"
-#include "State.h"
-
-#include "app/AppContext.h"
-#include "lvgl.h"
-
-namespace tt::app::wificonnect {
-
-class WifiConnect;
-
-class View {
-
-private:
-
-    Bindings* bindings;
-    State* state;
-
-public:
-
-    lv_obj_t* ssid_textarea = nullptr;
-    lv_obj_t* ssid_error = nullptr;
-    lv_obj_t* password_textarea = nullptr;
-    lv_obj_t* password_error = nullptr;
-    lv_obj_t* connect_button = nullptr;
-    lv_obj_t* remember_switch = nullptr;
-    lv_obj_t* connecting_spinner = nullptr;
-    lv_obj_t* connection_error = nullptr;
-    lv_group_t* group = nullptr;
-
-    View(Bindings* bindings, State* state) :
-        bindings(bindings),
-        state(state)
-    {}
-
-    void init(AppContext& app, lv_obj_t* parent);
-    void update();
-
-    void createBottomButtons(lv_obj_t* parent);
-    void setLoading(bool loading);
-    void resetErrors();
-};
-
-
-} // namespace

Tactility/Source/app/wificonnect/WifiConnect.cpp

@@ -1,4 +1,4 @@
-#include "WifiConnect.h"
+#include "app/wificonnect/WifiConnectPrivate.h"
 
 #include "app/AppContext.h"
 #include "TactilityCore.h"
@@ -9,6 +9,8 @@
 namespace tt::app::wificonnect {
 
 #define TAG "wifi_connect"
+#define WIFI_CONNECT_PARAM_SSID "ssid" // String
+#define WIFI_CONNECT_PARAM_PASSWORD "password" // String
 
 extern const AppManifest manifest;
 
@@ -23,18 +25,18 @@ std::shared_ptr<WifiConnect> _Nullable optWifiConnect() {
 }
 
 static void eventCallback(const void* message, void* context) {
-    auto* event = static_cast<const service::wifi::WifiEvent*>(message);
+    auto* event = static_cast<const service::wifi::Event*>(message);
     auto* wifi = static_cast<WifiConnect*>(context);
     State& state = wifi->getState();
     switch (event->type) {
-        case service::wifi::WifiEventTypeConnectionFailed:
+        case service::wifi::EventType::ConnectionFailed:
             if (state.isConnecting()) {
                 state.setConnecting(false);
                 state.setConnectionError(true);
                 wifi->requestViewUpdate();
             }
             break;
-        case service::wifi::WifiEventTypeConnectionSuccess:
+        case service::wifi::EventType::ConnectionSuccess:
             if (wifi->getState().isConnecting()) {
                 state.setConnecting(false);
                 service::loader::stopApp();
@@ -123,10 +125,25 @@ extern const AppManifest manifest = {
     .id = "WifiConnect",
     .name = "Wi-Fi Connect",
     .icon = LV_SYMBOL_WIFI,
-    .type = TypeSettings,
+    .type = TypeHidden,
     .onStart = &onStart,
     .onShow = &onShow,
     .onHide = &onHide
 };
 
+void start(const std::string& ssid, const std::string& password) {
+    auto parameters = std::make_shared<Bundle>();
+    parameters->putString(WIFI_CONNECT_PARAM_SSID, ssid);
+    parameters->putString(WIFI_CONNECT_PARAM_PASSWORD, password);
+    service::loader::startApp(manifest.id, parameters);
+}
+
+bool optSsidParameter(const std::shared_ptr<const Bundle>& bundle, std::string& ssid) {
+    return bundle->optString(WIFI_CONNECT_PARAM_SSID, ssid);
+}
+
+bool optPasswordParameter(const std::shared_ptr<const Bundle>& bundle, std::string& password) {
+    return bundle->optString(WIFI_CONNECT_PARAM_PASSWORD, password);
+}
+
 } // namespace

Tactility/Source/app/wificonnect/WifiConnect.h

@@ -1,48 +1,12 @@
 #pragma once
 
-#include "Bindings.h"
-#include "State.h"
-#include "View.h"
-
-#include "Mutex.h"
-#include "service/wifi/Wifi.h"
+#include <string>
 
 namespace tt::app::wificonnect {
 
-class WifiConnect {
-    Mutex mutex;
-    State state;
-    Bindings bindings = {
-        .onConnectSsid = nullptr,
-        .onConnectSsidContext = nullptr
-    };
-    View view = View(&bindings, &state);
-    PubSubSubscription* wifiSubscription;
-    bool view_enabled = false;
-
-public:
-
-    WifiConnect();
-    ~WifiConnect();
-
-    void lock();
-    void unlock();
-
-    void onShow(AppContext& app, lv_obj_t* parent);
-    void onHide(AppContext& app);
-
-    State& getState() { return state; }
-    Bindings& getBindings() { return bindings; }
-    View& getView() { return view; }
-
-
-    void requestViewUpdate();
-};
-
-void lock(WifiConnect* wifi);
-
-void unlock(WifiConnect* wifi);
-
-void view_update(WifiConnect* wifi);
+/**
+ * Start the app with optional pre-filled fields.
+ */
+void start(const std::string& ssid = "", const std::string& password = "");
 
 } // namespace