puslib 0.2.5__tar.gz → 0.4.0__tar.gz

{puslib-0.2.5/src/puslib.egg-info → puslib-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: puslib
-Version: 0.2.5
+Version: 0.4.0
 Summary: An implementation of the telemetry and telecommand packet utilization standard (PUS).
 Home-page: https://github.com/pxntus/puslib
 Author: Pontus Nyman
@@ -14,42 +14,43 @@ Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Communications
 Classifier: Topic :: Scientific/Engineering
-Requires-Python: >=3.7
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: bitstring
+Dynamic: license-file
 
 # Puslib
 
-**Puslib** is a Python implementation of the telemetry and telecommand packet utilization standard (PUS). It is a standard widely used in the space industry for the purposes of remote monitoring and control of spacecraft subsystems and payloads.
+**Puslib** is a Python library for working with the ECSS Packet Utilization Standard (PUS), a protocol widely used in the space industry.
 
-This package is mainly intended for ground segment tools, e.g.:
+PUS defines an application-level interface between ground and space, covering both segments. It specifies a binary packet format for telecommands and telemetry (based on CCSDS space packets) and a routing mechanism for those packets, as well as a software architecture built around application processes and a set of standard services.
 
-* data extraction and post-processing of telemetry.
-* simulators.
-* EGSE SW, and thus enabling the use of mission control systems for controling and monitoring of EGSE equipment.
-* enable Python based commanding for mission control systems and other PUS based systems.
-* mission-specific tools.
-* student projects.
+Puslib covers two main use cases:
+
+* **TM/TC packet parsing** — deserialize raw packet streams, inspect packet fields, and extract parameter data for post-processing or analysis.
+* **PUS application stack** — implement a PUS-compliant backend that receives telecommands and emits telemetry, for use in EGSE equipment, simulators, or any system that communicates over TM/TC.
+
+The PUS stack is designed from the perspective of the system being monitored and controlled. It receives telecommands and produces telemetry, making it better suited for simulators and EGSE than for mission control systems. It targets ground tooling and test equipment rather than flight software, but don't let the sky be the limit.
 
 ## Install
 
-```Shell
+```shell
 pip install puslib
 ```
 
-Python 3.7 or later is required.
+Python 3.10 or later is required.
 
 ## Basic Example
 
-```Python
+```python
 from datetime import datetime
 from functools import partial
 

{puslib-0.2.5 → puslib-0.4.0}/README.md

@@ -1,27 +1,27 @@
 # Puslib
 
-**Puslib** is a Python implementation of the telemetry and telecommand packet utilization standard (PUS). It is a standard widely used in the space industry for the purposes of remote monitoring and control of spacecraft subsystems and payloads.
+**Puslib** is a Python library for working with the ECSS Packet Utilization Standard (PUS), a protocol widely used in the space industry.
 
-This package is mainly intended for ground segment tools, e.g.:
+PUS defines an application-level interface between ground and space, covering both segments. It specifies a binary packet format for telecommands and telemetry (based on CCSDS space packets) and a routing mechanism for those packets, as well as a software architecture built around application processes and a set of standard services.
 
-* data extraction and post-processing of telemetry.
-* simulators.
-* EGSE SW, and thus enabling the use of mission control systems for controling and monitoring of EGSE equipment.
-* enable Python based commanding for mission control systems and other PUS based systems.
-* mission-specific tools.
-* student projects.
+Puslib covers two main use cases:
+
+* **TM/TC packet parsing** — deserialize raw packet streams, inspect packet fields, and extract parameter data for post-processing or analysis.
+* **PUS application stack** — implement a PUS-compliant backend that receives telecommands and emits telemetry, for use in EGSE equipment, simulators, or any system that communicates over TM/TC.
+
+The PUS stack is designed from the perspective of the system being monitored and controlled. It receives telecommands and produces telemetry, making it better suited for simulators and EGSE than for mission control systems. It targets ground tooling and test equipment rather than flight software, but don't let the sky be the limit.
 
 ## Install
 
-```Shell
+```shell
 pip install puslib
 ```
 
-Python 3.7 or later is required.
+Python 3.10 or later is required.
 
 ## Basic Example
 
-```Python
+```python
 from datetime import datetime
 from functools import partial
 

{puslib-0.2.5 → puslib-0.4.0}/setup.cfg

@@ -18,11 +18,11 @@ classifiers =
 	Operating System :: OS Independent
 	Programming Language :: Python :: 3
 	Programming Language :: Python :: 3 :: Only
-	Programming Language :: Python :: 3.7
-	Programming Language :: Python :: 3.8
-	Programming Language :: Python :: 3.9
 	Programming Language :: Python :: 3.10
 	Programming Language :: Python :: 3.11
+	Programming Language :: Python :: 3.12
+	Programming Language :: Python :: 3.13
+	Programming Language :: Python :: 3.14
 	Topic :: Communications
 	Topic :: Scientific/Engineering
 
@@ -30,7 +30,9 @@ classifiers =
 package_dir = = src
 packages = find:
 include_package_data = True
-python_requires = >=3.7
+python_requires = >=3.10
+install_requires = 
+	bitstring
 
 [options.packages.find]
 where = src
@@ -38,6 +40,13 @@ where = src
 [tool:pytest]
 testpaths = tests
 
+[mypy]
+files = src/puslib
+python_version = 3.10
+warn_return_any = True
+warn_unused_ignores = True
+check_untyped_defs = True
+
 [egg_info]
 tag_build = 
 tag_date = 0

puslib-0.4.0/setup.py

@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup()

puslib-0.4.0/src/puslib/__init__.py

@@ -0,0 +1,39 @@
+from puslib.packet import PusTcPacket, PusTmPacket, AckFlag  # noqa: F401
+from puslib.time import CucTime  # noqa: F401
+from puslib.pus_policy import PusPolicy
+
+__version__ = "0.4.0"
+
+_pus_policy = PusPolicy()
+
+
+def set_policy(policy):
+    """Set PUS policy to be used.
+
+    A PUS policy is an object defining various properties of the PUS implementation,
+    e.g., various field lengths. This is due to that many parts of the PUS standard
+    are mission-specific.
+
+    The policy is stored as a module-level global and is not thread-safe. This is a
+    deliberate design choice: the library assumes a single-threaded execution model
+    where the policy is set once at startup and remains unchanged for the lifetime of
+    the application. Calling set_policy() from multiple threads, or changing the policy
+    while packets are being processed, results in undefined behavior.
+
+    If per-thread policies are ever required, replace this global with a
+    contextvars.ContextVar to give each thread or async task its own policy instance.
+
+    Arguments:
+        policy -- PUS policy
+    """
+    global _pus_policy  # pylint: disable=global-statement
+    _pus_policy = policy
+
+
+def get_policy() -> PusPolicy:
+    """Get the current selected PUS policy.
+
+    Returns:
+        PUS policy
+    """
+    return _pus_policy

puslib-0.4.0/src/puslib/crc_ccitt.py

@@ -0,0 +1,20 @@
+"""CRC-16-CCITT checksum (polynomial 0x1021, preset 0xFFFF)."""
+
+import binascii
+
+_PRESET = 0xffff
+
+
+def calculate(buffer: bytes | bytearray | memoryview) -> int:
+    """Calculate the CRC-16-CCITT checksum on a buffer.
+
+    Using polynomial 0x1021 (default for crc_hqx) and preset (or initial value)
+    0xffff according to ECSS and CCSDS standards.
+
+    Arguments:
+        buffer -- input buffer to calculate checksum for
+
+    Returns:
+        16 bit CRC checksum
+    """
+    return binascii.crc_hqx(buffer, _PRESET)

puslib-0.4.0/src/puslib/exceptions.py

@@ -0,0 +1,13 @@
+# flake8: noqa
+
+"""All exceptions used by puslib.
+"""
+
+
+class PusException(Exception): ...
+class CrcException(PusException): ...
+class IncompletePacketException(PusException): ...
+class InvalidPacketException(PusException): ...
+class TooSmallBufferException(PusException): ...
+class InvalidTimeFormat(PusException): ...
+class TcPacketRoutingError(PusException): ...

puslib-0.4.0/src/puslib/ident.py

@@ -0,0 +1,45 @@
+from typing import Iterator
+
+
+def _seq_count_generator() -> Iterator[int]:
+    seq_count = -1
+    max_count = 2 ** 14
+    while True:
+        seq_count = (seq_count + 1) % max_count
+        yield seq_count
+
+
+class PusIdent:
+    """Represents the identity of A PUS packet.
+
+    The identity of a PUS packet consists of:
+
+    - APID (Application ID)
+    - packet sequence count
+
+    The sequence count is per APID and spans [0..16383].
+
+    The APID-sequence pair, thus, uniquely identifies a PUS packet for the foreseeable future.
+    """
+    def __init__(self, apid: int):
+        """Create an identity instance.
+
+        Arguments:
+            apid -- application ID [0..2047]
+        """
+        if not 0 <= apid <= 2047:
+            raise ValueError("APID must be between 0 and 2047")
+        self._apid = apid
+        self._seq_count_generator = _seq_count_generator()
+
+    @property
+    def apid(self) -> int:
+        return self._apid
+
+    def next_seq_count(self) -> int:
+        """Returns next sequence count.
+
+        Returns:
+            sequence count [0..16383]
+        """
+        return next(self._seq_count_generator)