Cannot compile: driver/spi_master.h not found

[calando]

When trying to build an ESP32 project using this component, I get this error:

C:/Users/Calando/source/repos/ec_spinning/managed_components/nopnop2002__ssd1306/ssd1306.h:4:10: fatal error: driver/spi_master.h: No such file or directory

My idf_component.yml contains:

dependencies:
pid_ctrl: "^0.1.1"
bdc_motor: "^0.2.0"
nopnop2002/ssd1306:
path: components/ssd1306/
git: https://github.com/nopnop2002/esp-idf-ssd1306.git

The component is cloned into managed_components, but it seems that the PRIV_REQUIRES does not lead the the include path for esp_driver_spi to be included into the compiler command for the main.c file (I am using ESP-IDF V6.0.2 and the latest ESP-IDF VS Code extension).

In my main.c file, I include ssd1306.h which in turn includes driver/spi_master.h; this should work due to the CMakeLists.txt in managed_components/nopnop2002__ssd1306. When looking in the c:\esp directory, the include file is present (C:\esp\v6.0.2\esp-idf\components\esp_driver_spi\include\driver\spi_master.h), however.

I found no workaround for that problem up to now.

[nopnop2002]

Please try building from the command line without using the ESP-IDF VS Code extension.
This is likely the cause.
Try this

$ cp -r esp-idf-ssd1306/TextDemo $HOME

$ cd $HOME/TextDemo

$ vi main/idf_component.yml
dependencies:
  pid_ctrl: "^0.1.1"
  bdc_motor: "^0.2.0"
  nopnop2002/ssd1306:
    path: components/ssd1306/
    git: https://github.com/nopnop2002/esp-idf-ssd1306.git

$ vi CMakeLists.txt
# The following lines of boilerplate have to be in your project's CMakeLists
# in this exact order for cmake to work correctly
cmake_minimum_required(VERSION 3.5)

#set(EXTRA_COMPONENT_DIRS ../components/ssd1306) --> Delete this

include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(ssd1306)

$ idf.py build

[calando]

I do not have the extra_component_dirs in the top-level CmakeLists.txt file anyway. However, building from the CLI shows the solution:

ninja: build stopped: subcommand failed.
Compilation failed because ssd1306.h (in "nopnop2002__ssd1306" component) includes driver/spi_master.h,
provided by esp_driver_spi component(s).
However, esp_driver_spi component(s) is in the private requirements list of "nopnop2002__ssd1306".
To fix this, move esp_driver_spi from PRIV_REQUIRES into REQUIRES list of idf_component_register call in
C:\Users\Calando\source\repos\ec_spinning\managed_components\nopnop2002__ssd1306\CMakeLists.txt.

Changing "PRIV_REQUIRES" to "REQUIRES" in the components/ssd1306/CmakeLists.txt file indeed fixes the behavior:

set(component_srcs "ssd1306.c" "ssd1306_spi.c")
set(component_requires "driver esp_driver_spi esp_driver_i2c esp_driver_gpio")

# get IDF version for comparison
set(idf_version "${IDF_VERSION_MAJOR}.${IDF_VERSION_MINOR}")

if(idf_version VERSION_GREATER_EQUAL "5.2")
	if(CONFIG_LEGACY_DRIVER)
		list(APPEND component_srcs "ssd1306_i2c_legacy.c")
	else()
		list(APPEND component_srcs "ssd1306_i2c_new.c")
	endif()
else()
	list(APPEND component_srcs "ssd1306_i2c_legacy.c")
endif()

idf_component_register(SRCS "${component_srcs}" REQUIRES "${component_requires}" INCLUDE_DIRS ".")