packetizing the software

CCSDS/__init__.py

+

ccsds.py → CCSDS/ccsds.py

 #! /usr/bin/env python3
 from bitstring import BitStream
 import spiceypy as spice
+from datetime import datetime, timedelta
+from rich.console import Console
 
-# Versio 0.1.0
 
 class PacketId:
     def __init__(self,data):
@@ -46,7 +47,7 @@ class SourcePacketHeader:
         return [*self.packetId.serialize(), *self.sequeceControl.serialize(), self.packetLength]
 
 class DataFieldHeader:
-    def __init__(self,data):
+    def __init__(self,data,missionID,t0):
         # Read The Data Field Header (80 bit)
         dfhData = BitStream(hex=data).unpack('bin:1,uint:3,bin:4,3*uint:8,uint:1,uint:31,uint:16')
         self.pusVersion = dfhData[1]
@@ -58,7 +59,7 @@ class DataFieldHeader:
         self.FineTime = dfhData[8]
         self.SCET = "%s.%s" % (self.CorseTime, self.FineTime)
         if self.Synchronization == 0:
-            self.UTCTime = self.scet2UTC()
+            self.UTCTime = self.scet2UTC(missionID,t0)
         else:
             self.UTCTime = '1970-01-01T00:00:00.00000Z'
         pass
@@ -67,27 +68,42 @@ class DataFieldHeader:
         return [self.pusVersion, self.ServiceType, self.ServiceSubType,
                 self.DestinationId, self.SCET, self.UTCTime]
 
-    def scet2UTC(self):
-        et = spice.scs2e(-121, "{}.{}".format(self.CorseTime, self.FineTime))
-        ScTime = spice.et2utc(et, 'ISOC', 5)
+    def scet2UTC(self,missionID,t0):
+        if t0 == None:
+            et = spice.scs2e(missionID, "{}.{}".format(self.CorseTime, self.FineTime))
+            ScTime = spice.et2utc(et, 'ISOC', 5)
+        else:
+            dateFormat = "%Y-%m-%dT%H:%M:%S.%f"
+            dt=datetime.strptime(t0,dateFormat)
+            sc = self.CorseTime + self.FineTime*(2**(-16))
+            f=dt+timedelta(seconds=sc)
+            ScTime=f.strftime(dateFormat)
         return ScTime+'Z'
 
 class PackeDataField:
-    def __init__(self,data):
+    def __init__(self,data, missionID,t0):
         # Data Field Header
-        self.DFHeader = DataFieldHeader(data[0:20])
+        self.DFHeader = DataFieldHeader(data[0:20],missionID,t0)
         # Data
         self.Data = data[20:]
         pass  
 
 class CCSDS:
     """ Reader for the CCSDS header """
-    """     Main Class   """
-    def __init__(self,data):
+    def __init__(self, missionID, data,console:Console=None,t0= None):
+        if type(missionID) is str:
+            if missionID.lower() == 'bepicolombo':
+                missionID=-121
+            else:
+                if t0 == None:
+                    print("WARNING: the Mission name is not valid. time converte setted to 1970-01-01 00:00:00")
+                    t0 = "1970-01-01T00:00:00"
         # Source Packet Header
         self.SPH = SourcePacketHeader(data[0:12])
         # Packet Data Field
-        self.PDF = PackeDataField(data[12:])
+        self.PDF = PackeDataField(data[12:],missionID,t0)
+        self.APID = self.SPH.packetId.Apid
+        self.Service=self.PDF.DFHeader.ServiceType
+        self.subService=self.PDF.DFHeader.ServiceSubType
         self.Data=self.PDF.Data
 
-        pass

CCSDSpy.egg-info/PKG-INFO

+Metadata-Version: 2.1
+Name: CCSDSpy
+Version: 0.1.0
+Author-email: Romolo Politi <romolo.politi@gmail.com>
+License: GNU GPL ver3
+Description-Content-Type: text/markdown
+Provides-Extra: docs
+License-File: LICENSE
+
+# CCSDSpy
+
+---
+
+CCSDSpy is a library to read a data packet coming from a space mission that follows the Consultative Committee for Space Data Systems (CCSDS) standard
+
+Current version **0.1.0**
+
+[[_TOC_]]
+
+## Installation
+## Usage
+```python
+from CCSDS import CCSDS
+
+dat = CCSDS('BepiColombo',packet)
+```
+wehre *packet* is a string with the HEX rappresentation of the pachet
+
+## Limitation
+
+## Data Structure
+
+The CCSDS Header is composed by two blocks:
++ the Source Packet Header 
++ the Packet Data Field
+
+The first one il long 48 bits the second one has a varble dimension and structure depending by the type and the content of the packet. in [Figure 1](#figure-1-telemetry-packet) is reported the structure for a Telemetry Packet.
+
+The structure of the CCSDS class follow the structure of the packet header.
+
+
+```mermaid
+classDiagram
+    CCSDS --|> SPH
+    CCSDS --|> PDF
+    SPH --|> packetID
+    SPH--|> sequenceControl
+    PDF --|> DFHeader
+    class CCSDS{
+        + str Data 
+    }
+    class DFHeader{
+        + uint PUSVersion
+        + uint ServiceType
+        + uint ServiceSubType
+        + uint DestinationId
+        + uint Synchronization
+        + uint CorseTime
+        + uint FineTime
+        + str SCET
+        + str  UTCTime
+    }
+    class SPH{
+        + uint packetLength
+    }
+    class packetID{
+        + uint VersionNum
+        + uint packetType
+        + uint dataFieldHeaderFlag 
+        + uint Apid
+        + uint Pid
+        + uint Pcat
+    }
+    class sequenceControl{
+        + bin SegmentationFlag
+        + uint SSC
+    }
+    class PDF{
+        +str Data
+    }
+```
+
+![TM packet](docs/TM_Packet_Header.png "Telemetry packet")
+####Figure 1 - Telemetry Packet

CCSDSpy.egg-info/SOURCES.txt

+LICENSE
+README.md
+pyproject.toml
+CCSDS/__init__.py
+CCSDS/ccsds.py
+CCSDSpy.egg-info/PKG-INFO
+CCSDSpy.egg-info/SOURCES.txt
+CCSDSpy.egg-info/dependency_links.txt
+CCSDSpy.egg-info/requires.txt
+CCSDSpy.egg-info/top_level.txt
\ No newline at end of file

CCSDSpy.egg-info/dependency_links.txt

+

CCSDSpy.egg-info/requires.txt

+rich
+bitstring
+spiceypy
+
+[:python_version > "3.9"]
+importlib-metadata
+
+[docs]
+sphinx

CCSDSpy.egg-info/top_level.txt

+CCSDS

build/lib/CCSDS/__init__.py

+

build/lib/CCSDS/ccsds.py

+#! /usr/bin/env python3
+from bitstring import BitStream
+import spiceypy as spice
+from datetime import datetime, timedelta
+from rich.console import Console
+
+
+class PacketId:
+    def __init__(self,data):
+        pID = BitStream(hex=data).unpack('uint: 3, 2*bin: 1, bits: 11')
+        self.VersionNum = pID[0]
+        self.packetType = pID[1]
+        self.dataFieldHeaderFlag = pID[2]
+        self.Apid = pID[3].uint
+        self.Pid = pID[3][0:7].uint
+        self.Pcat = pID[3][7:].uint
+        pass
+    def serialize(self):
+        return [self.VersionNum, self.packetType, self.dataFieldHeaderFlag,
+                self.Apid, self.Pid, self.Pcat]
+
+class SeqControl:
+    def __init__(self,data):
+        sq = BitStream(hex=data).unpack('bin:2,uint:14')
+        self.SegmentationFlag = sq[0]
+        self.SSC = sq[1]
+
+    def serialize(self):
+        return [self.SegmentationFlag, self.SSC]
+
+class SourcePacketHeader:
+    def __init__(self,data):
+        # Read the Source Packet Header(48 bits)
+        # - Packet ID (16 bits)
+        self.packetId = PacketId(data[0:4])
+        # - Packet Sequence Control (16 bits)
+        self.sequeceControl = SeqControl(data[4:8])
+        """ 
+        - Packet Length (16 bits)
+        In the packet is stored Packet length is an unsigned word 
+        expressing “Number of octects contained in Packet Data Field” minus 1.
+        """
+        self.packetLength = BitStream(hex=data[8:12]).unpack('uint:16')[0]+1
+        # Based on BepiColombo SIMBIO-SYS
+        # ref: BC-SIM-GAF-IC-002 pag. 48
+    def serialize(self):
+        return [*self.packetId.serialize(), *self.sequeceControl.serialize(), self.packetLength]
+
+class DataFieldHeader:
+    def __init__(self,data,missionID,t0):
+        # Read The Data Field Header (80 bit)
+        dfhData = BitStream(hex=data).unpack('bin:1,uint:3,bin:4,3*uint:8,uint:1,uint:31,uint:16')
+        self.pusVersion = dfhData[1]
+        self.ServiceType = dfhData[3]
+        self.ServiceSubType = dfhData[4]
+        self.DestinationId = dfhData[5]
+        self.Synchronization = dfhData[6]
+        self.CorseTime = dfhData[7]
+        self.FineTime = dfhData[8]
+        self.SCET = "%s.%s" % (self.CorseTime, self.FineTime)
+        if self.Synchronization == 0:
+            self.UTCTime = self.scet2UTC(missionID,t0)
+        else:
+            self.UTCTime = '1970-01-01T00:00:00.00000Z'
+        pass
+
+    def serialize(self):
+        return [self.pusVersion, self.ServiceType, self.ServiceSubType,
+                self.DestinationId, self.SCET, self.UTCTime]
+
+    def scet2UTC(self,missionID,t0):
+        if t0 == None:
+            et = spice.scs2e(missionID, "{}.{}".format(self.CorseTime, self.FineTime))
+            ScTime = spice.et2utc(et, 'ISOC', 5)
+        else:
+            dateFormat = "%Y-%m-%dT%H:%M:%S.%f"
+            dt=datetime.strptime(t0,dateFormat)
+            sc = self.CorseTime + self.FineTime*(2**(-16))
+            f=dt+timedelta(seconds=sc)
+            ScTime=f.strftime(dateFormat)
+        return ScTime+'Z'
+
+class PackeDataField:
+    def __init__(self,data, missionID,t0):
+        # Data Field Header
+        self.DFHeader = DataFieldHeader(data[0:20],missionID,t0)
+        # Data
+        self.Data = data[20:]
+        pass  
+
+class CCSDS:
+    """ Reader for the CCSDS header """
+    def __init__(self, missionID, data,console:Console=None,t0= None):
+        if type(missionID) is str:
+            if missionID.lower() == 'bepicolombo':
+                missionID=-121
+            else:
+                if t0 == None:
+                    print("WARNING: the Mission name is not valid. time converte setted to 1970-01-01 00:00:00")
+                    t0 = "1970-01-01T00:00:00"
+        # Source Packet Header
+        self.SPH = SourcePacketHeader(data[0:12])
+        # Packet Data Field
+        self.PDF = PackeDataField(data[12:],missionID,t0)
+        self.APID = self.SPH.packetId.Apid
+        self.Service=self.PDF.DFHeader.ServiceType
+        self.subService=self.PDF.DFHeader.ServiceSubType
+        self.Data=self.PDF.Data
+

pyproject.toml

+[project]
+name = "CCSDSpy"
+version = "0.1.0"
+dependencies = [
+    "rich",
+    "bitstring",
+    "spiceypy",
+    'importlib-metadata; python_version>"3.9"',
+]
+
+authors = [{name="Romolo Politi", email ="romolo.politi@gmail.com" }]
+license = {text = "GNU GPL ver3"}
+readme = "README.md"
+
+
+[project.optional-dependencies]
+docs = ["sphinx"]
+
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"

requirements.txt

+rich
+bitstring
+spiceypy
\ No newline at end of file