feat: SUB operator

.gitignore

@@ -1,3 +1,4 @@
 .coverage
 __pycache__/
 venv
+site/

README.md

@@ -9,7 +9,7 @@ Please raise an [issue](https://github.com/radiorabe/axia-pathfinder-client/issu
 ## Features
 
 * partially implements the "SAPv2" protocol as described in the [pathfinder manual](https://www.telosalliance.com/images/Axia%20Products/Pathfinder%20PC/Support%20Files/PathFinder%20PC%20Manual-5.00.pdf)
-  * only "LOGIN" and "GET" operators are currently supported
+  * only "LOGIN", "GET" and "SUB" operators are currently supported
   * "INDI" responses to "GET" requests get parsed and returned in a timeout governed timeout fashion
 * Also works with xNode Telnet interfaces
   * GPO responses to "GPO" requests are currently parsed

pathfinder/operators/sub.py

@@ -0,0 +1,15 @@
+"""
+SUB operator
+
+https://docs.telosalliance.com/pathfinder-core-pro/pathfindercore-pro/appendix-a-sapv2#subscription-examples
+"""
+from typing import NoReturn
+
+from pathfinder.operators.base import BaseOperator
+
+
+class Sub(BaseOperator):
+    config = {"path": "."}
+
+    def execute(self) -> NoReturn:
+        self.client.write(f"SUB {self.config.get('path')}".encode("ascii") + b"\r\n")

tests/test_sub.py

@@ -0,0 +1,12 @@
+import pytest
+
+from pathfinder.operators.sub import Sub
+
+
+class TestGetOperator:
+    def test_sub_root(self, client):
+        sub = Sub(client=client, config={"path": "."})
+
+        sub.execute()
+
+        sub.client.write.assert_called_with(b"SUB .\r\n")