modm

modm：準系統嵌入式庫產生器

modm（發音類似於撥號「數據機」）是一個工具箱，用於建立適合您的嵌入式裝置的自訂 C++23 庫。 modm 以模組化、可自訂的流程產生啟動程式碼、HAL 及其實作、通訊協定、外部裝置驅動程式和 BSP，您可以根據需要進行微調。

• 該項目有一個主頁。
• 安裝工具鏈並探索我們的範例。
• 您可以更詳細地發現調製解調器庫。
• 輕鬆啟動您自己的完全自訂專案。
• 我們的 CI 檢查每個貢獻的回歸。
• 我們關心測試調製解調器。
• API 參考可在此處取得。
• 我們每季發布一次更新日誌。

該專案還有一​​個討論論壇和一個技術部落格來記錄更大的設計概念。

• 你發現了一個錯誤嗎？提出問題，我們不會咬人。
• 你有問題嗎？我們或許已經有了答案。
• 您需要一個功能嗎？把它寫下來，讓事情順利進行。
• 你想貢獻嗎？閱讀貢獻指南並提出拉取請求。

modm 對 Eurobot 競賽的嚴格要求進行了優化，我們的機器人需要在比賽的 100 秒持續時間內可靠且完全自主地運行。我們的機器人包含許多不同的微控制器，其中一些沒有大量資源，因此 modm 需要實現一系列不同的目標，例如小程式碼大小和小記憶體消耗、可預測的程式流程、極高的可移植性。

此函式庫原始碼與任何外部原始碼均依照相容授權（BSD、Apache2、MIT）授權為 MPLv2。因此，請隨意分叉這個項目並根據您的需求進行調整。我們唯一要求您做的就是貢獻您的更改，以便每個人都能受益。

請遞歸克隆 modm，您需要所有子模組：

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

特徵

• 高效率、快速的物件導向的 C++23 API。
• 支援來自 Microchip、STMicroElectronics 和 Raspberry Pi 的數千種 AVR 和 ARM Cortex-M 微控制器。
• 與建置系統無關：選擇 SCons、CMake、Makefile 或使用您自己的。
• 使用 lbuild 程式碼產生器產生模組化、資料驅動、特定於目標的 HAL。
• HAL 中沒有記憶體分配，整體 RAM 消耗非常低。
• 高度可配置的模組，具有合理的預設值和大量文件。
• 跨平台週邊接口，包括位元敲擊：
  • GPIO、外部中斷和 IO 擴充器。
  • ADC、DAC 和比較器。
  • UART、I ² C、SPI、CAN 和乙太網路。
• 許多外部 I ² C 和 SPI 感測器和設備的介面和驅動程式。
• 帶有 IOStream 和 printf 介面的調試/日誌系統。
• 協作的堆疊光纖和調度程序。
• AVR 的功能（部分）libstdc++ 實作。
• 有用的過濾器、插值和幾何演算法。
• 輕量級單元測試系統（適用於AVR）。
• 數百次測試以確保功能正確。
• 整合有用的第三方軟體：
  • FreeRTOS和FreeRTOS+TCP作業系統。
  • CMSIS 和 CMSIS-DSP 介面。
  • ETL：嵌入式範本庫。
  • TinyUSB：USB 主機/裝置堆疊。
  • FatFS：FAT/exFAT 檔案系統。
  • ROSserial：嵌入式 ROS 用戶端。
  • CrashCatcher：硬故障的崩潰報告。
  • printf：小型 printf 實作。
  • Nanopb：嵌入式協定緩衝區。
  • LVGL：嵌入式圖形庫。

微控制器

modm 可以為這些供應商的 3839 設備建立 HAL：

• 意法半導體 STM32：3034 裝置。
• Microchip SAM：416 個設備。
• Microchip AVR：388 個設備。
• 樹莓派：1 個設備。

下表列出了所有設備系列及其支援的周邊驅動程式：

• ✅ 作為 modm 中的軟體驅動程式實作。
• ○ 在硬體中可用，但數據機中缺少軟體驅動程式。
• ✕ 不適用於數據機不支援該週邊設備的硬體或設備。

請注意，這是一個摘要概述，您的特定設備可能不具備此表中的所有周邊設備。請尋找適合您的特定裝置的數據機週邊設備驅動程式。

	STM32															薩姆				RP	在
週邊	二氧化碳	F0	F1	F2	F3	F4	F7	G0	G4	H7	L0	L1	L4	L5	U5	D1x d2x DAx	D5x E5x	E7x S7x V7x	G5x	20	90	百萬	微小的
類比數位轉換器	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	○	✅	✅	✅	○	○	○	✅	✅	✅	○	✅	✅
能	✕	✅	✅	✅	✅	✅	✅	✅	✅	✅	✕	✕	✅	✅	✅	✕	○	✅	✕	✕	○	○	✕
比較器	✕	○	✕	✕	✅	✕	✕	✅	✅	○	○	○	✅	○	○	○	○	○	✕	✕	○	○	○
數位類比轉換器	✕	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	○	○	✅	✕	✕	✕	○	✕
DMA	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	○	○	○	✅	✕	✅	✕	✕	✕
乙太網路	✕	✕	○	○	✕	✅	✅	✕	✕	○	✕	✕	✕	✕	✕	✕	○	○	✕	✕	✕	✕	✕
外部中斷	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	○	○	○	✅	✅	✅	✅
外部記憶體	✕	✕	✅	✅	✕	✅	○	✕	○	○	✕	✕	○	○	○	✕	✕	○	✕	✕	✕	✕	✕
通用輸入輸出介面	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
我2C	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	○	○	✅	○	✅	✅	✅	✅
內部快閃記憶體	○	○	✅	○	○	✅	○	✅	✅	○	○	○	○	○	○	○	○	○	○	✕	✕	✕	✕
IWDG	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✕	✕	✕	✕	✕	✕	✕	✕
隨機發生器	✕	✕	✕	✅	✕	✅	✅	✅	✅	✅	✅	✕	✅	✅	✅	✕	○	○	✕	✕	✕	✕	✕
SPI	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	○	○	○	✅	✅	✅	✅	✅	✅
系統時鐘	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✕	✕	✕
定時器	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	○	○	✅	✅	○	○	○	○
串口	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	○
唯一ID	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✕	✕	✕	✕	✕	✕	✕	✕
USB	✅	✅	✅	✅	✅	✅	✅	✕	✅	✅	✅	✅	✅	✅	✅	✅	✅	○	✅	✅	✕	✕	✕

我們只是一小群開發人員，並且我們可以在硬體中支援和測試的設備數量有限。展開討論，詢問您的特定裝置是否受開箱即用支援以及如何添加它。

板

我們為許多開發板提供開箱即用的支持，包括文件。

阿爾-阿夫雷布-坎	Arduino 奈米	Arduino UNO	黑丸F103
黑丸F401	黑丸F411	藍丸F103	DEVEBOX-STM32F4XX
DEVEBOX-STM32H750VB	迪斯科-F051R8	迪斯可-F072RB	迪斯可-F100RB
DISCO-F303VC	迪斯可-F401VC	迪斯可-F407VG	迪斯可-F411VE
迪斯可-F429ZI	迪斯可-F469NI	迪斯可-F746NG	迪斯可-F769NI
迪斯科-L152RC	迪斯可-L476VG	羽毛-M0	羽毛-M4
羽毛-RP2040	MEGA-2560-PRO	NUCLEO-C031C6	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-G070RB
NUCLEO-G071RB	NUCLEO-G431KB	NUCLEO-G431RB	NUCLEO-G474RE
NUCLEO-H723ZG	NUCLEO-H743ZI	NUCLEO-L031K6	NUCLEO-L053R8
核仁-L152RE	NUCLEO-L432KC	核仁-L452RE	NUCLEO-L476RG
NUCLEO-L496ZG-P	NUCLEO-L552ZE-Q	NUCLEO-U575ZI-Q	奧利美西諾-STM32
樹莓派 Pico	SAMD21-MINI	SAMD21-XPLAINED-PRO	SAME54-XPLAINED-PRO
SAME70-X解釋	SAMG55-XPLAINED-PRO	SAMV71-XPLAINED-ULTRA	智慧型響應XE
STM32-F4VE	STM32F030-演示	THINGPLUS-RP2040

司機

我們還有許多完全獨立於目標的驅動程序，用於透過 I ² C、SPI、UART、BitBang 等連接的外部設備。輕鬆配置它們。

AD7280A	AD7928	ADIS16470	ADNS9800	ADS101X	ADS7828
ADS7843	ADS816x	AMS5915	APA102	AS5047	AS5600
AT24MAC402	SPI快閃記憶體	BME280	BMI088	BMP085	BNO055
CAT24AA	自行車計數器	DRV832X	DS1302	DS1631	DS18B20
DW3110	EA狗	編碼器輸入	編碼器輸入 BitBang	編碼器輸出 BitBang	FT245
FT6x06	GPIO 採樣器	HCLAx	HD44780	HMC58x	HMC6343
HX711	I2C-EEPROM	ILI9341	IS31FL3733	ITG3200	IXM42XXX
L3GD20	區域網路8720A	洛維賽爾	LIS302DL	LIS3DSH	LIS3MDL
LM75	LP503x	LSM303A	LSM6DS33	LSM6DSO	LTC2984
MAX31855	MAX31865	MAX6966	MAX7219	MCP23x17	MCP2515
MCP3008	MCP7941x	MCP990X	MMC5603	MS5611	MS5837
諾基亞5110	NRF24	TFT顯示幕	PAT9125EL	PCA8574	PCA9535
PCA9548A	PCA9685	QMC5883L	SH1106	西門子-S65	西門子-S75
SK6812	SK9822	SSD1306	ST7586S	ST7789	STTS22H
STUSB4500	SX1276	SX128X	TCS3414	TCS3472	TLC594x
TMP102	TMP12x	TMP175	觸摸2046	VL53L0	VL6180
WS2812

請參閱我們的範例以取得已測試目標和驅動程式的完整清單。

我怎樣才能做出貢獻？

對於您和我們來說，查看是否有不清楚或丟失的內容的最簡單方法是，您是否使用該庫並通過提交錯誤報告向我們提供一些反饋，或者您是否已經修復了打開拉取請求的問題。

請參閱 CONTRIBUTING.md 以了解我們的貢獻指南。

modm 專案由 Niklas Hauser (@salkinium)、Raphael Lehmann (@rleh) 和 Christopher Durand (@chris-durand) 維護，Sascha Schade (@strongly-typed)、Fabian Greif (@dergraaf)、Kevin 做出了重大貢獻Läufer (@ekiwi)、Martin Rosekeit (@thundernail)、Daniel Krebs (@daniel-k)、Georgi Grinshpun (@georgi-g)、David Hebbeker (@dhebbeker)、Thorsten Lajewski (@TheTh0r)、Mike Wolfram (@mikewolfram) ）以及更多貢獻者。

資料夾結構

例子

顯示 modm 庫各部分用法的範例項目。這些項目始終是最新的，並經過我們的 CI 編譯測試。

原始碼

該資料夾包含分為幾個模組的 modm 的實際原始碼。

測試

包含數百個測試，以確保調製解調器按照我們期望的方式運作。

文件

有關該庫以及如何使用它的一般文件。

分機

該庫中使用的第三方程式碼。

工具

支援工具、腳本和文件。