RadioLib/examples/NonArduino/ESP-IDF
Darian Leung ed67ef372a
refactor: Use sdkconfig.defaults for ESP-IDF example
ESP-IDF allows projects to specify a sdkconfig.defaults values which contain
preset values for configuration options of relevance to the project. This
allows ESP-IDF to use those presets while supplying default values for all
other configuration options, when generting the final sdkconfig file.

Changes:

- Ran `idf.py save-defconfig` to find non-default value configs. Saved
relevant ones to `sdkconfig.defaults`
- Removed `sdkconfig` file
- Added `sdkconfig` to `.gitignore` as ESP-IDF will generate a `sdkconfig`
based on `sdkconfig.defaults` when building.
2025-06-23 19:56:28 +08:00
..
main Move ESP-IDF HAL back to examples (#1322) 2024-11-30 21:53:48 +01:00
.gitignore refactor: Use sdkconfig.defaults for ESP-IDF example 2025-06-23 19:56:28 +08:00
CMakeLists.txt
README.md refactor: Use sdkconfig.defaults for ESP-IDF example 2025-06-23 19:56:28 +08:00
sdkconfig.defaults refactor: Use sdkconfig.defaults for ESP-IDF example 2025-06-23 19:56:28 +08:00

README.md

RadioLib ESP-IDF example

This example shows how to use RadioLib as ESP-IDF component, without the Arduino framework. To run in ESP-IDF (or on any other platform), RadioLib includes an internal hardware abstraction layer (HAL). This software layer takes care of basic interaction with the hardware, such as performing SPI transaction or GPIO operations. To run on your chosen ESP microcontroller, you will likely have to customize the example HAL for your specific ESP type.

Structure of the example

  • main/CMakeLists.txt - IDF component CMake file
  • main/EspHal.h - RadioLib HAL example implementation
  • main/idf_component.yml - declaration of the RadioLib dependency for this example
  • main/main.cpp - the example source code
  • sdkconfig.defaults - List of preset configuration option values for ESP-IDF. All other options use default values provided by ESP-IDF.