Skip to main content

Module proximity1

Module proximity1 

Source
Expand description

CCSDS Proximity-1 protocol. CCSDS Proximity-1 Space Link Protocol — Data Link Layer (CCSDS 211.0-B-6)

Implements the Version-3 Transfer Frame used for short-range, bi-directional space links (e.g., orbiter-to-lander, rover-to-relay).

Modules§

bitmask
Bitmasks for the first header word.
plcw_bitmask
Bitmasks for the 16-bit PLCW.
segment_bitmask
Bitmasks for the 8-bit segment header.

Structs§

Plcw
A Proximity Link Control Word (PLCW).
Prox1FrameReader
Extracts packets from a received Proximity-1 transfer frame.
Prox1FrameWriter
Accumulates packets into Proximity-1 transfer frames.
Prox1FrameWriterConfig
Configuration for building Proximity-1 transfer frames.
Proximity1Header
The 5-byte header of a Proximity-1 Version-3 Transfer Frame.
Proximity1TransferFrame
A zero-copy view over a Proximity-1 Version-3 Transfer Frame.
Proximity1TransferFrameBuilder
Use builder syntax to set the inputs and finish with build().
SegmentHeader
An 8-bit segment header prepended to the data when DFC ID = 01.

Enums§

BuildError
An error that can occur during frame construction.
DfcId
Data Field Construction Identifier.
ParseError
An error that can occur during frame parsing.
PduType
PDU Type — distinguishes user data from supervisory frames.
QoS
Quality of Service indicator.
SequenceFlag
Sequence flags for segmented data units.
SrcDest
Source-or-Destination Identifier.

Constants§

MAX_DATA_FIELD_LEN
Maximum data field size in bytes.
MAX_FRAME_LEN
Maximum total frame size in bytes (header + data).
PROXIMITY1_VERSION
The Proximity-1 Version-3 Transfer Frame version (binary ‘10’).