Frame types · Medius

Section

Getting Started

API

Features

Guides

Reference

AI Access

Medius - Rust LibraryFrames

Low-level types for inspecting raw frame traffic: FrameType is the TYPE byte and DecodedFrame is one parsed frame.

VARIANTS

Variant	Opcode	Meaning
`Move`	`0x01`	Motion-tagged cursor or wheel movement (PC to box).
`Inject`	`0x03`	Class-tagged button, key, or media override (PC to box).
`Reset`	`0x04`	Clear all injection (PC to box).
`Query`	`0x05`	Request a state snapshot (PC to box).
`Resp`	`0x06`	Reply to a query, with the request's seq echoed (box to PC).
`RebootDl`	`0x07`	Reboot a chip to download or run (PC to box).
`Log`	`0x08`	Unsolicited device diagnostics (box to PC).
`Led`	`0x09`	Drive a status LED (PC to box).
`Lock`	`0x0A`	Weigh a physical input: block, pass, or amplify (PC to box).
`Catch`	`0x0B`	Add or remove one subscription-table entry (PC to box).
`MotionEvent`	`0x0C`	An unsolicited relative-axis catch event, dx/dy/dz (box to PC).
`UsageEvent`	`0x0F`	An unsolicited held-usage snapshot: button, key, or media (box to PC).
`Option`	`0x11`	Set a persistent box option by id, e.g. imperfect-clone opt-in or movement riding (PC to box).
`ClipAppend`	`0x12`	Append buffered-clip entries to the device ring; seq = append seq (PC to box).
`ClipCtrl`	`0x13`	Drive clip playback: start, stop, pause, resume, restart, toggle, clear, finalize (PC to box).
`ClipSet`	`0x14`	Set one clip setting: auto-lock, loop, or retain (PC to box).
`ClipTrigger`	`0x15`	Bind a physical edge to a clip engine verb (PC to box).
`TrafficEvent`	`0x16`	An unsolicited byte-oriented catch event: HID, vendor, control, emit, or bus (box to PC).

DECODEDFRAME

Field	Type	Description
`ty`	`FrameType`	Which opcode this frame carries.
`seq`	`u8`	The sequence byte; a reply echoes the request's value.
`payload`	`Vec<u8>`	The raw payload bytes, already CRC-checked.

EXAMPLE

use medius::{FrameType, DecodedFrame};

// Byte -> variant is fallible; an unknown opcode is an Err.
assert_eq!(FrameType::try_from(0x06), Ok(FrameType::Resp));
assert!(FrameType::try_from(0xFF).is_err());

// Variant -> byte always works.
assert_eq!(u8::from(FrameType::Log), 0x08);

// Read a decoded frame by field: a MOTION_EVENT at ts_us=1000 carrying dx=5, dy=-5, dz=1.
let frame = DecodedFrame { ty: FrameType::MotionEvent, seq: 7, payload: vec![0xE8, 3, 0, 0, 5, 0, 0xFB, 0xFF, 1, 0] };
println!("{:?} seq={} {} bytes", frame.ty, frame.seq, frame.payload.len());

Full wire layout is on the frame page. For everyday work, stay on Requests and Diagnostics instead.