Merge pull request #71 from us-irs/add-countdown-utility

add some more documentation

CHANGELOG.md

@@ -22,6 +22,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ## Added
 
 - Added `ByteFieldU64` variant.
+- Added `spacepackets.countdown` utility module. This class was moved from
+  `tmtccmd.util.countdown` and contains the `Countdown` class. It was moved here so it can
+  be re-used more easily.
 
 # [v0.22.0] 2023-12-22
 

README.md

@@ -25,8 +25,9 @@ Currently, this includes the following components:
 
 It also contains various helper modules
 
-- `PusVerificator` module to track the verification of sent telecommands
-- [PTC and PFC definitions](https://spacepackets.readthedocs.io/en/latest/api/ecss.html#module-spacepackets.ecss.fields) for ECSS packets
+- `PusVerificator` module to track the verification of sent telecommands.
+- [PTC and PFC definitions](https://spacepackets.readthedocs.io/en/latest/api/ecss.html#module-spacepackets.ecss.fields) for ECSS packets.
+- `Countdown` utility class.
 
 # Install
 

docs/api.rst

@@ -28,4 +28,5 @@ This package also uses the :py:mod:`logging` package to emit warnings.
    api/cfdp_pdu
    api/cfdp_tlv
    api/uslp
+   api/countdown
    api/util

docs/api/countdown.rst

@@ -0,0 +1,7 @@
+Countdown Module
+================
+
+.. automodule:: spacepackets.countdown
+ :members:
+ :undoc-members:
+ :show-inheritance:

docs/api/util.rst

@@ -2,6 +2,6 @@ Utility Module
 ================
 
 .. automodule:: spacepackets.util
-   :members:
-   :undoc-members:
-   :show-inheritance:
+ :members:
+ :undoc-members:
+ :show-inheritance:

docs/index.rst

@@ -28,6 +28,7 @@ It also contains various helper modules
 
 - :py:class:`spacepackets.ecss.pus_verificator.PusVerificator` class to track the verification of sent telecommands
 - PTC and PFC definitions for ECSS packets inside the :py:mod:`spacepackets.ecss.fields` module
+- :py:class:`spacepackets.countdown.Countdown` utility class
 
 Other pages (online)
 ---------------------

spacepackets/countdown.py

@@ -5,10 +5,14 @@
 
 
 def time_ms() -> int:
+    """Returns the current :py:func:`time.time` as milliseconds."""
     return round(time.time() * 1000)
 
 
 class Countdown:
+    """Utility class for counting down time. Exposes a simple API to initiate
+    it with an initial timeout and to check whether is has expired."""
+
     def __init__(self, init_timeout: Optional[timedelta]):
         if init_timeout is not None:
             self._timeout_ms = int(init_timeout / timedelta(milliseconds=1))

tests/cfdp/pdus/test_ack_pdu.py

@@ -60,7 +60,9 @@ def test_ack_pdu(self):
             transaction_seq_num=ByteFieldU32.from_u32_bytes(
                 bytes([0x50, 0x00, 0x10, 0x01])
             ),
-            source_entity_id=ByteFieldU32.from_u32_bytes(bytes([0x10, 0x00, 0x01, 0x02])),
+            source_entity_id=ByteFieldU32.from_u32_bytes(
+                bytes([0x10, 0x00, 0x01, 0x02])
+            ),
             dest_entity_id=ByteFieldU32.from_u32_bytes(bytes([0x30, 0x00, 0x01, 0x03])),
             crc_flag=CrcFlag.WITH_CRC,
             trans_mode=TransmissionMode.UNACKNOWLEDGED,

tests/cfdp/test_header.py

@@ -115,7 +115,9 @@ def test_with_prompt_pdu(self):
         self._switch_cfg()
         self.pdu_conf.source_entity_id = ByteFieldU8(0)
         self.pdu_conf.dest_entity_id = ByteFieldU8(0)
-        self.pdu_conf.transaction_seq_num = ByteFieldU16.from_u16_bytes(bytes([0x00, 0x2C]))
+        self.pdu_conf.transaction_seq_num = ByteFieldU16.from_u16_bytes(
+            bytes([0x00, 0x2C])
+        )
         prompt_pdu = PromptPdu(
             response_required=ResponseRequired.KEEP_ALIVE, pdu_conf=self.pdu_conf
         )