hardware-control 3.0.0__tar.gz → 3.0.1__tar.gz

{hardware-control-3.0.0/docs/source → hardware-control-3.0.1}/CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.0.1] 2023-02-18
+
+### CHANGED
+- updated docs
+- Removed auto_update from HCPushButton since it connects to a command not a parameter
+
+### FIXED
+- HCLabel: force convertion to string, so that call to .rjust works all the time
+- TPI: several fixes
+- Fix quering for a serial device
+
 ## [3.0.0] 2023-02-18
 
 The main new feature is updating to pyqt6.

{hardware-control-3.0.0 → hardware-control-3.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hardware-control
-Version: 3.0.0
+Version: 3.0.1
 Summary: A package to write QT programs to control hardware
 Home-page: https://bitbucket.org/berkeleylab/hardware-control.git
 Author: "Ariel Amsellem, Arun Persaud, Brian Mak, Brian Wynne, Grant Giesbrecht, Timo Bauer, Zhihao Qin"

{hardware-control-3.0.0 → hardware-control-3.0.1/docs/source}/CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.0.1] 2023-02-18
+
+### CHANGED
+- updated docs
+- Removed auto_update from HCPushButton since it connects to a command not a parameter
+
+### FIXED
+- HCLabel: force convertion to string, so that call to .rjust works all the time
+- TPI: several fixes
+- Fix quering for a serial device
+
 ## [3.0.0] 2023-02-18
 
 The main new feature is updating to pyqt6.

{hardware-control-3.0.0 → hardware-control-3.0.1}/docs/source/index.rst

@@ -4,7 +4,7 @@ Welcome to Hardware-control's documentation!
 Hardware-control is a Python package designed to simplify creating
 instrument control programs (for example for power supplies,
 oscilloscopes, etc.). By using reusable front ends (widgets) and
-instrument drivers hardware-control tries to minimize the
+instrument drivers. Hardware-control tries to minimize the
 effort and code required to communicate with instruments in the lab.
 
 Hardware-control uses a few basic constructs to organize its

{hardware-control-3.0.0 → hardware-control-3.0.1}/docs/source/installation.rst

@@ -1,7 +1,7 @@
 Installation
 ============
 
-Hardware control requires python ≥ 3.6.
+Hardware control requires python ≥ 3.7.
 
 The code is available on `PyPi
 <https://pypi.org/project/hardware-control>`_ and therefore can be

{hardware-control-3.0.0 → hardware-control-3.0.1}/docs/source/instrument_index.rst

@@ -33,3 +33,4 @@ drivers for the NI-DAQ modules and picoscopes.
    instruments/siglent
    instruments/srs
    instruments/tdkl
+   instruments/trinity_power

hardware-control-3.0.1/docs/source/instruments/picotech.rst

@@ -0,0 +1,10 @@
+Picotech
+========
+
+hardware_control.instruments.picotech.Picoscope module
+------------------------------------------------------
+
+.. automodule:: hardware_control.instruments.picotech.Picoscope
+   :members:
+   :undoc-members:
+   :show-inheritance:

hardware-control-3.0.1/docs/source/instruments/trinity_power.rst

@@ -0,0 +1,11 @@
+Trinity Power
+=============
+
+hardware_control.instruments.trinity_power.tpi module
+-----------------------------------------------------
+
+.. automodule:: hardware_control.instruments.trinity_power.TPI
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

{hardware-control-3.0.0 → hardware-control-3.0.1}/docs/source/outlook.md

@@ -5,11 +5,11 @@ Plans for the future include (but are not limited to):
 - Adding more instrument drivers
 - Expanding the instrument drivers we have to implement more parameters/commands
 - Modifying the auto-update functionality of the main app to be more flexible, e.g. custom timeout for each instrument
-- Looking into using binary ZMQ messages and sending for example numpy arrays over ZMQ instead of strings
+- Looking into using binary ZMQ messages and sending for example numpy arrays over ZMQ instead of strings (e.g., using msgpack)
 - Create a custom widget that shows all logging messages and lets you filter them on the fly (by loglevel and instrument driver, etc.)
 - Code improvement:
    - adding more type hints
    - adding more tests (e.g. figuring out how to test Qt apps)
-   - improving the code base (running linters such as pylint)
-   - update to Qt6
+   - improving the code base (running linters such as pylint, ruff)
    - replace some logging instances with raising an exception where appropiate (currently we only use logger.error)
+   - in the instrument drivers switch from commands (no argument) and parameters (one argument) to something that can handle multiple arguments

{hardware-control-3.0.0 → hardware-control-3.0.1}/docs/source/supported_instruments.rst

@@ -111,6 +111,9 @@ provide a pull request.
      * - `Siglent SDG Series <https://www.siglent.eu/waveform-generators>`_ (LAN)
        - .. image:: /images/SDG1000X.png
            :height: 100
+     * - `Trinity Power TPI <https://rf-consultant.com/products/tpi-1001-b-signal-generator/>`_ (USB)
+       - .. image:: /images/TPI.jpg
+           :height: 100
 
 
 - IOModule:

{hardware-control-3.0.0 → hardware-control-3.0.1}/hardware_control/_version.py

@@ -1,4 +1,4 @@
 # file generated by setuptools_scm
 # don't change, don't track in version control
-__version__ = version = '3.0.0'
-__version_tuple__ = version_tuple = (3, 0, 0)
+__version__ = version = '3.0.1'
+__version_tuple__ = version_tuple = (3, 0, 1)

{hardware-control-3.0.0 → hardware-control-3.0.1}/hardware_control/base/Instrument.py

@@ -90,7 +90,6 @@ class Instrument:
         default_port: int = None,
         pyvisa_backend: str = "@py",
     ) -> None:
-
         self.name = instrument_name
         self._online: bool = False
         self.pyvisa_backend = pyvisa_backend
@@ -643,7 +642,7 @@ class Instrument:
 
     def query_serial(self, command, delay):
         self.device.write(command)
-        time.sleep(inst_delay)
+        time.sleep(delay)
         reply = self.device.read(
             termination=(self.read_termination or self._termination)
         )
@@ -666,7 +665,7 @@ class Instrument:
 
                 if delay is not None:
                     inst_delay = delay
-                self.query_serial(command, delay)
+                reply = self.query_serial(command, inst_delay)
 
             elif self.connection_type == Instrument.SOCKET:
                 self.device.sendall(bytes(command + self._termination, self._encoding))
@@ -691,7 +690,7 @@ class Instrument:
                     )
 
             return reply
-        except Exception:
+        except Exception as e:
             logger.error(f"Query {command} failed in {self.name}", exc_info=True)
             self._online = False
             return None

{hardware-control-3.0.0 → hardware-control-3.0.1}/hardware_control/gui/widgets/hc_widgets.py

@@ -125,7 +125,6 @@ class HCMixin:
     """
 
     def __init__(self, **kwargs) -> None:
-
         app = kwargs.pop("app")
         instrument = kwargs.pop("instrument")
         parameter = kwargs.pop("parameter")
@@ -246,7 +245,6 @@ class HCLabel(HCMixin, QLabel):
         min_width: int = 10,
         auto_update=True,
     ) -> None:
-
         super().__init__(
             app=app,
             instrument=instrument,
@@ -273,6 +271,8 @@ class HCLabel(HCMixin, QLabel):
                     text = f"{float(text):.3g} {self.unit}"
                 except:
                     text = f"{text} {self.unit}"
+        else:
+            text = str(text)
         if self.min_width:
             text = text.rjust(self.min_width)
         super().setText(text)
@@ -378,7 +378,6 @@ class HCPushButton(HCMixin, QPushButton):
         parameter: str,
         label: str = "",
         label_align: str = "left",
-        auto_update=True,
     ):
         super().__init__(
             app=app,
@@ -387,7 +386,7 @@ class HCPushButton(HCMixin, QPushButton):
             label=label,
             label_align=label_align,
             text=label,
-            auto_update=auto_update,
+            auto_update=False,
         )
 
         self.clicked.connect(self.value_change)

{hardware-control-3.0.0 → hardware-control-3.0.1}/hardware_control/instruments/advantech/Adam_6024.py

@@ -5,6 +5,7 @@
 """
 
 import logging
+import time
 
 from ...base.hooks import range_validator, format_float
 
@@ -23,6 +24,15 @@ def _create_channel_parser(channel):
     return parse_channel
 
 
+def _create_channel_pulse(inst, channel):
+    def pulse():
+        inst.command(f"CH_DO{channel}_ON")
+        time.sleep(0.1)
+        inst.command(f"CH_DO{channel}_OFF")
+
+    return pulse
+
+
 class Adam_6024(AdamBase):
     """Adam 6024 input/output module instrument class.
 
@@ -53,6 +63,9 @@ class Adam_6024(AdamBase):
         self.n_input_channels = 7
         self.n_output_channels = 2
 
+        self.n_digital_input_channels = 2
+        self.n_digital_output_channels = 2
+
         for channel in range(self.n_input_channels):
             self.add_parameter(
                 f"CH{channel}_READ_VOLTAGE",
@@ -67,3 +80,21 @@ class Adam_6024(AdamBase):
                 set_command=f"#01{channel:02d}{{}}",
                 pre_hooks=[range_validator(0, 10), format_float("06.3f")],
             )
+
+        # turn on
+        for channel in range(self.n_digital_output_channels):
+            self.add_command(
+                command_name=f"CH_DO{channel}_ON",
+                command=f"#011{channel}01",
+            )
+            self.add_command(
+                command_name=f"CH_DO{channel}_OFF",
+                command=f"#011{channel}00",
+            )
+            self.add_command(
+                command_name=f"CH_DO{channel}_PULSE",
+                command=_create_channel_pulse(self, channel),
+            )
+
+        # note: channel 0 is DO0 (Pin 5), channel 1 is DO 1 (Pin2)
+        # trigger function - includes in and out signals

{hardware-control-3.0.0 → hardware-control-3.0.1}/hardware_control/instruments/picotech/Picoscope.py

@@ -1,7 +1,11 @@
 """
+Control class to handle different picoscopes.
+
 .. image:: /images/Pico_6000.jpg
   :height: 200
 
+Currently supports 2000, 5000, and 6000 Picoscopes.
+
 """
 
 from functools import partial

{hardware-control-3.0.0 → hardware-control-3.0.1}/hardware_control/instruments/trinity_power/tpi.py

@@ -1,17 +1,14 @@
 """
-Instrument driver fro TPI from Trinity Power
+Instrument driver for TPI from Trinity Power
 
-TOOD: refactor query and set_value, so that many checks are still done in Instruemnt
-and only the actual write is overwritten here
-
-Move all COMMANDS2 into add_parameter, add_commnad
+.. image:: /images/TPI.jpg
+  :height: 200
 
 """
 
 from dataclasses import dataclass
 import logging
 import time
-from typing import Any
 
 import numpy as np
 
@@ -41,7 +38,12 @@ def validate_frequency(value: int):
 class TPI(Instrument):
     """TPI Signal Generator
 
-    TPI-1001, TPI-1002, & TPI-1005
+    .. image:: /images/TPI.jpg
+      :height: 200
+
+    TPI-1001, TPI-1002, & TPI-1005.
+
+    Implements its own binary driver.
 
     """
 
@@ -53,22 +55,22 @@ class TPI(Instrument):
 
         self.add_parameter(
             "FREQUENCY",
-            Command(b"\x07\x09", 4, np.dtype("<i4")),
-            Command(b"\x08\x09", 4, np.dtype("<i4")),
-            post_hooks=[lambda x: int(x)],
+            read_command=Command(b"\x07\x09", 4, np.dtype("<i4")),
+            set_command=Command(b"\x08\x09", 4, np.dtype("<i4")),
+            post_hooks=[lambda x: str(int(x))],
         )
         self.add_parameter(
             "OUTPUT_LEVEL",
-            Command(b"\x07\x0A", 1, np.dtype("i1")),
-            Command(b"\x08\x0A", 1, np.dtype("i1")),
-            post_hooks=[lambda x: int(x)],
+            read_command=Command(b"\x07\x0A", 1, np.dtype("i1")),
+            set_command=Command(b"\x08\x0A", 1, np.dtype("i1")),
+            post_hooks=[lambda x: str(int(x))],
         )
 
         self.add_parameter(
             "OUTPUT_ON_OFF",
-            Command(b"\x07\x0B", 1, np.dtype(bool)),
-            Command(b"\x08\x0B", 1, np.dtype(bool)),
-            post_hooks=[lambda x: bool(x)],
+            read_command=Command(b"\x07\x0B", 1, np.dtype(bool)),
+            set_command=Command(b"\x08\x0B", 1, np.dtype(bool)),
+            post_hooks=[lambda x: str(bool(x))],
         )
 
         READ_ONLY_COMMANDS = {
@@ -96,6 +98,15 @@ class TPI(Instrument):
         for k, v in COMMANDS.items():
             self.add_command(k, v)
 
+        self.add_command("OUTPUT_ON", self.output_on)
+        self.add_command("OUTPUT_OFF", self.output_off)
+
+    def output_on(self):
+        self["OUTPUT_ON_OFF"] = 1
+
+    def output_off(self):
+        self["OUTPUT_ON_OFF"] = 0
+
     def config(self):
         """Needs to be called when coming online."""
         self.config_serial(
@@ -112,9 +123,12 @@ class TPI(Instrument):
 
     def try_connect(self) -> bool:
         """Overwrite try_connect to always call config when getting online."""
+
         ret = super().try_connect()
         if self._online:
             self.config()
+            self.command("USER_CONTROL")
+
         return ret
 
     def read_package(self):
@@ -190,14 +204,18 @@ class TPI(Instrument):
 
         self.device.write_raw(package)
 
-    def query_serial(self, command):
+    def query_serial(self, command, delay):
         self.write_package(command.command)
-        time.sleep(inst_delay)
+        time.sleep(delay)
         reply = self.read_package()
+        reply = reply[2:]
+        reply = np.frombuffer(reply, dtype=command.parameter_type)[0]
+
         return reply
 
     def write(self, command):
         self.write_package(command.command)
+        self.read_package()
 
     def set_value(self, parameter: str, value) -> None:
         if parameter in self.set_commands:

{hardware-control-3.0.0 → hardware-control-3.0.1}/hardware_control.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hardware-control
-Version: 3.0.0
+Version: 3.0.1
 Summary: A package to write QT programs to control hardware
 Home-page: https://bitbucket.org/berkeleylab/hardware-control.git
 Author: "Ariel Amsellem, Arun Persaud, Brian Mak, Brian Wynne, Grant Giesbrecht, Timo Bauer, Zhihao Qin"

{hardware-control-3.0.0 → hardware-control-3.0.1}/hardware_control.egg-info/SOURCES.txt

@@ -77,6 +77,7 @@ docs/source/images/RigolDS100Z.png
 docs/source/images/SDG1000X.png
 docs/source/images/SRS_CIS.jpg
 docs/source/images/TDKLGenH.jpg
+docs/source/images/TPI.jpg
 docs/source/images/controls/DelayGenerator.png
 docs/source/images/controls/FlowController.png
 docs/source/images/controls/FunctionGenerator.png
@@ -104,6 +105,7 @@ docs/source/instruments/rigol.rst
 docs/source/instruments/siglent.rst
 docs/source/instruments/srs.rst
 docs/source/instruments/tdkl.rst
+docs/source/instruments/trinity_power.rst
 examples/dataset_plotting.py
 examples/hooks.py
 examples/interactive_python.py

hardware-control-3.0.0/docs/source/instruments/picotech.rst

@@ -1,10 +0,0 @@
-Picotech
-========
-
-hardware_control.instruments.picotech.Picotech_6000 module
-----------------------------------------------------------
-
-.. automodule:: hardware_control.instruments.picotech.Picotech_6000
-   :members:
-   :undoc-members:
-   :show-inheritance: