Created wifi-module

Buildscripts/release-sdk-modules.txt

@@ -7,4 +7,5 @@ http-module
 lvgl-module
 lvgl-window-manager-module
 service-module
-graphics-module
+graphics-module
+wifi-module

CMakeLists.txt

@@ -149,6 +149,7 @@ if (NOT DEFINED ENV{ESP_IDF_VERSION})
     add_subdirectory(Modules/posix-symbols-module)
     add_subdirectory(Modules/pthread-module)
     add_subdirectory(Modules/service-module)
+    add_subdirectory(Modules/wifi-module)
     add_subdirectory(Modules/app-module)
     add_subdirectory(Modules/coreutils-module)
     add_subdirectory(Modules/app-posix-module)

Documentation/ideas.md

@@ -10,7 +10,6 @@
 - coreutils apps: Only emit colour escapes when stdout is the terminal (command_support.h color() function)
 - CrashDiagnostics shouldn't show a QR when there's no callstack
 - Move USB host task stacks to SPIRAM when available: esp32_usbhost*.cpp
-- Get rid of WiFi service (Wifi.cpp/h) in Tactility.cpp
 - Add bold fonts for e-ink readability improvement
 - Improve Setup: Add keyboard/keypad navigation explanation
 - Drivers/audio-codec-module is not a module. Move it somewhere else. Or make it an actual module.
@@ -23,6 +22,7 @@
 
 ## Medium Priority
 
+- netutils-module: ping, wget, ifconfig, nslookup, etc.
 - Core2: support power off via software
 - Improve Setup: Show "Step done" screen
 - Make it more clear to end-users that an SD card is required to run Tactility

Modules/cpp-symbols-module/source/function_instantiations.cpp

@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: Apache-2.0
+#include <functional>
+
+#ifdef ESP_PLATFORM
+
+// Out-of-line definitions for the std::function<long()> members that module.cpp exports.
+// On ESP32, int32_t is long, so this is Thread::MainFunction. Nothing else is guaranteed to emit
+// these, so they are explicitly instantiated here.
+// Kept out of module.cpp: it declares these same symbols by their mangled names as extern "C".
+template long std::function<long()>::operator()() const;
+template std::function<long()>::function(const std::function<long()>&);
+
+#endif

Modules/wifi-module/CMakeLists.txt

@@ -0,0 +1,12 @@
+cmake_minimum_required(VERSION 3.20)
+
+include("${CMAKE_CURRENT_LIST_DIR}/../../Buildscripts/module.cmake")
+
+file(GLOB_RECURSE SOURCE_FILES "source/*.c*")
+
+tactility_add_module(wifi-module
+    SRCS ${SOURCE_FILES}
+    PRIV_INCLUDE_DIRS private/
+    INCLUDE_DIRS include/
+    REQUIRES TactilityKernel app-module service-module crypt-module
+)

Modules/wifi-module/LICENSE-Apache-2.0.md

@@ -0,0 +1,195 @@
+Apache License
+==============
+
+_Version 2.0, January 2004_  
+_&lt;<http://www.apache.org/licenses/>&gt;_
+
+### Terms and Conditions for use, reproduction, and distribution
+
+#### 1. Definitions
+
+“License” shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+“Licensor” shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+“Legal Entity” shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, “control” means **(i)** the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or **(ii)** ownership of fifty percent (50%) or more of the
+outstanding shares, or **(iii)** beneficial ownership of such entity.
+
+“You” (or “Your”) shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+“Source” form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+“Object” form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+“Work” shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+“Derivative Works” shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+“Contribution” shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+“submitted” means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as “Not a Contribution.”
+
+“Contributor” shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+#### 2. Grant of Copyright License
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+#### 3. Grant of Patent License
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+#### 4. Redistribution
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+* **(a)** You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+* **(b)** You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+* **(c)** You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+* **(d)** If the Work includes a “NOTICE” text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+#### 5. Submission of Contributions
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+#### 6. Trademarks
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+#### 7. Disclaimer of Warranty
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an “AS IS” BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+#### 8. Limitation of Liability
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+#### 9. Accepting Warranty or Additional Liability
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+_END OF TERMS AND CONDITIONS_
+
+### APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets `[]` replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same “printed page” as the copyright notice for easier identification within
+third-party archives.
+
+    Copyright [yyyy] [name of copyright owner]
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+

Modules/wifi-module/README.md

@@ -0,0 +1,5 @@
+# Wi-Fi Module
+
+This module contains:
+- Settings API and a commandline app to manage them.
+- Service that manages auto-connect behaviour.

Modules/wifi-module/include/wifi/module.h

@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: Apache-2.0
+#pragma once
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/** Registers and starts the Wi-Fi auto-connect service. */
+extern struct Module wifi_module;
+
+#ifdef __cplusplus
+}
+#endif

Modules/wifi-module/include/wifi/wifi_autoconnect.h

@@ -0,0 +1,16 @@
+// SPDX-License-Identifier: Apache-2.0
+#pragma once
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief Pause auto-connect until the next connection attempt finishes or the radio is turned on.
+ * Call this before a user-initiated disconnect, so auto-connect doesn't immediately reconnect.
+ */
+void wifi_autoconnect_pause_until_connected(void);
+
+#ifdef __cplusplus
+}
+#endif

Modules/wifi-module/include/wifi/wifi_settings.h

@@ -0,0 +1,82 @@
+// SPDX-License-Identifier: Apache-2.0
+#pragma once
+
+#include <stdbool.h>
+#include <stdint.h>
+
+#include <tactility/error.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/** 32 characters/octets, according to IEEE 802.11-2020 spec */
+#define WIFI_SETTINGS_SSID_LIMIT 32
+/** 64 characters/octets, according to IEEE 802.11-2020 spec */
+#define WIFI_SETTINGS_PASSWORD_LIMIT 64
+/** Default auto-connect setting for new access points */
+#define WIFI_SETTINGS_AUTO_CONNECT_DEFAULT true
+
+/** The persisted settings of an access point. */
+struct WifiApSettings {
+    char ssid[WIFI_SETTINGS_SSID_LIMIT + 1];
+    char password[WIFI_SETTINGS_PASSWORD_LIMIT + 1];
+    bool auto_connect;
+    /** The Wi-Fi channel, or 0 for any */
+    int32_t channel;
+};
+
+/**
+ * @param[in] ssid the access point to look for
+ * @return true if settings exist for the provided SSID
+ */
+bool wifi_settings_contains(const char* ssid);
+
+/**
+ * Load the settings for the provided SSID.
+ * @param[in] ssid the access point to look for
+ * @param[out] settings the loaded settings
+ * @retval ERROR_NOT_FOUND no settings exist for the SSID
+ * @retval ERROR_RESOURCE the settings could not be read or decrypted
+ * @retval ERROR_NONE on success
+ */
+error_t wifi_settings_load(const char* ssid, struct WifiApSettings* settings);
+
+/**
+ * Save the settings of an access point. The password is stored encrypted.
+ * @param[in] settings the settings to save
+ * @retval ERROR_INVALID_ARGUMENT the SSID is empty
+ * @retval ERROR_RESOURCE the settings could not be written
+ * @retval ERROR_NONE on success
+ */
+error_t wifi_settings_save(const struct WifiApSettings* settings);
+
+/**
+ * Remove settings that were saved previously.
+ * @param[in] ssid the access point to remove the settings for
+ * @retval ERROR_NOT_FOUND no settings exist for the SSID
+ * @retval ERROR_RESOURCE the settings could not be removed
+ * @retval ERROR_NONE on success
+ */
+error_t wifi_settings_remove(const char* ssid);
+
+/**
+ * Iterate over the SSIDs of all saved access points.
+ * @param[in] context passed through to on_ssid, can be NULL
+ * @param[in] on_ssid called once per saved access point, return false to stop iterating
+ */
+void wifi_settings_for_each(void* context, bool (*on_ssid)(const char* ssid, void* context));
+
+/**
+ * @param[in] enable whether to turn on the radio when booting
+ * @retval ERROR_RESOURCE the setting could not be written
+ * @retval ERROR_NONE on success
+ */
+error_t wifi_settings_set_enable_on_boot(bool enable);
+
+/** @return true when the radio should be turned on when booting */
+bool wifi_settings_get_enable_on_boot(void);
+
+#ifdef __cplusplus
+}
+#endif