EspUp

rustup for esp-rs

espup is a tool for installing and maintaining the required toolchains for developing applications in Rust for Espressif SoC's.

Requirements

Before running or installing espup, make sure that rustup and the following dependencies are installed.

Windows

git.
Python: Only required when installing ESP-IDF.

Linux

Ubuntu/Debian sh sudo apt-get install -y git python3 python3-pip gcc build-essential curl pkg-config libudev-dev libtinfo5
- libudev-dev is only required when installing cargo-espflash.
- python3 and python3-pip are only required when installing ESP-IDF.
- libtinfo5 is required by LLVM 15.
Fedora sh sudo dnf -y install git python3 python3-pip gcc systemd-devel ncurses-compat-libs
- systemd-devel is only required when installing cargo-espflash.
- python3 and python3-pip are only required when installing ESP-IDF.
- ncurses-compat-libs is required by LLVM 15.
openSUSE Thumbleweed/Leap sudo zypper install -y git gcc libudev-devel ninja python3 python3-pip make libncurses5
- libudev-devel is only required when installing cargo-espflash.
- python3 and python3-pip are only required when installing ESP-IDF.
- libncurses5 is required by LLVM 15.

Installation

sh cargo install espup --git https://github.com/esp-rs/espup

It's also possible to directly download the pre-compiled release binaries or using cargo-binstall.

Quickstart

See Usage section for more details.

Install

no_std sh espup install # Unix . ./export-esp.sh # Windows .\export-esp.ps1
std: Installing esp-idf via espup is not mandatory, as esp-idf-sys already takes care of it, but has some benefits. sh espup install --espidf-version <ESPIDF_VERSION> # Unix . ./export-esp.sh # Windows .\export-esp.ps1

Warning

The generated export file, by default export-esp, needs to be sourced in every terminal before building an application.

Uninstall

sh espup uninstall

Update

sh espup update

Usage

``` Usage: espup

Commands: install Installs esp-rs environment uninstall Uninstalls esp-rs environment update Updates Xtensa Rust toolchain help Print this message or the help of the given subcommand(s)

Options: -h, --help Print help information -V, --version Print version information ```

Install Subcommand

Note

Installation paths can be modified by setting the environment variables CARGO_HOME and RUSTUP_HOME before running the install command. Xtensa Rust toolchain will be installed under <rustup_home>/toolchains/esp.

``` Usage: espup install [OPTIONS]

Options: -d, --default-host Target triple of the host

-e, --espidf-version ESP-IDF version to install. If empty, no esp-idf is installed. Version format:

      - `commit:<hash>`: Uses the commit `<hash>` of the `esp-idf` repository.

      - `tag:<tag>`: Uses the tag `<tag>` of the `esp-idf` repository.

      - `branch:<branch>`: Uses the branch `<branch>` of the `esp-idf` repository.

      - `v<major>.<minor>` or `<major>.<minor>`: Uses the tag `v<major>.<minor>` of the `esp-idf` repository.

      - `<branch>`: Uses the branch `<branch>` of the `esp-idf` repository.

      When using this option, `ldproxy` crate will also be installed.

-f, --export-file Destination of the generated export file

      [default: export-esp.sh]

-c, --extra-crates Comma or space list of extra crates to install

      [default: cargo-espflash]

-l, --log-level Verbosity level of the logs

      [default: info]
      [possible values: debug, info, warn, error]

-n, --nightly-version Nightly Rust toolchain version

      [default: nightly]

-m, --profile-minimal Minifies the installation

-t, --targets Comma or space separated list of targets [esp32,esp32s2,esp32s3,esp32c3,all]

      [default: all]

-v, --toolchain-version Xtensa Rust toolchain version

      [default: 1.64.0.0]

-h, --help Print help information (use -h for a summary) ```

Uninstall Subcommand

``` Usage: espup uninstall [OPTIONS]

Options: -l, --log-level Verbosity level of the logs [default: info] [possible values: debug, info, warn, error] -h, --help Print help information ```

Update Subcommand

``` Usage: espup update [OPTIONS]

Options: -d, --default-host Target triple of the host -l, --log-level Verbosity level of the logs [default: info] [possible values: debug, info, warn, error] -v, --toolchain-version Xtensa Rust toolchain version [default: 1.64.0.0] -h, --help Print help information ```

Known Issues or Limitations

If installing esp-idf in Windows, only all targets is allowed.
In Windows, when installing esp-idf fails with: ERROR: Could not find a version that satisfies the requirement windows-curses; sys_platform == "win32" (from esp-windows-curses) (from versions: none) ERROR: No matching distribution found for windows-curses; sys_platform == "win32" Traceback (most recent call last): File "<home_dir>/.espressif\esp-idf-ae062fbba3ded0aa\release-v4.4\tools\idf_tools.py", line 1973, in <module> main(sys.argv[1:]) File "<home_dir>/.espressif\esp-idf-ae062fbba3ded0aa\release-v4.4\tools\idf_tools.py", line 1969, in main action_func(args) File "<home_dir>/.espressif\esp-idf-ae062fbba3ded0aa\release-v4.4\tools\idf_tools.py", line 1619, in action_install_python_env subprocess.check_call(run_args, stdout=sys.stdout, stderr=sys.stderr, env=env_copy) File "C:\Python311\Lib\subprocess.py", line 413, in check_call raise CalledProcessError(retcode, cmd) subprocess.CalledProcessError: Command '['<home_dir>/.espressif\\python_env\\idf4.4_py3.11_env\\Scripts\\python.exe', '-m', 'pip', 'install', '--no-warn-script-location', '-r', <home_dir>/.espressif\\esp-idf-ae062fbba3ded0aa\\release-v4.4\\requirements.txt', '--extra-index-url', 'https://dl.espressif.com/pypi']' returned non-zero exit status 1. Error: Could not install esp-idf _Solution_: Use a python version between 3.6 and 3.10 as 3.11 Python wheels are not yet released for Windows.

License

Licensed under either of:

Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.