modm API documentation
modm API documentation Documentation

modm: a barebone embedded library generator

modm (pronounced like dial-up "modem") is a toolbox for building custom C++20 libraries tailored to your embedded device. modm generates startup code, HALs and their implementations, communication protocols, drivers for external devices, BSPs, etc… in a modular, customizable process that you can fine-tune to your needs.

This project also has a forum for discussions and a technical blog to document larger design concepts.

modm is optimized for the harsh requirements of the Eurobot competition, where our robots need to run reliably and completely autonomously for the game's 100 second duration. Our robots contain a lot of different microcontrollers, some without a lot of resources, so modm needs to fulfill a diverse set of objectives, like small code size with small memory consumption, predictable program flow, extreme portability.

The library source code is licensed as MPLv2 with any external source code under compatible licenses (BSD, Apache2, MIT). So feel free to fork this project and adapt it to your needs. The only thing we ask of you is to contribute your changes back so everyone can benefit.

Please clone modm recursively, you need all the submodules:

git clone --recurse-submodules --jobs 8 https://github.com/modm-io/modm.git

Features

  • Efficient and fast object-oriented C++20 API.
  • Support for hundreds of AVR and ARM Cortex-M microcontrollers from Atmel and ST.
  • Build system agnostic: Choose SCons, CMake, Makefile or use your own.
  • Data-driven, target-specific HAL generation using the lbuild engine.
  • No memory allocations in HAL with very low overall RAM consumption.
  • Highly configurable modules with sensible defaults and lots of documentation.
  • Cross-platform peripheral interfaces incl. bit banging:
    • GPIO, External Interrupt and IO expanders.
    • ADC, DAC and Comparators.
    • UART, I2C, SPI, CAN and Ethernet.
  • Interfaces and drivers for many external I2C and SPI sensors and devices.
  • Debug/logging system with IOStream and printf interface.
  • Lightweight, stackless threads and resumable functions using cooperative multitasking.
  • Functional (partial) libstdc++ implementation for AVRs.
  • Useful filter, interpolation and geometric algorithms.
  • Lightweight unit testing system (suitable for AVRs).
  • Hundreds of tests to ensure correct functionality.
  • Integration of useful third-party software:

Microcontrollers

modm can create a HAL for 3195devices of these vendors:

  • STMicroelectronics STM32: 2621devices.
  • Microchip SAM: 186devices.
  • Microchip AVR: 388devices.

Here is a table with all device families and the peripheral drivers they support:

  • ✅ Implemented as a software driver in modm.
  • ○ Available in hardware but missing a software driver in modm.
  • ✕ Unavailable in hardware or device with that peripheral not supported by modm.

Note that this is a summary overview and your specific device may not have all the peripherals in this table. Please discover modm's peripheral drivers for your specific device.

STM32 SAM AT
Peripheral F0 F1 F2 F3 F4 F7 G0 G4 H7 L0 L1 L4 D21 G55 V70 90 Mega Tiny
ADC
CAN
Comparator
DAC
DMA
Ethernet
External Interrupt
External Memory
GPIO
I2C
Internal Flash
Random Generator
SPI
System Clock
Timer
UART
Unique ID
USB

We are only a small team of developers and are limited in the amount of devices we can support and test in hardware. Open an issue to ask if your specific device is supported out-of-the-box and what you can do if it is not.

Boards

We have out-of-box support for many development boards including documentation.

AL-AVREB-CAN Arduino NANO Arduino UNO Black Pill F103
Black Pill F401 Black Pill F411 Blue Pill F103 DEVEBOX-STM32F4XX
DEVEBOX-STM32H750VB DISCO-F051R8 DISCO-F072RB DISCO-F100RB
DISCO-F303VC DISCO-F407VG DISCO-F429ZI DISCO-F469NI
DISCO-F746NG DISCO-F769NI DISCO-L152RC DISCO-L476VG
FEATHER-M0 MEGA-2560-PRO NUCLEO-F031K6 NUCLEO-F042K6
NUCLEO-F072RB NUCLEO-F091RC NUCLEO-F103RB NUCLEO-F303K8
NUCLEO-F303RE NUCLEO-F334R8 NUCLEO-F401RE NUCLEO-F411RE
NUCLEO-F429ZI NUCLEO-F439ZI NUCLEO-F446RE NUCLEO-F446ZE
NUCLEO-F746ZG NUCLEO-F767ZI NUCLEO-G071RB NUCLEO-G431KB
NUCLEO-G431RB NUCLEO-G474RE NUCLEO-H723ZG NUCLEO-H743ZI
NUCLEO-L031K6 NUCLEO-L053R8 NUCLEO-L152RE NUCLEO-L432KC
NUCLEO-L452RE NUCLEO-L476RG NUCLEO-L496ZG-P OLIMEXINO-STM32
Raspberry Pi SAMD21-MINI SAMG55-XPLAINED-PRO STM32-F4VE
STM32F030-DEMO Smart Response XE

Drivers

We also have a number of completely target-independent drivers for external devices connected via I2C, SPI, UART, BitBang, etc. Most of these also give you access to the entire device so you can easily configure them for you specific needs.

AD7280A AD7928 ADNS9800 ADS7843 AMS5915 APA102
SPI-FLASH BME280 BMP085 BNO055 CAT24AA DRV832X
DS1302 DS1631 DS18B20 EA-DOG ENCODER-INPUT ENCODER-INPUT-BITBANG
ENCODER-OUTPUT-BITBANG FT245 FT6X06 GPIO-SAMPLER HCLAx HD44780
HMC58x HMC6343 HX711 I2C-EEPROM ILI9341 IS31FL3733
ITG3200 L3GD20 LAN8720A LAWICEL LIS302DL LIS3DSH
LIS3MDL LM75 LP503X LSM303A LSM6DS33 LTC2984
MAX6966 MAX7219 MCP23X17 MCP2515 MMC5603 NOKIA5110
NRF24 TFT-DISPLAY PAT9125EL PCA8574 PCA9535 PCA9548A
PCA9685 SH1106 SIEMENS-S65 SIEMENS-S75 SK6812 SK9822
SSD1306 ST7586S STTS22H STUSB4500 SX1276 TCS3414
TCS3472 TLC594X TMP102 TMP12X TMP175 TOUCH2046
VL53L0 VL6180 WS2812

Please see our examples for a complete list of tested targets and drivers.

How can I contribute?

The easiest way for you and the best way for us to see if something is unclear or missing, is if you use the library and give us some feedback by filing a bug report or if you have a fix already opening a pull request.

See CONTRIBUTING.md for our contribution guidelines.

The modm project is maintained by Niklas Hauser (@salkinium) and Raphael Lehmann (@rleh) with significant contributions from Sascha Schade (@strongly-typed), Fabian Greif (@dergraaf), Kevin Läufer (@ekiwi), Martin Rosekeit (@thundernail), Daniel Krebs (@daniel-k), Georgi Grinshpun (@georgi-g), Christopher Durand (@chris-durand) David Hebbeker (@dhebbeker), Thorsten Lajewski (@TheTh0r), Mike Wolfram (@mikewolfram) and many more contributors.

Folder structure

examples
Example projects that show the usage of parts of the modm library. These projects are always up to date and are tested to compile by our CI.
src
This folder contains the actual source code of modm grouped into several modules.
test
Contains hundreds of tests for making sure modm works the way we expect it to.
docs
General documentation about this library and how to use it.
ext
Third-party code used in this library.
tools
Support tools, scripts and files.