syndesi 0.1.1__tar.gz → 0.1.3__tar.gz

{syndesi-0.1.1/syndesi.egg-info → syndesi-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: syndesi
-Version: 0.1.1
+Version: 0.1.3
 Summary: Syndesi
 Author: Sebastien Deriaz
 Author-email: sebastien.deriaz1@gmail.com

{syndesi-0.1.1 → syndesi-0.1.3}/setup.py

@@ -1,6 +1,6 @@
 from setuptools import setup, find_packages
 
-VERSION = '0.1.1'
+VERSION = '0.1.3'
 DESCRIPTION = 'Syndesi'
 
 with open("README.md", "r", encoding="utf-8") as fh:

syndesi-0.1.3/syndesi/protocols/__init__.py

@@ -0,0 +1,5 @@
+from syndesi.protocols.iprotocol import IProtocol
+from .commands import Commands
+from .raw import Raw, RawStream
+from .scpi import SCPI
+from .sdp import SDP

syndesi-0.1.3/syndesi/protocols/commands.py

@@ -0,0 +1,78 @@
+from .iprotocol import IProtocol
+from ..adapters import IAdapter
+
+
+class Commands(IProtocol):
+    def __init__(self, adapter : IAdapter, termination='\n', format_response=True) -> None:
+        """
+        Command-based protocol, with LF, CR or CRLF termination
+
+        No presentation or application layers
+
+        Parameters
+        ----------
+        adapter : IAdapter
+        end : bytearray
+            Command termination, '\n' by default
+        format_response : bool
+            Apply formatting to the response (i.e removing the termination)
+        """
+        super().__init__(adapter)
+
+        if not isinstance(termination, str):
+            raise ValueError(f"end argument must be of type str, not {type(termination)}")
+        self._termination = termination
+        self._response_formatting = format_response
+
+    def _to_bytearray(self, command) -> bytearray:
+        if isinstance(command, str):
+            return command.encode('ASCII')
+        elif isinstance(command, bytes) or isinstance(command, bytearray):
+            return command
+        else:
+            raise ValueError(f'Invalid command type : {type(command)}')
+    
+    def _from_bytearray(self, payload) -> str:
+        if isinstance(payload, bytearray):
+            return payload.decode('ASCII')
+        else:
+            raise ValueError(f"Invalid payload type : {type(payload)}")
+        
+
+    def _format_command(self, command : str) -> str:
+        return command + self._termination
+    
+    def _format_response(self, response : str) -> str:
+        if response.endswith(self._termination):
+            response = response[:-len(self._termination)]
+        return response
+
+    def write(self, command : str):
+        command = self._format_command(command)
+        self._adapter.write(self._to_bytearray(command))
+
+    def query(self, command : str) -> str:
+        """
+        Writes then reads from the device then return the result
+        
+        """
+        self._adapter.flushRead()
+        self.write(command)
+        return self.read()
+
+
+    def read(self) -> str:
+        """
+        Reads command and formats it as an str
+        """
+        output = self._from_bytearray(self._adapter.read())
+        if self._response_formatting:
+            return self._format_response(output)
+        else:
+            return output
+
+    def read_raw(self) -> bytearray:
+        """
+        Returns the raw bytes instead of str
+        """
+        return self._adapter.read()

syndesi-0.1.3/syndesi/protocols/iprotocol.py

@@ -0,0 +1,14 @@
+from ..adapters import IAdapter
+
+class IProtocol:
+    def __init__(self, adapter : IAdapter) -> None:
+        self._adapter = adapter
+
+    def write(self, data):
+        pass
+
+    def query(self, data):
+        pass
+
+    def read(self):
+        pass

syndesi-0.1.1/syndesi/protocols/raw_stream.py → syndesi-0.1.3/syndesi/protocols/raw.py

@@ -2,7 +2,30 @@ from ..adapters import IAdapter
 from .iprotocol import IProtocol
 
 
-# This is a temporary class to manage continuously streaming devices (Arduino for datalogging, some RS-232 multimeters, etc...)
+# Raw protocols provide the user with the binary data directly,
+# without converting it to string first
+
+class Raw(IProtocol):
+    def __init__(self, adapter: IAdapter) -> None:
+        """
+        Raw device, no presentation and application layers
+
+        Parameters
+        ----------
+        adapter : IAdapter
+        """
+        super().__init__(adapter)
+
+    def write(self, data : bytearray):
+        self._adapter.write(data)
+
+    def query(self, data : bytearray) -> bytearray:
+        self._adapter.flushRead()
+        self.write(data)
+        return self.read()
+
+    def read(self) -> bytearray:
+        return self._adapter.read()
 
 class RawStream(IProtocol):
     def __init__(self, adapter: IAdapter, delimiter = b'\n') -> None:

{syndesi-0.1.1 → syndesi-0.1.3}/syndesi/protocols/scpi.py

@@ -21,10 +21,14 @@ class SCPI(IProtocol):
     def _to_bytearray(self, command):
         if isinstance(command, str):
             return command.encode('ASCII')
-        elif isinstance(command, bytes) or isinstance(command, bytearray):
-            return command
         else:
             raise ValueError(f'Invalid command type : {type(command)}')
+    
+    def _from_bytearray(self, payload):
+        if isinstance(payload, bytearray):
+            return payload.decode('ASCII')
+        else:
+            raise ValueError(f"Invalid payload type : {type(payload)}")
 
     def _formatCommand(self, command):
         return command + self._end
@@ -32,22 +36,27 @@ class SCPI(IProtocol):
     def _unformatCommand(self, payload):
         return payload.replace(self._end, '')
     
-    def _checkCommand(self, command : bytearray):
+    def _checkCommand(self, command : str):
         for c in ['\n', '\r']:
             if c in command:
                 raise ValueError(f"Invalid char '{c}' in command")
 
-    def write(self, command : bytearray) -> None:
+    def write(self, command : str) -> None:
         self._checkCommand(command)
-        command = self._to_bytearray(command)
-        self._adapter.write(self._formatCommand(command))
+        payload = self._to_bytearray(self._formatCommand(command))
+        self._adapter.write(payload)
 
     def query(self, command : str) -> str:
-        data = self._to_bytearray(command)
         self._adapter.flushRead()
-        self.write(data)
+        self.write(command)
         return self.read()
 
     def read(self) -> str:
-        data = self._adapter.read().decode('ASCII')
-        return self._unformatCommand(data)
+        output = self._from_bytearray(self._adapter.read())
+        return self._unformatCommand(output)
+
+    def read_raw(self) -> str:
+        """
+        Return the raw bytes instead of str
+        """
+        return self._adapter.read()

{syndesi-0.1.1 → syndesi-0.1.3/syndesi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: syndesi
-Version: 0.1.1
+Version: 0.1.3
 Summary: Syndesi
 Author: Sebastien Deriaz
 Author-email: sebastien.deriaz1@gmail.com

{syndesi-0.1.1 → syndesi-0.1.3}/syndesi.egg-info/SOURCES.txt

@@ -2,6 +2,7 @@ LICENSE
 README.md
 setup.py
 bin/syndesi
+experiments/__init__.py
 syndesi/__init__.py
 syndesi.egg-info/PKG-INFO
 syndesi.egg-info/SOURCES.txt
@@ -29,7 +30,5 @@ syndesi/protocols/__init__.py
 syndesi/protocols/commands.py
 syndesi/protocols/iprotocol.py
 syndesi/protocols/raw.py
-syndesi/protocols/raw_stream.py
 syndesi/protocols/scpi.py
-syndesi/protocols/sdp.py
-tests/__init__.py
+syndesi/protocols/sdp.py

syndesi-0.1.3/syndesi.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+experiments
+syndesi

syndesi-0.1.1/syndesi/protocols/__init__.py

@@ -1,6 +0,0 @@
-from syndesi.protocols.iprotocol import IProtocol
-from .commands import RawCommands
-from .raw_stream import RawStream
-from .raw import Raw
-from .scpi import SCPI
-from .sdp import SDP

syndesi-0.1.1/syndesi/protocols/commands.py

@@ -1,57 +0,0 @@
-from .iprotocol import IProtocol
-from ..adapters import IAdapter
-
-
-class RawCommands(IProtocol):
-    def __init__(self, adapter : IAdapter, end=b'\n', format_response=True) -> None:
-        """
-        Command-based protocol, with LF, CR or CRLF termination
-
-        No presentation or application layers
-
-        Parameters
-        ----------
-        adapter : IAdapter
-        end : bytearray
-            Command termination, '\n' by default
-        format_response : bool
-            Apply formatting to the response (i.e removing the termination)
-        """
-        super().__init__(adapter)
-
-        if not isinstance(end, bytes):
-            raise ValueError(f"end argument must be of type bytes, not {type(end)}")
-        self._end = end
-        self._response_formatting = format_response
-
-    def _to_bytearray(self, command) -> bytearray:
-        if isinstance(command, str):
-            return command.encode('ASCII')
-        elif isinstance(command, bytes) or isinstance(command, bytearray):
-            return command
-        else:
-            raise ValueError(f'Invalid command type : {type(command)}')
-
-    def _format_command(self, command : bytearray) -> bytearray:
-        return command + self._end
-    
-    def _format_response(self, response : bytearray) -> bytearray:
-        if response.endswith(self._end):
-            response = response[:-len(self._end)]
-        return response
-
-    def write(self, command : bytearray):
-        command = self._to_bytearray(command)
-        self._adapter.write(self._format_command(command))
-
-    def query(self, command : bytearray) -> bytearray:
-        data = self._to_bytearray(command)
-        self._adapter.flushRead()
-        self.write(data)
-        return self.read()
-
-    def read(self) -> bytearray:
-        if self._response_formatting:
-            return self._format_response(self._adapter.read())
-        else:
-            return self._adapter.read()

syndesi-0.1.1/syndesi/protocols/iprotocol.py

@@ -1,5 +0,0 @@
-from ..adapters import IAdapter
-
-class IProtocol:
-    def __init__(self, adapter : IAdapter) -> None:
-        self._adapter = adapter

syndesi-0.1.1/syndesi/protocols/raw.py

@@ -1,24 +0,0 @@
-from ..adapters import IAdapter
-from .iprotocol import IProtocol
-
-class Raw(IProtocol):
-    def __init__(self, adapter: IAdapter) -> None:
-        """
-        Raw device, no presentation and application layers
-
-        Parameters
-        ----------
-        adapter : IAdapter
-        """
-        super().__init__(adapter)
-
-    def write(self, data : bytearray):
-        self._adapter.write(data)
-
-    def query(self, data : bytearray) -> bytearray:
-        self._adapter.flushRead()
-        self.write(data)
-        return self.read()
-
-    def read(self) -> bytearray:
-        return self._adapter.read()

syndesi-0.1.1/syndesi.egg-info/top_level.txt

@@ -1,2 +0,0 @@
-syndesi
-tests