Repository files navigation

With GitPod you can edit, build and run Micropython + LVGL from your web browser!

To quickly run Micropython + LVGL from your web browser you can also use theOnline Simulator.

For information abound Micropython lvgl bindings please refer tolv_binding_micropython/README.md

See alsoMicropython + LittlevGL blog post. (LittlevGL is LVGL's previous name.)
For questions and discussions - please use the forum:https://forum.lvgl.io/c/micropython

Original micropython README:https://github.com/micropython/micropython/blob/master/README.md

Originally,lv_micropython was created as an example of how to uselv_binding_micropython on a Micropython fork.
As such, we try to keep changes here as minimal as possible and we try to keep it in sync with Micropython upstream releases. We also try to add changes tolv_binding_micropython instead of tolv_micropython, when possible. (for example we keep all drivers inlv_binding_micropython, the ESP32 CMake functionality etc.)

Eventually it turned out that many people prefer usinglv_micropython directly and only a few use it as a reference to support LVGL on their own Micropython fork.If you are only starting with Micropython+LVGL, it's recommended that you uselv_micropython, while porting a Micropython fork to LVGL is for advanced users.

First step is always to clone lv_micropython and update its submodules recursively:

git clone https://github.com/lvgl/lv_micropython.gitcd lv_micropythongit submodule update --init --recursive lib/lv_bindings

Next you should build mpy-cross

make -C mpy-cross

Port specific steps usually include updating the port's submodules withmake submodules and running make for the port itself.

1. sudo apt-get install build-essential libreadline-dev libffi-dev git pkg-config libsdl2-2.0-0 libsdl2-dev python3.8 parallelPython 3 is required, but you can install some other version of python3 instead of 3.8, if needed.
2. git clone https://github.com/lvgl/lv_micropython.git
3. cd lv_micropython
4. git submodule update --init --recursive lib/lv_bindings
5. make -C mpy-cross
6. make -C ports/unix submodules
7. make -C ports/unix
8. ./ports/unix/micropython

Please setESPIDF parameter for the esp-idf install dir.It needs to match Micropython expected esp-idf, otherwise a warning will be displayed (and build will probably fail)For more details refer toSetting up the toolchain and ESP-IDF

When using IL9341 driver, the color depth and swap mode need to be set to match ILI9341. This can be done from the command line.Here is the command to build ESP32 + LVGL which is compatible with ILI9341 driver:

make -C mpy-crossmake -C ports/esp32 LV_CFLAGS="-DLV_COLOR_DEPTH=16 -DLV_COLOR_16_SWAP=1" BOARD=GENERIC_SPIRAM deploy

Explanation about the paramters:

• LV_CFLAGS are used to override color depth and swap mode, for ILI9341 compatibility.
  • LV_COLOR_DEPTH=16 is needed if you plan to use the ILI9341 driver.
  • LV_COLOR_16_SWAP=1 is needed if you plan to use thePure Micropython Display Driver.
• BOARD - I use WROVER board with SPIRAM. You can choose other boards fromports/esp32/boards/ directory.
• deploy - make command will create ESP32 port of Micropython, and will try to deploy it through USB-UART bridge.

For more details please refer toMicropython ESP32 README.

Refer to the README of thelvgl_javascript branch:https://github.com/lvgl/lv_micropython/tree/lvgl_javascript_v8#javascript-port

This port usesMicropython infrastructure for C modules andUSER_C_MODULES must be given:

1. git clone https://github.com/lvgl/lv_micropython.git
2. cd lv_micropython
3. git submodule update --init --recursive lib/lv_bindings
4. make -C ports/rp2 BOARD=PICO submodules
5. make -j -C mpy-cross
6. make -j -C ports/rp2 BOARD=PICO USER_C_MODULES=../../lib/lv_bindings/bindings.cmake

If you experience unstable behaviour, it is worth checking the value ofMICROPY_HW_FLASH_STORAGE_BASE against the value of__flash_binary_end from the firmware.elf.map file.If the storage base is lower than the binary end, parts of the firmware will be overwritten when the micropython filesystem is initialised.

First, LVGL needs to be imported and initialized

importlvglaslvlv.init()

Then display driver and input driver needs to be registered.Refer toPorting the library for more information.Here is an example of registering SDL drivers on Micropython unix port:

importSDLSDL.init()# Register SDL display driver.draw_buf=lv.disp_draw_buf_t()buf1_1=bytearray(480*10)draw_buf.init(buf1_1,None,len(buf1_1)//4)disp_drv=lv.disp_drv_t()disp_drv.init()disp_drv.draw_buf=draw_bufdisp_drv.flush_cb=SDL.monitor_flushdisp_drv.hor_res=480disp_drv.ver_res=320disp_drv.register()# Regsiter SDL mouse driverindev_drv=lv.indev_drv_t()indev_drv.init()indev_drv.type=lv.INDEV_TYPE.POINTERindev_drv.read_cb=SDL.mouse_readindev_drv.register()

Here is an alternative example, for registering ILI9341 drivers on Micropython ESP32 port:

importlvglaslv# Import ILI9341 driver and initialized itfromili9341importili9341disp=ili9341()# Import XPT2046 driver and initalize itfromxpt2046importxpt2046touch=xpt2046()

By default, both ILI9341 and XPT2046 are initialized on the same SPI bus with the following parameters:

• ILI9341:miso=5, mosi=18, clk=19, cs=13, dc=12, rst=4, power=14, backlight=15, spihost=esp.HSPI_HOST, mhz=40, factor=4, hybrid=True
• XPT2046:cs=25, spihost=esp.HSPI_HOST, mhz=5, max_cmds=16, cal_x0 = 3783, cal_y0 = 3948, cal_x1 = 242, cal_y1 = 423, transpose = True, samples = 3

You can change any of these parameters on ili9341/xpt2046 constructor.You can also initalize them on different SPI buses if you want, by providing miso/mosi/clk parameters. Set them to -1 to use existing (initialized) spihost bus.

Now you can create the GUI itself:

# Create a screen with a button and a labelscr=lv.obj()btn=lv.btn(scr)btn.align_to(lv.scr_act(),lv.ALIGN.CENTER,0,0)label=lv.label(btn)label.set_text("Hello World!")# Load the screenlv.scr_load(scr)

More info about LVGL:

• Websitehttps://lvgl.io
• GitHub:https://github.com/lvgl/lvgl
• Documentation:https://docs.lvgl.io/master/get-started/micropython.html
• Examples:https://docs.lvgl.io/master/examples.html
• More examples:https://github.com/lvgl/lv_binding_micropython/tree/master/examples

More info about lvgl Micropython bindings:

• https://github.com/lvgl/lv_binding_micropython/blob/master/README.md

Discussions about the Microptyhon binding:lvgl/lvgl#557

More info about the unix port:https://github.com/micropython/micropython/wiki/Getting-Started#debian-ubuntu-mint-and-variants

This is the MicroPython project, which aims to put an implementationof Python 3.x on microcontrollers and small embedded systems.You can find the official website atmicropython.org.

WARNING: this project is in beta stage and is subject to changes of thecode-base, including project-wide name changes and API changes.

MicroPython implements the entire Python 3.4 syntax (including exceptions,with,yield from, etc., and additionallyasync/await keywords fromPython 3.5). The following core datatypes are provided:str (includingbasic Unicode support),bytes,bytearray,tuple,list,dict,set,frozenset,array.array,collections.namedtuple, classes and instances.Builtin modules includesys,time, andstruct, etc. Select ports havesupport for_thread module (multithreading). Note that only a subset ofPython 3 functionality is implemented for the data types and modules.

MicroPython can execute scripts in textual source form or from precompiledbytecode, in both cases either from an on-device filesystem or "frozen" intothe MicroPython executable.

See the repositoryhttp://github.com/micropython/pyboard for the MicroPythonboard (PyBoard), the officially supported reference electronic circuit board.

Major components in this repository:

• py/ -- the core Python implementation, including compiler, runtime, andcore library.
• mpy-cross/ -- the MicroPython cross-compiler which is used to turn scriptsinto precompiled bytecode.
• ports/unix/ -- a version of MicroPython that runs on Unix.
• ports/stm32/ -- a version of MicroPython that runs on the PyBoard and similarSTM32 boards (using ST's Cube HAL drivers).
• ports/minimal/ -- a minimal MicroPython port. Start with this if you wantto port MicroPython to another microcontroller.
• tests/ -- test framework and test scripts.
• docs/ -- user documentation in Sphinx reStructuredText format. RenderedHTML documentation is available athttp://docs.micropython.org.

Additional components:

• ports/bare-arm/ -- a bare minimum version of MicroPython for ARM MCUs. Usedmostly to control code size.
• ports/teensy/ -- a version of MicroPython that runs on the Teensy 3.1(preliminary but functional).
• ports/pic16bit/ -- a version of MicroPython for 16-bit PIC microcontrollers.
• ports/cc3200/ -- a version of MicroPython that runs on the CC3200 from TI.
• ports/esp8266/ -- a version of MicroPython that runs on Espressif's ESP8266 SoC.
• ports/esp32/ -- a version of MicroPython that runs on Espressif's ESP32 SoC.
• ports/nrf/ -- a version of MicroPython that runs on Nordic's nRF51 and nRF52 MCUs.
• extmod/ -- additional (non-core) modules implemented in C.
• tools/ -- various tools, including the pyboard.py module.
• examples/ -- a few example Python scripts.

The subdirectories above may include READMEs with additional info.

"make" is used to build the components, or "gmake" on BSD-based systems.You will also need bash, gcc, and Python 3.3+ available as the commandpython3(if your system only has Python 2.7 then invoke make with the additional optionPYTHON=python2).

Most ports require the MicroPython cross-compiler to be built first. Thisprogram, called mpy-cross, is used to pre-compile Python scripts to .mpyfiles which can then be included (frozen) into the firmware/executable fora port. To build mpy-cross use:

$ cd mpy-cross$ make

The "unix" port requires a standard Unix environment with gcc and GNU make.x86 and x64 architectures are supported (i.e. x86 32- and 64-bit), as wellas ARM and MIPS. Making full-featured port to another architecture requireswriting some assembly code for the exception handling and garbage collection.Alternatively, fallback implementation based on setjmp/longjmp can be used.

To build (see section below for required dependencies):

$ cd ports/unix$ make submodules$ make

Then to give it a try:

$ ./micropython>>> list(5 * x + y for x in range(10) for y in [4, 2, 1])

UseCTRL-D (i.e. EOF) to exit the shell.Learn about command-line options (in particular, how to increase heap sizewhich may be needed for larger applications):

$ ./micropython -h

Run complete testsuite:

$ make test

Unix version comes with a builtin package manager called upip, e.g.:

$ ./micropython -m upip install micropython-pystone$ ./micropython -m pystone

Browse available modules onPyPI.Standard library modules come frommicropython-lib project.

Building MicroPython ports may require some dependencies installed.

For Unix port,libffi library andpkg-config tool are required. OnDebian/Ubuntu/Mint derivative Linux distros, installbuild-essential(includes toolchain and make),libffi-dev, andpkg-config packages.

Other dependencies can be built together with MicroPython. This maybe required to enable extra features or capabilities, and in recentversions of MicroPython, these may be enabled by default. To buildthese additional dependencies, in the port directory you'reinterested in (e.g.ports/unix/) first execute:

$ make submodules

This will fetch all the relevant git submodules (sub repositories) thatthe port needs. Use the same command to get the latest versions ofsubmodules as they are updated from time to time. After that execute:

$ make deplibs

This will build all available dependencies (regardless whether theyare used or not). If you intend to build MicroPython with additionaloptions (like cross-compiling), the same set of options should be passedtomake deplibs. To actually enable/disable use of dependencies, editports/unix/mpconfigport.mk file, which has inline descriptions of the options.For example, to build SSL module (required forupip tool described above,and so enabled by default),MICROPY_PY_USSL should be set to 1.

For some ports, building required dependences is transparent, and happensautomatically. But they still need to be fetched with themake submodulescommand.

The "stm32" port requires an ARM compiler, arm-none-eabi-gcc, and associatedbin-utils. For those using Arch Linux, you need arm-none-eabi-binutils,arm-none-eabi-gcc and arm-none-eabi-newlib packages. Otherwise, try here:https://launchpad.net/gcc-arm-embedded

To build:

$ cd ports/stm32$ make submodules$ make

You then need to get your board into DFU mode. On the pyboard, connect the3V3 pin to the P1/DFU pin with a wire (on PYBv1.0 they are next to each otheron the bottom left of the board, second row from the bottom).

Then to flash the code via USB DFU to your device:

$ make deploy

This will use the includedtools/pydfu.py script. If flashing the firmwaredoes not work it may be because you don't have the correct permissions, andneed to usesudo make deploy.See the README.md file in the ports/stm32/ directory for further details.

MicroPython is an open-source project and welcomes contributions. To beproductive, please be sure to follow theContributors' Guidelinesand theCode Conventions.Note that MicroPython is licenced under the MIT license, and all contributionsshould follow this license.