This repository provides everything required to run the fantastic esp-open-sdk in docker containers.
- No need to install all the dependancies on your local machine.
- No need to build esp-open-sdk yourself, you can just pull it pre-built from docker hub.
- Easily build esp-open-sdk yourself if you do want, using the latest source from pfalcon/esp-open-sdk.
- Ensure you have a consistent build environment - your esp-open-sdk-docker environment will be the same on any machine and the same for everyone else too.
- Easily switch between
STANDALONE=y
andSTANDALONE=n
versions of esp-open-sdk.
- Scripts to build the latest esp-open-sdk into docker images
- Scripts to use those docker images to run esp-open-sdk based commands
Written for mac users, likely to work for linux users too. (If you can translate this to Windows please send a pull request.)
-
Homebrew Suggested
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)
-
Git Required
brew install git
-
Make - Not sure if the BSD version of make, which comes with mac, will work. Need to test this. To get the GNU version just do:
brew install coreutils make
-
Docker Required
See also https://docs.docker.com/
-
VirtualBox Suggested
At least I used this for the usb port mapping bit, you might be able to do the same with HyperKit.
$ git clone esp-open-sdk-docker
$ cd esp-open-sdk-docker
$ make containerimages
You could now have a number of docker images. Take a look:
$ docker images --filter=reference='esp-open-sdk/*'
esp-open-sdk/source # safe to ignore
esp-open-sdk/dependencies # safe to ignore
esp-open-sdk/standalone # SDK built with STANDALONE=y
esp-open-sdk/bare # SDK built with STANDALONE=n
esp-open-sdk/serialtools # Some useful serial debugging tools
If you only want one of these, for example the standalone build, you can do that with:
$ cd containerimages
$ make standalone
If you don't want to build your own images you can skip the git clone
and make
steps and just pull the latest from docker hub:
$ docker pull esp-open-sdk/standalone:latest