lamium2 / uiflow-micropython

uiflow micropython project

uiflow_micropython

How to build

Setting up ESP-IDF and the build environment

mkdir uiflow_workspace && cd uiflow_workspace
git clone -b uiflow/v2.0-idf5.0.4 https://github.com/m5stack/esp-idf.git 
git -C esp-idf submodule update --init --recursive
./esp-idf/install.sh
. ./esp-idf/export.sh

Building the firmware

git clone https://github.com/m5stack/uiflow_micropython
cd uiflow_micropython/m5stack
make submodules
make patch
make littlefs
make mpy-cross
make flash_all

The default board build the M5STACK_AtomS3 one, You can specify a different board by passing BOARD=<board> to the make commands. More BOARD type define is under m5satck/boards path.

More command support, you can check the Makefile.

Documentation

API documentation for this library can be found on Read the Docs.

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.
• haptic Copyright (c) 2022 lbuque and licensed under MIT License.