Compile fails with PlatformIO under Windows

[gicking]

Describe the bug
(Any) Arduino sketch fails to compile with Arduino Core STM32 v3.0.0 under Windows

Due to recent enhancements, I need Arduino Core STM32 v3.0.0 for a PlatformIO project. Under Linux the project compiles, under Windows I get this error

Processing nucleo_l432kc (platform: ststm32; board: nucleo_l432kc; framework: arduino)
----------------------------------------------------------------------------------------------------------------------------------
Verbose mode can be enabled via `-v, --verbose` option
CONFIGURATION: https://docs.platformio.org/page/boards/ststm32/nucleo_l432kc.html
PLATFORM: ST STM32 (19.7.1) > ST Nucleo L432KC
HARDWARE: STM32L432KCU6 80MHz, 64KB RAM, 256KB Flash
DEBUG: Current (stlink) On-board (stlink) External (blackmagic, cmsis-dap, jlink)
PACKAGES:
 - framework-arduinoststm32 @ 0.0.0+sha.7698174
 - framework-cmsis @ 2.60300.0 (6.3.0)
 - framework-cmsis-dsp @ 1.16.2
 - toolchain-gccarmnoneeabi @ 1.120301.0 (12.3.1)
LDF: Library Dependency Finder -> https://bit.ly/configure-pio-ldf
LDF Modes: Finder ~ chain, Compatibility ~ soft
Found 15 compatible libraries
Scanning dependencies...
No dependencies
Building in release mode
Compiling .pio\build\nucleo_l432kc\FrameworkArduinoVariant\PeripheralPins.c.o
Compiling .pio\build\nucleo_l432kc\FrameworkArduinoVariant\generic_clock.c.o
...
Compiling .pio\build\nucleo_l432kc\SrcWrapper\src\LL\stm32yyxx_ll_ucpd.c.o
In file included from C:\Users\ICK2BUE\.platformio\packages\framework-arduinoststm32@src-d84578b36232bb5f951e2e3754949218\cores\arduino/api/ArduinoAPI.h:31,
                 from C:\Users\ICK2BUE\.platformio\packages\framework-arduinoststm32@src-d84578b36232bb5f951e2e3754949218\cores\arduino/Arduino.h:36,
                 from C:\Users\ICK2BUE\.platformio\packages\framework-arduinoststm32@src-d84578b36232bb5f951e2e3754949218\libraries\SrcWrapper\src\HardwareTimer.cpp:26:
C:\Users\ICK2BUE\.platformio\packages\framework-arduinoststm32@src-d84578b36232bb5f951e2e3754949218\cores\arduino/api/Print.h: In member function 'size_t arduino::Print::write(const char*)':
C:\Users\ICK2BUE\.platformio\packages\framework-arduinoststm32@src-d84578b36232bb5f951e2e3754949218\cores\arduino/api/Print.h:54:42: error: 'strlen' was not declared in this scope
   54 |       return write((const uint8_t *)str, strlen(str));
      |                                          ^~~~~~
C:\Users\ICK2BUE\.platformio\packages\framework-arduinoststm32@src-d84578b36232bb5f951e2e3754949218\cores\arduino/api/Print.h:27:1: note: 'strlen' is defined in header '<cstring>'; did you forget to '#include <cstring>'?
   26 | #include "String.h"
  +++ |+#include <cstring>
   27 | #include "Printable.h"
Compiling .pio\build\nucleo_l432kc\SrcWrapper\src\LL\stm32yyxx_ll_usart.c.o
...
Compiling .pio\build\nucleo_l432kc\SrcWrapper\src\stm32\clock.c.o
*** [.pio\build\nucleo_l432kc\SrcWrapper\src\HardwareTimer.cpp.o] Error 1

================================================== [FAILED] Took 22.36 seconds ==================================================

 *  The terminal process "C:\Users\ICK2BUE\.platformio\penv\Scripts\platformio.exe 'run'" terminated with exit code: 1.
*  Terminal will be reused by tasks, press any key to close it.

Compiling the attached dummy PlatformIO project STM32_bug.zip shows the same error. I tried with Linux and Arduino IDE also and get the following results

• Linux
  • PlatformIO: ok
  • Arduino IDE: ok
• Windows
  • PlatformIO / Arduino Core STM32 v3.0.0: fails
  • Arduino IDE: ok

Note that the project compiles without error with previous v2.12.0 of Arduino Core STM32, so this was newly introduced with v3.0.0.

To Reproduce

Steps to reproduce the behavior:

1. Under Windows, open the attached project STM32_bug.zip in VSCode / PlatformIO
2. Press compile
3. See error

Expected behavior
Project should build without error.

Screenshots
See above error message

Desktop (please complete the following information):

• OS: Windows 11
• STM32 core version: 3.0.0

Board (please complete the following information):

• Name: Nucleo L432KC

Additional context
ChatGPT suspects that this is due to Windows file system not being case sensitive, i.e. #include "String.h" and #include <string.h> are not distinguished. This would explain why Linux has no issue, as it's file system is case sensitive.

I tried to fix the problem and issue a pull request, but I failed. Also, I figured that this should be easy to fix, as v2.12.0 of Arduino Core STM32 did not have this issue

[fpistm]

Hi @gicking
I convert your issue as a discussion.
Only Arduino is supported, PIO issue should be opened as a discussion or on its own GH issue/discussion or community.

I don't think it is a case sensitive issue as it build properly under Arduino IDE and also using CMake under windows.
As far as I know PIO doesn't integrate yet the 3.0.0 release and so I wonder how you can use it except if you manually add it and so probably an issue here.

We met yor issue under Arduino and fix it as advised by Arduino:
#2991

So you probably get an issue with include path under pio, ensure to not have cores/arduino/api/ folder in your include path.

[fpistm]

Thinking about it, I guess issue comes from the /tools/platformio/platformio-build.py script available within the core.
Mainly this one:
join(FRAMEWORK_DIR, "cores", "arduino", "api"),

Could you try to change it like this:

-         join(FRAMEWORK_DIR, "cores", "arduino", "api"),
+         join(FRAMEWORK_DIR, "cores", "arduino", "api", "deprecated"),

[fpistm]

I've made a PR to fix this and include a mssing path:
#3046

Let me know if it fixes your issue.

[gicking]

hello Frederic,

thanks a lot for your fast support! I added this to platformio.ini

platform_packages =
    framework-arduinoststm32 @ https://github.com/stm32duino/Arduino_Core_STM32.git#36a8f85

and now the dummy project compiles without issues, also under Win11 and PlatformIO. In my actual project I still see a lot of errors, but that may be unrelated. Please give me time to investigate and don't yet close. Thanks again and have a great day!

Georg

[gicking]

hello again,

I can confirm that your PR solves the issue under windows. The other errors were observed were my fault and unrelated to this issue.

Thanks again and have a great day! 👍

PS: will this be part of the next release, e.g. 3.0.1? Do you know when this will be released?

[fpistm]

Well latest release has less than 3 weeks so I will wait before doing a new one. Probably not before october except if I think a new one is mandatory. At this time some fixes have been merged which could requires a new release but I'm waiting to see if there is other regression.