space_packet_parser.cli

Command line interface to the Space Packet Parsing library.

This module serves as a command line utility to inspect and process packet data.

Use

spp <command> [<args>] spp –help spp –describe <packet_file>

Attributes

console
MAX_ROWS
HEAD_ROWS
DISPLAY_HEADER_FIELDS

Functions

spp(verbose, quiet, log_level)	Command line utility for working with CCSDS packets.
describe_xtce(→ None)	Describe the contents and structure of an XTCE packet definition file.
describe_packets(→ None)	Describe the header contents of a packet file, no packet definition required.
parse(→ None)	Parse a packet file using the provided XTCE definition.
validate(→ None)	Validate an XTCE document.

Module Contents

space_packet_parser.cli.console

space_packet_parser.cli.MAX_ROWS = 10

space_packet_parser.cli.HEAD_ROWS = 5

space_packet_parser.cli.DISPLAY_HEADER_FIELDS = ('VER', 'TYPE', 'SHFLG', 'APID', 'SEQFLG', 'SEQCNT', 'PKTLEN')

space_packet_parser.cli.spp(verbose, quiet, log_level)

Command line utility for working with CCSDS packets.

space_packet_parser.cli.describe_xtce(file_path: pathlib.Path, sequence_containers: bool, parameters: bool, parameter_types: bool, root_container: str) → None

Describe the contents and structure of an XTCE packet definition file.

space_packet_parser.cli.describe_packets(file_path: pathlib.Path) → None

Describe the header contents of a packet file, no packet definition required.

space_packet_parser.cli.parse(packet_file: pathlib.Path, definition_file: pathlib.Path, packet: int | None, max_items: int, max_string: int, skip_header_bytes: int) → None

Parse a packet file using the provided XTCE definition.

space_packet_parser.cli.validate(file_path: pathlib.Path, level: str, timeout: int, local_xsd: pathlib.Path) → None

Validate an XTCE document.