Anonymous user
ESP-IDF: Difference between revisions
Add easy setup with nixpkgs-esp-dev
imported>Mirrexagon m (Move Python venv note below shell.nix and put in Note: box) |
imported>Mirrexagon (Add easy setup with nixpkgs-esp-dev) |
||
| Line 1: | Line 1: | ||
[https://github.com/espressif/esp-idf ESP-IDF] is the official framework to develop programs for the Espressif Systems [https://en.wikipedia.org/wiki/ESP32 ESP32] series microcontrollers. | [https://github.com/espressif/esp-idf ESP-IDF] is the official framework to develop programs for the Espressif Systems [https://en.wikipedia.org/wiki/ESP32 ESP32] series microcontrollers. | ||
This guide explains how to install and use ESP-IDF on NixOS | This guide explains how to install and use ESP-IDF on NixOS. | ||
== Setting up the toolchain == | == The easy way == | ||
ESP-IDF uses the Xtensa ESP32 GCC toolchain. Espressif hosts [https:// | The ESP32 toolchain and ESP-IDF have been packaged in https://github.com/mirrexagon/nixpkgs-esp-dev. If you have Nix 2.4 or later, you can get a shell with everything you need to build ESP-IDF projects for ESP32 with this command (no need to download anything yourself): | ||
<syntaxhighlight lang="sh"> | |||
nix --experimental-features 'nix-command flakes' develop github:mirrexagon/nixpkgs-esp-dev#esp32-idf | |||
</syntaxhighlight> | |||
If you have an older version of Nix that doesn't support flakes, you can clone the repo and use one of the included shell files: | |||
<syntaxhighlight lang="sh"> | |||
mkdir ~/esp | |||
cd ~/esp | |||
git clone https://github.com/mirrexagon/nixpkgs-esp-dev.git | |||
cd nixpkgs-esp-dev | |||
nix-shell shells/esp32-idf.nix | |||
</syntaxhighlight> | |||
See the [https://github.com/mirrexagon/nixpkgs-esp-dev#readme README] for more information. | |||
== The manual way == | |||
If you want to set up the environment yourself, here is one way to do it. | |||
=== Setting up the toolchain === | |||
ESP-IDF uses the Xtensa ESP32 GCC toolchain. Espressif hosts the official [https://github.com/espressif/crosstool-NG/releases prebuilt binaries] on GitHub. Sadly, these are not statically compiled, and do not work on NixOS without the use of a FHS environment. I will use <code>buildFHSUserEnv</code> to make the binaries work. Let's make a derivation out of this: | |||
<syntaxhighlight lang="nix"> | <syntaxhighlight lang="nix"> | ||
| Line 51: | Line 73: | ||
{{note| You can choose any other location instead of <code>~/esp</code>. This guide assumes that the location is <code>~/esp</code>.}} | {{note| You can choose any other location instead of <code>~/esp</code>. This guide assumes that the location is <code>~/esp</code>.}} | ||
== Setting up ESP-IDF and the development shell == | === Setting up ESP-IDF and the development shell === | ||
Clone the [https://github.com/espressif/esp-idf espressif/esp-idf] repository: | Clone the [https://github.com/espressif/esp-idf espressif/esp-idf] repository: | ||
<syntaxhighlight lang="sh"> | <syntaxhighlight lang="sh"> | ||