Skip to content

Setup the freeRTOS SDK

mtribiere edited this page Mar 28, 2021 · 3 revisions

In this section, we will download and setup the official ESP8266 freeRTOS-based SDK.
We will assume that you have already a workspace directory called "esp", and a sourced toolchain. If not click here.

1. Setup the SDK

  • First you need to clone the official repo from github (This operation could take a while depending on you internet connection)
 $> cd ~/esp/
 $> git clone --recursive https://github.com/espressif/ESP8266_RTOS_SDK.git
  • Then automate the sourcing of the SDK
 $> echo "export IDF_PATH=\"$HOME/esp/ESP8266_RTOS_SDK\"" >> ~/.bashrc

You need to close and re-open your terminal for change to take effect

  • Now, you will need to install pip2 and all the required dependency
 $> cd ~/esp
 $> sudo apt install python-pip
 $> python2.7 -m pip install --user -r ~/esp/ESP8266_RTOS_SDK/requirements.txt

2. Test the installation

To test the installation of the your new SDK, we will compile the get-started example project.

 $> cd ~/esp/ESP8266_RTOS_SDK/examples/get-started/hello_world
 $> make menuconfig
 ** Change any parameter you'd like ***
 $> make

The compilation process could take a bit of time, since the entire SDK will have to be compiled for the first time. Consider getting yourself a coffee☕
If the compilation was successful, congrats, you have a fully working official ESP8266 SDK at you disposal ! 🥳

Clone this wiki locally