From 0728ce97ab8d73f7ec1880194bf772e407a054b9 Mon Sep 17 00:00:00 2001
From: oclyke <oclyke@oclyke.dev>
Date: Wed, 18 Sep 2024 10:37:39 -0700
Subject: [PATCH 1/2] use ESP_DMX_ROOT variable to locate sources

---
 CMakeLists.txt | 35 ++++++++++++++++++++---------------
 1 file changed, 20 insertions(+), 15 deletions(-)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 6ef5f3056..537d4bc05 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -1,28 +1,33 @@
+# If the ESP_DMX_ROOT variable is not set, set it to the current directory
+if(NOT DEFINED ESP_DMX_ROOT)
+  set(ESP_DMX_ROOT ".")
+endif()
+
 idf_component_register(
   SRCS 
        # DMX driver HAL
-       "src/dmx/hal/uart.c" "src/dmx/hal/timer.c" "src/dmx/hal/nvs.c"
-       "src/dmx/hal/gpio.c"
+       "${ESP_DMX_ROOT}/src/dmx/hal/uart.c" "${ESP_DMX_ROOT}/src/dmx/hal/timer.c" "${ESP_DMX_ROOT}/src/dmx/hal/nvs.c"
+       "${ESP_DMX_ROOT}/src/dmx/hal/gpio.c"
        
        # DMX driver and sniffer
-       "src/dmx/service.c" "src/dmx/driver.c"
-       "src/dmx/io.c" "src/dmx/device.c" "src/dmx/parameter.c"
-       "src/dmx/sniffer.c" 
+       "${ESP_DMX_ROOT}/src/dmx/service.c" "${ESP_DMX_ROOT}/src/dmx/driver.c"
+       "${ESP_DMX_ROOT}/src/dmx/io.c" "${ESP_DMX_ROOT}/src/dmx/device.c" "${ESP_DMX_ROOT}/src/dmx/parameter.c"
+       "${ESP_DMX_ROOT}/src/dmx/sniffer.c" 
 
        # RDM driver
-       "src/rdm/driver.c"
+       "${ESP_DMX_ROOT}/src/rdm/driver.c"
        
        # RDM controller
-       "src/rdm/controller/discovery.c" "src/rdm/controller/product_info.c"
-       "src/rdm/controller/device_control.c" "src/rdm/controller/dmx_setup.c"
-       "src/rdm/controller/utils.c"
+       "${ESP_DMX_ROOT}/src/rdm/controller/discovery.c" "${ESP_DMX_ROOT}/src/rdm/controller/product_info.c"
+       "${ESP_DMX_ROOT}/src/rdm/controller/device_control.c" "${ESP_DMX_ROOT}/src/rdm/controller/dmx_setup.c"
+       "${ESP_DMX_ROOT}/src/rdm/controller/utils.c"
        
        # RDM responder
-       "src/rdm/responder.c" "src/rdm/responder/discovery.c"
-       "src/rdm/responder/product_info.c" "src/rdm/responder/rdm_info.c"
-       "src/rdm/responder/device_control.c" "src/rdm/responder/queue_status.c"
-       "src/rdm/responder/dmx_setup.c" "src/rdm/responder/sensor_parameter.c"
-       "src/rdm/responder/power_lamp.c" "src/rdm/responder/utils.c"
-  INCLUDE_DIRS "src"
+       "${ESP_DMX_ROOT}/src/rdm/responder.c" "${ESP_DMX_ROOT}/src/rdm/responder/discovery.c"
+       "${ESP_DMX_ROOT}/src/rdm/responder/product_info.c" "${ESP_DMX_ROOT}/src/rdm/responder/rdm_info.c"
+       "${ESP_DMX_ROOT}/src/rdm/responder/device_control.c" "${ESP_DMX_ROOT}/src/rdm/responder/queue_status.c"
+       "${ESP_DMX_ROOT}/src/rdm/responder/dmx_setup.c" "${ESP_DMX_ROOT}/src/rdm/responder/sensor_parameter.c"
+       "${ESP_DMX_ROOT}/src/rdm/responder/power_lamp.c" "${ESP_DMX_ROOT}/src/rdm/responder/utils.c"
+  INCLUDE_DIRS "${ESP_DMX_ROOT}/src"
   REQUIRES driver esp_timer esp_common esp_hw_support nvs_flash
 )   
\ No newline at end of file

From ffcce4ef0ea77eeaf4d739be9e76ca712e1d174f Mon Sep 17 00:00:00 2001
From: oclyke <oclyke@oclyke.dev>
Date: Wed, 18 Sep 2024 13:30:32 -0700
Subject: [PATCH 2/2] add readme note for external cmake inclusion

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index c43f30f2a..f813f02db 100644
--- a/README.md
+++ b/README.md
@@ -61,6 +61,16 @@ This library can be installed by cloning this repository into your your `Arduino
 
 This library requires ESP-IDF version 4.4.1 or newer. Clone this repository into your project's `components` folder. The library can be linked by writing `#include "esp_dmx.h"` at the top of your `main.c` file.
 
+Inclusion of the library as a compoonent in your ESP-IDF project works by default. If you prefer to locate the library elsewhere it
+is possible to create a simple wrapper component in your project's `components` folder. This wrapper component should contain a `CMakeLists.txt` file with the following content:
+
+```cmake
+set(ESP_DMX_ROOT <path to esp_dmx>)
+include("${ESP_DMX_ROOT}/CMakeLists.txt")
+```
+
+The variable `ESP_DMX_ROOT` will be used to locate source files and includes for the library. Everything else will function as normal.
+
 ### PlatformIO
 
 This library is compatible with the PlatformIO IDE. Search for this library in the PlatformIO library registry and add it to your project. The library can be included by writing `#include "esp_dmx.h"` at the top of your `main.c` or `main.cpp` file.