Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hasselmm/cmake-toolchain-arduino-cli

A CMake toolchain for Arduino entirely based upon Arduino CLI
https://github.com/hasselmm/cmake-toolchain-arduino-cli

arduino avr cmake cmake-toolchain esp32 esp8266 samd stm32

Last synced: 24 days ago
JSON representation

A CMake toolchain for Arduino entirely based upon Arduino CLI

Awesome Lists containing this project

README 

        
# CMake toolchain for Arduino CLI



How about using [CMake](https://cmake.org) to build your [Arduino](https://arduino.cc/) projects?



How about using `CMakeLists.txt` files as simple as this?



```CMake

cmake_minimum_required(VERSION 3.19)

project(CMakeBlink LANGUAGES CXX)

add_executable(CMakeBlink CMakeBlink.ino)

```



This all can be done using [Arduino CLI](https://github.com/arduino/arduino-cli).

This toolchain is fully based upon this really great tool: There are no tricks, no hacks, 

no manual parsing of obscure text files at undocumented locations. Just the official

API and some pretty straight forward CMake. That's the main principle of this toolchain

file, and that's what hopefully makes it more robust than any other Arduino toolchain

file before *(— famous last words)*.



## Status



This project is in **early development**.

So far nothing more than a fairly successful proof of concept.



- There still are plenty of shorcuts and major FIXME comments in the scipts.

- The toolchain only has been successfully tested with the Ninja generator so far.

- CMake's MS-Build generator is known to fail.

- Most importantly one cannot add libraries yet.

- Annoyingly one still needs an `#include ` in the main sketch.

- Many more problems, I guess...



Check ["ready for public announcement"][milestone-2] to see what's missing.



The following Arduino platforms are tested automatically:



| Platform                                               | Status                                                    |

| ------------------------------------------------------ | --------------------------------------------------------: |

| [Arduino Core for AVR boards][arduino-avr]             | [![Status: AVR    ][arduino-avr.svg]    ][workflows/main] |

| [Arduino Core for ESP32 boards][arduino-esp32]         | [![Status: ESP32  ][arduino-esp32.svg]  ][workflows/main] |

| [Arduino Core for ESP8266 boards][arduino-esp8266]     | [![Status: ESP8266][arduino-esp8266.svg]][workflows/main] |

| [Arduino Core for SAMD21 boards][arduino-samd]         | [![Status: SAM D  ][arduino-samd.svg]   ][workflows/main] |

| [Arduino Core for STM32 boards][arduino-stm32]         | [![Status: STM32  ][arduino-stm32.svg]  ][workflows/main] |

| [ATTinyCore Universal for ATtiny devices][attiny-core] | [![Status: ATtiny ][attiny-core.svg]    ][workflows/main] |



Anyway, if you got some spare time, feel free to try out, to test, to give feedback,

to contribute.



## Usage

### General



In general just configure your project like this:



```Bash

cmake -S ~/Arduino/YourProject \

    --toolchain PATH-TO/arduino-cli-toolchain.cmake \

    -D ARDUINO_BOARD=arduino:avr:nano

```



The parameter `ARDUINO_BOARD` is mandatory and provides your device's FQBN to the toolchain.



For more information about the FQBN string, or so called "fully qualified board names" visit

the [Arduino CLI wiki](https://arduino.github.io/arduino-cli/1.0/FAQ/#whats-the-fqbn-string).



### QtCreator



![Setup a new kit](.assets/qtcreator-kit-setup.png)



1. add a new kit to QtCreator

2. name the new kit, e.g. "Arduino (board name)"

3. select "Bare Metal Device"

4. make sure no Qt version is selected

5. configure CMake's initial configuration



![Configure the kit's CMake settings](.assets/qtcreator-kit-setup-cmake.png)



1. remove all old settings

2. select the toolchain: `-DCMAKE_TOOLCHAIN_FILE:PATH=/YOUR/PATH/TO/cmake-toolchain-arduino-cli/toolchain/arduino-cli-toolchain.cmake`

3. configure a board: `-DARDUINO_BOARD:STRING=esp8266:esp8266:nodemcuv2:baud=512000`



![Setup a project](.assets/qtcreator-project-setup.png)



Here you go! You are ready to open CMake based Arduino projects in QtCreator.



## License



This toolchain file, its related tools, tests, and examples are provided by under the terms

of the [MIT License](LICENSE).



## Credits



This project would not have been possible without all the previous hard work

[Arduino-CMake-Toolchain](https://github.com/a9183756-gh/Arduino-CMake-Toolchain).

I took good inspiration from it, especially when it comes to making CMake's initial

compiler detection accept Arduinos very special binary layout.



[arduino-avr]:          https://github.com/arduino/ArduinoCore-avr

[arduino-samd]:         https://github.com/arduino/ArduinoCore-samd

[arduino-esp32]:        https://github.com/arduino/arduino-esp32

[arduino-esp8266]:      https://github.com/esp8266/Arduino

[arduino-stm32]:        https://github.com/stm32duino/Arduino_Core_STM32

[attiny-core]:          https://github.com/SpenceKonde/ATTinyCore



[arduino-avr.svg]:      https://github.com/hasselmm/cmake-toolchain-arduino-cli/actions/workflows/badge-arduino-avr.yml/badge.svg

[arduino-esp32.svg]:    https://github.com/hasselmm/cmake-toolchain-arduino-cli/actions/workflows/badge-esp32.yml/badge.svg

[arduino-esp8266.svg]:  https://github.com/hasselmm/cmake-toolchain-arduino-cli/actions/workflows/badge-esp8266.yml/badge.svg

[arduino-samd.svg]:     https://github.com/hasselmm/cmake-toolchain-arduino-cli/actions/workflows/badge-arduino-samd.yml/badge.svg

[arduino-stm32.svg]:    https://github.com/hasselmm/cmake-toolchain-arduino-cli/actions/workflows/badge-stm32.yml/badge.svg

[attiny-core.svg]:      https://github.com/hasselmm/cmake-toolchain-arduino-cli/actions/workflows/badge-attinycore.yml/badge.svg

[workflows/main]:       https://github.com/hasselmm/cmake-toolchain-arduino-cli/actions/workflows/main.yml



[milestone-2]:          https://github.com/hasselmm/cmake-toolchain-arduino-cli/milestone/2