https://github.com/nunorc/minsp
Minimalistic implementation of the Space Packet specification from the CCSDS Space Packet Protocol standard.
https://github.com/nunorc/minsp
Last synced: 14 days ago
JSON representation
Minimalistic implementation of the Space Packet specification from the CCSDS Space Packet Protocol standard.
- Host: GitHub
- URL: https://github.com/nunorc/minsp
- Owner: nunorc
- License: gpl-3.0
- Created: 2024-12-20T17:47:56.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2025-05-10T16:22:30.000Z (2 months ago)
- Last Synced: 2025-06-12T21:56:19.728Z (about 1 month ago)
- Language: Python
- Homepage: https://nunorc.github.io/minsp/
- Size: 5.15 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# minsp
Minimalistic implementation of the Space Packet specification from the CCSDS Space Packet Protocol standard.
[Repository](https://github.com/nunorc/minsp) | [Documentation](https://nunorc.github.io/minsp)
## Installation
Install using pip:
```bash
$ pip install minsp
```
Install package from the git repository:
```bash
$ pip install git+https://github.com/nunorc/minsp@master
```
## Getting Started
Import the `SpacePacket` class from the package:
```python
>>> from minsp import SpacePacket
```
For example, to create a new space packet for APID 11 and an arbitrary data field:
```python
>>> space_packet = SpacePacket(apid=11, data_field=b'hello')
>>> space_packet
SpacePacket(version=0, type=, secondary_header_flag=0, apid=11,sequence_flags=, sequence_count=0, data_length=4, secondary_header=b'', data_field=b'hello')
```
To get the bytes representation of the packet:
```python
>>> byte_stream = space_packet.as_bytes()
>>> byte_stream
b'\x00\x0b\xc0\x00\x00\x04hello'
```
Packets can also be created from a byte stream:
```python
>>> new_packet = SpacePacket.from_bytes(byte_stream)
>>> new_packet
SpacePacket(version=0, type=, secondary_header_flag=0, apid=11, sequence_flags=, sequence_count=0, data_length=4, secondary_header=b'', data_field=b'hello')
>>> new_packet.data_field
b'hello'
```
Secondary header can have a custom data definition, or to use PUS:
```python
>>> from minsp.pus import PUSHeader
>>> pus_header = PUSHeader()
>>> pus_header
PUSHeader(version=1, ack=0, service_type=1, service_subtype=1, source_id=0, has_time=False, cuc_time=b'')
```
And create a new packet with the PUS header:
```python
>>> space_packet = SpacePacket(secondary_header=pus_header)
>>> space_packet
SpacePacket(version=0, type=, secondary_header_flag=1, apid=0, sequence_flags=, sequence_count=0, data_length=3, secondary_header=PUSHeader(version=1, ack=0, service_type=1, service_subtype=1, source_id=0, has_time=False, cuc_time=b''), data_field=b'')
```
Similar approach for a MAL secondary header:
```python
>>> from minsp.mo import MALHeader
>>> mal_header = MALHeader()
>>> mal_header
MALHeader(version=0, sdu_type=0, service_area=0, service=0, operation=0, area_version=0, is_error=0, qos_level=0, session=0, secondary_apid=0, secondary_apid_qualifier=0, transaction_id=0, source_id_flag=0, destination_id_flag=0, priority_flag=0, timestamp_flag=0, network_zone_flag=0, session_name_flag=0, domain_flag=0, authentication_id_flag=0, source_id=0, destination_id=0, segment_counter=0, priority=0, timestamp=None, network_zone='', session_name='', domain='', authentication_id='')
```
And to create a new packet with the MAL header:
```python
>>> space_packet = SpacePacket(secondary_header=mal_header)
>>> space_packet
SpacePacket(version=0, type=, secondary_header_flag=1, apid=0, sequence_flags=, sequence_count=0, data_length=20, secondary_header=MALHeader(version=0, sdu_type=0, service_area=0, service=0, operation=0, area_version=0, is_error=0, qos_level=0, session=0, secondary_apid=0, secondary_apid_qualifier=0, transaction_id=0, source_id_flag=0, destination_id_flag=0, priority_flag=0, timestamp_flag=0, network_zone_flag=0, session_name_flag=0, domain_flag=0, authentication_id_flag=0, source_id=0, destination_id=0, segment_counter=0, priority=0, timestamp=None, network_zone='', session_name='', domain='', authentication_id=''), data_field=b'')
```
To create a space packet from a byte stream including a PUS header:
```python
>>> byte_stream = SpacePacket(secondary_header=pus_header).as_bytes()
>>> SpacePacket.from_bytes(byte_stream, pus=True)
SpacePacket(version=0, type=, secondary_header_flag=1, apid=0, sequence_flags=, sequence_count=0, data_length=3, secondary_header=PUSHeader(version=1, ack=0, service_type=1, service_subtype=1, source_id=0, has_time=False, cuc_time=b''), data_field=b'')
```
Or from a byte stream including a MAL header:
```python
>>> byte_stream = SpacePacket(secondary_header=mal_header).as_bytes()
>>> SpacePacket.from_bytes(byte_stream, mal=True)
SpacePacket(version=0, type=, secondary_header_flag=1, apid=0, sequence_flags=, sequence_count=0, data_length=20, secondary_header=MALHeader(version=0, sdu_type=0, service_area=0, service=0, operation=0, area_version=0, is_error=0, qos_level=0, session=0, secondary_apid=0, secondary_apid_qualifier=0, transaction_id=0, source_id_flag=0, destination_id_flag=0, priority_flag=0, timestamp_flag=0, network_zone_flag=0, session_name_flag=0, domain_flag=0, authentication_id_flag=0, source_id=0, destination_id=0, segment_counter=0, priority=0, timestamp=None, network_zone='', session_name='', domain='', authentication_id=''), data_field=b'')
```
Use `SpacePacketAssembler` to recover the data from a list
of fragmented packets, for example consider the following packets:
```python
>>> from minsp import SpacePacket, SequenceFlags
>>> sp1 = SpacePacket(sequence_flags=SequenceFlags.FIRST, data_field=b"123")
>>> sp2 = SpacePacket(sequence_flags=SequenceFlags.CONTINUATION, data_field=b"456")
>>> sp3 = SpacePacket(sequence_flags=SequenceFlags.LAST, data_field=b"789")
```
To recover the fragmented payload by processing the individual packets:
```python
>>> from minsp import SpacePacketAssembler
>>> spa = SpacePacketAssembler()
>>> spa.process_packet(sp1)
>>> spa.process_packet(sp2)
>>> spa.process_packet(sp3)
b'123456789'
```
Or directly using the `from_packets` method:
```python
>>> SpacePacketAssembler.from_packets([sp1, sp2, sp3])
b'123456789'
```
## Acknowledgements
* Dominik Marszk for general support and MAL header baseline implementation.