Update: March 24, 2019. Script now works with new "port" directory structure and confirmed to work in WSL.
BUILD ESP8266
This is the source code to build MicroPython for the ESP8266 on a Raspberry Pi (or debian, or WSL Ubuntu).
debian_specific.sh
If you are not using a Raspberry Pi, then there are some things on Debian that are not installed by default.
quick_start.sh
To get started quickly, here's a simple script to fetch the build script, flag it as executable, and run it:
build_esp8266.sh
This is the main script to build MicroPython for the ESP8266
Usage:
./build_esp8266.sh [OPTION]
OPTIONS (note the change to lower case, and addtion of --prefix since last release!)
--help
show this help. Source will be placed in ~/workspace/ directory.
--full
Update OS and installed apps, download latest esp-open-sdk and micropython, build everything, erase and upload new binary to /dev/ttyUSB0 (or /dev/ttyS0 for WSL)
--make-only
Download latest esp-open-sdk and micropython, build everything.
--make-only-esp8266
Download latest micropython and build (skip esp-open-sdk).
--run-tests
Run the esp8266 test script
--flash-only
Only writing existing flash to device. (no updates, no build)
Note the FULL option, of rebuilding EVERYTHING can take a quite long time on the Raspberry Pi.
#Examples:
./build_esp8266.sh --make-only-esp8266
or
./build_esp8266.sh --flash-only
which really just does this:
~/workspace/esptool/esptool.py --port /dev/ttyUSB0 --baud 115200 write_flash 0 ~/workspace/micropython/esp8266/build/firmware-combined.bin
Known issues:
Errors like this mean that the bash file was edited in Windows:
./build_esp8266.sh: line 65: $'\r': command not found
to fix:
dos2unix build_esp8266.sh
Comments & Feedback
You can leave messages on the MicroPython forum:
http://forum.micropython.org/viewtopic.php?f=16&t=1720
References
[1] https://downloads.raspberrypi.org/raspbian_latest Latest binary image to write to Raspberry Pi SD Flash
[2] https://sourceforge.net/projects/win32diskimager/files/Archive/Win32DiskImager-0.9.5-install.exe/download executable image for win32diskimager (useful for getting binary image from Windows onto RPi SD card)
[3] https://sourceforge.net/projects/win32diskimager/ More info for win32diskimager tool
[4] http://forum.micropython.org/viewforum.php?f=16 The MicroPython ESP8266 Forum
[5] https://github.com/pfalcon/esp-open-sdk The eps-open-sdk (required to build for ESP8266)
[6] https://github.com/micropython The MicroPython source
License
The MIT License (MIT)
Copyright (c) 2016, gojimmypi
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.
Other stuff referenced:
esp-open-sdk is in its nature merely a makefile, and is in public domain. However, the toolchain this makefile builds consists of many components, each having its own license. You should study and abide them all.
Quick summary: gcc is under GPL, which means that if you're distributing a toolchain binary you must be ready to provide complete toolchain sources on the first request.
Since version 1.1.0, vendor SDK comes under modified MIT license. Newlib, used as C library comes with variety of BSD-like licenses. libgcc, compiler support library, comes with a linking exception. All the above means that for applications compiled with this toolchain, there are no specific requirements regarding source availability of the application or toolchain. (In other words, you can use it to build closed-source applications). (There're however standard attribution requirements - see licences for details).