change(examples): explicitly specify component dependencies for examples

Currently, several examples do not explicitly state their component dependencies, relying instead on the default behavior that includes all registered components and commonly required ones in the build. Explicitly adding component dependencies can reduce build time when set(COMPONENTS main) is used. Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2025-11-22 10:19:34 +01:00 · 2024-09-24 14:22:10 +02:00
parent 496e9cdff8
commit ad15109daa
216 changed files with 285 additions and 58 deletions
--- a/examples/peripherals/adc/continuous_read/main/CMakeLists.txt
+++ b/examples/peripherals/adc/continuous_read/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "continuous_read_main.c"
+                    PRIV_REQUIRES esp_adc
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/adc/oneshot_read/main/CMakeLists.txt
+++ b/examples/peripherals/adc/oneshot_read/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "oneshot_read_main.c"
+                    PRIV_REQUIRES esp_adc
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/dedicated_gpio/soft_spi/main/CMakeLists.txt
+++ b/examples/peripherals/dedicated_gpio/soft_spi/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "soft_spi_master_main.c"
+                       PRIV_REQUIRES soft_spi
                       INCLUDE_DIRS ".")
--- a/examples/peripherals/gpio/matrix_keyboard/main/CMakeLists.txt
+++ b/examples/peripherals/gpio/matrix_keyboard/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "matrix_keyboard_example_main.c"
+                       PRIV_REQUIRES matrix_keyboard
                       INCLUDE_DIRS "")
--- a/examples/peripherals/i2c/i2c_eeprom/main/CMakeLists.txt
+++ b/examples/peripherals/i2c/i2c_eeprom/main/CMakeLists.txt
@@ -1,4 +1,5 @@
 set(srcs "i2c_eeprom_main.c")

 idf_component_register(SRCS ${srcs}
-                    INCLUDE_DIRS ".")
+                       PRIV_REQUIRES esp_driver_i2c i2c_eeprom
+                       INCLUDE_DIRS ".")
--- a/examples/peripherals/i2c/i2c_tools/main/CMakeLists.txt
+++ b/examples/peripherals/i2c/i2c_tools/main/CMakeLists.txt
@@ -1,3 +1,4 @@
 idf_component_register(SRCS "i2ctools_example_main.c"
                            "cmd_i2ctools.c"
+                       PRIV_REQUIRES fatfs esp_driver_i2c
                       INCLUDE_DIRS ".")
--- a/examples/peripherals/jpeg/jpeg_decode/main/CMakeLists.txt
+++ b/examples/peripherals/jpeg/jpeg_decode/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "jpeg_decode_main.c"
+                    PRIV_REQUIRES fatfs esp_driver_jpeg esp_psram
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/jpeg/jpeg_encode/main/CMakeLists.txt
+++ b/examples/peripherals/jpeg/jpeg_encode/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "jpeg_encode_main.c"
+                    PRIV_REQUIRES fatfs esp_driver_jpeg
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/lcd/i80_controller/main/CMakeLists.txt
+++ b/examples/peripherals/lcd/i80_controller/main/CMakeLists.txt
@@ -4,6 +4,7 @@ if(CONFIG_EXAMPLE_LCD_IMAGE_FROM_EMBEDDED_BINARY)
 endif()

 idf_component_register(SRCS "i80_controller_example_main.c" "lvgl_demo_ui.c" ${embedded_images}
+                       PRIV_REQUIRES esp_lcd spiffs esp_psram
                       INCLUDE_DIRS ".")

 if(CONFIG_EXAMPLE_LCD_IMAGE_FROM_FILE_SYSTEM)
--- a/examples/peripherals/lcd/rgb_panel/main/CMakeLists.txt
+++ b/examples/peripherals/lcd/rgb_panel/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "rgb_lcd_example_main.c" "lvgl_demo_ui.c"
+                       PRIV_REQUIRES esp_lcd
                       INCLUDE_DIRS ".")
--- a/examples/peripherals/lcd/tjpgd/main/CMakeLists.txt
+++ b/examples/peripherals/lcd/tjpgd/main/CMakeLists.txt
@@ -5,4 +5,5 @@ set(srcs "pretty_effect.c"

 idf_component_register(SRCS ${srcs}
                    INCLUDE_DIRS "."
+                    PRIV_REQUIRES esp_lcd
                    EMBED_FILES image.jpg)
--- a/examples/peripherals/ledc/ledc_basic/main/CMakeLists.txt
+++ b/examples/peripherals/ledc/ledc_basic/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "ledc_basic_example_main.c"
+                    PRIV_REQUIRES esp_driver_ledc esp_driver_gpio
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/ledc/ledc_fade/main/CMakeLists.txt
+++ b/examples/peripherals/ledc/ledc_fade/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "ledc_fade_example_main.c"
+                    PRIV_REQUIRES esp_driver_ledc esp_driver_gpio
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/ledc/ledc_gamma_curve_fade/main/CMakeLists.txt
+++ b/examples/peripherals/ledc/ledc_gamma_curve_fade/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "ledc_gamma_curve_fade_example_main.c"
+                    PRIV_REQUIRES esp_driver_ledc esp_driver_gpio
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/mcpwm/mcpwm_bldc_hall_control/main/CMakeLists.txt
+++ b/examples/peripherals/mcpwm/mcpwm_bldc_hall_control/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "mcpwm_bldc_hall_control_example_main.c"
+                       PRIV_REQUIRES esp_driver_mcpwm esp_timer esp_driver_gpio
                       INCLUDE_DIRS ".")
--- a/examples/peripherals/mcpwm/mcpwm_capture_hc_sr04/main/CMakeLists.txt
+++ b/examples/peripherals/mcpwm/mcpwm_capture_hc_sr04/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "mcpwm_capture_hc_sr04.c"
-                    INCLUDE_DIRS ".")
+                       PRIV_REQUIRES esp_driver_mcpwm esp_driver_gpio
+                       INCLUDE_DIRS ".")
--- a/examples/peripherals/mcpwm/mcpwm_servo_control/main/CMakeLists.txt
+++ b/examples/peripherals/mcpwm/mcpwm_servo_control/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "mcpwm_servo_control_example_main.c"
-                    INCLUDE_DIRS ".")
+                       PRIV_REQUIRES esp_driver_mcpwm
+                       INCLUDE_DIRS ".")
--- a/examples/peripherals/mcpwm/mcpwm_sync/main/CMakeLists.txt
+++ b/examples/peripherals/mcpwm/mcpwm_sync/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "mcpwm_sync_example_main.c"
+                       PRIV_REQUIRES esp_driver_mcpwm esp_driver_gpio
                       INCLUDE_DIRS ".")
--- a/examples/peripherals/pcnt/rotary_encoder/main/CMakeLists.txt
+++ b/examples/peripherals/pcnt/rotary_encoder/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "rotary_encoder_example_main.c"
+                       PRIV_REQUIRES esp_driver_pcnt esp_driver_gpio
                       INCLUDE_DIRS ".")
--- a/examples/peripherals/rmt/dshot_esc/main/CMakeLists.txt
+++ b/examples/peripherals/rmt/dshot_esc/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "dshot_esc_example_main.c" "dshot_esc_encoder.c"
+                       PRIV_REQUIRES esp_driver_rmt
                       INCLUDE_DIRS ".")
--- a/examples/peripherals/rmt/ir_nec_transceiver/main/CMakeLists.txt
+++ b/examples/peripherals/rmt/ir_nec_transceiver/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "ir_nec_transceiver_main.c" "ir_nec_encoder.c"
+                       PRIV_REQUIRES esp_driver_rmt
                       INCLUDE_DIRS ".")
--- a/examples/peripherals/rmt/led_strip/main/CMakeLists.txt
+++ b/examples/peripherals/rmt/led_strip/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "led_strip_example_main.c" "led_strip_encoder.c"
+                       PRIV_REQUIRES esp_driver_rmt
                       INCLUDE_DIRS ".")
--- a/examples/peripherals/rmt/led_strip_simple_encoder/main/CMakeLists.txt
+++ b/examples/peripherals/rmt/led_strip_simple_encoder/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "led_strip_example_main.c"
+                       PRIV_REQUIRES esp_driver_rmt
                       INCLUDE_DIRS ".")
--- a/examples/peripherals/rmt/musical_buzzer/main/CMakeLists.txt
+++ b/examples/peripherals/rmt/musical_buzzer/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "musical_buzzer_example_main.c" "musical_score_encoder.c"
+                       PRIV_REQUIRES esp_driver_rmt
                       INCLUDE_DIRS ".")
--- a/examples/peripherals/rmt/stepper_motor/main/CMakeLists.txt
+++ b/examples/peripherals/rmt/stepper_motor/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "stepper_motor_example_main.c" "stepper_motor_encoder.c"
+                       PRIV_REQUIRES esp_driver_rmt esp_driver_gpio
                       INCLUDE_DIRS ".")
--- a/examples/peripherals/sdio/slave/main/CMakeLists.txt
+++ b/examples/peripherals/sdio/slave/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "app_main.c"
-                    INCLUDE_DIRS ".")
+                       PRIV_REQUIRES esp_driver_sdio esp_ringbuf
+                       INCLUDE_DIRS ".")
--- a/examples/peripherals/sigma_delta/sdm_dac/main/CMakeLists.txt
+++ b/examples/peripherals/sigma_delta/sdm_dac/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "sdm_dac_example_main.c"
+                       PRIV_REQUIRES esp_driver_sdm esp_driver_gptimer
                       INCLUDE_DIRS ".")
--- a/examples/peripherals/sigma_delta/sdm_led/main/CMakeLists.txt
+++ b/examples/peripherals/sigma_delta/sdm_led/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "sdm_led_example_main.c"
+                       PRIV_REQUIRES esp_driver_sdm
                       INCLUDE_DIRS ".")
--- a/examples/peripherals/spi_master/hd_eeprom/main/CMakeLists.txt
+++ b/examples/peripherals/spi_master/hd_eeprom/main/CMakeLists.txt
@@ -1,4 +1,5 @@
 set(srcs "spi_eeprom_main.c")

 idf_component_register(SRCS ${srcs}
-                    INCLUDE_DIRS ".")
+                       PRIV_REQUIRES esp_driver_spi esp_driver_gpio eeprom
+                       INCLUDE_DIRS ".")
--- a/examples/peripherals/spi_master/lcd/main/CMakeLists.txt
+++ b/examples/peripherals/spi_master/lcd/main/CMakeLists.txt
@@ -5,4 +5,5 @@ set(srcs "pretty_effect.c"

 idf_component_register(SRCS ${srcs}
                    INCLUDE_DIRS "."
+                    PRIV_REQUIRES esp_driver_spi esp_driver_gpio
                    EMBED_FILES image.jpg)
--- a/examples/peripherals/spi_slave/receiver/main/CMakeLists.txt
+++ b/examples/peripherals/spi_slave/receiver/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "app_main.c"
+                    PRIV_REQUIRES esp_driver_spi esp_driver_gpio
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/spi_slave/sender/main/CMakeLists.txt
+++ b/examples/peripherals/spi_slave/sender/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "app_main.c"
+                    PRIV_REQUIRES esp_driver_spi esp_driver_gpio esp_timer
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/spi_slave_hd/append_mode/slave/main/CMakeLists.txt
+++ b/examples/peripherals/spi_slave_hd/append_mode/slave/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "app_main.c"
+                    PRIV_REQUIRES esp_driver_spi
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/spi_slave_hd/segment_mode/seg_slave/main/CMakeLists.txt
+++ b/examples/peripherals/spi_slave_hd/segment_mode/seg_slave/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "app_main.c"
+                    PRIV_REQUIRES esp_driver_spi
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/temperature_sensor/temp_sensor/main/CMakeLists.txt
+++ b/examples/peripherals/temperature_sensor/temp_sensor/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "temp_sensor_main.c"
+                       PRIV_REQUIRES esp_driver_tsens
                       INCLUDE_DIRS ".")
--- a/examples/peripherals/temperature_sensor/temp_sensor_monitor/main/CMakeLists.txt
+++ b/examples/peripherals/temperature_sensor/temp_sensor_monitor/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "temp_sensor_monitor_main.c"
+                       PRIV_REQUIRES esp_driver_tsens
                       INCLUDE_DIRS ".")
--- a/examples/peripherals/timer_group/gptimer/main/CMakeLists.txt
+++ b/examples/peripherals/timer_group/gptimer/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "gptimer_example_main.c"
-                    INCLUDE_DIRS ".")
+                       PRIV_REQUIRES esp_driver_gptimer
+                       INCLUDE_DIRS ".")
--- a/examples/peripherals/timer_group/gptimer_capture_hc_sr04/main/CMakeLists.txt
+++ b/examples/peripherals/timer_group/gptimer_capture_hc_sr04/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "gptimer_capture_hc_sr04.c"
+                       PRIV_REQUIRES esp_driver_gptimer esp_driver_gpio
                       INCLUDE_DIRS ".")
--- a/examples/peripherals/touch_sensor/touch_sensor_v1/touch_pad_interrupt/main/CMakeLists.txt
+++ b/examples/peripherals/touch_sensor/touch_sensor_v1/touch_pad_interrupt/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "tp_interrupt_main.c"
-                    INCLUDE_DIRS ".")
+                       PRIV_REQUIRES driver
+                       INCLUDE_DIRS ".")
--- a/examples/peripherals/touch_sensor/touch_sensor_v1/touch_pad_read/main/CMakeLists.txt
+++ b/examples/peripherals/touch_sensor/touch_sensor_v1/touch_pad_read/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "tp_read_main.c"
-                    INCLUDE_DIRS ".")
+                       PRIV_REQUIRES driver
+                       INCLUDE_DIRS ".")
--- a/examples/peripherals/twai/twai_alert_and_recovery/main/CMakeLists.txt
+++ b/examples/peripherals/twai/twai_alert_and_recovery/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "twai_alert_and_recovery_example_main.c"
+                    REQUIRES driver
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/twai/twai_network/twai_network_listen_only/main/CMakeLists.txt
+++ b/examples/peripherals/twai/twai_network/twai_network_listen_only/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "twai_network_example_listen_only_main.c"
+                    REQUIRES driver
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/twai/twai_network/twai_network_master/main/CMakeLists.txt
+++ b/examples/peripherals/twai/twai_network/twai_network_master/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "twai_network_example_master_main.c"
+                    REQUIRES driver
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/twai/twai_network/twai_network_slave/main/CMakeLists.txt
+++ b/examples/peripherals/twai/twai_network/twai_network_slave/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "twai_network_example_slave_main.c"
+                    REQUIRES driver
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/twai/twai_self_test/main/CMakeLists.txt
+++ b/examples/peripherals/twai/twai_self_test/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "twai_self_test_example_main.c"
+                    REQUIRES driver
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/uart/nmea0183_parser/main/CMakeLists.txt
+++ b/examples/peripherals/uart/nmea0183_parser/main/CMakeLists.txt
@@ -1,3 +1,4 @@
 idf_component_register(SRCS "nmea_parser_example_main.c"
                            "nmea_parser.c"
+                    REQUIRES esp_event esp_driver_uart
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/uart/uart_async_rxtxtasks/main/CMakeLists.txt
+++ b/examples/peripherals/uart/uart_async_rxtxtasks/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "uart_async_rxtxtasks_main.c"
+                    REQUIRES esp_driver_uart esp_driver_gpio
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/uart/uart_echo/main/CMakeLists.txt
+++ b/examples/peripherals/uart/uart_echo/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "uart_echo_example_main.c"
+                    REQUIRES esp_driver_uart esp_driver_gpio
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/uart/uart_echo_rs485/main/CMakeLists.txt
+++ b/examples/peripherals/uart/uart_echo_rs485/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "rs485_example.c"
+                    REQUIRES nvs_flash esp_driver_uart
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/uart/uart_events/main/CMakeLists.txt
+++ b/examples/peripherals/uart/uart_events/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "uart_events_example_main.c"
+                    REQUIRES esp_driver_uart
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/uart/uart_repl/main/CMakeLists.txt
+++ b/examples/peripherals/uart/uart_repl/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "uart_repl_example_main.c"
+                    REQUIRES esp_driver_uart esp_driver_gpio console
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/uart/uart_select/main/CMakeLists.txt
+++ b/examples/peripherals/uart/uart_select/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "uart_select_example_main.c"
+                    REQUIRES esp_driver_uart vfs
                    INCLUDE_DIRS ".")
--- a/examples/peripherals/usb_serial_jtag/usb_serial_jtag_echo/main/CMakeLists.txt
+++ b/examples/peripherals/usb_serial_jtag/usb_serial_jtag_echo/main/CMakeLists.txt
@@ -1,2 +1,3 @@
 idf_component_register(SRCS "usb_serial_echo_main.c"
+                    PRIV_REQUIRES esp_driver_usb_serial_jtag
                    INCLUDE_DIRS ".")