Merge pull request #10 from m5stack/develop

Author: imliubo

.github/workflows/code_formatting.yml

@@ -6,8 +6,8 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-python@v1
+    - uses: actions/checkout@v3.3.0
+    - uses: actions/setup-python@v4.5.0
     - name: Install packages
       run: source tools/ci.sh && ci_code_formatting_setup
     - name: Run code formatting

.github/workflows/nightly-build.yml

@@ -0,0 +1,64 @@
+name: Nightly Build
+
+on:
+  schedule:
+    - cron: 0 0 * * *
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build_atoms3:
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/[email protected]
+    - name: Install packages
+      run: source tools/ci.sh && ci_esp32_idf44_setup
+    - name: Build
+      run: source tools/ci.sh && ci_esp32_nightly_build
+    - name: Deliver AtomS3 firmware
+      uses: actions/upload-artifact@v3
+      with:
+        name: M5STACK_AtomS3_firmware
+        path: ./m5stack/build-M5STACK_AtomS3/uiflow-*.bin
+    - name: Deliver AtomS3-Lite firmware
+      uses: actions/upload-artifact@v3
+      with:
+        name: M5STACK_AtomS3-Lite_firmware
+        path: ./m5stack/build-M5STACK_AtomS3_Lite/uiflow-*.bin
+    - name: Deliver StampS3 firmware
+      uses: actions/upload-artifact@v3
+      with:
+        name: M5STACK_StampS3_firmware
+        path: ./m5stack/build-M5STACK_StampS3/uiflow-*.bin
+    - name: Deliver CoreS3 firmware
+      uses: actions/upload-artifact@v3
+      with:
+        name: M5STACK_CoreS3_firmware
+        path: ./m5stack/build-M5STACK_CoreS3/uiflow-*.bin
+    - name: Deliver AtomS3U firmware
+      uses: actions/upload-artifact@v3
+      with:
+        name: M5STACK_AtomS3U_firmware
+        path: ./m5stack/build-M5STACK_AtomS3U/uiflow-*.bin
+    - name: Deliver Core2 firmware
+      uses: actions/upload-artifact@v3
+      with:
+        name: M5STACK_Core2_firmware
+        path: ./m5stack/build-M5STACK_Core2/uiflow-*.bin
+    - name: Deliver StickC_PLUS2 firmware
+      uses: actions/upload-artifact@v3
+      with:
+        name: M5STACK_StickC_PLUS2_firmware
+        path: ./m5stack/build-M5STACK_StickC_PLUS2/uiflow-*.bin
+    - name: Deliver StickC_PLUS firmware
+      uses: actions/upload-artifact@v3
+      with:
+        name: M5STACK_StickC_PLUS_firmware
+        path: ./m5stack/build-M5STACK_StickC_PLUS/uiflow-*.bin
+    - name: Deliver Fire firmware
+      uses: actions/upload-artifact@v3
+      with:
+        name: M5STACK_Fire_firmware
+        path: ./m5stack/build-M5STACK_Fire/uiflow-*.bin

.github/workflows/ports_m5stack.yml

@@ -16,9 +16,7 @@ jobs:
   build_idf44:
     runs-on: ubuntu-20.04
     steps:
-    - uses: actions/checkout@v2
-      with:
-        submodules: true
+    - uses: actions/[email protected]
     - name: Install packages
       run: source tools/ci.sh && ci_esp32_idf44_setup
     - name: Build

.gitignore

@@ -48,3 +48,6 @@ genrst/
 .DS_Store
 
 .vscode/
+tools/littlefs/prebuilt/
+
+dependencies.lock

.gitmodules

@@ -4,3 +4,15 @@
 [submodule "tools/littlefs/mbed-littlefs"]
 	path = tools/littlefs/mbed-littlefs
 	url = https://github.com/ARMmbed/mbed-littlefs.git
+[submodule "m5stack/components/esp32-camera"]
+	path = m5stack/components/esp32-camera
+	url = https://github.com/espressif/esp32-camera.git
+[submodule "m5stack/components/M5Unified/M5GFX"]
+	path = m5stack/components/M5Unified/M5GFX
+	url = https://github.com/m5stack/M5GFX.git
+[submodule "m5stack/components/M5Unified/M5Unified"]
+	path = m5stack/components/M5Unified/M5Unified
+	url = https://github.com/m5stack/M5Unified.git
+[submodule "m5stack/components/lv_bindings"]
+	path = m5stack/components/lv_bindings
+	url = https://github.com/lvgl/lv_binding_micropython.git

.readthedocs.yaml

@@ -0,0 +1,30 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+# sphinx:
+#    configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 M5Stack
+
+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.

README.md

@@ -1,7 +1,9 @@
 # uiflow_micropython
 
 ## How to build
+
 ### Setting up ESP-IDF and the build environment
+
 ```shell
 mkdir uiflow_workspace && cd uiflow_workspace
 git clone https://github.com/m5stack/esp-idf.git
@@ -12,12 +14,61 @@ git -C esp-idf submodule update --init --recursive
 ```
 
 ### Building the firmware
+
 ```shell
 git clone https://github.com/m5stack/uiflow_micropython
 cd uiflow_micropython/m5stack
-make submodules
+make submodules # Only need once
 make littlefs
 make mpy-cross
-make -j
-make deploy PORT=/dev/ttyUSBx BAUD=1500000
+# atoms3, atoms3-lite
+make BOARD=M5STACK_S3_8MB BOARD_TYPE=atoms3 flash # Build and flash to atoms3 baord
+# stamps3
+make BOARD=M5STACK_S3_8MB BOARD_TYPE=stamps3 flash
+# cores3
+make BOARD=M5STACK_S3_SPIRAM_16MB BOARD_TYPE=cores3 flash
+# atoms3u
+make BOARD=M5STACK_S3_8MB BOARD_TYPE=atoms3u flash
+# core2,tough
+make BOARD=M5STACK_SPIRAM_16MB BOARD_TYPE=core2 flash
+# stickcplus2
+make BOARD=M5STACK_SPIRAM_8MB BOARD_TYPE=stickcplus2 flash
+# stickcplus
+make BOARD=M5STACK_4MB BOARD_TYPE=stickcplus flash
 ```
+
+## License
+
+- [micropython][] Copyright (c) 2013-2023 Damien P. George and licensed under MIT License.
+- [umqtt][] Copyright (c) 2013-2014 micropython-lib contributors and licensed under MIT License.
+- [urequests][] Copyright (c) 2013-2014 micropython-lib contributors and licensed under MIT License.
+- [ir][] Copyright (c) 2020 Peter Hinch and licensed under MIT License.
+- [neopixel][] Copyright (c) 2013-2014 micropython-lib contributors and licensed under MIT License.
+- [bh1750fvi][] Copyright (c) 2022 Sebastian Wicki and licensed under MIT License.
+- [bmp280][] Copyright (c) 2020 Sebastian Wicki and licensed under MIT License.
+- [checksum][] Copyright (c) 2022 Sebastian Wicki and licensed under MIT License.
+- [dht12][] Copyright (c) 2020 Sebastian Wicki and licensed under MIT License.
+- [pcf8563][] Copyright (c) 2020 Sebastian Wicki and licensed under MIT License.
+- [qmp6988][] Copyright (c) 2022 Sebastian Wicki and licensed under MIT License.
+- [scd40][] Copyright (c) 2022 Sebastian Wicki and licensed under MIT License.
+- [sgp30][] Copyright (c) 2022 Sebastian Wicki and licensed under MIT License.
+- [sht4x][] Copyright (c) 2021 ladyada for Adafruit and licensed under MIT License.
+- [vl53l0x][] Copyright (c) 2017 Tony DiCola for Adafruit Industries and licensed under MIT License.
+- [camera][] Copyright (c) 2021 Mauro Riva and licensed under Apache License Version 2.0.
+
+[micropython]: https://github.com/micropython/micropython
+[umqtt]: https://github.com/micropython/micropython-lib
+[urequests]: https://github.com/micropython/micropython-lib
+[ir]: https://github.com/peterhinch/micropython_ir
+[neopixel]: https://github.com/micropython/micropython-lib
+[bh1750fvi]: https://github.com/gandro/micropython-m5stamp-c3u
+[bmp280]: https://github.com/gandro/micropython-m5stickc-plus
+[checksum]: https://github.com/gandro/micropython-m5stamp-c3u
+[dht12]: https://github.com/gandro/micropython-m5stickc-plus
+[pcf8563]: https://github.com/gandro/micropython-m5stickc-plus
+[qmp6988]: https://github.com/gandro/micropython-m5stamp-c3u
+[scd40]: https://github.com/gandro/micropython-m5stamp-c3u
+[sgp30]: https://github.com/gandro/micropython-m5stamp-c3u
+[sht4x]: https://github.com/adafruit/Adafruit_CircuitPython_SHT4x
+[vl53l0x]: https://github.com/adafruit/Adafruit_CircuitPython_VL53L0X
+[camera]: https://github.com/lemariva/micropython-camera-driver

docs/.gitignore

@@ -0,0 +1 @@
+build

docs/Makefile

@@ -0,0 +1,23 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = zh_CN
+BUILDDIR      = build/$(SOURCEDIR)
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+doxygen:
+	doxygen
+
+.PHONY: help Makefile #doxygen
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile #doxygen
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)