Firmware for the M1 NFC/RFID multi-protocol device, built on STM32H5.
Fork note: This fork is based on upstream 0.8.1.0 (pinned
2af1f8a339db, grafted — see the Merge Policy section in DEVELOPMENT.md). Fork version namespace: 0.9.0.0-UFO.
Responsible use: Use this project only with systems and signals you own or are authorized to test. Radio, credential, privacy, and access-control laws vary by jurisdiction. See Legal notice and responsible use and Regulatory status.
The M1 firmware provides support for:
- NFC (13.56 MHz)
- LF RFID (125 kHz)
- Sub-GHz (315–915 MHz)
- Infrared (IR transmit/receive)
- Bluetooth (BLE scan, advertise, GATT; via ESP32 co-processor)
- WiFi (AP scan, station/AP modes; via ESP32 co-processor)
- Battery monitoring
- Display (ST7586s ERC240160)
- USB (CDC, MSC)
- MCU: STM32H573VIT6 (32-bit, 2MB Flash, 100LQFP)
- Hardware revision: 2.x
See HARDWARE.md for more details.
- Technical documentation index – System, hardware, protocol, testing, release, security, and known-issue documentation
- Build and debug – Canonical command-line build
- Build Tool (mbt) – Build with STM32CubeIDE or VS Code
- Architecture – Project structure
- Development – Development guidelines
- Merge ledger – Disposition of every fork-changed file vs the upstream 0.8.1.0 base (issue #38): what the base already covers, what follow-up patches carry, what was dropped and why
- Release delta audit – Machine-checked audit of
git diff upstream/main..mainat the v0.9.0.0-UFO release: every difference mapped to a ledger disposition or an explained merge-era change (issue #45) - Release notes – v0.9.0.0-UFO release notes: carried features, dropped/superseded work, known limits, IR starter database
See documentation/mbt.md for full build instructions (STM32CubeIDE and VS Code setup, extensions, and the CRC post-build step). That step is not optional for provisioning: only the CRC-appended _wCRC.bin validates at boot — see Provisioning.
- STM32CubeIDE 1.17+ (recommended), or
- VS Code with ARM GCC 14.2, CMake Tools, Cortex-Debug, and Ninja, or
- Linux with ARM GCC toolchain and Ninja
macOS or Linux:
./build.sh --releaseThis requires CMake, Ninja, GNU Arm Embedded Toolchain 14.2, and srec_cat.
Output is written to ./artifacts/ (.elf, .bin, .hex, _wCRC.bin, and a
release manifest). A release build requires a clean Git working tree.
Flash <artifact>_wCRC.bin, not the plain .bin/.hex/ELF. Only the
CRC-appended image carries the CRC word the firmware's boot-time integrity check
reads at 0x080FFC14; the other artifacts stop at 0x080FFC14. A device
provisioned over SWD or an IDE download from one of those boots and runs, but
shows FW CORRUPT! on every boot (and counts failures in the backup registers)
because the check finds no CRC word. Use _wCRC.bin over SWD, or copy
_wCRC.bin to the SD card and install it through the update menu. See
Provisioning.
STM32CubeIDE:
Open the project and build Release in the IDE. Only the IDE's Release
configuration carries the CRC post-build step, so _wCRC.bin exists only there:
a Debug build (and an IDE debug download) produces no CRC-appended image, and a
device provisioned from it shows FW CORRUPT! on every boot.
VS Code:
- Configure the project (e.g.
gcc-14_2_build-releaseorgcc-14_2_build-debug) - Build via the Build icon
Output: ./out/build/gcc-14_2_build-release (VS Code) or ./Release (STM32CubeIDE)
Contributions are welcome. See CONTRIBUTING.md and the Code of Conduct.
See LICENSE for details.