Models

Dataclass for analog component (DAC / ADC) configuration.

Attributes:

• bits (int) –

  Number of bits this device uses.

• gain (float) –

  Voltage gain of the device.

• max_raw_value (int) –

  Maximum raw value, based on the amount of bits.

• max_value (float) –

  Maximum analog value this device can handle.

• min_value (float) –

  Minimum analog value this device can handle.

• offset (float) –

  Voltage offset of the device.

• resolution (float) –

  Resolution of this analog device.

• step_size (float) –

  Analog step size for the input or output of this component.

• v_range (float) –

  Gets the reference voltage range of the device.

bits: int

gain: float

max_raw_value: int

max_value: float

min_value: float

offset: float

resolution: float

step_size: float

v_range: float

Dataclass for device capabilities and info.

Attributes:

• acv_max_frequency (int) –

  The maximum frequency for ACV in Hz.

• adc_auxiliary (AnalogComponent) –

  Gets an object with values to calculate the auxiliary voltage from the integer value received from the instrument.

• adc_bipot (AnalogComponent) –

  Gets an object with values to calculate the bipot current from the integer value received from the instrument.

• adc_current (AnalogComponent) –

  Gets an object with values to calculate the current from the integer value received from the instrument.

• adc_potential (AnalogComponent) –

  Gets an object with values to calculate the potential from the integer value received from the instrument.

• connection (str) –

  Connection type for this device.

• dac_auxiliary (AnalogComponent) –

  Gets an object with values to calculate the instrument integer value for setting the auxiliary output voltage.

• dac_bipot (AnalogComponent) –

  Gets an object with values to calculate the instrument integer value for setting the bipot potential.

• dac_current (AnalogComponent) –

  Gets an object with values to calculate the instrument integer value for setting the current.

• dac_potential (AnalogComponent) –

  Gets an object with values to calculate the potential from the integer value received from the instrument.

• default_baudrate (int) –

  Gets the default baud rate.

• device_type (str) –

  The device type for this capabilities.

• eis_max_frequency (float) –

  Maximum frequency for EIS measurements in Hz.

• eis_min_frequency (float) –

  Minimum frequency for EIS measurements in Hz.

• firmware_build_date (str) –

  Build date of the firmware.

• firmware_commit (str) –

  Commit associated with the build of the firmware.

• firmware_release_type (Literal['Release', 'Beta', 'Debug']) –

  Get a string representation if the build is 'Release', 'Beta' or 'Debug'

• firmware_special_description (str) –

  Special description for the firmware

• firmware_version (float) –

  Firmware version of connected device.

• geis_max_frequency (int) –

  Gets the maximum GEIS frequency in Hz.

• hardware_revision (int) –

  Gets the hardware revision.

• has_bipot (bool) –

  True if bipot (WE2) capabilities are present

• is_galvanostat (bool) –

  True if the potentiastat can act as a galvanostat.

• is_hw_sync_master (bool) –

  Gets or sets a value indicating whether this instance is designated as the hardware synchronization master in MultiTrace.

• is_hw_sync_slave (bool) –

  Gets or sets a value indicating whether this instance is slave channel in a multichannel device.

• max_current (float) –

  Maximum current (* current range) that can be read/applied

• max_eis_amplitude_erms (float) –

  Gets the maximum E RMS amplitude for EIS.

• max_n_points (int) –

  Maximum amount of points within a measurement technique for this device.

• max_potential (float) –

  Maximum potential in V that can be read/applied.

• max_potential_bipot (float) –

  Maximum potential in V that can be read/applied with the bipot.

• max_v_aux (float) –

  Maximum potential output of the AUX port in V.

• min_current (float) –

  Minimum current (* current range) that can be read/applied.

• min_potential (float) –

  Minimum potential in V that can be read/applied

• min_potential_bipot (float) –

  Minimum potential that can be read/applied with the bipot

• min_potential_step (float) –

  Minimum potential step in mV that can be applied.

• model_name (str) –

  Name of the device.

• model_short_name (str) –

  Short name of the device.

• serial_number (str) –

  Serial number of the device.

• supported_applied_current_ranges (list[AllowedCurrentRanges]) –

  list of current ranges supported for applying current by this particular device.

• supported_bipot_current_ranges (list[AllowedCurrentRanges]) –

  list of current ranges for the BiPot module supported by this particular device.

• supported_current_ranges (list[AllowedCurrentRanges]) –

  list of current ranges supported by this particular device.

• supported_methods (list[AllowedMethods]) –

  List supported methods.

• supported_potential_ranges (list[AllowedPotentialRanges]) –

  list of potential ranges supported by this particular device.

• supports_impedance (bool) –

  Whether or not the device supports impedance measurements

• supports_ir_drop_compensation (bool) –

  Whether the device supports IR Drop compensation

acv_max_frequency: int

adc_auxiliary: AnalogComponent

adc_bipot: AnalogComponent

adc_current: AnalogComponent

adc_potential: AnalogComponent

connection: str

dac_auxiliary: AnalogComponent

dac_bipot: AnalogComponent

dac_current: AnalogComponent

dac_potential: AnalogComponent

default_baudrate: int

device_type: str

eis_max_frequency: float

eis_min_frequency: float

firmware_build_date: str

firmware_commit: str

firmware_release_type: Literal['Release', 'Beta', 'Debug']

firmware_special_description: str

firmware_version: float

geis_max_frequency: int

hardware_revision: int

has_bipot: bool

is_galvanostat: bool

is_hw_sync_master: bool

is_hw_sync_slave: bool

max_current: float

max_eis_amplitude_erms: float

max_n_points: int

max_potential: float

max_potential_bipot: float

max_v_aux: float

min_current: float

min_potential: float

min_potential_bipot: float

min_potential_step: float

model_name: str

model_short_name: str

serial_number: str

supported_applied_current_ranges: list[AllowedCurrentRanges]

supported_bipot_current_ranges: list[AllowedCurrentRanges]

supported_current_ranges: list[AllowedCurrentRanges]

supported_methods: list[AllowedMethods]

supported_potential_ranges: list[AllowedPotentialRanges]

supports_impedance: bool

supports_ir_drop_compensation: bool