stm32duino · fpistm · Jan 12, 2026 · Dec 11, 2025
diff --git a/.codespellrc b/.codespellrc
diff --git a/.gitignore b/.gitignore
diff --git a/api/ArduinoAPI.h → ArduinoAPI.h b/api/ArduinoAPI.h → ArduinoAPI.h
diff --git a/api/Binary.h → Binary.h b/api/Binary.h → Binary.h
diff --git a/api/CanMsg.cpp → CanMsg.cpp b/api/CanMsg.cpp → CanMsg.cpp
diff --git a/api/CanMsg.h → CanMsg.h b/api/CanMsg.h → CanMsg.h
diff --git a/api/CanMsgRingbuffer.cpp → CanMsgRingbuffer.cpp b/api/CanMsgRingbuffer.cpp → CanMsgRingbuffer.cpp
diff --git a/api/CanMsgRingbuffer.h → CanMsgRingbuffer.h b/api/CanMsgRingbuffer.h → CanMsgRingbuffer.h
diff --git a/api/Client.h → Client.h b/api/Client.h → Client.h
diff --git a/api/Common.cpp → Common.cpp b/api/Common.cpp → Common.cpp
diff --git a/api/Common.h → Common.h b/api/Common.h → Common.h
diff --git a/api/Compat.h → Compat.h b/api/Compat.h → Compat.h
diff --git a/api/DMAPool.h → DMAPool.h b/api/DMAPool.h → DMAPool.h
diff --git a/api/HardwareCAN.h → HardwareCAN.h b/api/HardwareCAN.h → HardwareCAN.h
diff --git a/api/HardwareI2C.h → HardwareI2C.h b/api/HardwareI2C.h → HardwareI2C.h
diff --git a/api/HardwareSPI.h → HardwareSPI.h b/api/HardwareSPI.h → HardwareSPI.h
diff --git a/api/HardwareSerial.h → HardwareSerial.h b/api/HardwareSerial.h → HardwareSerial.h
diff --git a/api/IPAddress.cpp → IPAddress.cpp b/api/IPAddress.cpp → IPAddress.cpp
diff --git a/api/IPAddress.h → IPAddress.h b/api/IPAddress.h → IPAddress.h
diff --git a/api/Interrupts.h → Interrupts.h b/api/Interrupts.h → Interrupts.h
diff --git a/api/PluggableUSB.cpp → PluggableUSB.cpp b/api/PluggableUSB.cpp → PluggableUSB.cpp
diff --git a/api/PluggableUSB.h → PluggableUSB.h b/api/PluggableUSB.h → PluggableUSB.h
diff --git a/api/Print.cpp → Print.cpp b/api/Print.cpp → Print.cpp
diff --git a/api/Print.h → Print.h b/api/Print.h → Print.h
diff --git a/api/Printable.h → Printable.h b/api/Printable.h → Printable.h
diff --git a/README.md b/README.md
diff --git a/api/RingBuffer.h → RingBuffer.h b/api/RingBuffer.h → RingBuffer.h
diff --git a/ST-README.md b/ST-README.md
@@ -0,0 +1,100 @@
+# 📚 ArduinoCore-API for STM32duino
+
+Fork of [`arduino/ArduinoCore-API`](https://github.com/arduino/ArduinoCore-API)  
+Designed to be used as a git submodule in [`stm32duino/Arduino_Core_STM32`](https://github.com/stm32duino/Arduino_Core_STM32)
+
+---
+
+## 🎯 Purpose
+
+This repository is a fork which reworks the folder structure to contain only the official Arduino API and hardware‑independent code, in order to simplify Arduino API integration into STM32duino via a git submodule.
+
+It will also contain some updates/changes/enhancements/fixes.
+
+---
+
+## 📦 What's Included?
+
+- ✅ Official Arduino API files (`api/` folder)
+- ✅ some updates, changes, enhancements and fixes.
+
+---
+
+## 🚀 Submodule usage
+
+### 1️⃣ Add the Submodule
+
+In the `Arduino_Core_STM32` repository, run:
+
+```bash
+
+git submodule add https://github.com/stm32duino/ArduinoCore-API.git cores/arduino/api
+```
+### 2️⃣ Initialize and update
+```bash
+git submodule update --init 
+```
+
+---
+
+## 🔗 Official Resources
+
+| Resource | Link |
+|----------|------|
+| **Official ArduinoCore-API** | https://github.com/arduino/ArduinoCore-API |
+| **STM32duino** | https://github.com/stm32duino/Arduino_Core_STM32 |
+
+---
+
+## 📝 License
+
+This repository is a fork of `arduino/ArduinoCore-API` and maintains the **same license** (LGPL 2.1+).
+
+See the [LICENSE](License) file in the repository root for details.
+
+---
+
+## 💡 Important Notes
+
+### ✅ Advantages of Using a Submodule
+
+- **Traceability**: Know exactly which version of the API you're using
+- **Easy Updates**: Simple `git submodule update` to sync
+- **Isolation**: API stays in its own code branch
+- **Compatibility**: STM32-specific modifications remain separate
+
+### ⚠️ Points to Consider
+
+- After cloning **Arduino_Core_STM32**, run:
+  ```bash
+  git submodule update --init --recursive
+  ```
+
+---
+
+## 📊 Project Information
+
+| Property | Value |
+|----------|-------|
+| **Type** | fork |
+| **Use Case** | Submodule for STM32duino |
+| **Language** | C/C++ |
+| **License** | LGPL 2.1+ |
+| **Original Repository** | https://github.com/arduino/ArduinoCore-API |
+---
+
+## ✨ Quick Start
+
+### Clone **Arduino_Core_STM32** with this submodule
+
+```bash
+git clone --recurse-submodules https://github.com/stm32duino/Arduino_Core_STM32.git
+```
+
+### Update submodule
+
+```bash
+git submodule update --remote
+```
+
+---
diff --git a/api/Server.h → Server.h b/api/Server.h → Server.h
diff --git a/api/Stream.cpp → Stream.cpp b/api/Stream.cpp → Stream.cpp
diff --git a/api/Stream.h → Stream.h b/api/Stream.h → Stream.h
diff --git a/api/String.cpp → String.cpp b/api/String.cpp → String.cpp
diff --git a/api/String.h → String.h b/api/String.h → String.h
diff --git a/api/USBAPI.h → USBAPI.h b/api/USBAPI.h → USBAPI.h
diff --git a/api/Udp.h → Udp.h b/api/Udp.h → Udp.h
diff --git a/api/WCharacter.h → WCharacter.h b/api/WCharacter.h → WCharacter.h
diff --git a/api/deprecated-avr-comp/avr/dtostrf.c.impl → deprecated-avr-comp/avr/dtostrf.c.impl b/api/deprecated-avr-comp/avr/dtostrf.c.impl → deprecated-avr-comp/avr/dtostrf.c.impl
diff --git a/api/deprecated-avr-comp/avr/dtostrf.h → deprecated-avr-comp/avr/dtostrf.h b/api/deprecated-avr-comp/avr/dtostrf.h → deprecated-avr-comp/avr/dtostrf.h
diff --git a/api/deprecated-avr-comp/avr/interrupt.h → deprecated-avr-comp/avr/interrupt.h b/api/deprecated-avr-comp/avr/interrupt.h → deprecated-avr-comp/avr/interrupt.h
diff --git a/api/deprecated-avr-comp/avr/pgmspace.h → deprecated-avr-comp/avr/pgmspace.h b/api/deprecated-avr-comp/avr/pgmspace.h → deprecated-avr-comp/avr/pgmspace.h
diff --git a/api/deprecated/Client.h → deprecated/Client.h b/api/deprecated/Client.h → deprecated/Client.h
diff --git a/api/deprecated/HardwareSerial.h → deprecated/HardwareSerial.h b/api/deprecated/HardwareSerial.h → deprecated/HardwareSerial.h
diff --git a/api/deprecated/IPAddress.h → deprecated/IPAddress.h b/api/deprecated/IPAddress.h → deprecated/IPAddress.h
diff --git a/api/deprecated/Print.h → deprecated/Print.h b/api/deprecated/Print.h → deprecated/Print.h
diff --git a/api/deprecated/Printable.h → deprecated/Printable.h b/api/deprecated/Printable.h → deprecated/Printable.h
diff --git a/api/deprecated/Server.h → deprecated/Server.h b/api/deprecated/Server.h → deprecated/Server.h
diff --git a/api/deprecated/Stream.h → deprecated/Stream.h b/api/deprecated/Stream.h → deprecated/Stream.h
diff --git a/api/deprecated/Udp.h → deprecated/Udp.h b/api/deprecated/Udp.h → deprecated/Udp.h
diff --git a/api/deprecated/WString.h → deprecated/WString.h b/api/deprecated/WString.h → deprecated/WString.h
diff --git a/api/itoa.h → itoa.h b/api/itoa.h → itoa.h
diff --git a/test/.gitignore b/test/.gitignore
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt