Cleanup README

2026-07-08 09:37:21 +02:00 · 2026-01-14 13:37:15 -05:00
parent 498c21cffe
commit b889706706
4 changed files with 71 additions and 35 deletions
--- a/README.md
+++ b/README.md
@@ -1,22 +1,12 @@
 # Firmware

-1. [Setup](#Setup)
-    1. [Install Dependencies](#InstallDependencies)
-        1. [MacOS](#MacOS1)
-        2. [Windows](#Windows1)
-2. [Development](#Development)
-    1. [Command Line Tools](#CommandLineTools)
-        1. [MacOS](#MacOS2)
-        2. [Windows](#Windows2)
-    2. [Using an IDE](#UsinganIDE)
-        1. [Visual Studio Code](#VisualStudioCode)
-        2. [JetBrains CLion](#JetBrainsCLion)
+[[_TOC_]]

 <hr>

 ## Setup <a name="Setup"></a>
-**This project is currently setup to work with the ESP32-S3 board.** 
-We use ESP-IDF version 5.5.1. 
+**This project is currently setup to work with the ESP32-S3 board.**
+We use ESP-IDF version 5.5.1.
 The Espressif docs have a [well written article](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-guides/build-system.html) that explains the build system.
 Versions before 5.5 are incompatible due to an issue with the CMakeLists.txt file in the ledc component (that we depend on).

@@ -38,13 +28,18 @@ mkdir -p ~/esp
 cd ~/esp
 git clone --recursive https://github.com/espressif/esp-idf.git
 cd ~/esp/isp-idf
+git switch release/v5.5
+git submodule update --init --recursive
 ./install.sh esp32,esp32s3
+sudo chmod -R 777 ~/esp
 ```

+If your install is broken, you can delete the espressif folder `rm -rf ~/.espressif` and re-run the `./install` script.
+
 #### Windows <a name="Windows1"></a>
-Install ESP-IDF with with the GUI [Windows installer](https://dl.espressif.com/dl/esp-idf/?idf=4.4). 
+Install ESP-IDF with with the GUI [Windows installer](https://dl.espressif.com/dl/esp-idf/?idf=4.4).
 - Use default options.
- You may install ESP-IDF to a path that is different than the default, however, keep the length of the path under 90 characters and do not include any spaces or non ASCII characters. 
+- You may install ESP-IDF to a path that is different than the default, however, keep the length of the path under 90 characters and do not include any spaces or non ASCII characters.
 - Select version v5.5.x.
 - Ensure that the `esp32s3` checkbox is selected (should be by default)
 - The installer will automatically provide
@@ -153,4 +148,4 @@ CLion is compatible with this project. Follow [the tutorial on Espressif's site]
 ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠘⢆⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⡏⠘⣆⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢠⠏⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
 ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣼⠃⠀⠈⠳⣄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣠⠏⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
 ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠘⠁⠀⠀⠀⠀⠀⠙⠓⠤⢤⣤⣀⣀⣀⣀⣀⣠⡤⢖⠏⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
-⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠁⠀⠀⠀⠀⠀⠀⠀⠀⣀⠀⠀⠀⠀⢀⠀⠀⢀⡔⠉⠀⠀⢀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
+⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠁⠀⠀⠀⠀⠀⠀⠀⠀⣀⠀⠀⠀⠀⢀⠀⠀⢀⡔⠉⠀⠀⢀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
--- a/compile_commands.json
+++ b/compile_commands.json
@@ -0,0 +1 @@
+build/compile_commands.json
--- a/dependencies.lock
+++ b/dependencies.lock
@@ -12,7 +12,7 @@ dependencies:
  idf:
    source:
      type: idf
-    version: 6.0.0
+    version: 5.5.2
 direct_dependencies:
 - espressif/mdns
 - idf
--- a/76
+++ b/76
@@ -1,6 +1,6 @@
 #
 # Automatically generated file. DO NOT EDIT.
-# Espressif IoT Development Framework (ESP-IDF) 6.0.0 Project Configuration
+# Espressif IoT Development Framework (ESP-IDF) 5.5.2 Project Configuration
 #
 CONFIG_SOC_ADC_SUPPORTED=y
 CONFIG_SOC_UART_SUPPORTED=y
@@ -124,7 +124,6 @@ CONFIG_SOC_GPIO_OUT_RANGE_MAX=48
 CONFIG_SOC_GPIO_VALID_DIGITAL_IO_PAD_MASK=0x0001FFFFFC000000
 CONFIG_SOC_GPIO_CLOCKOUT_BY_IO_MUX=y
 CONFIG_SOC_GPIO_CLOCKOUT_CHANNEL_NUM=3
-CONFIG_SOC_GPIO_SUPPORT_HOLD_IO_IN_DSLP=y
 CONFIG_SOC_DEDIC_GPIO_OUT_CHANNELS_NUM=8
 CONFIG_SOC_DEDIC_GPIO_IN_CHANNELS_NUM=8
 CONFIG_SOC_DEDIC_GPIO_OUT_AUTO_ENABLE=y
@@ -185,7 +184,7 @@ CONFIG_SOC_RMT_CHANNELS_PER_GROUP=8
 CONFIG_SOC_RMT_MEM_WORDS_PER_CHANNEL=48
 CONFIG_SOC_RMT_SUPPORT_RX_PINGPONG=y
 CONFIG_SOC_RMT_SUPPORT_RX_DEMODULATION=y
-CONFIG_SOC_RMT_SUPPORT_TX_ASYNC_STOP=y
+CONFIG_SOC_RMT_SUPPORT_ASYNC_STOP=y
 CONFIG_SOC_RMT_SUPPORT_TX_LOOP_COUNT=y
 CONFIG_SOC_RMT_SUPPORT_TX_LOOP_AUTO_STOP=y
 CONFIG_SOC_RMT_SUPPORT_TX_SYNCHRO=y
@@ -364,7 +363,6 @@ CONFIG_SOC_COEX_HW_PTI=y
 CONFIG_SOC_EXTERNAL_COEX_LEADER_TX_LINE=y
 CONFIG_SOC_SDMMC_USE_GPIO_MATRIX=y
 CONFIG_SOC_SDMMC_NUM_SLOTS=2
-CONFIG_SOC_SDMMC_DATA_WIDTH_MAX=8
 CONFIG_SOC_SDMMC_SUPPORT_XTAL_CLOCK=y
 CONFIG_SOC_SDMMC_DELAY_PHASE_NUM=4
 CONFIG_SOC_TEMPERATURE_SENSOR_SUPPORT_FAST_RC=y
@@ -623,12 +621,10 @@ CONFIG_COMPILER_DISABLE_DEFAULT_ERRORS=y
 # CONFIG_COMPILER_DISABLE_GCC12_WARNINGS is not set
 # CONFIG_COMPILER_DISABLE_GCC13_WARNINGS is not set
 # CONFIG_COMPILER_DISABLE_GCC14_WARNINGS is not set
-# CONFIG_COMPILER_DISABLE_GCC15_WARNINGS is not set
 # CONFIG_COMPILER_DUMP_RTL_FILES is not set
 CONFIG_COMPILER_RT_LIB_GCCLIB=y
 CONFIG_COMPILER_RT_LIB_NAME="gcc"
-CONFIG_COMPILER_ORPHAN_SECTIONS_ERROR=y
-# CONFIG_COMPILER_ORPHAN_SECTIONS_WARNING is not set
+CONFIG_COMPILER_ORPHAN_SECTIONS_WARNING=y
 # CONFIG_COMPILER_ORPHAN_SECTIONS_PLACE is not set
 # CONFIG_COMPILER_STATIC_ANALYZER is not set
 # end of Compiler options
@@ -666,6 +662,33 @@ CONFIG_COMPILER_ORPHAN_SECTIONS_ERROR=y
 CONFIG_TWAI_ERRATA_FIX_LISTEN_ONLY_DOM=y
 # end of Legacy TWAI Driver Configurations

+#
+# Legacy ADC Driver Configuration
+#
+# CONFIG_ADC_SUPPRESS_DEPRECATE_WARN is not set
+# CONFIG_ADC_SKIP_LEGACY_CONFLICT_CHECK is not set
+
+#
+# Legacy ADC Calibration Configuration
+#
+# CONFIG_ADC_CALI_SUPPRESS_DEPRECATE_WARN is not set
+# end of Legacy ADC Calibration Configuration
+# end of Legacy ADC Driver Configuration
+
+#
+# Legacy MCPWM Driver Configurations
+#
+# CONFIG_MCPWM_SUPPRESS_DEPRECATE_WARN is not set
+# CONFIG_MCPWM_SKIP_LEGACY_CONFLICT_CHECK is not set
+# end of Legacy MCPWM Driver Configurations
+
+#
+# Legacy Timer Group Driver Configurations
+#
+# CONFIG_GPTIMER_SUPPRESS_DEPRECATE_WARN is not set
+# CONFIG_GPTIMER_SKIP_LEGACY_CONFLICT_CHECK is not set
+# end of Legacy Timer Group Driver Configurations
+
 #
 # Legacy RMT Driver Configurations
 #
@@ -673,12 +696,26 @@ CONFIG_TWAI_ERRATA_FIX_LISTEN_ONLY_DOM=y
 # CONFIG_RMT_SKIP_LEGACY_CONFLICT_CHECK is not set
 # end of Legacy RMT Driver Configurations

+#
+# Legacy I2S Driver Configurations
+#
+# CONFIG_I2S_SUPPRESS_DEPRECATE_WARN is not set
+# CONFIG_I2S_SKIP_LEGACY_CONFLICT_CHECK is not set
+# end of Legacy I2S Driver Configurations
+
 #
 # Legacy I2C Driver Configurations
 #
 # CONFIG_I2C_SKIP_LEGACY_CONFLICT_CHECK is not set
 # end of Legacy I2C Driver Configurations

+#
+# Legacy PCNT Driver Configurations
+#
+# CONFIG_PCNT_SUPPRESS_DEPRECATE_WARN is not set
+# CONFIG_PCNT_SKIP_LEGACY_CONFLICT_CHECK is not set
+# end of Legacy PCNT Driver Configurations
+
 #
 # Legacy SDM Driver Configurations
 #
@@ -686,6 +723,13 @@ CONFIG_TWAI_ERRATA_FIX_LISTEN_ONLY_DOM=y
 # CONFIG_SDM_SKIP_LEGACY_CONFLICT_CHECK is not set
 # end of Legacy SDM Driver Configurations

+#
+# Legacy Temperature Sensor Driver Configurations
+#
+# CONFIG_TEMP_SENSOR_SUPPRESS_DEPRECATE_WARN is not set
+# CONFIG_TEMP_SENSOR_SKIP_LEGACY_CONFLICT_CHECK is not set
+# end of Legacy Temperature Sensor Driver Configurations
+
 #
 # Legacy Touch Sensor Driver Configurations
 #
@@ -737,6 +781,7 @@ CONFIG_GPTIMER_OBJ_CACHE_SAFE=y
 #
 # CONFIG_I2C_ISR_IRAM_SAFE is not set
 # CONFIG_I2C_ENABLE_DEBUG_LOG is not set
+# CONFIG_I2C_ENABLE_SLAVE_DRIVER_VERSION_2 is not set
 CONFIG_I2C_MASTER_ISR_HANDLER_IN_IRAM=y
 # end of ESP-Driver:I2C Configurations

@@ -792,12 +837,6 @@ CONFIG_RMT_OBJ_CACHE_SAFE=y
 # CONFIG_SDM_ENABLE_DEBUG_LOG is not set
 # end of ESP-Driver:Sigma Delta Modulator Configurations

-#
-# ESP-Driver:SD Host SDMMC Controller Configurations
-#
-# CONFIG_SD_HOST_SDMMC_ISR_CACHE_SAFE is not set
-# end of ESP-Driver:SD Host SDMMC Controller Configurations
-
 #
 # ESP-Driver:SPI Configurations
 #
@@ -817,6 +856,7 @@ CONFIG_SPI_SLAVE_ISR_IN_IRAM=y
 # ESP-Driver:TWAI Configurations
 #
 # CONFIG_TWAI_ISR_IN_IRAM is not set
+# CONFIG_TWAI_IO_FUNC_IN_IRAM is not set
 # CONFIG_TWAI_ISR_CACHE_SAFE is not set
 # CONFIG_TWAI_ENABLE_DEBUG_LOG is not set
 # end of ESP-Driver:TWAI Configurations
@@ -928,6 +968,7 @@ CONFIG_GDMA_CTRL_FUNC_IN_IRAM=y
 CONFIG_GDMA_ISR_HANDLER_IN_IRAM=y
 CONFIG_GDMA_OBJ_DRAM_SAFE=y
 # CONFIG_GDMA_ENABLE_DEBUG_LOG is not set
+# CONFIG_GDMA_ISR_IRAM_SAFE is not set
 # end of GDMA Configurations

 #
@@ -1002,9 +1043,11 @@ CONFIG_ESP_PHY_RF_CAL_PARTIAL=y
 # CONFIG_ESP_PHY_RF_CAL_NONE is not set
 # CONFIG_ESP_PHY_RF_CAL_FULL is not set
 CONFIG_ESP_PHY_CALIBRATION_MODE=0
+CONFIG_ESP_PHY_PLL_TRACK_PERIOD_MS=1000
 # CONFIG_ESP_PHY_PLL_TRACK_DEBUG is not set
 # CONFIG_ESP_PHY_RECORD_USED_TIME is not set
 CONFIG_ESP_PHY_IRAM_OPT=y
+# CONFIG_ESP_PHY_DEBUG is not set
 # end of PHY

 #
@@ -1256,10 +1299,10 @@ CONFIG_ESP_WIFI_MBEDTLS_TLS_CLIENT=y
 #
 # CONFIG_ESP_WIFI_WPS_STRICT is not set
 # CONFIG_ESP_WIFI_WPS_PASSPHRASE is not set
+# CONFIG_ESP_WIFI_WPS_RECONNECT_ON_FAIL is not set
 # end of WPS Configuration Options

 # CONFIG_ESP_WIFI_DEBUG_PRINT is not set
-# CONFIG_ESP_WIFI_TESTING_OPTIONS is not set
 CONFIG_ESP_WIFI_ENTERPRISE_SUPPORT=y
 # CONFIG_ESP_WIFI_ENT_FREE_DYNAMIC_BUFFER is not set
 # end of Wi-Fi
@@ -1345,7 +1388,6 @@ CONFIG_HAL_ASSERTION_EQUALS_SYSTEM=y
 # CONFIG_HAL_ASSERTION_ENABLE is not set
 CONFIG_HAL_DEFAULT_ASSERTION_LEVEL=2
 CONFIG_HAL_WDT_USE_ROM_IMPL=y
-CONFIG_HAL_GPIO_USE_ROM_IMPL=y
 # end of Hardware Abstraction Layer (HAL) and Low Level (LL)

 #
@@ -1445,7 +1487,6 @@ CONFIG_LWIP_IP6_FRAG=y
 # CONFIG_LWIP_IP4_REASSEMBLY is not set
 # CONFIG_LWIP_IP6_REASSEMBLY is not set
 CONFIG_LWIP_IP_REASS_MAX_PBUFS=10
-CONFIG_LWIP_IPV6_DUP_DETECT_ATTEMPTS=1
 # CONFIG_LWIP_IP_FORWARD is not set
 # CONFIG_LWIP_STATS is not set
 CONFIG_LWIP_ESP_GRATUITOUS_ARP=y
@@ -1627,6 +1668,7 @@ CONFIG_MBEDTLS_SSL_OUT_CONTENT_LEN=4096
 # CONFIG_MBEDTLS_X509_TRUSTED_CERT_CALLBACK is not set
 # CONFIG_MBEDTLS_SSL_CONTEXT_SERIALIZATION is not set
 CONFIG_MBEDTLS_SSL_KEEP_PEER_CERTIFICATE=y
+# CONFIG_MBEDTLS_SSL_KEYING_MATERIAL_EXPORT is not set
 CONFIG_MBEDTLS_PKCS7_C=y
 # end of mbedTLS v3.x related

@@ -1640,7 +1682,6 @@ CONFIG_MBEDTLS_CERTIFICATE_BUNDLE_DEFAULT_FULL=y
 # CONFIG_MBEDTLS_CUSTOM_CERTIFICATE_BUNDLE is not set
 # CONFIG_MBEDTLS_CERTIFICATE_BUNDLE_DEPRECATED_LIST is not set
 CONFIG_MBEDTLS_CERTIFICATE_BUNDLE_MAX_CERTS=200
-# CONFIG_MBEDTLS_CERTIFICATE_BUNDLE_CROSS_SIGNED_VERIFY is not set
 # end of Certificate Bundle

 # CONFIG_MBEDTLS_ECP_RESTARTABLE is not set
@@ -2069,7 +2110,6 @@ CONFIG_WPA_MBEDTLS_TLS_CLIENT=y
 # CONFIG_WPA_WPS_SOFTAP_REGISTRAR is not set
 # CONFIG_WPA_WPS_STRICT is not set
 # CONFIG_WPA_DEBUG_PRINT is not set
-# CONFIG_WPA_TESTING_OPTIONS is not set
 CONFIG_TIMER_TASK_PRIORITY=1
 CONFIG_TIMER_TASK_STACK_DEPTH=2048
 CONFIG_TIMER_QUEUE_LENGTH=10