Merge branch 'main' into wrapper

Author: pschatzmann

.github/workflows/c-cpp-cmake.yml

@@ -13,5 +13,7 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
+      with:
+        submodules: 'true'
     - name: build.sh
       run: ./build.sh

.github/workflows/unit-tests.yml

@@ -25,6 +25,8 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v2
+        with:
+          submodules: 'true'
 
       - name: Relax some warings
         # run: echo 'add_compile_options(-Wno-unused-function)' >> ArduinoCore-API/test/CMakeLists.txt
@@ -51,4 +53,4 @@ jobs:
       #  with:
       #    token: ${{ secrets.CODECOV_TOKEN }}
       #    files: ${{ env.COVERAGE_DATA_PATH }}
-      #    fail_ci_if_error: true
+      #    fail_ci_if_error: true

ArduinoCore-Linux/cores/arduino/EthernetUDP.h

@@ -34,8 +34,8 @@
  * bjoern@cs.stanford.edu 12/30/2008
  */
 
-#include <api/IPAddress.h>
-#include <api/Udp.h>
+#include "api/IPAddress.h"
+#include "api/Udp.h"
 #include <RingBufferExt.h>
 #include "SignalHandler.h"
 #include "ArduinoLogger.h"

ArduinoCore-Linux/cores/arduino/FileStream.h

@@ -2,8 +2,7 @@
 
 #include <fstream>
 #include <iostream>
-
-#include "Stream.h"
+#include "api/Stream.h"
 
 namespace arduino {
 

ArduinoCore-Linux/cores/arduino/Serial.h

@@ -2,8 +2,8 @@
 
 #if USE_SERIALLIB
 
-#include "HardwareSerial.h"
 #include "serialib.h"
+#include "api/HardwareSerial.h"
 
 namespace arduino {
 

ArduinoCore-Linux/cores/arduino/StdioDevice.h

@@ -2,9 +2,8 @@
 
 #include <iostream>
 #include <streambuf>
-
-#include "Printable.h"
-#include "Stream.h"
+#include "api/Stream.h"
+#include "api/Printable.h"
 
 namespace arduino {
 

CMakeLists.txt

@@ -45,7 +45,7 @@ target_include_directories (arduino_emulator PUBLIC
 
 # Install header files 
 install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/ArduinoCore-API/api/" # source directory
-    DESTINATION "include/arduino" # target directory
+    DESTINATION "include/arduino/api" # target directory
     FILES_MATCHING # install only matched files
     PATTERN "*.h" # select header files
 )

README.md

@@ -6,7 +6,7 @@
 ## Using this Project as a library
 
 If you have an Arduino Sketch that you want to run e.g in Linux, OS/X or Windows you can include this library with cmake. 
-Here is an [example cmake file](https://github.com/pschatzmann/arduino-audio-tools/blob/main/examples/examples-desktop/generator/CMakeLists.txt) for a [Arduino Audio Sketch](https://github.com/pschatzmann/arduino-audio-tools/tree/main/examples/examples-desktop/generator)).
+Here is an [example cmake file](https://github.com/pschatzmann/arduino-audio-tools/blob/main/examples/examples-desktop/generator/CMakeLists.txt) for an [Arduino Audio Sketch](https://github.com/pschatzmann/arduino-audio-tools/tree/main/examples/examples-desktop/generator)).
 
 ## GPIO/SPI/I2C
 
@@ -66,5 +66,12 @@ Adjust the cmake parameters dependent on your requirements.
 
 ## Documentation
 
-The generated [Class documentation](https://pschatzmann.github.io/Arduino-Emulator/html/annotated.html). 
+- [Class documentation](https://pschatzmann.github.io/Arduino-Emulator/html/annotated.html). 
+- You can find further information in the [Wiki](https://github.com/pschatzmann/Arduino-Emulator/wiki)
 
+## Usage notes
+
+### Case-insensitive file systems (Windows, OSX, WSL)
+
+To avoid conflicts between system `string.h` and Arduino’s string library `String.h`, just do not put `(include)/api` to include path. Put `(include)` and `(include)/api/deprecated` instead.
+This usual way to resolve this conflict in all Arduino cores.