Dependency problem on AVR specific #include.

[RobTillaart]

Hi,

am struggling with a library - https://github.com/RobTillaart/DS18B20_INT

The library needs the "OneWire: so I adapted .arduino-ci.yml

compile:
  # Choosing to run compilation tests on 2 different Arduino platforms
  platforms:
    - uno
    - leonardo
    - due
    - zero
  # Declaring Dependent Arduino Libraries (to be installed via the Arduino Library Manager)
  libraries:
    - "OneWire"

unittest:
  # These dependent libraries will be installed
  libraries:
    - "OneWire"
    - "util/crc16"   <<<<<<<<<<<<<<<<<<< does not work.

The example of the lib now compiles correctly, however the unit test fails on util/crc16.h  which is used by the OneWire lib.
The path (on my PC) is   ...\Arduino\hardware\tools\avr\avr\include\util\crc16.h  but I do not know how to include it in the unit test.

It might be a feature that need to be solved in the future.

For now I will disable the unit test.

[ianfixes]

Can you post the output from the unit test run? The libraries that you list in the config file refer to the names that the library manager would use, not paths on disk. If utl/crc16.h isn't being made available to the unit tests, that's the real bug here.

[RobTillaart]

LOG_DS28CM00_LIB.zip

This log is from the DS28CM00 library [this is an ID chip] - https://github.com/RobTillaart/DS28CM00/tree/arduino-ci

• The unit test compiles and runs as expected.
• Three examples

1. Compiles as expected
2. fails on #include util/crc16.h
3. fails on #include rom/crc.h This example is an ESP32 specific example of previous.

The problem 3 is expected and need to be fixed. I will merge [2] and [3] and use conditional compilation.
When I get ESP32 to work it will be tested too. (another story).

[ianfixes]

@per1234 does the use of utli/crc16.h or rom/crc.h fall under either "undocumented API" or "platform-specific feature"?

I'm tempted to close this as "works as intended", with limiting the set of test platforms & adding preprocessor directives being the proper remedy. But I want to double check that assumption.

[per1234]

"undocumented API"

util/crc16.h

it's definitely documented: https://www.nongnu.org/avr-libc/user-manual/group__util__crc.html

rom/crc.h

I'm not sure. I see there is doxygen documentation in the source code:
https://github.com/espressif/esp-idf/blob/v3.3.4/components/esp32/include/rom/crc.h
but I didn't find that documentation published anywhere. I really don't have much experience with the ESP32.

"platform-specific feature"

It looks like both of these are platform-specific.

[ianfixes]

Hmm. I'll probably deprioritize this then, sorry Rob.

My reasoning here is that it seems fruitless to try and replicate all functions that might exist in any platform library (vs existing in the "core" set of Arduino library functions). I had enough trouble with the AVR side of things, and don't want to go further down that path unless/until I can find a smarter way to do it.

I can revisit this if there is movement on arduino/arduino-cli#1090 or arduino/arduino-cli#1092

[RobTillaart]

Hmm. I'll probably deprioritize this then, sorry Rob.

OK, but as the OneWire library is used for several devices / libraries, all these will be affected.
So please do not close.

If I find a workaround I will let you know.