nibcq.ACIRTestParameters

class nibcq.ACIRTestParameters

Bases: nibcq.measurement.TestParameters, nibcq.measurement.ConfigFileSupport

Configuration parameters for Alternating Current Internal Resistance (ACIR) measurements.

This class extends the base TestParameters to provide ACIR-specific configuration options for single-frequency AC impedance measurements. ACIR measurements characterize the complex impedance of a Device Under Test (DUT) at a specific frequency using sinusoidal current excitation and voltage measurement.

These parameters control the measurement conditions including voltage limits for safety, signal amplitude for signal-to-noise ratio optimization, measurement duration for accuracy, and error compensation methods for systematic error correction.

nominal_voltage

Expected DUT voltage level in Volts for measurement range optimization. Default 4.0V is typical for battery cells and electrochemical systems.

Type:

float

voltage_limit_hi

Upper voltage limit in Volts for DUT protection. Default 5.0V provides safety margin for most applications.

Type:

float

current_amplitude

AC current amplitude in Amperes for excitation signal. Default 1.0A provides good signal levels but may need adjustment based on DUT characteristics and desired measurement conditions.

Type:

float

number_of_periods

Number of complete AC cycles to measure for averaging and noise reduction. Default 20 periods provides good balance between accuracy and measurement speed.

Type:

int

compensation_method

Error correction method from CompensationMethod enum. Options include NO_COMPENSATION, SHORT, GOLDEN_DUT, or SHORT_GOLDEN_DUT for systematic error correction.

Type:

CompensationMethod

Example

>>> params = ACIRTestParameters(
...     nominal_voltage=3.7,
...     voltage_limit_hi=4.2,
...     current_amplitude=0.1,
...     number_of_periods=50,
...     compensation_method=CompensationMethod.SHORT
... )
classmethod from_json(json_data: Dict[str, Any]) → ACIRTestParameters

Create ACIRTestParameters instance from JSON dictionary.

Parameters:

json_data (Dict[str, Any]) – Dictionary containing ACIR configuration data.

Returns:

Instance configured from JSON data

Return type:

ACIRTestParameters

Raises:

  • ValueError – If required parameters are missing or invalid

  • KeyError – If expected keys are not found in json_data

classmethod from_file(file_path: str) → ACIRTestParameters

Create ACIRTestParameters instance from JSON configuration file.

Parameters:

file_path (str) – Path to JSON configuration file

Returns:

Instance configured from file

Return type:

ACIRTestParameters

Raises: