Settings

Set the autoranging current.

Attributes:

• max (AllowedCurrentRanges) –

  Maximum current range.

• min (AllowedCurrentRanges) –

  Minimum current range.

• start (AllowedCurrentRanges) –

  Start current range.

max: AllowedCurrentRanges = '10mA'

min: AllowedCurrentRanges = '1uA'

start: AllowedCurrentRanges = '100uA'

Set the autoranging potential.

Attributes:

• max (AllowedPotentialRanges) –

  Maximum potential range.

• min (AllowedPotentialRanges) –

  Minimum potential range.

• start (AllowedPotentialRanges) –

  Start potential range.

max: AllowedPotentialRanges = '1V'

min: AllowedPotentialRanges = '1mV'

start: AllowedPotentialRanges = '1V'

Set the measurement pretreatment settings.

Attributes:

• deposition_potential (float) –

  Deposition potential in V.

• deposition_time (float) –

  Deposition time in s.

• conditioning_potential (float) –

  Conditioning potential in V.

• conditioning_time (float) –

  Conditioning time in s.

deposition_potential: float = 0.0

deposition_time: float = 0.0

conditioning_potential: float = 0.0

conditioning_time: float = 0.0

Set the versus OCP settings.

Attributes:

• mode (int) –

  Set versus OCP mode.

• max_ocp_time (float) –

  Maximum OCP time in s.

• stability_criterion (float) –

  Stability criterion (potential/time) in mV/s.

mode: int = 0

max_ocp_time: float = 20.0

stability_criterion: float = 0.0

Set the bipot settings.

Attributes:

• mode (Literal['constant', 'offset']) –

  Set the bipotential mode.

• potential (float) –

  Set the bipotential in V.

• current_range (AllowedCurrentRanges | BiPotCurrentRange) –

  Set the bipotential current range.

mode: Literal['constant', 'offset'] = 'constant'

potential: float = 0.0

current_range: AllowedCurrentRanges | BiPotCurrentRange = '1uA'

Create a multi-step amperometry level method object.

Methods:

• from_psobj –

  Construct ELevel dataclass from PalmSens.Techniques.ELevel object.

Attributes:

• level (float) –

  Level in V.

• duration (float) –

  Duration in s.

• record (bool) –

  Record the current.

• limit_current_max (float | None) –

  Limit current max in µA. Set to None to disable.

• limit_current_min (float | None) –

  Limit current min in µA. Set to None to disable.

• trigger_lines (Sequence[Literal[0, 1, 2, 3]]) –

  Trigger at level lines.

• use_limits (bool) –

  Return True if instance sets current limits.

level: float = 0.0

duration: float = 1.0

record: bool = True

limit_current_max: float | None = None

limit_current_min: float | None = None

trigger_lines: Sequence[Literal[0, 1, 2, 3]] = field(default_factory=list)

use_limits: bool

from_psobj(psobj: ELevel)

250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268

@classmethod
def from_psobj(cls, psobj: PalmSens.Techniques.ELevel):
    """Construct ELevel dataclass from PalmSens.Techniques.ELevel object."""
    trigger_lines: list[Literal[0, 1, 2, 3]] = []

    if psobj.UseTriggerOnStart:
        trigger_bools = convert_int_to_bools(psobj.TriggerValueOnStart)
        for i in (0, 1, 2, 3):
            if trigger_bools[i]:
                trigger_lines.append(i)

    return cls(
        level=single_to_double(psobj.Level),
        duration=single_to_double(psobj.Duration),
        record=psobj.Record,
        limit_current_max=single_to_double(psobj.MaxLimit) if psobj.MaxLimit else None,
        limit_current_min=single_to_double(psobj.MinLimit) if psobj.MinLimit else None,
        trigger_lines=trigger_lines,
    )

Create a multi-step potentiometry level method object.

Methods:

• from_psobj –

  Construct ILevel dataclass from PalmSens.Techniques.ELevel object.

Attributes:

• level (float) –

  Level in I.

• duration (float) –

  Duration in s.

• record (bool) –

  Record the potential.

• limit_potential_max (float | None) –

  Limit potential max in V. Set to None to disable.

• limit_potential_min (float | None) –

  Limit potential min in V. Set to None to disable.

• trigger_lines (Sequence[Literal[0, 1, 2, 3]]) –

  Trigger at level lines.

• use_limits (bool) –

  Return True if instance sets current limits.

level: float = 0.0

duration: float = 1.0

record: bool = True

limit_potential_max: float | None = None

limit_potential_min: float | None = None

trigger_lines: Sequence[Literal[0, 1, 2, 3]] = field(default_factory=list)

use_limits: bool

from_psobj(psobj: ELevel)

326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344

@classmethod
def from_psobj(cls, psobj: PalmSens.Techniques.ELevel):
    """Construct ILevel dataclass from PalmSens.Techniques.ELevel object."""
    trigger_lines: list[Literal[0, 1, 2, 3]] = []

    if psobj.UseTriggerOnStart:
        trigger_bools = convert_int_to_bools(psobj.TriggerValueOnStart)
        for i in (0, 1, 2, 3):
            if trigger_bools[i]:
                trigger_lines.append(i)

    return cls(
        level=single_to_double(psobj.Level),
        duration=single_to_double(psobj.Duration),
        record=psobj.Record,
        limit_potential_max=single_to_double(psobj.MaxLimit) if psobj.MaxLimit else None,
        limit_potential_min=single_to_double(psobj.MinLimit) if psobj.MinLimit else None,
        trigger_lines=trigger_lines,
    )

Set the post measurement settings.

Attributes:

• cell_on_after_measurement (bool) –

  Enable/disable cell after measurement.

• standby_potential (float) –

  Standby potential (V) for use with cell on after measurement.

• standby_time (float) –

  Standby time (s) for use with cell on after measurement.

cell_on_after_measurement: bool = False

standby_potential: float = 0.0

standby_time: float = 0.0

Set the limit settings.

Depending on the method, this will: - Abort the measurement - Reverse the scan instead (CV) - Proceed to the next stage (Mixed Mode)

Attributes:

• max (None | float) –

  Set limit current max in µA.

• min (None | float) –

  Set limit current min in µA.

max: None | float = None

min: None | float = None

Set the limit settings.

Depending on the method, this will: - Abort the measurement - Proceed to the next stage (Mixed Mode)

Attributes:

• max (None | float) –

  Set limit potential max in V.

• min (None | float) –

  Set limit potential min in V.

max: None | float = None

min: None | float = None

Set the charge limit settings.

Attributes:

• max (None | float) –

  Set limit charge max in µC.

• min (None | float) –

  Set limit charge min in µC.

max: None | float = None

min: None | float = None

Set the iR drop compensation settings.

Attributes:

• resistance (None | float) –

  Set the iR compensation resistance in Ω

resistance: None | float = None

Set the equilibration triggers.

Set one or more digital outputs on the AUX port at the start of equilibration.

The selected digital line(s) will be set to high when triggered and remain high until the end of the equilibration.

See the instrument-specific documentation for more information about the position of the digital pins on your instrument’s auxiliary port.

Methods:

• clear –

  Clear triggers.

Attributes:

• d0 (bool) –

  If True, enable trigger at d0 high.

• d1 (bool) –

  If True, enable trigger at d1 high.

• d2 (bool) –

  If True, enable trigger at d2 high.

• d3 (bool) –

  If True, enable trigger at d3 high.

d0: bool = False

d1: bool = False

d2: bool = False

d3: bool = False

clear()

444
445
446
447
448
449

def clear(self):
    """Clear triggers."""
    self.d0 = False
    self.d1 = False
    self.d2 = False
    self.d3 = False

Set the measurement triggers.

Set one or more digital outputs on the AUX port at the start measurement (end of equilibration).

The selected digital line(s) will be set to high when triggered and remain high until the end of the measurement.

See the instrument-specific documentation for more information about the position of the digital pins on your instrument’s auxiliary port.

Methods:

• clear –

  Clear triggers.

Attributes:

• d0 (bool) –

  If True, enable trigger at d0 high.

• d1 (bool) –

  If True, enable trigger at d1 high.

• d2 (bool) –

  If True, enable trigger at d2 high.

• d3 (bool) –

  If True, enable trigger at d3 high.

d0: bool = False

d1: bool = False

d2: bool = False

d3: bool = False

clear()

497
498
499
500
501
502

def clear(self):
    """Clear triggers."""
    self.d0 = False
    self.d1 = False
    self.d2 = False
    self.d3 = False

Set the multiplexer settings.

Attributes:

• mode (Literal['none', 'consecutive', 'alternate']) –

  Set multiplexer mode.

• channels (list[int]) –

  Set multiplexer channels

• connect_sense_to_working_electrode (bool) –

  Connect the sense electrode to the working electrode. Default is False.

• combine_reference_and_counter_electrodes (bool) –

  Combine the reference and counter electrodes. Default is False.

• use_channel_1_reference_and_counter_electrodes (bool) –

  Use channel 1 reference and counter electrodes for all working electrodes. Default is False.

• set_unselected_channel_working_electrode (int) –

  Set the unselected channel working electrode to 0 = Disconnected / floating, 1 = Ground, 2 = Standby potential. Default is 0.

mode: Literal['none', 'consecutive', 'alternate'] = 'none'

channels: list[int] = Field(default_factory=list)

connect_sense_to_working_electrode: bool = False

combine_reference_and_counter_electrodes: bool = False

use_channel_1_reference_and_counter_electrodes: bool = False

set_unselected_channel_working_electrode: int = 0

Set the data processing settings.

Attributes:

• smooth_level (int) –

  Set the default curve post processing filter.

• min_height (float) –

  Determines the minimum peak height in µA for peak finding.

• min_width (float) –

  The minimum peak width for peak finding.

smooth_level: int = 0

min_height: float = 0.0

min_width: float = 0.1

Sets general/other settings.

Attributes:

• save_on_internal_storage (bool) –

  Save on internal storage.

• use_hardware_sync (bool) –

  Use hardware synchronization with other channels/instruments.

• notes (str) –

  Add some user notes for use with this technique.

• power_frequency (Literal[50, 60]) –

  Set the DC mains filter in Hz.

save_on_internal_storage: bool = False

use_hardware_sync: bool = False

notes: str = ''

power_frequency: Literal[50, 60] = 50