Skip to content

v0.1.0

Choose a tag to compare

@github-actions github-actions released this 07 Nov 02:09
· 121 commits to main since this release
ebdccdb

The first release of this line. Not hardware-verified: the host library, the protocol and the
firmware core are tested with a simulated board over a pseudo-terminal and with the firmware
core's own tests; an earlier firmware ran on a Raspberry Pi Pico, this one has not yet.

  • What it is. A PC-managed USB emulation coprocessor: a host library (C ABI in
    include/mimhid.h, header-only C++ forwarders in mimhid.hpp, Python, C# and Rust bindings) and
    the firmware of a board that turns serial frames into the reports of a USB HID composite
    device. Boards: RP2040 and RP2350 (the reference), STM32F4, nRF52840 and ESP32-S3 (build-only
    ports).
  • Devices and Nodes. A Device is one board on one serial port. Its Nodes are HID interfaces
    with an immutable specification: keyboard, mouse, touchscreen, touchpad, pen, digitizer, gamepad,
    toggle controls, or a raw report descriptor. Descriptors, interface and endpoint numbers, polling intervals, strings
    and the USB identity are given by the program; nothing is inferred.
  • Strings are Unicode. UTF-8 on the API, UTF-16 in the string descriptor (USB 2.0 9.6.7), up
    to 126 code units; control characters and malformed text are refused.
  • The line is as fast as it carries. Frames end in a CRC-16/CCITT-FALSE. There is no table of
    rates: the board starts at 115,200 baud and makes any rate its UART divider gives within 2 %;
    MIMHID_BAUD_FASTEST measures the fastest rate the port, adapter and board carry without loss
    (counters on the board judge it). A UART BREAK returns a board to the boot rate, so a program
    that went away cannot lose it. mimhid_device_link_counters reads the board's error counters.
  • Versions. The firmware and the library of one release agree on the protocol: a host talks to
    a board whose major and minor version equal its own. A board of another version is listed by
    mimhid_discover with only its version and refused with MIMHID_ERR_PROTOCOL.
  • Control transfers. Control routing rules hand chosen requests to the program, which answers
    them (a proxy of a real device is built on this); Feature reports, idle and protocol requests,
    output reports and the other events are reported to the program.
  • Reports are sent through a per-Node queue with optional loss reporting; batches commit a
    configuration change once.
  • Build and release. CMake presets (dev, release, tsan), an ABI golden file, symbol
    lint, and release archives for Linux, macOS and Windows with the firmware images.

Firmware Binary Third-Party Notices

The host library (libmimhid) is licensed under the MIT License and has no third-party runtime library dependencies.

Prebuilt microcontroller firmware images (mimhid_firmware-*) incorporate third-party SDK and USB stack components under permissive licenses:

Firmware asset Third-party components & licenses
mimhid_firmware-rp2040-*, mimhid_firmware-rp2350-* TinyUSB 0.18.0 (MIT), Raspberry Pi Pico SDK 2.2.0 (BSD-3-Clause, Copyright (c) 2020 Raspberry Pi (Trading) Ltd.), Arm CMSIS Core (Apache-2.0), Newlib C runtime
mimhid_firmware-nrf52840-* TinyUSB 0.18.0 (MIT), Nordic Semiconductor nrfx (BSD-3-Clause, Copyright (c) 2017-2024 Nordic Semiconductor ASA), Arm CMSIS 5 (Apache-2.0), Newlib C runtime
mimhid_firmware-stm32f4-* TinyUSB 0.18.0 (MIT), STMicroelectronics cmsis_device_f4 & stm32f4xx_hal_driver (BSD-3-Clause / Apache-2.0, Copyright (c) 2016-2019 STMicroelectronics), Arm CMSIS 5 (Apache-2.0), Newlib C runtime
mimhid_firmware-esp32s3-* TinyUSB 0.18.0 (MIT), Espressif ESP-IDF v5.4.2 (Apache-2.0, Copyright 2015-2025 Espressif Systems), Amazon FreeRTOS Kernel (MIT), Newlib C runtime

Complete copyright notices, license texts, and warranty disclaimers for all firmware binaries are provided in the release asset mimhid_firmware-THIRD_PARTY_NOTICES-0.1.0.txt and in THIRD_PARTY_NOTICES.md / NOTICE.