Medius Docs
Medius docs: the binary control protocol, device behavior, and the medius Rust library.
Open source Repository Open in the app JSON README (API)
About
Medius docs: the binary control protocol, device behavior, and the medius Rust library.
Details
- Kind
- MCP servers
- Topic
- No topic detected
- Publisher
- net.k4tech
- Origin
- official
- Category
- ferramentas
- Transport
- http
- Version
- 1.0.0
- Last push
- 2026-09-06T12:36:33Z
- Repository state
- ativo
- Language
- TypeScript
- Added
- 2026-08-29 04:01:49
- Updated
- 2026-08-29 04:01:49
- Origin id
net.k4tech/docs
README
# Medius Documentation Documentation site for Medius: the input-passthrough firmware, its binary control protocol, and the `medius` Rust library. Built with [SolidJS](https://solidjs.com) and MidnightUI. ## Sections | Section | What | |---|---| | Native API | The binary control protocol and how the box behaves. Covers the hardware, transport, frame format, injection model, and every command (opcodes `0x01`-`0x18`). | | Rust Library | API reference for the `medius` crate: connecting, the command bindings, keepalive and reconnect, and the `async` / `mock` / `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 read the device log. | | AI Access | Using the docs with an AI assistant: per-page Markdown twins, `llms.txt`, and the MCP server. | ## Development ### Prerequisites - [Bun](https://bun.sh) ### Setup ```bash bun install ``` ### Dev Server ```bash bun run dev ``` Open [http://localhost:3000](http://localhost:3000). ### Build ```bash bun run build ``` Output goes to `dist/`. ## Tech Stack | Tool | Role | |---|---| | [SolidJS](https://solidjs.com) | Reactive UI framework | | [@solidjs/router](https://docs.solidjs.com/solid-router) | Client-side routing | | [Vite](https://vitejs.dev) | Build tool | | [Bun](https://bun.sh) | Runtime and package manager | | MidnightUI | Component library | | [solid-icons](https://github.com/x64Bits/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: ```bash 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.