v1.0.0 - Add proper support for compiling LOWMEM versions, add examples for ethernet usage, declare some things

Author: ukicomputers

.github/workflows/make_mpy.yml

@@ -40,6 +40,15 @@ jobs:
           make clean
           cd ../../
         done
+        for board_dir in mcu/*/; do
+          cd "$board_dir"
+          make -j$(nproc) LOWMEM=1
+          board_name=$(basename "$board_dir")
+          mkdir -p release
+          cp build/firmware.hex "release/${board_name}-LOWMEM.hex"
+          make clean
+          cd ../../
+        done
         cd ../../
 
     - name: Release version

LATEST.md

@@ -1,12 +1,20 @@
-## Support
-This is information about latest release of firmware update. The firmware supports MikroE MCU card family for STM32.
-| Supported MCU(s)        |   Ethernet  | SSL support | Test passed |
+# Support
+This is information about latest release of firmware update. Firmware supports MikroE MCU card family for STM32.
+| Supported MCU(s)        |   Tests passed |
+| :----------------: | :------:|
+| STM32F43        |   Yes   |
+| STM32F43-LOWMEM        |   Yes   |
+| STM32F76       |   No |
+| STM32F76-LOWMEM       |   N/A |
+
+Version differences:
+| Version        |   Ethernet  | MbedTLS (crypto, SSL) support | Typical out file size |
 | :----------------: | :------:| :----:| :----: |
-| STM32F43        |   Yes   | Yes | Yes |
-| STM32F43-LOWMEM        |   Yes   | No | Yes |
-| STM32F76       |   Yes   | Yes | No |
-## Default communications
+| NORMAL        |   Yes   | Yes | ~1200 KB |
+| LOWMEM        |   Yes   | No | ~900 KB |
+
+The supported key features for it is built-in Ethernet, RTC clock, USB U(S)ART protocol, mikroBUS usage. You can check [examples](https://github.com/ukicomputers/Fusion_STM32/tree/main/examples) folder for all key feature usage.
+# Default communications
 The prefered default communication is via USB UART with baud rate of 115200.
-## Credits
-Uglješa Lukešević (@ukicomputers) & other contributors. <br>
-Made for MikroE.
+# Credits
+Uglješa Lukešević (@ukicomputers) & other contributors.

README.md

@@ -5,7 +5,7 @@ Port for MicroPython language on STM32 developed for Fusion for ARM v8.
 [![Compile and Release MicroPython firmware](https://github.com/ukicomputers/Fusion_STM32/actions/workflows/make_mpy.yml/badge.svg)](https://github.com/ukicomputers/Fusion_STM32/actions/workflows/make_mpy.yml)
 
 # Prepare
-You are required to init submodules and install required compilers. <br>
+You are required to init submodules and install required compilers. Required compilers are GCC/G++ (GNU SDK) for ARM. <br>
 **Submodule initialization:**
 ```sh
 git submodule update --init lib/micropython
@@ -20,21 +20,23 @@ make -C lib/micropython/mpy-cross
 To build a firmware for choosen development board, you need to do following. The firmware will be located at `boards/<dev_board>/build/firmware.hex`.
 ```sh
 cd boards/<dev_board>
-make -j$(nproc) LTO=1 DEBUG=0
+make -j$(nproc) LTO=1 DEBUG=0 LOWMEM=1
 ```
-`LTO` (Link Time Optimisation) usually shrinks .hex file for 2-3%.
+`LTO` (Link Time Optimisation) usually shrinks .hex file for 2-3%. Not recommended in usage when MbedTLS is enabled.
 `DEBUG` stands to enable debugging symbols for GDB.
+`LOWMEM` is used to build a firmware for Low Memory MCU or normal (> 1024KB flash size).
+Differences are explained in [LATEST.md](https://github.com/ukicomputers/Fusion_STM32/blob/main/LATEST.md).
 
 # Alternate Function file generation
 To generate a Alternate Function file, and later use it for specific MCU port, execute following Python script:
 ```
 python3 make_af.py <stm32_mcu_name>
 ```
+The source for the script is from micropython main repository.
 
-# Support
+# TODO, future releases, support
 Port currently **DOES NOT** support TFT SSD19603 controller.<br>
 However, plans are to add LVGL support. <br>
-Ethernet may work.
 ## STM32 family
 This MPY port supports following STM32 families (some of them are ported):
 - F0
@@ -56,7 +58,7 @@ The ports are automatically built by GitHub Actions on every new commit. Check t
 # License
 MicroPython is licensed under MIT license by Damien P. George `Copyright (c) 2021 Damien P. George`<br>
 This port is licensed under CC BY-3.0 license under Uglješa Lukešević. <br>
-Made for **MikroE**.
+Full support written for **MikroE** MCU cards.
 
 ## Required header
 On every file that uses this port, please add this header:
@@ -73,6 +75,6 @@ MicroPython licensed with MIT license under Damien P. George
 """
 ```
 
-It is also required when calling `help()` in MicroPython firmware to output show that port is written by me. If use this port in NECTO, also in About section, define that port is written by me, exactly like this:
+It is also required when calling `help()` in MicroPython firmware to output show that port is written by me. That is already set up. <br><br>If use this port in NECTO, also in About section, define that port is written by me, exactly like this:
 ## MicroPython port
-Uglješa Lukešević
+Uglješa Lukešević

examples/eth_client.py

@@ -0,0 +1,153 @@
+"""
+MicroPyServer is a simple HTTP server for MicroPython projects.
+
+@see https://github.com/troublegum/micropyserver
+
+The MIT License
+
+Copyright (c) 2019 troublegum. https://github.com/troublegum/micropyserver
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+"""
+import re
+import socket
+import sys
+import io
+
+
+class MicroPyServer(object):
+
+    def __init__(self, host="0.0.0.0", port=80):
+        """ Constructor """
+        self._host = host
+        self._port = port
+        self._routes = []
+        self._connect = None
+        self._on_request_handler = None
+        self._on_not_found_handler = None
+        self._on_error_handler = None
+        self._sock = None
+
+    def start(self):
+        """ Start server """
+        self._sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+        self._sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+        self._sock.bind((self._host, self._port))
+        self._sock.listen(1)
+        print("Server start")
+        while True:
+            if self._sock is None:
+                break
+            try:
+                self._connect, address = self._sock.accept()
+                request = self.get_request()
+                if len(request) == 0:
+                    self._connect.close()
+                    continue
+                if self._on_request_handler:
+                    if not self._on_request_handler(request, address):
+                        continue
+                route = self.find_route(request)
+                if route:
+                    route["handler"](request)
+                else:
+                    self._route_not_found(request)
+            except Exception as e:
+                self._internal_error(e)
+            finally:
+                self._connect.close()
+
+    def stop(self):
+        """ Stop the server """
+        self._connect.close()
+        self._sock.close()
+        self._sock = None
+        print("Server stop")
+
+    def add_route(self, path, handler, method="GET"):
+        """ Add new route  """
+        self._routes.append(
+            {"path": path, "handler": handler, "method": method})
+
+    def send(self, data):
+        """ Send data to client """
+        if self._connect is None:
+            raise Exception("Can't send response, no connection instance")
+        self._connect.sendall(data.encode())
+
+    def find_route(self, request):
+        """ Find route """
+        lines = request.split("\r\n")
+        method = re.search("^([A-Z]+)", lines[0]).group(1)
+        path = re.search("^[A-Z]+\\s+(/[-a-zA-Z0-9_.]*)", lines[0]).group(1)
+        for route in self._routes:
+            if method != route["method"]:
+                continue
+            if path == route["path"]:
+                return route
+            else:
+                match = re.search("^" + route["path"] + "$", path)
+                if match:
+                    print(method, path, route["path"])
+                    return route
+
+    def get_request(self, buffer_length=4096):
+        """ Return request body """
+        return str(self._connect.recv(buffer_length), "utf8")
+
+    def on_request(self, handler):
+        """ Set request handler """
+        self._on_request_handler = handler
+
+    def on_not_found(self, handler):
+        """ Set not found handler """
+        self._on_not_found_handler = handler
+
+    def on_error(self, handler):
+        """ Set error handler """
+        self._on_error_handler = handler
+
+    def _route_not_found(self, request):
+        """ Route not found handler """
+        if self._on_not_found_handler:
+            self._on_not_found_handler(request)
+        else:
+            """ Default not found handler """
+            self.send("HTTP/1.0 404 Not Found\r\n")
+            self.send("Content-Type: text/plain\r\n\r\n")
+            self.send("Not found")
+
+    def _internal_error(self, error):
+        """ Internal error handler """
+        if self._on_error_handler:
+            self._on_error_handler(error)
+        else:
+            """ Default internal error handler """
+            if "print_exception" in dir(sys):
+                output = io.StringIO()
+                sys.print_exception(error, output)
+                str_error = output.getvalue()
+                output.close()
+            else:
+                str_error = str(error)
+            self.send("HTTP/1.0 500 Internal Server Error\r\n")
+            self.send("Content-Type: text/plain\r\n\r\n")
+            self.send("Error: " + str_error)
+            print(str_error)
+

examples/micropyserver.py

@@ -0,0 +1,29 @@
+from micropyserver import MicroPyServer
+from machine import Pin
+import time
+import network
+
+nic = network.LAN()
+nic.active(True)
+nic.ifconfig("dhcp")
+print(nic.ifconfig())
+
+def ukljuci(request):
+    pin.value(1)
+    server.send("UKLJUCENO! ukicomputers.")
+
+def iskljuci(request):
+    pin.value(0)
+    server.send("ISKLJUCENO! ukicomputers.")
+
+def poruka(request):
+    server.send("/ukljuci za HIGH, /iskljuci za LOW. ukicomputers.")
+
+pin = Pin("PA0", Pin.OUT)
+server = MicroPyServer()
+
+server.add_route("/", poruka)
+server.add_route("/ukljuci", ukljuci)
+server.add_route("/iskljuci", iskljuci)
+
+server.start()