From 260534741d97d2847583847008e3d2cd8725b20a Mon Sep 17 00:00:00 2001 From: jgromes Date: Sat, 17 Aug 2024 21:19:14 +0200 Subject: [PATCH] Added readme to ESP-IDF example --- examples/NonArduino/ESP-IDF/README.md | 10 ++++++++++ examples/NonArduino/ESP-IDF/main/idf_component.yml | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 examples/NonArduino/ESP-IDF/README.md diff --git a/examples/NonArduino/ESP-IDF/README.md b/examples/NonArduino/ESP-IDF/README.md new file mode 100644 index 00000000..401785ea --- /dev/null +++ b/examples/NonArduino/ESP-IDF/README.md @@ -0,0 +1,10 @@ +# 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 diff --git a/examples/NonArduino/ESP-IDF/main/idf_component.yml b/examples/NonArduino/ESP-IDF/main/idf_component.yml index 38382f42..ce1ccc2c 100644 --- a/examples/NonArduino/ESP-IDF/main/idf_component.yml +++ b/examples/NonArduino/ESP-IDF/main/idf_component.yml @@ -1,7 +1,7 @@ dependencies: RadioLib: # referenced locally because the example is a part of the repository itself - # under normal circumstances, it's preferrable to reference the repository instead + # under normal circumstances, it's preferable to reference the repository instead # for other options, see https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html path: ../../../../../RadioLib #git: https://github.com/jgromes/RadioLib.git