circuitpython/ports/esp8266/boards/GENERIC/board.md
Jim Mussared e359b077dd ports: Add board.json for all boards.
This will be used by https://micropython.org/download/ to generate the
full listing of boards and firmware files.

Optionally supports a board.md for additional customisation of the
download page, as well as deploy.md for flashing instructions.

Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
2021-10-27 14:04:53 +11:00

20 lines
1.0 KiB
Markdown

The following are daily builds of the ESP8266 firmware for boards with at
least 2MiB of flash. They have the latest features and bug fixes, WebREPL is
not automatically started, and debugging is enabled by default.
Note: v1.12-334 and newer (including v1.13) require an ESP8266 module with
2MiB of flash or more, and use littlefs as the filesystem by default. When
upgrading from older firmware please backup your files first, and either
erase all flash before upgrading, or after upgrading execute
`uos.VfsLfs2.mkfs(bdev)`.
### OTA builds
Over-The-Air (OTA) builds of the ESP8266 firmware are also provided.
The first time you use this build you need to flash one of the "initial image"
images using esptool.py as described above. After that, you can update the
firmware over the air using the "OTA update" file in conjunction with the
ota-client script from yaota8266. The "OTA update" files are digitally signed
and will only work with the provided "initial image" files, and vice versa.
(Note: this feature is work-in-progress.)