pytmtc as regular package now

satrs-example/README.md

@@ -48,16 +48,17 @@ It is recommended to use a virtual environment to do this. To set up one in the
 you can use `python3 -m venv venv` on Unix systems or `py -m venv venv` on Windows systems.
 After doing this, you can check the [venv tutorial](https://docs.python.org/3/tutorial/venv.html)
 on how to activate the environment and then use the following command to install the required
-dependency:
+dependency interactively:
 
 ```sh
-pip install -r requirements.txt
+pip install -e .
 ```
 
 Alternatively, if you would like to use the GUI functionality provided by `tmtccmd`, you can also
 install it manually with
 
 ```sh
+pip install -e .
 pip install tmtccmd[gui]
 ```
 

satrs-example/pytmtc/.gitignore

@@ -1,3 +1,4 @@
+/tmtc_conf.json
 __pycache__
 
 /venv
@@ -7,3 +8,136 @@ __pycache__
 
 /seqcnt.txt
 /.tmtc-history.txt
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# PyCharm
+.idea

satrs-example/pytmtc/main.py

@@ -46,8 +46,8 @@ from spacepackets.seqcount import FileSeqCountProvider, PusFileSeqCountProvider
 from tmtccmd.util.obj_id import ObjectIdDictT
 
 
-import pus_tc
-from common import Apid, EventU32
+from pytmtc.pus_tc import pack_pus_telecommands, create_cmd_definition_tree
+from pytmtc.common import Apid, EventU32
 
 _LOGGER = logging.getLogger()
 
@@ -76,7 +76,7 @@ class SatRsConfigHook(HookBase):
 
     def get_command_definitions(self) -> CmdTreeNode:
         """This function should return the root node of the command definition tree."""
-        return pus_tc.create_cmd_definition_tree()
+        return create_cmd_definition_tree()
 
     def get_cmd_history(self) -> Optional[History]:
         """Optionlly return a history class for the past command paths which will be used
@@ -213,7 +213,7 @@ class TcHandler(TcHandlerBase):
         if info.proc_type == TcProcedureType.TREE_COMMANDING:
             def_proc = info.to_tree_commanding_procedure()
             assert def_proc.cmd_path is not None
-            pus_tc.pack_pus_telecommands(q, def_proc.cmd_path)
+            pack_pus_telecommands(q, def_proc.cmd_path)
 
 
 def main():

satrs-example/pytmtc/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pytmtc"
+description = "Python TMTC client for OPS-SAT"
+readme = "README.md"
+version = "0.1.0"
+requires-python = ">=3.8"
+authors = [
+  {name = "Robin Mueller", email = "robin.mueller.m@gmail.com"},
+]
+dependencies = [
+    "tmtccmd~=8.0",
+    "pydantic~=2.7"
+]
+
+[tool.setuptools.packages]
+find = {}
+
+[tool.ruff]
+extend-exclude = ["archive"]
+[tool.ruff.lint]
+ignore = ["E501"]
+[tool.ruff.lint.extend-per-file-ignores]
+"__init__.py" = ["F401"]

satrs-example/pytmtc/pytmtc/pus_tc.py

@@ -10,26 +10,11 @@ from tmtccmd.tmtc import DefaultPusQueueHelper
 from tmtccmd.pus.s11_tc_sched import create_time_tagged_cmd
 from tmtccmd.pus.s200_fsfw_mode import Subservice as ModeSubservice
 
-from common import AcsId, Apid
+from pytmtc.common import AcsId, Apid
 
 _LOGGER = logging.getLogger(__name__)
 
 
-def create_set_mode_cmd(
-    apid: int, unique_id: int, mode: int, submode: int
-) -> PusTelecommand:
-    app_data = bytearray()
-    app_data.extend(struct.pack("!I", unique_id))
-    app_data.extend(struct.pack("!I", mode))
-    app_data.extend(struct.pack("!H", submode))
-    return PusTelecommand(
-        service=200,
-        subservice=ModeSubservice.TC_MODE_COMMAND,
-        apid=apid,
-        app_data=app_data,
-    )
-
-
 def create_cmd_definition_tree() -> CmdTreeNode:
 
     root_node = CmdTreeNode.root_node()
@@ -77,6 +62,21 @@ def create_cmd_definition_tree() -> CmdTreeNode:
     return root_node
 
 
+def create_set_mode_cmd(
+    apid: int, unique_id: int, mode: int, submode: int
+) -> PusTelecommand:
+    app_data = bytearray()
+    app_data.extend(struct.pack("!I", unique_id))
+    app_data.extend(struct.pack("!I", mode))
+    app_data.extend(struct.pack("!H", submode))
+    return PusTelecommand(
+        service=200,
+        subservice=ModeSubservice.TC_MODE_COMMAND,
+        apid=apid,
+        app_data=app_data,
+    )
+
+
 def pack_pus_telecommands(q: DefaultPusQueueHelper, cmd_path: str):
     # It should always be at least the root path "/", so we split of the empty portion left of it.
     cmd_path_list = cmd_path.split("/")[1:]

satrs-example/pytmtc/requirements.txt

@@ -1,2 +1 @@
-tmtccmd == 8.0.0rc2
-# -e git+https://github.com/robamu-org/tmtccmd@97e5e51101a08b21472b3ddecc2063359f7e307a#egg=tmtccmd
+.

satrs-example/pytmtc/tc_definitions.py

@@ -1,38 +0,0 @@
-from tmtccmd.config import OpCodeEntry, TmtcDefinitionWrapper, CoreServiceList
-from tmtccmd.config.globals import get_default_tmtc_defs
-
-from common import HkOpCodes
-
-
-def tc_definitions() -> TmtcDefinitionWrapper:
-    defs = get_default_tmtc_defs()
-    srv_5 = OpCodeEntry()
-    srv_5.add("0", "Event Test")
-    defs.add_service(
-        name=CoreServiceList.SERVICE_5.value,
-        info="PUS Service 5 Event",
-        op_code_entry=srv_5,
-    )
-    srv_17 = OpCodeEntry()
-    srv_17.add("ping", "Ping Test")
-    srv_17.add("trigger_event", "Trigger Event")
-    defs.add_service(
-        name=CoreServiceList.SERVICE_17_ALT,
-        info="PUS Service 17 Test",
-        op_code_entry=srv_17,
-    )
-    srv_3 = OpCodeEntry()
-    srv_3.add(HkOpCodes.GENERATE_ONE_SHOT, "Generate AOCS one shot HK")
-    defs.add_service(
-        name=CoreServiceList.SERVICE_3,
-        info="PUS Service 3 Housekeeping",
-        op_code_entry=srv_3,
-    )
-    srv_11 = OpCodeEntry()
-    srv_11.add("0", "Scheduled TC Test")
-    defs.add_service(
-        name=CoreServiceList.SERVICE_11,
-        info="PUS Service 11 TC Scheduling",
-        op_code_entry=srv_11,
-    )
-    return defs