Skip to content

Support ESP-IDF Install from External Directory #170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: release/v4.1
Choose a base branch
from
Open

Support ESP-IDF Install from External Directory #170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0728ce9
use ESP_DMX_ROOT variable to locate sources
oclyke Sep 18, 2024
ffcce4e
add readme note for external cmake inclusion
oclyke Sep 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 20 additions & 15 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
)
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down