Skip to content

Document Generic Packet Parsing #190

@medley56

Description

@medley56

Summary

In 6.0.0 we added support for generic packet parsing by allowing users to specify their own packet bytes generator for parsing. We included a default ccsds_generator and a simple fixed length generator in the package.

We need to document how to do this in the user documentation.

Suggested Changes

This documentation should include a brief discussion of how XTCE is not limited to CCSDS packets and can support packet definitions for packets that lack a CCSDS header. The only real requirement is that the user can provide a generator that splits a binary stream into individual packets worth of bytes (e.g. by assuming a fixed length or by using a custom field in the packet to determine its length).

Also include an example of how to provide a custom generator for a non-CCSDS packet type. If it's short, this example could go inline but it might be better to put it in the examples directory. Make sure to include a reference to this example in the examples section of the user docs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions