MicroPython on ESP32 with SPIRAM support

[loboris]

MicroPython for ESP32 with SPIRAM support
GitHub repository

The repository can be used to build MicroPython for modules/boards with SPIRAM as well as for regular ESP32 modules/boards without SPIRAM.

As of Sep 18, 2017 full support for psRAM is included into esp-idf and xtensa toolchain.

Building on Linux, MacOS and Windows is supported.

You can support this project by donating via PayPal

MicroPython works great on ESP32, but the most serious issue is still (as on most other MicroPython boards) limited amount of free memory.

ESP32 can use external SPI RAM (psRAM) to expand available RAM up to 16MB.
Currently, there are several modules & development boards which incorporates 4MB of SPIRAM:

ESP-WROVER-KIT boards from Espressif, AnalogLamb or Electrodragon.
ESP-WROVER from Espressif, AnalogLamb or Electrodragon.
ALB32-WROVER from AnalogLamb.
S01 and L01 OEM modules from Pycom.

The repository contains all the tools and sources necessary to build working MicroPython firmware which can fully use the advantages of 4MB (or more) of SPIRAM

It is huge difference between MicroPython running with less than 100KB of free memory and running with 4MB of free memory.

Some basic documentation specific to this MicroPython port is available. It will soon be updated to include the documentation for all added/changed modules.

Some examples can be found in modules_examples directory.

The MicroPython firmware is built as esp-idf component

This means the regular esp-idf menuconfig system can be used for configuration. Besides the ESP32 configuration itself, some MicroPython options can also be configured via menuconfig.
This way many features not available in standard ESP32 MicroPython are enabled, like unicore/dualcore, all Flash speed/mode options etc. No manual sdkconfig.h editing and tweaking is necessary.


Features and some differences from standard MicroPython ESP32 build

• MicroPython build is based on latest build (1.9.2) from main MicroPython repository.
• ESP32 build is based on MicroPython's ESP32 build) with added changes needed to build on ESP32 with SPIRAM and with esp-idf build system.
• Default configuration for SPIRAM build has 2MB of MicroPython heap, 20KB of MicroPython stack, ~200KB of free DRAM heap for C modules and functions
• MicroPython can be built in unicore (FreeRTOS & MicroPython task running only on the first ESP32 core, or dualcore configuration (MicroPython task running on ESP32 App core).
• ESP32 Flash can be configured in any mode, QIO, QOUT, DIO, DOUT
• BUILD.sh script is provided to make building MicroPython firmware as easy as possible
• Internal filesystem is built with esp-idf wear leveling driver, so there is less danger of damaging the flash with frequent writes. File system parameters (start address, size, ...) can be set via menuconfig.
• sdcard module is included which uses esp-idf sdmmc driver and can work in SD mode (1-bit and 4-bit) or in SPI mode (sd card can be connected to any pins). On ESP-WROVER-KIT it works without changes, for information on how to connect sdcard on other boards check the dicumentation
• Native ESP32 VFS support is used for spi Flash (FatFS or SPIFS) & sdcard filesystems.
• SPIFFS filesystem support, can be used instead of FatFS on SPI Flash. Configurable via menuconfig
• RTC Class is added to machine module, including methods for synchronization of system time to ntp server, deepsleep, wakeup from deepsleep on external pin level, ...
• Time zone can be configured via menuconfig and is used when syncronizing time from NTP server
• files timestamp is correctly set to system time both on internal fat filesysten and on sdcard
• Built-in ymodem module for fast transfer of text or binary files of any size to/from host. Uses the same uart on which REPL runs.
• Some additional frozen modules are added, like pye editor, urequests, functools, logging, ...
• Btree module is included, can be Enabled/Disabled via menuconfig.
• _threads module is greatly improved, inter-thread notifications and messaging included
• Neopixel module using ESP32 RMT peripheral with many new features, unlimited number of pixels
• i2c module uses ESP32 hardware i2c driver
• spi module uses ESP32 hardware spi driver
• curl module added, http/https get,post, send mail (including gMail), ftp client (get, put, list)
• ssh module added, sftp get, put, list, mkdir, execute any command on host
• display module added with full support for spi TFT displays
• DHT module implemented using ESP32 RMT peripheral
• mqtt module added, implemented in C, runs in separate task
• telnet module added, connect to **REPL via WiFi** using telnet protocol
• ftp server module added, runs as separate ESP32 task
• GSM module with PPPoS support, all network functions works the same as with WiFi, SMS, AT commands, ...
• NVS support in machine module
• Eclipse project files are included. To include the project into Eclipse goto File->Import->Existing Projects into Workspace->Select root directory->[select MicroPython_BUILD directory]->Finish. After opening, rebuild the index.

How to Build

Clone the repository:

Code: Select all

git clone https://github.com/loboris/MicroPython_ESP32_psRAM_LoBo.git

Xtensa toolchains for Linux, Windows and MacOS and esp-idf are provided as tar archives. They will be automatically unpacked on first run of BUILD.sh script.

Goto MicroPython_BUILD directory

To change some ESP32 & Micropython options run:

Code: Select all

./BUILD.sh menuconfig

To build the MicroPython firmware, run:

Code: Select all

./BUILD.sh

You can use -jN (N=number of cores to use) to make the build process faster (it only takes les 15 seconds seconds on my system with -j4).
If using too high N the build may fail, if that happens, run build again or run without the -j option.

If no errors are detected, you can now flash the MicroPython firmware to your board. Run:

Code: Select all

./BUILD.sh flash

The board stays in bootloader mode. Run your terminal emulator to connect to the board and reset the board.
You can also run ./BUILD.sh monitor to use esp-idf's terminal program, it will reset the board automatically.

BUILD.sh

Included BUILD.sh script makes building MicroPython firmware easy.
Usage:

• ./BUILD.sh - run the build, create MicroPython firmware
• ./BUILD.sh -jn - run the build on multicore system, much faster build. Replace n with the number of cores on your system
• ./BUILD.sh menuconfig - run menuconfig to configure ESP32/MicroPython
• ./BUILD.sh clean - clean the build
• ./BUILD.sh flash - flash MicroPython firmware to ESP32
• ./BUILD.sh erase - erase the whole ESP32 Flash
• ./BUILD.sh monitor - run esp-idf terminal program
• ./BUILD.sh makefs - create SPIFFS file system image which can be flashed to ESP32
• ./BUILD.sh flashfs - flash SPIFFS file system image to ESP32, if not created, create it first
• ./BUILD.sh copyfs - flash the default SPIFFS file system image to ESP32
• ./BUILD.sh makefatfs - create FatFS file system image which can be flashed to ESP32
• ./BUILD.sh flashfatfs - flash FatFS file system image to ESP32, if not created, create it first
• ./BUILD.sh copyfatfs - flash the default FatFS file system image to ESP32

As default the build process runs silently, without showing compiler output. You can change that by adding verbose as the last parameter to BUILD.sh.

To build with SPIRAM support:
In menuconfig select → Component config → ESP32-specific → Support for external, SPI-connected RAM
In menuconfig select → Component config → ESP32-specific → SPI RAM config → Make RAM allocatable using heap_caps_malloc

After the successful build the firmware files will be placed into firmware directory. flash.sh script will also be created which can be used for flashing the firmware without building it first.

Using SPIFFS filesystem

SPIFFS filesystem can be used on internal spi Flash instead of FatFS.
If you want to use it configure it via menuconfig → MicroPython → File systems → Use SPIFFS

Prepared image file can be flashed to ESP32, if not flashed, filesystem will be formated after first boot.

SFPIFFS image can be prepared on host and flashed to ESP32:

Copy the files to be included on spiffs into components/spiffs_image/image/ directory. Subdirectories can also be added.

Execute:

Code: Select all

./BUILD.sh makefs

to create spiffs image in build directory without flashing to ESP32

Execute:

Code: Select all

./BUILD.sh flashfs

to create spiffs image in build directory and flash it to ESP32

Execute:

Code: Select all

./BUILD.sh copyfs

to flash default spiffs image components/spiffs_image/spiffs_image.img to ESP32


Some examples

Using new machine methods and RTC:

Code: Select all

import machine

rtc = machine.RTC()

rtc.init((2017, 6, 12, 14, 35, 20))

rtc.now()

rtc.ntp_sync(server="<ntp_server>" [,update_period=])
  <ntp_server> can be empty string, then the default server is used ("pool.ntp.org")

rtc.synced()
  returns True if time synchronized to NTP server

rtc.wake_on_ext0(Pin, level)
rtc.wake_on_ext1(Pin, level)
  wake up from deepsleep on pin level

machine.deepsleep(time_ms)
machine.wake_reason()
  returns tuple with reset & wakeup reasons
machine.wake_description()
  returns tuple with strings describing reset & wakeup reasons

Using sdcard module:

Code: Select all

import uos

uos.mountsd()
uos.listdir('/sd')

You can also set working directory to the root sd card directory automatically:

Code: Select all

>>> import uos
>>> uos.mountsd(True)
---------------------
 Mode:  SD (4bit)
 Name: NCard
 Type: SDHC/SDXC
Speed: default speed (25 MHz)
 Size: 15079 MB
  CSD: ver=1, sector_size=512, capacity=30881792 read_bl_len=9
  SCR: sd_spec=2, bus_width=5

>>> uos.listdir()
['overlays', 'bcm2708-rpi-0-w.dtb', ......

Example terminal session

Code: Select all

rst:0x1 (POWERON_RESET),boot:0x3e (SPI_FAST_FLASH_BOOT)
configsip: 0, SPIWP:0xee
clk_drv:0x00,q_drv:0x00,d_drv:0x00,cs0_drv:0x00,hd_drv:0x00,wp_drv:0x00
mode:DIO, clock div:2
load:0x3fff0010,len:4
load:0x3fff0014,len:5656
load:0x40078000,len:0
ho 12 tail 0 room 4
load:0x40078000,len:13220
entry 0x40078fe4
W (36) rtc_clk: Possibly invalid CONFIG_ESP32_XTAL_FREQ setting (40MHz). Detected 40 MHz.
I (59) boot: ESP-IDF ESP32_LoBo_v1.9.1-13-gfecf988-dirty 2nd stage bootloader
I (60) boot: compile time 21:07:29
I (108) boot: Enabling RNG early entropy source...
I (108) boot: SPI Speed      : 40MHz
I (108) boot: SPI Mode       : DIO
I (115) boot: SPI Flash Size : 4MB
I (128) boot: Partition Table:
I (139) boot: ## Label            Usage          Type ST Offset   Length
I (162) boot:  0 nvs              WiFi data        01 02 00009000 00006000
I (185) boot:  1 phy_init         RF data          01 01 0000f000 00001000
I (209) boot:  2 MicroPython      factory app      00 00 00010000 00270000
I (232) boot:  3 internalfs       Unknown data     01 81 00280000 00140000
I (255) boot: End of partition table
I (268) esp_image: segment 0: paddr=0x00010020 vaddr=0x3f400020 size=0x48a74 (297588) map
I (613) esp_image: segment 1: paddr=0x00058a9c vaddr=0x3ffb0000 size=0x07574 ( 30068) load
I (650) esp_image: segment 2: paddr=0x00060018 vaddr=0x400d0018 size=0xc83f4 (820212) map
0x400d0018: _stext at ??:?

I (1525) esp_image: segment 3: paddr=0x00128414 vaddr=0x3ffb7574 size=0x052d0 ( 21200) load
I (1551) esp_image: segment 4: paddr=0x0012d6ec vaddr=0x40080000 size=0x00400 (  1024) load
0x40080000: _iram_start at /home/LoBo2_Razno/ESP32/MicroPython/MicroPython_ESP32_psRAM_LoBo/Tools/esp-idf/components/freertos/./xtensa_vectors.S:1675

I (1553) esp_image: segment 5: paddr=0x0012daf4 vaddr=0x40080400 size=0x1a744 (108356) load
I (1711) esp_image: segment 6: paddr=0x00148240 vaddr=0x400c0000 size=0x0006c (   108) load
I (1712) esp_image: segment 7: paddr=0x001482b4 vaddr=0x50000000 size=0x00400 (  1024) load
I (1794) boot: Loaded app from partition at offset 0x10000
I (1794) boot: Disabling RNG early entropy source...
I (1800) spiram: SPI RAM mode: flash 40m sram 40m
I (1812) spiram: PSRAM initialized, cache is in low/high (2-core) mode.
I (1834) cpu_start: Pro cpu up.
I (1846) cpu_start: Starting app cpu, entry point is 0x400814e4
0x400814e4: call_start_cpu1 at /home/LoBo2_Razno/ESP32/MicroPython/MicroPython_ESP32_psRAM_LoBo/Tools/esp-idf/components/esp32/./cpu_start.c:219

I (0) cpu_start: App cpu up.
I (4612) spiram: SPI SRAM memory test OK
I (4614) heap_init: Initializing. RAM available for dynamic allocation:
I (4615) heap_init: At 3FFAE2A0 len 00001D60 (7 KiB): DRAM
I (4633) heap_init: At 3FFC30C0 len 0001CF40 (115 KiB): DRAM
I (4653) heap_init: At 3FFE0440 len 00003BC0 (14 KiB): D/IRAM
I (4672) heap_init: At 3FFE4350 len 0001BCB0 (111 KiB): D/IRAM
I (4692) heap_init: At 4009AB44 len 000054BC (21 KiB): IRAM
I (4712) cpu_start: Pro cpu start user code
I (4777) cpu_start: Starting scheduler on PRO CPU.
I (2920) cpu_start: Starting scheduler on APP CPU.

FreeRTOS running on BOTH CORES, MicroPython task started on App Core.

uPY stack size = 19456 bytes
uPY  heap size = 2097152 bytes (in SPIRAM using heap_caps_malloc)

Reset reason: Power on reset Wakeup: Power on wake
I (3130) phy: phy_version: 359.0, e79c19d, Aug 31 2017, 17:06:07, 0, 0

Starting WiFi ...
WiFi started
Synchronize time from NTP server ...
Time set

MicroPython ESP32_LoBo_v2.0.2 - 2017-09-19 on ESP32 board with ESP32
Type "help()" for more information.
>>> 
>>> import micropython, machine
>>> micropython.mem_info()
stack: 736 out of 19456
GC: total: 2049088, used: 6848, free: 2042240
 No. of 1-blocks: 37, 2-blocks: 9, max blk sz: 329, max free sz: 127565
>>> machine.heap_info()
Free heap outside of MicroPython heap:
 total=2232108, SPISRAM=2097108, DRAM=135000
>>> 
>>> a = ['esp32'] * 200000
>>> 
>>> a[123456]
'esp32'
>>> 
>>> micropython.mem_info()
stack: 736 out of 19456
GC: total: 2049088, used: 807104, free: 1241984
 No. of 1-blocks: 44, 2-blocks: 13, max blk sz: 50000, max free sz: 77565
>>> 

Tested on ESP-WROVER-KIT v3, Adafruit HUZZAH32 - ESP32 Feather
.............................................................

[ESP_krzychb]

Hi @loboris,

This is really impressive!
In not time at all I was able to build, upload, run and test MicroPython

Taken the application support for psRAM and the ESP-WROVER-KIT with 4MB of psRAM have been just recently released, this is really remarkable.

Congratulations!

MicroPython deployment by loboris running on

Screenshot from 2017-07-16 18-40-21.png (135.84 KiB) Viewed 40044 times

[Josegm]

Execellent work! But just a note the Pycom W01 module with 4MB pSRAM is in fact already in stock and available for sale:

https://www.pycom.io/product/w01/

Same for the L01 (with LoRa). I ordered 10 (minimum for OSM modules) and received on the next day.

[loboris]

Important update:

• The MicroPython firmware is now built as esp-idf component.
• The repository can be used to build MicroPython for modules with psRAM as well as for ESP32 modules without psRAM. Standard esp-idf and Xtensa toolchain can be used if building without psRAM support.
• micropython is no longer submodule, it's core is based on latest build (1.9.1) from main MicroPython repository, with some modifications needed for the new build system.
• Eclipse project files are included.
• Btree module is included, can be Enabled/Disabled via menuconfig.
• The opening post is updated with new information.

[loboris]

Good news for everybody wanting to work with MicroPython on ESP32+psRAM.

AnalogLamb is offering ALB32-WROVER module with 8MB Flash and 4MB psRAM in ESP-WROOM-32 footprint package. Available for pre-order, will be released on August 8, 2017.
https://www.analoglamb.com/product/alb3 ... 32mb-psram

[WiFive]

Are they going to do any certifications?

[rudi ;-)]

Are they going to do any certifications?

edit:
i think no

[loboris]

Update:

• Added native ESP32 VFS support, MicroPython's FatFS VFS is not used (it can still be selected via menuconfig).
  It is now very simple to work with files from C modules using standard file functions.
  Thanks to SHA2017 Badge Team for initial support.
• New MicroPython configuration options added to menuconfig
• Xtensa toolchain and eps-idf directories (for both standard & psRAM build) added to make the build process even easier

[loboris]

Update:

• Added support for SPIFFS filesystem on internal spi Flash
• SPIFFS or FatFS can be selected via menuconfig
• SFPIFFS fs image file can be prepared on host and flashed to ESP32
• File systems functions updated, improved, some bugfixes
• MicroPython sources updated
• BUILD.sh script updated with new options

See GitHub repository for more info.

[loboris]

Update:

• Added support for connecting sd card in SPI mode
• works only with master esp-idf, psRAM esp-idf branch does not have the necessary support yet
• main advantage (the only one?) of connecting sd card in SPI mode is that the card can be attached to any ESP32 pins
• Sd card working mode (SD-1-line, SD-4-line, SPI) can be selected via menuconfig
• sdcard module initialization syntax is changed:

  Code: Select all

  import sdcard
  sd = sdcard.SDCard([chdir_to_sd_root])

  If the optional boolean parameter is True the working directory will be changed to sdcard root
• umount method is added

  Code: Select all

  >>> uos.listdir('/')
  ['flash']
  >>> sd = sdcard.SDCard()
  ---------------------
   Mode:  SD (4bit)
   Name: SL08G
   Type: SDHC/SDXC
  Speed: default speed (25 MHz)
   Size: 7580 MB
    CSD: ver=1, sector_size=512, capacity=15523840 read_bl_len=9
    SCR: sd_spec=2, bus_width=5
  
  >>> uos.listdir('/')
  ['flash', 'sd']
  >>> sd.umount()
  >>> uos.listdir('/')
  ['flash']
  

See GitHub repository for more info.