Users/ankit/current measurement (#24)

* added current measurement and validation examples

* updated instrument name in validation examples

Author: ankitan-ni

src/nipcbatt/pcbatt_library/dmm/__init__.py

@@ -33,3 +33,21 @@
 from nipcbatt.pcbatt_library.dmm.dc_rms_voltage_measurements.dc_rms_voltage_measurement import (
     DcRmsVoltageMeasurement,
 )
+from nipcbatt.pcbatt_library.dmm.dc_rms_current_measurements.dc_rms_current_constants import (
+    DEFAULT_DC_RMS_CURRENT_AC_MIN_FREQUENCY,
+    DEFAULT_DC_RMS_CURRENT_EXECUTION_TYPE,
+    DEFAULT_DC_RMS_CURRENT_MEASUREMENT_CONFIGURATION,
+    DEFAULT_DC_RMS_CURRENT_MEASUREMENT_PARAMETERS,
+    DEFAULT_DC_RMS_CURRENT_TIMING_PARAMETERS,
+    DEFAULT_DC_RMS_CURRENT_TRIGGER_PARAMETERS,
+    ConstantsForDcRmsCurrentMeasurements,
+)
+from nipcbatt.pcbatt_library.dmm.dc_rms_current_measurements.dc_rms_current_data_types import (
+    CurrentRangeAndFunctions,
+    DcRmsCurrentMeasurementConfiguration,
+    DcRmsCurrentMeasurementFunctionParameters,
+    DcRmsCurrentMeasurementResultData,
+)
+from nipcbatt.pcbatt_library.dmm.dc_rms_current_measurements.dc_rms_current_measurement import (
+    DcRmsCurrentMeasurement,
+)

src/nipcbatt/pcbatt_library/dmm/dc_rms_current_measurements/__init__.py

@@ -0,0 +1 @@
+"""Provides DC and RMS current measurement functionality using DMM."""  

src/nipcbatt/pcbatt_library/dmm/dc_rms_current_measurements/dc_rms_current_constants.py

@@ -0,0 +1,59 @@
+"""Constants data types for DC-RMS Current Measurements."""
+
+import dataclasses
+
+from nipcbatt.pcbatt_library.dmm.common.common_data_types import (
+    TimingParameters,
+    TriggerParameters,
+)
+from nipcbatt.pcbatt_library.dmm.common.constants import ConstantsForDcRmsMeasurements
+from nipcbatt.pcbatt_library.dmm.dc_rms_current_measurements.dc_rms_current_data_types import (
+    CurrentRangeAndFunctions,
+    DcRmsCurrentMeasurementFunctionParameters,
+    DcRmsCurrentMeasurementConfiguration,
+)
+
+
+@dataclasses.dataclass
+class ConstantsForDcRmsCurrentMeasurements:
+    """Constants used for Current measurement."""
+
+    RANGE_AND_FUNCTION = CurrentRangeAndFunctions.DC_Current_Auto_Range
+
+
+"""Current measurement-specific range/function setting is defined 
+    in ConstantsForDcRmsCurrentMeasurements."""
+# Default execution type for current measurements
+DEFAULT_DC_RMS_CURRENT_EXECUTION_TYPE = ConstantsForDcRmsMeasurements.DEFAULT_EXECUTION_TYPE
+
+# Default measurement function parameters including current range/function and resolution in digits
+DEFAULT_DC_RMS_CURRENT_MEASUREMENT_PARAMETERS = DcRmsCurrentMeasurementFunctionParameters(
+    measurement_function=ConstantsForDcRmsCurrentMeasurements.RANGE_AND_FUNCTION,
+    resolution_in_digits=ConstantsForDcRmsMeasurements.DEFAULT_RESOLUTION_IN_DIGITS,
+)
+
+# Default timing parameters including aperture time and settle time
+DEFAULT_DC_RMS_CURRENT_TIMING_PARAMETERS = TimingParameters(
+    aperture_time_seconds=ConstantsForDcRmsMeasurements.DEFAULT_APERTURE_TIME_SECONDS,
+    settle_time_seconds=ConstantsForDcRmsMeasurements.DEFAULT_SETTLE_TIME_SECONDS,
+)
+
+# Default AC minimum frequency
+DEFAULT_DC_RMS_CURRENT_AC_MIN_FREQUENCY = ConstantsForDcRmsMeasurements.DEFAULT_AC_MIN_FREQUENCY
+
+# Default trigger parameters including trigger source, trigger delay, and trigger enable setting
+DEFAULT_DC_RMS_CURRENT_TRIGGER_PARAMETERS = TriggerParameters(
+    trigger_source=ConstantsForDcRmsMeasurements.DEFAULT_TRIGGER_SOURCE,
+    trigger_delay=ConstantsForDcRmsMeasurements.DEFAULT_TRIGGER_DELAY,
+    slope=ConstantsForDcRmsMeasurements.DEFAULT_TRIGGER_SLOPE,
+    enable_trigger=ConstantsForDcRmsMeasurements.DEFAULT_ENABLE_TRIGGER,
+)
+
+# Default DC-RMS current measurement configuration
+DEFAULT_DC_RMS_CURRENT_MEASUREMENT_CONFIGURATION = DcRmsCurrentMeasurementConfiguration(
+    execution_type=DEFAULT_DC_RMS_CURRENT_EXECUTION_TYPE,
+    measurement_function_parameters=DEFAULT_DC_RMS_CURRENT_MEASUREMENT_PARAMETERS,
+    trigger_parameters=DEFAULT_DC_RMS_CURRENT_TRIGGER_PARAMETERS,
+    timing_parameters=DEFAULT_DC_RMS_CURRENT_TIMING_PARAMETERS,
+    ac_min_frequency=DEFAULT_DC_RMS_CURRENT_AC_MIN_FREQUENCY,
+)

src/nipcbatt/pcbatt_library/dmm/dc_rms_current_measurements/dc_rms_current_data_types.py

@@ -0,0 +1,191 @@
+"""DC-RMS current data types."""
+
+from enum import Enum
+from typing import Union
+
+import nidmm
+
+from nipcbatt.pcbatt_library.common.common_data_types import MeasurementExecutionType
+from nipcbatt.pcbatt_library.dmm.common.common_data_types import (
+    ResolutionInDigits,
+    TimingParameters,
+    TriggerParameters,
+)
+from nipcbatt.pcbatt_library_core.pcbatt_data_types import PCBATestToolkitData
+
+
+class CurrentRangeAndFunctions(Enum):
+    """Defines the measurement function and range settings for current measurement."""
+
+    DC_Current_Auto_Range = (nidmm.Function.DC_CURRENT, -1.0)
+    DC_1uA = (nidmm.Function.DC_CURRENT, 0.000001)
+    DC_10uA = (nidmm.Function.DC_CURRENT, 0.00001)
+    DC_100uA = (nidmm.Function.DC_CURRENT, 0.0001)
+    DC_1mA = (nidmm.Function.DC_CURRENT, 0.001)
+    DC_10mA = (nidmm.Function.DC_CURRENT, 0.01)
+    DC_20mA = (nidmm.Function.DC_CURRENT, 0.02)
+    DC_100mA = (nidmm.Function.DC_CURRENT, 0.1)
+    DC_200mA = (nidmm.Function.DC_CURRENT, 0.2)
+    DC_1A = (nidmm.Function.DC_CURRENT, 1)
+    DC_3A = (nidmm.Function.DC_CURRENT, 3)
+
+    AC_Current_Auto_Range = (nidmm.Function.AC_CURRENT, -1.0)
+    AC_100uA = (nidmm.Function.AC_CURRENT, 0.0001)
+    AC_1mA = (nidmm.Function.AC_CURRENT, 0.001)
+    AC_10mA = (nidmm.Function.AC_CURRENT, 0.01)
+    AC_100mA = (nidmm.Function.AC_CURRENT, 0.1)
+    AC_500mA = (nidmm.Function.AC_CURRENT, 0.5)
+    AC_1A = (nidmm.Function.AC_CURRENT, 1)
+    AC_3A = (nidmm.Function.AC_CURRENT, 3)
+
+
+class DcRmsCurrentMeasurementFunctionParameters:
+    """Defines parameters used for configuration of DC-RMS current measurement.."""
+
+    def __init__(
+        self,
+        measurement_function: CurrentRangeAndFunctions,
+        resolution_in_digits: ResolutionInDigits,
+    ) -> None:
+        """Initializes measurement function parameters.
+
+        Args:
+            measurement_function (CurrentRangeAndFunctions):
+                The current measurement function and range setting.
+            resolution_in_digits (ResolutionInDigits):
+                The measurement resolution in digits.
+        """
+        self._measurement_function = measurement_function
+        self._resolution_in_digits = resolution_in_digits
+
+    @property
+    def measurement_function(self) -> CurrentRangeAndFunctions:
+        """Gets the current measurement function and range setting.
+
+        Returns:
+            CurrentRangeAndFunctions: The configured current range and function.
+        """
+        return self._measurement_function
+
+    @property
+    def resolution_in_digits(self) -> ResolutionInDigits:
+        """Gets the measurement resolution in digits.
+
+        Returns:
+            ResolutionInDigits: The configured resolution setting.
+        """
+        return self._resolution_in_digits
+
+
+class DcRmsCurrentMeasurementConfiguration(PCBATestToolkitData):
+    """Defines configuration parameters for current DC-RMS measurements."""
+
+    def __init__(
+        self,
+        execution_type: MeasurementExecutionType,
+        measurement_function_parameters: DcRmsCurrentMeasurementFunctionParameters,
+        trigger_parameters: TriggerParameters,
+        timing_parameters: TimingParameters,
+        ac_min_frequency: float,
+    ) -> None:
+        """Initializes the current measurement configuration.
+
+        Args:
+            execution_type (MeasurementExecutionType):
+                Specifies whether to configure only, measure only, or both configure and measure.
+            measurement_function_parameters (DcRmsCurrentMeasurementFunctionParameters):
+                The measurement function settings including current range and resolution.
+            trigger_parameters (TriggerParameters):
+                Trigger configuration including source, delay, and enable/disable settings.
+            timing_parameters (TimingParameters):
+                Timing settings including aperture time and settle time.
+            ac_min_frequency (float):
+                Minimum frequency for AC current measurements in Hz (ignored for DC measurements).
+        """
+        self._execution_type = execution_type
+        self._measurement_function_parameters = measurement_function_parameters
+        self._trigger_parameters = trigger_parameters
+        self._timing_parameters = timing_parameters
+        self._ac_min_frequency = ac_min_frequency
+
+    @property
+    def execution_type(self) -> MeasurementExecutionType:
+        """Gets the measurement execution type.
+
+        Returns:
+            MeasurementExecutionType: The execution mode (configure only, measure only, or both).
+        """
+        return self._execution_type
+
+    @property
+    def trigger_parameters(self) -> TriggerParameters:
+        """Gets the trigger configuration parameters.
+
+        Returns:
+            TriggerParameters: The trigger settings for the measurement.
+        """
+        return self._trigger_parameters
+
+    @property
+    def measurement_function_parameters(self) -> DcRmsCurrentMeasurementFunctionParameters:
+        """Gets the measurement function parameters.
+
+        Returns:
+            DcRmsCurrentMeasurementFunctionParameters: The current range, function,
+            and resolution settings.
+        """
+        return self._measurement_function_parameters
+
+    @property
+    def timing_parameters(self) -> TimingParameters:
+        """Gets the timing configuration parameters.
+
+        Returns:
+            TimingParameters: The aperture time and settle time settings.
+        """
+        return self._timing_parameters
+
+    @property
+    def ac_min_frequency(self) -> float:
+        """Gets the minimum AC frequency setting.
+
+        Returns:
+            float: The minimum frequency for AC current measurements.
+        """
+        return self._ac_min_frequency
+
+
+class DcRmsCurrentMeasurementResultData(PCBATestToolkitData):
+    """Defines current DC-RMS results obtained from DMM DC-RMS Current Measurement."""
+
+    def __init__(self, dmm_execution_settings: dict, measurement: Union[dict, None]) -> None:
+        """Initializes the current measurement result data.
+
+        Args:
+            dmm_execution_settings (dict):
+                Dictionary containing the DMM configuration used during measurement.
+            measurement (dict | None):
+                Dictionary containing the measurement results,
+                or None if only configuration was performed.
+        """
+        self._dmm_execution_settings = dmm_execution_settings
+        self._measurement = measurement
+
+    @property
+    def dmm_execution_settings(self) -> dict:
+        """Gets the DMM execution settings used during the measurement.
+
+        Returns:
+            dict: Dictionary with labeled keys and values including units for each setting.
+        """
+        return self._dmm_execution_settings
+
+    @property
+    def measurement(self) -> Union[dict, None]:
+        """Gets the measurement result data.
+
+        Returns:
+            dict | None: Dictionary containing 'Measured_Value', 'Unit', and
+                'Formatted_Measurement' keys, or None if only configuration was performed.
+        """
+        return self._measurement