Module embuild::espidf

Available on crate feature espidf only.

esp-idf source and tools installation.

This module enables discovering and/or installing an esp-idf GIT repository, and the corresponding tools for an esp-idf version.

Right now, there are two locations where the esp-idf source and tools are detected and installed:

• install_dir

• ~/.espressif, if install_dir is None

Modules

ulp_fsmelf

Structs

EspIdf

Information about a esp-idf source and tools installation.

EspIdfBuildInfo

Info about the esp-idf build.

EspIdfRemote

A distinct version of the esp-idf repository to be installed.

EspIdfVersion

The version of an esp-idf repository.

Installer

Installer for the esp-idf source and tools.

Tools

One or more esp-idf tools.

Enums

EspIdfOrigin

The origin of the esp-idf repository.

FromEnvError

The error returned by EspIdf::try_from_env.

Constants

BUILD_INFO_FILENAME

Default filename for the file that contains EspIdfBuildInfo.

GLOBAL_INSTALL_DIR

The global install dir of the esp-idf and its tools, relative to the user home dir.

IDF_PATH_VAR

Environment variable containing the path to the esp-idf when in activated environment.

IDF_TOOLS_PATH_VAR

Environment variable containing the path to the tools required by the esp-idf.

Functions

parse_esp_idf_git_ref

Parse a git::Ref from an esp-idf version string.