Differences

This shows you the differences between two versions of the page.

--- gsoc:2023-gsoc-zephyr [2023/02/12 14:43]
cfriedt Change project to #2
+++ gsoc:2023-gsoc-zephyr [2023/03/27 11:59] (current)
IulianaProdan
@@ Line 32: / Line 32: @@
 **To be updated**
-==== Project #1   Arduino module based on Zephyr ====
+==== Project #1   HTTP Server Implementation ====
 contributor full-size (350 hours).
-Arduino's popularity is renowned as a popular framework for providing a simplified interface to program embedded devices. Recently, Arduino adopted mbed OS as the base RTOS for some of their newer devices. With that work, they separated out [[https://github.com/arduino/ArduinoCore-API|Arduino Core]] as an independent abstraction layer from [[https://github.com/arduino/ArduinoCore-mbed|Arduino Core for mbed]]. This opens up the possibility for leveraging Arduino Core on other OSes.
+Zephyr has historically incorporated the [[https://github.com/civetweb/civetweb|CivetWeb]] embedded HTTP server. However, Zephyr's CivetWeb module was [[https://github.com/zephyrproject-rtos/zephyr/pull/46061|deprecated]] and subsequently module [[https://github.com/zephyrproject-rtos/zephyr/pull/46746|removed]] due to complications of maintaining a fork of a 3rd-party project in an external module.
-The project idea is to create a Zephyr module that leverages the Arduino Core so that a developer can use Zephyr as the underlying OS when they use the Arduino framework on Arduino-compatible devices. The benefits to the user include:
+The project has specified many desired features for a new, fully-integrated, and in-tree [[https://github.com/zephyrproject-rtos/zephyr/issues/46758|replacement for CivetWeb]]. The proposed design will be able to take advantage of Zephyr's many existing building blocks.
-  * Access to Arduino APIs as well as advanced Zephyr capabilities
+  * [[https://docs.zephyrproject.org/latest/develop/test/ztest.html|ZTest Framework]]
-  * Broader set of devices than the standard Arduino ecosystem thanks to Zephyrs' device support
+  * [[https://docs.zephyrproject.org/latest/connectivity/networking/api/http.html|HTTP]], [[https://docs.zephyrproject.org/latest/connectivity/networking/api/websocket.html|WebSocket]], [[https://docs.zephyrproject.org/latest/services/misc.html#json|JSON]], and [[https://github.com/zephyrproject-rtos/mbedtls|mbedTLS]] libraries
-  * Ability to re-use Arduino tools like the Arduino IDE and wealth of libraries
+  * [[https://docs.zephyrproject.org/latest/services/portability/posix.html|POSIX API]] support for socket, threads, and filesystem operations
+  * [[https://docs.zephyrproject.org/latest/build/kconfig/index.html|Kconfig]] and [[https://docs.zephyrproject.org/latest/build/cmake/index.html|Build System]] to fine-tune built-in server options
+  * [[https://docs.zephyrproject.org/latest/kernel/iterable_sections/index.html|Iterable Section]] support, for flexible specification of HTTP services and resources
-Note 1: Arduino Core is licensed under the GNU Lesser General Public License and Zephyr is licensed under Apache 2. That means this project will most likely need to be developed out of tree and in a separate repo to keep code and license separation.
+{{ :gsoc:gsoc-2023-httpd.png?400 | HTTP Server Layers}}
-See [[https://github.com/zephyrproject-rtos/zephyr/issues/22247|#22247]] for a historic discussion & [[https://github.com/soburi/arduino-on-zephyr|soburi/arduino-on-zephyr]] for an earlier attempt prior to the Arduino Core architecture.
-The contributor's task is thus:
+An API layer diagram of the project is above. The GSoC contributor is responsible for the items shown in Grey. Please see GitHub links for full details.
-  * Implement a bare-bones Module based on Arduino Core that can compile for any target (no functionality, possibly in QEMU)
+The goal of the GSoC project is the following:
-  * Implement a common peripheral from the Arduino API based on Zephyr such as [[https://www.arduino.cc/reference/en/language/functions/communication/serial/|Serial]]
-  * Target one physical board, such as the Arduino Zero
-Difficulty: Medium
+  * Prototype the basic HTTP 2.0 server using POSIX APIs (complexity analysis, instrumentation & telemetry, performance benchmarks)
+  * Port the basic HTTP server to Zephyr (initial Kconfig, tests, samples, documentation)
+  * Test Plan and Tests to demonstrate 3 mandatory features: REST API, TLS, and Compressed Resources in Memory (CRiMe)
+  * Test Plan and Tests to demonstrate 1 feature from: JSON support, Filesystem support, Web-based Dashboard, or OAuth
+  * Generate test coverage reports using the [[https://docs.zephyrproject.org/latest/guides/test/ztest.html|Zephyr Test Framework]]
+  * Demonstrate HTTP server functionality with one of Zephyr's many [[https://docs.zephyrproject.org/latest/boards/index.html|supported boards]] or [[https://docs.zephyrproject.org/latest/guides/networking/qemu_user_setup.html|Qemu]]
-Skill Required: Zephyr RTOS, C++, Arduino
+The successful candidate must be able to demonstrate writing a simple socket-based program in C that presents a "Hello, world!" web page to the user with a WireShark capture of the network traffic between the client and host.
-Mentors: Jonathan Beri - CEO of Golioth and Zephyr TSC (jberi AT golioth.io), Alvaro Viebrantz - founding engineer and Google GDE (alvaro AT golioth.io)
-Code License: LGPL
+Candidates must ensure that they have made a clear choice which feature they have chosen to implement (JSON support, Filesystem support, Web-based Dashboard, or OAuth) and explain how that feature would benefit the community.
+Difficulty: High.
+Mentors:
+  * Chris Friedt - SWE / ASIC FW at Meta (cfriedt AT meta.com) - POSIX API Maintainer
+  * Robert Lubos - SWE at Nordic Semiconductor (Robert.lubos AT nordicsemi.no) - Network Subsystem Maintainer
+Skills that are Required: Zephyr RTOS,C,CXX,Python,WireShark
+Code License: Apache 2.0.
 ==== Project #2 Implement a driver for Audio NXP Platform Driver in Zephyr ====
+contributor full-size (350 hours).
 [[https://www.sofproject.org/|Sound Open Firmware (SOF)]] is an open source audio Digital Signal Processing (DSP) firmware infrastructure and SDK.

Wiki

User Tools

Site Tools

Differences

Page Tools