1"""
  2Provides controls for the Rigol DM3068 DMM.
  3
  4# (c) 2020-2024 TurnAround Factor, Inc.
  5#
  6# CUI DISTRIBUTION CONTROL
  7# Controlled by: DLA J68 R&D SBIP
  8# CUI Category: Small Business Research and Technology
  9# Distribution/Dissemination Controls: PROTECTED BY SBIR DATA RIGHTS
 10# POC: GOV SBIP Program Manager Denise Price, 571-767-0111
 11# Distribution authorized to U.S. Government Agencies only, to protect information not owned by the
 12# U.S. Government and protected by a contractor’s ‘limited rights’ statement, or received with the understanding that
 13# it is not routinely transmitted outside the U.S. Government (determination made September 14, 2024). Other requests
 14# for this document shall be referred to ACOR DLA Logistics Operations (J-68), 8725 John J. Kingman Rd., Suite 4317,
 15# Fort Belvoir, VA 22060-6221
 16#
 17# SBIR DATA RIGHTS
 18# Contract No.:SP4701-23-C-0083
 19# Contractor Name: TurnAround Factor, Inc.
 20# Contractor Address: 10365 Wood Park Ct. Suite 313 / Ashland, VA 23005
 21# Expiration of SBIR Data Rights Period: September 24, 2029
 22# The Government's rights to use, modify, reproduce, release, perform, display, or disclose technical data or computer
 23# software marked with this legend are restricted during the period shown as provided in paragraph (b)(4) of the Rights
 24# in Noncommercial Technical Data and Computer Software--Small Business Innovative Research (SBIR) Program clause
 25# contained in the above identified contract. No restrictions apply after the expiration date shown above. Any
 26# reproduction of technical data, computer software, or portions thereof marked with this legend must also reproduce
 27# the markings.
 28"""
 29
 30from __future__ import annotations
 31
 32import time
 33from time import sleep
 34
 35from hitl_tester.modules.bms_types import SafeResource, DMMImpedance
 36
 37
 38class Dmm:
 39    """Rigol DM3068 DMM command wrapper."""
 40
 41    def __init__(self, resource: SafeResource):
 42        """
 43        Initialize the DM3068 wrapper with a specific PyVISA resource.
 44        This class does NOT open the resource, you have to open it for yourself!
 45        """
 46        self.resource = resource
 47        self.voltage_range = 20  # The maximum voltage that can be measured
 48        self.impedance_config = DMMImpedance(1, 1)
 49        self.reset()
 50
 51    def configure_voltage_normal(self):
 52        """The voltage settings for normal measurements."""
 53        self.resource.write("ZERO:AUTO ON")  # Only take the zero reading at the start. Speeds up measurement
 54        self.resource.write(f"CONF:VOLT:DC {self.voltage_range}")  # Range(V) = 0.2, 2, 20, 200, 1000, AUTO
 55        self.resource.write("VOLT:DC:NPLC 10")  # NPLC = 0.006, 0.02, 0.2, 1, 10, 100. 1PLC is equal to 0.02s
 56
 57    def configure_voltage_trigger(
 58        self, timestamps: bool = False, sample_count: int = 2000
 59    ):  # pylint: disable=unused-argument
 60        """Set up trigger parameters."""
 61        self.resource.write("ZERO:AUTO ONCE")  # Only take the zero reading at the start. Speeds up measurement
 62        self.resource.write(f"CONF:VOLT:DC {self.voltage_range},MAX")  # 20V range, with the fastest integration time
 63        self.resource.write("TRIG:SOUR IMM")  # Software trigger
 64        self.resource.write("TRIG:COUN 1")  # Only 1 group
 65        self.resource.write("TRIG:DEL 0")  # No delay in-between measurements
 66        self.resource.write(f"SAMP:COUN {sample_count}")  # Amount of samples
 67        self.resource.write("*ESE 1")  # Enable status bit (helps determine when operation completed)
 68
 69    def send_trigger(self):
 70        """Send a software trigger."""
 71
 72        self.resource.write("INIT")  # Run scans
 73        self.resource.write("*OPC")  # Set status bit to 1 when operation completes
 74
 75    def read_internal_memory(self) -> list[float]:
 76        """Return measured data from internal memory."""
 77
 78        # Wait until operation completes
 79        while int(self.resource.query("*ESR?")) & 1 != 1:
 80            time.sleep(0.1)
 81
 82        result = self.resource.query("FETC?")
 83        return list(map(float, result.split(",")))
 84
 85    @property
 86    def volts(self) -> float:
 87        """Measures DC voltage."""
 88        return float(self.resource.query("MEAS:VOLT:DC?"))
 89
 90    @property
 91    def amps_ac(self) -> float:
 92        """Measures AC current."""
 93        return float(self.resource.query("MEAS:CURR:AC?"))
 94
 95    def reset(self):
 96        """Resets the instrument."""
 97        self.resource.write("*CLS")  # Reset any errors
 98        self.resource.write("*RST")  # Put the system in a known state
 99        sleep(2)  # This instrument needs time to reset for some reason
100        self.resource.write("CMDSET AGILENT")
101        self.configure_voltage_normal()