digilent 0.17.4__tar.gz → 0.18.1__tar.gz

{digilent-0.17.4 → digilent-0.18.1}/.gitignore

@@ -22,9 +22,14 @@ dist
 .nox
 htmlcov
 
-# Virtual environments
+# dotenv, ignore all but the example file
 
 .env
+.env.*
+!.env.example
+
+# Virtual environments
+
 .venv
 venv
 

{digilent-0.17.4 → digilent-0.18.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digilent
-Version: 0.17.4
+Version: 0.18.1
 Summary: Digilent temperature and voltage monitoring for CGSE
 Author: IvS KU Leuven
 Maintainer-email: Rik Huygen <rik.huygen@kuleuven.be>, Sara Regibo <sara.regibo@kuleuven.be>

{digilent-0.17.4 → digilent-0.18.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "digilent"
-version = "0.17.4"
+version = "0.18.1"
 description = "Digilent temperature and voltage monitoring for CGSE"
 authors = [
     {name = "IvS KU Leuven"}

{digilent-0.17.4 → digilent-0.18.1}/src/egse/digilent/digilent.py

@@ -465,7 +465,7 @@ class DigilentInterface(DeviceInterface):
         setup = setup or load_setup()
 
         try:
-            channel_config = setup.gse.dt8874
+            channel_config = setup.gse.pmx_a
 
             if "RTD" in channel_config:
                 self.channels["RTD"] = navdict()
@@ -534,14 +534,14 @@ class DigilentInterface(DeviceInterface):
         device is forced into the operation complete idle state.
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_type=CommandType.WRITE,
-        cmd_string="*ESE",
+        cmd_string="*ESE ${bits}",
         process_cmd_string=add_lf,
     )
-    def std_event_status_enable_register(self, bits: int) -> None:
+    def set_std_event_status_enable_register(self, bits: int) -> None:
         """Enables specified bits in the Standard Event Status Enable register.
 
         The bits in the Standard Event Status Enable register are:
@@ -570,7 +570,7 @@ class DigilentInterface(DeviceInterface):
             > *ESE 189
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_type=CommandType.TRANSACTION,
@@ -609,7 +609,7 @@ class DigilentInterface(DeviceInterface):
             This value indicates that bits 0, 2, 3, 4, 5, and 7 of the Standard Event Status Enable register are enabled.
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_type=CommandType.TRANSACTION,
@@ -637,7 +637,6 @@ class DigilentInterface(DeviceInterface):
         Status Enable register.  On power-up, the Standard Event Status Enable register is zero; therefore, all bits in
         the Standard Event Status register are masked.
 
-
         Returns:
             Integer value expressed in base 2 (binary) that represents the weighted bit value of the Standard Event
             Status register and the binary-weighted decimal value for each bit.  Values range from 0 to 255.
@@ -663,7 +662,7 @@ class DigilentInterface(DeviceInterface):
                 < 16
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_type=CommandType.TRANSACTION,
@@ -692,7 +691,7 @@ class DigilentInterface(DeviceInterface):
             firmware.
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string="*RST",
@@ -709,7 +708,7 @@ class DigilentInterface(DeviceInterface):
         Refer to IEE 388.2-1992, Sect. 10.32, for more information.
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_type=CommandType.TRANSACTION,
@@ -720,7 +719,7 @@ class DigilentInterface(DeviceInterface):
     def get_status_byte_register(self) -> int:
         """Returns the current value of the Status Byte register.
 
-        The weighted sum of the bit values of hte Status Byte register is returned, ranging from 0 to 255.  The
+        The weighted sum of the bit values of the Status Byte register is returned, ranging from 0 to 255.  The
         following bits, described in 1999 SCPI Syntax & Stype, Sect. 9, are supported:
 
             | Bit | Binary weight | Description |
@@ -732,6 +731,9 @@ class DigilentInterface(DeviceInterface):
 
         Refer to IEE 388.2-1992, Sect. 10.36, for more information.
 
+        Returns:
+            Weighted sum of the bit values of the Status Byte register, ranging from 0 to 255.
+
         Examples:
             The following example shows a query that is correct and causes no errors:
 
@@ -770,7 +772,7 @@ class DigilentInterface(DeviceInterface):
                 < 0
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string="STATus:OPERation:CONDition?",
@@ -827,7 +829,8 @@ class DigilentInterface(DeviceInterface):
                 < 0
                 > *STB?
         """
-        pass
+
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":STATus:SCAn?",
@@ -853,7 +856,7 @@ class DigilentInterface(DeviceInterface):
                 < 1001,1050
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:CALibrate",
@@ -871,7 +874,7 @@ class DigilentInterface(DeviceInterface):
                 > :SYST:CAL
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:DATE?",
@@ -896,7 +899,7 @@ class DigilentInterface(DeviceInterface):
                 < 2008,1,15
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:ERRor?",
@@ -967,7 +970,7 @@ class DigilentInterface(DeviceInterface):
                 < 0,"No error"
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:ERRor:COUNt?",
@@ -993,7 +996,7 @@ class DigilentInterface(DeviceInterface):
                 < 0
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:PRESet",
@@ -1006,7 +1009,7 @@ class DigilentInterface(DeviceInterface):
         The effect of this command is the same as pushing the LAN reset switch on the rear panel of the instrument.
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:COMMunicate:NETwork:IPADdress?",
@@ -1022,7 +1025,7 @@ class DigilentInterface(DeviceInterface):
 
         # FIXME This actually returns the IP address of my laptop, rather than the instrument
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:COMMunicate:NETwork:MASk?",
@@ -1040,7 +1043,7 @@ class DigilentInterface(DeviceInterface):
             < 255.255.255.0
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:PASSword:CDISable ${password}",
@@ -1061,7 +1064,7 @@ class DigilentInterface(DeviceInterface):
             password (str): Password that is stored in permanent memory on the instrument.
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:PASSword:CENable ${password}",
@@ -1082,7 +1085,7 @@ class DigilentInterface(DeviceInterface):
             password (str): Password that is stored in permanent memory on the instrument.
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:PASSword:CENable:STATe?",
@@ -1103,7 +1106,7 @@ class DigilentInterface(DeviceInterface):
                 < 1
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:PASSword:NEW ${old_password},${new_password}",
@@ -1125,7 +1128,7 @@ class DigilentInterface(DeviceInterface):
                                 on the instrument.
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:VERSion?",
@@ -1145,7 +1148,7 @@ class DigilentInterface(DeviceInterface):
                 < 1999.0
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:BOArd?",
@@ -1166,7 +1169,7 @@ class DigilentInterface(DeviceInterface):
                 < 6
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:BOArd:MOdel? ${board_number}",
@@ -1200,7 +1203,7 @@ class DigilentInterface(DeviceInterface):
                 < 5
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:BOArd:MOdel:NAMe? ${board_number}",
@@ -1224,7 +1227,7 @@ class DigilentInterface(DeviceInterface):
                 < DT8872
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:BOArd:RANGe? ${board_number}",
@@ -1254,7 +1257,7 @@ class DigilentInterface(DeviceInterface):
                 < -1.250, 1.250
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:CHANnel?",
@@ -1277,7 +1280,7 @@ class DigilentInterface(DeviceInterface):
                 < @0:23
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:CHANnel:RTD?",
@@ -1309,7 +1312,7 @@ class DigilentInterface(DeviceInterface):
                 < @8:15
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:CHANnel:TCouple?",
@@ -1341,7 +1344,7 @@ class DigilentInterface(DeviceInterface):
                 < @0:15
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:CHANnel:VOLTage:RANGe?",
@@ -1372,7 +1375,7 @@ class DigilentInterface(DeviceInterface):
                 < (@16:23)
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:DINput?",
@@ -1393,7 +1396,7 @@ class DigilentInterface(DeviceInterface):
                 < 8
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:DINput?",
@@ -1414,7 +1417,7 @@ class DigilentInterface(DeviceInterface):
                 < 8
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:SCAn:RATe:MAXimum:SEC?",
@@ -1435,7 +1438,7 @@ class DigilentInterface(DeviceInterface):
                 < 0.10000
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:SCAn:RATe:MAXimum:HZ?",
@@ -1456,7 +1459,7 @@ class DigilentInterface(DeviceInterface):
                 < 10.00000
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:SCAn:RATe:MINimum:SEC?",
@@ -1477,7 +1480,7 @@ class DigilentInterface(DeviceInterface):
                 < 6553.5
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:SCAn:RATe:MINimum:HZ?",
@@ -1498,7 +1501,7 @@ class DigilentInterface(DeviceInterface):
                 < 1.525e-4
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:TIME?",
@@ -1522,7 +1525,7 @@ class DigilentInterface(DeviceInterface):
                 < 15:31:45
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:TZONe?",
@@ -1544,9 +1547,7 @@ class DigilentInterface(DeviceInterface):
                 < 4, -45
         """
 
-        # TODO
-
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":SYSTem:TZONe ${hour},${minute}",
@@ -1570,7 +1571,7 @@ class DigilentInterface(DeviceInterface):
                 > :SYST:TZON 4,-45
         """
 
-        pass
+        raise NotImplementedError
 
     # CONFigure Sub-System Commands
 
@@ -1611,7 +1612,7 @@ class DigilentInterface(DeviceInterface):
                 > :CONF:RES (@1,2,8:46)
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":CONFigure:TEMPerature:RTD ${rtd_type},${channels}",
@@ -1677,7 +1678,7 @@ class DigilentInterface(DeviceInterface):
                 < 0
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":CONFigure:TEMPerature:TCouple ${tc_type}, ${channels}",
@@ -1734,7 +1735,7 @@ class DigilentInterface(DeviceInterface):
                 < 0
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":CONFigure:VOLTage ${channels}",
@@ -1767,7 +1768,7 @@ class DigilentInterface(DeviceInterface):
                 > :CONF:VOLT (@1,2,8:46)
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":CONFigure:VOLTage:RANGe ${voltage_range},${channels}",
@@ -1838,7 +1839,8 @@ class DigilentInterface(DeviceInterface):
         """
 
         # TODO Only for VOLTpoint + MEASURpoint
-        pass
+
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":CONFigure? ${channels}",
@@ -1874,7 +1876,7 @@ class DigilentInterface(DeviceInterface):
                 < RAW
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":CONFigure:FILTer ${filter_type}",
@@ -1894,7 +1896,7 @@ class DigilentInterface(DeviceInterface):
             filter_type (str): Filter type to be used for the analogue input operations.
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":CONFigure:FILTer?",
@@ -1927,7 +1929,7 @@ class DigilentInterface(DeviceInterface):
                 < RAW
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":CONFigure:SCAn:BUFfer?",
@@ -1955,7 +1957,7 @@ class DigilentInterface(DeviceInterface):
                 < 1048576
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":CONFigure:SCAn:CJC ${cjc}",
@@ -1993,7 +1995,7 @@ class DigilentInterface(DeviceInterface):
                 < 1
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":CONFigure:SCAn:CJC?",
@@ -2034,7 +2036,7 @@ class DigilentInterface(DeviceInterface):
                 < 1
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":CONFigure:SCAn:LISt ${channels}",
@@ -2074,7 +2076,7 @@ class DigilentInterface(DeviceInterface):
                 < (@0,4:7)
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":CONFigure:SCAn:LISt?",
@@ -2109,7 +2111,7 @@ class DigilentInterface(DeviceInterface):
                 < (@0,4:7)
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":CONFigure:SCAn:RATe:SEC ${rate}",
@@ -2179,7 +2181,7 @@ class DigilentInterface(DeviceInterface):
                 < 0
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":CONFigure:SCAn:RATe:SEC?",
@@ -2189,7 +2191,8 @@ class DigilentInterface(DeviceInterface):
     )
     def get_scan_rate(self) -> float:
         """Returns the time period of each scan [s]."""
-        pass
+
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":CONFigure:SCAn:RATe:HZ?",
@@ -2237,7 +2240,7 @@ class DigilentInterface(DeviceInterface):
                 < 0
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":CONFigure:TRIGger:SOURce ${source}",
@@ -2262,7 +2265,7 @@ class DigilentInterface(DeviceInterface):
                 > :CONF:TRIG DIN0
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":CONFigure:TRIGger:SOURce?",
@@ -2287,7 +2290,7 @@ class DigilentInterface(DeviceInterface):
                 < DIN0
         """
 
-        pass
+        raise NotImplementedError
 
     # MEASure Sub-System Commands
 
@@ -2324,7 +2327,7 @@ class DigilentInterface(DeviceInterface):
             in the given list of channels [Ohm].
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_type=CommandType.TRANSACTION,
@@ -2382,7 +2385,7 @@ class DigilentInterface(DeviceInterface):
                 - 0a = carriage return; this is the standard ASCII terminator
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_type=CommandType.TRANSACTION,
@@ -2433,7 +2436,7 @@ class DigilentInterface(DeviceInterface):
                 - 0a = carriage return; this is the standard ASCII terminator
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_type=CommandType.TRANSACTION,
@@ -2470,6 +2473,8 @@ class DigilentInterface(DeviceInterface):
                 - 0a = carriage return; this is the standard ASCII terminator
         """
 
+        raise NotImplementedError
+
     # INITiate Sub-System Command
 
     @dynamic_command(
@@ -2525,7 +2530,7 @@ class DigilentInterface(DeviceInterface):
                < 0
         """
 
-        pass
+        raise NotImplementedError
 
     # ABORt Sub-System Command
 
@@ -2573,7 +2578,7 @@ class DigilentInterface(DeviceInterface):
                 < 0
         """
 
-        pass
+        raise NotImplementedError
 
     # FETCh Sub-System Command
 
@@ -2652,7 +2657,7 @@ class DigilentInterface(DeviceInterface):
                 0a Carriage Return. This is the standard SCPI Terminator.
         """
 
-        pass
+        raise NotImplementedError
 
     # Digital INPut Sub-System Command
 
@@ -2679,7 +2684,7 @@ class DigilentInterface(DeviceInterface):
                 < 130
         """
 
-        pass
+        raise NotImplementedError
 
     # Digital OUTPut Sub-System Commands
 
@@ -2706,7 +2711,7 @@ class DigilentInterface(DeviceInterface):
                 < 130
         """
 
-        pass
+        raise NotImplementedError
 
     @dynamic_command(
         cmd_string=":OUTPut:STATe ${state}",
@@ -2733,7 +2738,7 @@ class DigilentInterface(DeviceInterface):
                 > :OUTPut:STATe 129
         """
 
-        pass
+        raise NotImplementedError
 
 
 class DigilentController(DigilentInterface, DynamicCommandMixin):

{digilent-0.17.4 → digilent-0.18.1}/src/egse/digilent/measurpoint/digilent_devif.py

@@ -100,7 +100,7 @@ class DigilentEthernetInterface(DeviceConnectionInterface, DeviceTransport):
         self._is_connection_open = True
 
         # Check that we are connected to the controller by issuing the "VERSION" or
-        # "*ISDN?" query. If we don't get the right response, then disconnect automatically.
+        # "*IDN?" query. If we don't get the right response, then disconnect automatically.
 
         if not self.is_connected():
             raise DeviceConnectionError(
@@ -157,7 +157,7 @@ class DigilentEthernetInterface(DeviceConnectionInterface, DeviceTransport):
 
         if "Data Translation" not in manufacturer or "DT" not in model:
             logger.error(
-                f'Device did not respond correctly to a "IDN?" command, manufacturer={manufacturer}, model={model}. Disconnecting...'
+                f"Device did not respond correctly to a {IDENTIFICATION_QUERY} command, manufacturer={manufacturer}, model={model}. Disconnecting..."
             )
             self.disconnect()
             return False
@@ -187,7 +187,7 @@ class DigilentEthernetInterface(DeviceConnectionInterface, DeviceTransport):
             raise DeviceConnectionError(self.device_name, "Socket communication error.") from e_socket
         except AttributeError:
             if not self._is_connection_open:
-                msg = "The DAQ6510 is not connected, use the connect() method."
+                msg = "The DT8874 is not connected, use the connect() method."
                 raise DeviceConnectionError(self.device_name, msg)
             raise
 
@@ -214,7 +214,7 @@ class DigilentEthernetInterface(DeviceConnectionInterface, DeviceTransport):
 
             self._sock.sendall(command.encode())
 
-            # wait for, read and return the response from HUBER (will be at most TBD chars)
+            # wait for, read and return the response from Digilent (will be at most TBD chars)
 
             return_string = self.read()
 

{digilent-0.17.4 → digilent-0.18.1}/src/egse/digilent/measurpoint/dt8874/dt8874.py

@@ -47,7 +47,7 @@ class Dt8874Proxy(DynamicProxy, Dt8874Interface):
     """
 
     def __init__(self):
-        """Initialisation of a Dt8874Proxy."""
+        """Initialisation of a Digilent MEASURpoint DT8874 proxy."""
 
         # Fixed ports -> Use information from settings
 

{digilent-0.17.4 → digilent-0.18.1}/src/egse/digilent/measurpoint/dt8874/dt8874_cs.py

@@ -68,6 +68,12 @@ def is_dt8874_cs_active(timeout: float = 0.5) -> bool:
 
 class Dt8874ControlServer(ControlServer):
     def __init__(self, simulator: bool = False):
+        """Initialisation of a Digilent MEASURpoint DT8874 Control Server.
+
+        Args:
+            simulator (bool): Indicates whether to operate in simulator mode.
+        """
+
         super().__init__()
 
         multiprocessing.current_process().name = PROCESS_NAME

{digilent-0.17.4 → digilent-0.18.1}/src/egse/digilent/measurpoint/dt8874/dt8874_protocol.py

@@ -72,6 +72,7 @@ class Dt8874Protocol(DynamicCommandProtocol):
         Returns:
             Digilent MEASURpoint DT8874 interface.
         """
+
         return self.dt8874
 
     def get_status(self) -> dict: