Medius Documentation

Documentation site for Medius: the input-passthrough firmware, its binary control protocol, and the medius Rust library.

Built with SolidJS and MidnightUI.

Sections

• Native API -- The binary control protocol and how the box behaves. Covers the hardware, transport, frame format, injection model, and every command (opcodes 0x01-0x15).
• Rust Library -- API reference for the medius crate: connecting, the command bindings, keepalive and reconnect, and the async / mock / flash / tracing features.
• Bindings -- The C ABI and Python bindings over the same crate.
• Dashboard -- The in-browser box dashboard: connect, view device info, update firmware, recover, and a console.
• AI Access -- Using the docs with an AI assistant: per-page Markdown twins, llms.txt, and the MCP server.

Development

Prerequisites

• Bun

Setup

bun install

Dev Server

bun run dev

Open http://localhost:3000.

Build

bun run build

Output goes to dist/.

Tech Stack

• SolidJS -- Reactive UI framework
• @solidjs/router -- Client-side routing
• Vite -- Build tool
• Bun -- Runtime and package manager
• MidnightUI -- Component library
• solid-icons -- Icons

Deployment

CI builds the app and a multi-arch container on every push to main and publishes it to ghcr.io/k4hvh/medius-docs. Run it with Docker:

docker run --rm -p 3000:3000 ghcr.io/k4hvh/medius-docs:latest

docker-compose.yml runs the same image. The container builds with Bun and serves dist/ on port 3000.