vtx.foundation draft d03

VTX 1 · core · beta draft d03

VTX 1 Wire Specification: core

Oct 11, 2026, revised Nov 16, 202639 pagesALPN vtx1-d03MIT licence

§3Frame format

Every VTX message is a frame, and the frame layout is the same on every transport.

VTX Frame {
  Channel ID (i),
  Frame Type (i),
  Length (i),
  Payload (..),
}
Field Meaning
Channel ID The channel the frame belongs to (Section 4)
Frame Type What the payload means; registered per channel (Section 16)
Length Payload length in bytes
Payload One CBOR data item, unless the frame type is defined as raw bytes

Rules

  • A frame's payload MUST NOT exceed the receiver's max_frame limit (Section 5). Until WELCOME arrives, the limit is 4,096 bytes in both directions. No endpoint may advertise a max_frame below 1,024.
  • CBOR payloads MUST use definite-length encoding and MUST contain exactly one data item. Receivers MUST ignore map keys they do not know, so extensions and later drafts can add fields without breaking older peers. A map with duplicate keys is invalid. Integral numbers MUST be encoded as CBOR integers and all other numbers as floats; NaN and infinities are not allowed, and a float where an integer is required is invalid.
  • Receivers MUST skip frames of unknown type. A frame type that must not be skipped is only sent after the peer has accepted the capability that defines it.
  • A truncated frame, an over-limit frame or an invalid CBOR payload is a connection error: protocol_error or frame_too_large (Section 14).

Frame types common to all channels

Type Name Payload (CDDL) Use
0x01 CREDIT { bytes: uint } Extends the peer's send window (Section 4)
0x02 CLOSE { code: uint, ? reason: tstr } Closes a dynamic channel, or the connection on channel 0

Types 0x00 and 0x03–0x0F are reserved for future common frames.

Example. A CREDIT frame on channel 1 that grants 65,536 bytes is 15 bytes on the wire:

01                  Channel ID 1
01                  Frame Type 0x01 (CREDIT)
0C                  Length 12
A1                  CBOR map, 1 pair
   65 62 79 74 65 73   "bytes"
   1A 00 01 00 00      65536