space_packet_parser.cli
=======================

.. py:module:: space_packet_parser.cli

.. autoapi-nested-parse::

   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
----------

.. autoapisummary::

   space_packet_parser.cli.console
   space_packet_parser.cli.MAX_ROWS
   space_packet_parser.cli.HEAD_ROWS
   space_packet_parser.cli.DISPLAY_HEADER_FIELDS


Functions
---------

.. autoapisummary::

   space_packet_parser.cli.spp
   space_packet_parser.cli.describe_xtce
   space_packet_parser.cli.describe_packets
   space_packet_parser.cli.parse
   space_packet_parser.cli.validate


Module Contents
---------------

.. py:data:: console

.. py:data:: MAX_ROWS
   :value: 10


.. py:data:: HEAD_ROWS
   :value: 5


.. py:data:: DISPLAY_HEADER_FIELDS
   :value: ('VER', 'TYPE', 'SHFLG', 'APID', 'SEQFLG', 'SEQCNT', 'PKTLEN')


.. py:function:: spp(verbose, quiet, log_level)

   Command line utility for working with CCSDS packets.


.. py:function:: 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.


.. py:function:: describe_packets(file_path: pathlib.Path) -> None

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


.. py:function:: 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.


.. py:function:: validate(file_path: pathlib.Path, level: str, timeout: int, local_xsd: pathlib.Path) -> None

   Validate an XTCE document.