This repository provides a simple script dev.sh
to make the development for the ESP8266 or the ESP32 a bit more handful.
After you cloned this repository you need to run ./dev.sh install
once to initiate the SDK and to download the official espressif toolchain.
All command are available for both SDKs RTOS and NONOS(non os). For a full list of available commands simple run ./dev.sh
without arguments or ./dev.sh --help
.
- Install the xtensa-lx106-elf-linux64 toolchain, you can specify the version with the environment variable
TOOLCHAIN_VERSION
or viaTOOLCHAIN_VERSION
inconfig.inc.sh
. - Initiate git submodules, if required
- Update to the latest version 3 NONOS and RTOS SDK or the selected branch by
*_SDK_BRANCH
, seeinc/install/15_submodule.sh
for details - Generate a symlink for python2 for the PATH environment variable, since some official simple invoke
python
notpython2
- Fix shebank on all python files (They use and require python2)
- Create a project directory inside of the RTOS SDK
- Set the
$PATH
variable to contain thepython
symlink and the toolchain - Set the
$IDF_PATH
variable to the selected SDK root - Set the
$PS1_EXPAND
variable to an indicator string for the selected SDK - Changes to the SDK root directory or the selected project(if specified via command line argument)
- Start a new shell with all variables set
- Ask for the project name if not provided via command line argument
- Generate a new directory for the new project
- Generate required directory structure for the new project
- Copy all required Makefiles and so on
- Run
git init
inside of the new create project - Get a proper
.gitignore
and make initial commit - All things the
run
command does
Simple run ./dev.sh
without argument to see all avail options.
Add $PS1_EXPAND
anywhere to your shell PROMPT/PS1 in your local .bashrc
or .zshrc
. This will show you in indicator, when developing :) .
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.