Skip to main content

Module types

Module types 

Source

Structs§

Bearing
Configured bearing (RESP(OPTIONS, BEARING), §4.14).
Button
Mouse button by 0-based id (§3.3).
Caps
Capability summary of the cloned device, mouse and keyboard, from one caps() query.
CatchEntry
Row of CatchState::entries: a live subscription and what it has lost.
CatchFilter
Subscription entry: what to observe, in which direction, and how much of each packet to keep.
CatchState
Decoded RESP(CATCH) (§4.9): live subscription table, drop counts, inter-chip clock estimate.
ChipFirmware
One chip’s firmware version and booted app slot.
ClipBuilder
Clip entry stream (§3.11) for ClipHandle::append. Each method appends one entry: a gap run or one ClipFrame.
ClipFrame
Clip frame: everything the box does on one tick (§3.11).
ClipPacketTrigger
Packet trigger: a packet on a traffic surface whose head matches under a mask drives action on the box’s next tick.
ClipPacketTriggerEntry
Packet trigger the box holds, read back from RESP(CLIP).
ClipSettings
Clip config read back from RESP(CLIP) (§4.15): autolock scope, loop/retain settings and both trigger kinds. The config view of the frame ClipStatus reads.
ClipStatus
Clip ring and playback counters (§4.15): the runtime view of RESP(CLIP).
ClipTrigger
Input trigger: the edge of a physical on usage drives action, optionally consuming the input so it never reaches the game. A managed set keyed by (on, edge), like a lock.
ClockEstimate
Measured offset between the two chips’ clocks, from RESP(CATCH) (§4.9).
CountersSnapshot
Copyable snapshot of the always-on link counters, for diagnostics.
DeviceInfo
Cloned device’s USB identity, from its descriptors.
EmitPaceStatus
Configured EmitPace, emit-rate ceiling, and wire rate in effect (§4.14).
FirmwareInfo
Decoded RESP(FIRMWARE) (§4.16): the only source of the host chip’s version.
Health
Decoded RESP(HEALTH) flags word.
ImperfectStatus
Imperfect-clone opt-in and the attached device’s status against it (§4.14).
InputEvent
One Input and when the real device produced it.
KbdCaps
Cloned keyboard’s capabilities; the keyboard half of Caps.
Key
Keyboard key by HID usage (Keyboard/Keypad page, §3.10).
LockEntry
Decoded RESP(LOCKS) entry (§4.8): what is weighed, in which direction, by how much.
Locks
Decoded RESP(LOCKS) (§4.8): every active lock across every class.
LogLine
Decoded LOG frame (§4.7): severity and UTF-8 text.
MediaKey
Media key by 16-bit HID Consumer usage (§3.11, v2.0.0).
MotionEvent
Relative-axis catch event, a MOTION_EVENT frame (§4.10).
MouseCaps
Cloned mouse’s capabilities, parsed from its HID report descriptor.
Patch
Descriptor patch the host installs on the box.
PatchEntry
Row of the decoded PatchSet summary (§4.17): a stored patch’s key and length, without its bytes. query_patch_entry reads the full patch.
PatchKey
(section, cfg, index, offset) key of one stored patch.
PatchSet
Decoded RESP(PATCHES) (§4.17): the stored patch set and its apply state.
PortInfo
Discovered serial port.
Rate
Live native report rate, tracked from the report stream, and the cloned poll period.
RenderStatus
Configured RenderMode, whether native motion goes through it, and whether a profile has armed (§4.14).
RewriteEntry
Row of the decoded RewriteTable summary (§4.17): a rule’s address, action and live counters, without match/mask/payload bytes. query_rewrite_entry reads the full rule.
RewriteKey
(class, id, direction, match, mask) key of one table entry.
RewriteRule
Rewrite rule the host installs on the box.
RewriteTable
Decoded RESP(REWRITE) (§4.17): the rewrite table summary.
Setup
USB control-transfer setup packet: bmRequestType, bRequest, wValue, wIndex, wLength (USB spec §9.3), eight bytes little-endian on the wire.
SpreadStatus
Configured spread percent and the interval the box releases across (§4.14).
Stamped
Event placed on this machine’s clock.
Stats
Firmware delivery and telemetry counters (§4.6).
Timeline
Maps box stamps onto this machine’s clock.
TrafficEvent
Byte-oriented catch event, a TRAFFIC_EVENT frame (§4.10): everything the box relays besides parsed input.
TransferOutcome
Device’s reply to a transfer: status and any IN data.
Transform
Field transform: an operation, the source field it reads and the dest field it writes.
TransformKey
(source, dest) key of one transform-table entry; setting a second transform with the same key overwrites the first’s op.
Transforms
Decoded RESP(TRANSFORMS) (§4.18): the transform table as the commands that rebuild it, in the order the box applies them.
UpdateProgress
Staged transfer progress, for a progress callback.
UpdateStatus
Box’s reply to one UPDATE op (§4.16).
Usage
Momentary input usage: a (class, id) pair (button, key or media usage).
UsageSnapshot
Held-usage snapshot catch event, a USAGE_EVENT frame (§4.10).
Version
Decoded RESP(VERSION) payload.

Enums§

Action
Injection override action (§3.3); discriminants are the wire action byte.
Axis
Relative axis: continuous, signed, no press/release edge.
BearingMode
How the box reads whether physical motion runs with or against its injection.
Blanket
Whole-group blanket: the cursor axes (X+Y), the wheel, every mouse button, key or media usage.
BusEvent
CatchClass::Bus event kind.
Capture
How much of each packet to keep.
CatchClass
Class a CatchFilter addresses.
CatchEvent
Catch stream event.
Class
Class of a momentary Usage; the discriminant is the wire class byte (as in INJECT).
ClipAction
Engine action a ClipTrigger or ClipPacketTrigger drives; also a ClipHandle verb.
ClipState
Clip lifecycle state on the box (ClipStatus::state).
ClockDomain
Chip whose clock stamped an event.
ControlStatus
Handshake the game PC received for a control transaction.
DeviceKind
Cloned device’s primary kind, from its HID report descriptors and Boot declarations (§4.3). One carrying both kinds reads keyboard with a full key bitmap (unless it declares Boot for both) or a Boot keyboard alone, and mouse otherwise.
Direction
Direction byte carried by LOCK, CLIP and CATCH.
DirectionMeaning
Direction reading a class uses.
Edge
Edge of a trigger usage that fires its ClipTrigger. Encoded as Direction (Both=0, Press=1, Release=2).
EmitPace
What paces injected motion (OPTION(EMIT)).
ImageState
Bootloader state of the image a chip runs.
Input
One thing the real device did.
LedMode
LED state a LED command sets; Auto restores the box’s status display.
LedTarget
Status LED a LED command targets; discriminants are the wire target byte.
LockScope
What a RESP(LOCKS) entry addresses: a LockTarget, or a whole-Class blanket.
LockTarget
Addressable input field: a relative axis or a momentary usage (button/key/media).
LogLevel
LOG frame severity (§4.7).
Motion
Relative axis for move_axis.
MoveTiming
Whether a delta obeys set_movement_riding or bypasses it: the NOW bit of the MOVE flags byte (§3.1).
PatchSection
Descriptor a patch overwrites (§3.14).
PendingMotion
What a move does to motion the box already holds for a ride: the FLUSH and DISCARD bits of the MOVE flags byte (§3.1).
RebootTarget
REBOOT_DL target; discriminants are the wire target byte.
RenderMode
Texture the box renders motion with (OPTION(RENDER)’s mode). Off is the paced fill; the others render the device’s learned report texture and differ only in the path smoother. Independent of EmitPace, which caps the rendered rate.
RewriteAction
What the top-ranked matching rewrite rule does to the packet (§3.14).
RewriteClass
Traffic class a rewrite rule may address (§3.14).
TrafficClass
Byte-oriented half of the catch address space, so a traffic constructor cannot take an input class.
TransferStatus
How a transfer ended: TRANSFER_RESP’s status byte (§3.14).
TransformOp
Operation a Transform performs (§3.15); both move a value between fields. To weigh a field, or reverse it, use scale.
UpdateTarget
Chip an update addresses.

Constants§

CLIP_EDGES_MAX
Max edges on one ClipFrame, matching the firmware’s CLIP_EDGES_MAX.
CLIP_ENTRY_MAX
Max encoded bytes of one ClipFrame: one CLIP_APPEND payload.
CLIP_RAW_MAX
Max raw reports on one ClipFrame, matching the firmware’s CLIP_RAW_MAX.

Traits§

Timestamped
Event carrying a box timestamp and the domain that produced it.