From 1ea8b9eeb98c4ef85b21e68c49a3a930df167c4b Mon Sep 17 00:00:00 2001 From: Mike Dunston Date: Sat, 23 Dec 2023 06:53:45 -0800 Subject: [PATCH] Correct build instructions and dependencies The code will only build with ESP-IDF v5.1.x (or newer). It has not been tested with ESP-IDF v5.2 or master at this time. Fixes https://github.com/atanisoft/Esp32OlcbIO/issues/11 --- firmware/README.md | 10 +++++----- firmware/main/idf_component.yml | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/firmware/README.md b/firmware/README.md index 57a1f4d..11e70ab 100644 --- a/firmware/README.md +++ b/firmware/README.md @@ -32,20 +32,20 @@ Pressing the User button will generate a pair of events. ## Building -The ESP32 OpenLCB IO Board depends on ESP-IDF v4.4.x and will not build with -ESP-IDF v5.0.x at this time. +The ESP32 OpenLCB IO Board depends on ESP-IDF v5.1.x and will not build with +earlier versions. ### Configuring ESP-IDF build environment For Windows environments please use the [Windows Installer](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/windows-setup.html) -and select `release/v4.4` when prompted for a version. It is only necessary to +and select `release/v5.1` when prompted for a version. It is only necessary to install the basic command line tools, Eclipse (or other IDEs) are optional. For Linux / Mac environments it is recommended to use `git clone` to setup and maintain the ESP-IDF build enviornment: ``` -git clone https://github.com/espressif/esp-idf.git --depth 1 --branch release/v4.4 esp-idf-v4.4 --recursive -cd esp-idf-v4.4 +git clone https://github.com/espressif/esp-idf.git --depth 1 --branch release/v5.1 esp-idf-v5.1 --recursive +cd esp-idf-v5.1 sh install.sh ``` diff --git a/firmware/main/idf_component.yml b/firmware/main/idf_component.yml index e745f8e..4922acd 100644 --- a/firmware/main/idf_component.yml +++ b/firmware/main/idf_component.yml @@ -1,5 +1,5 @@ dependencies: - idf: ">=5.0" + idf: ">=5.1" OpenMRNIDF: version: 5.1.0 git: https://github.com/atanisoft/OpenMRNIDF.git