Skip to content

Types

For type checking, PyPalmSens uses Literal strings to define the allowed settings, such as supported current and potential ranges.

pypalmsens.types

Define types and string literals.

Attributes:

AllowedArrayTypes module-attribute 

AllowedArrayTypes = Literal['None', 'Time', 'Potential', 'Current', 'Charge', 'ExtraValue', 'Frequency', 'Phase', 'ZRe', 'ZIm', 'Iac', 'Z', 'Y', 'YRe', 'YIm', 'Cs', 'CsRe', 'CsIm', 'Index', 'Admittance', 'Concentration', 'Signal', 'Func', 'Integral', 'AuxInput', 'BipotCurrent', 'BipotPotential', 'ReverseCurrent', 'CEPotential', 'DCCurrent', 'ForwardCurrent', 'PotentialExtraRE', 'CurrentExtraWE', 'InverseDerative_dtdE', 'mEdc', 'Eac', 'MeasuredStepStartIndex', 'miDC', 'SE2vsXPotential', 'nPointsAC', 'realtintac', 'ymean', 'debugtext', 'Generic']

Possible array types.

AllowedCurrentRanges module-attribute 

AllowedCurrentRanges = Literal['100pA', '1nA', '10nA', '100nA', '1uA', '10uA', '100uA', '1mA', '10mA', '100mA', '2uA', '4uA', '8uA', '16uA', '32uA', '63uA', '125uA', '250uA', '500uA', '5mA', '6uA', '13uA', '25uA', '50uA', '200uA', '1A']

Possible current ranges.

See the device documentation or query the instrument manager for supported current ranges.

AllowedDeviceState module-attribute 

AllowedDeviceState = Literal['Unknown', 'Idle', 'Measurement', 'Download', 'Pretreatment', 'Error', 'MeasOCP']

Possible values for the device state.

AllowedMethods module-attribute 

AllowedMethods = Literal['acv', 'ad', 'cp', 'cpot', 'cv', 'dpv', 'eis', 'eis_it', 'fam', 'fcv', 'fgis', 'fis', 'geis_it', 'gis', 'gs', 'lp', 'lsp', 'lsv', 'ma', 'mm', 'mp', 'mpad', 'ms', 'npv', 'pad', 'pot', 'ps', 'scp', 'swv']

All available method IDs.

See the device documentation or query the instrument manager for supported methods.

AllowedPotentialRanges module-attribute 

AllowedPotentialRanges = Literal['1mV', '10mV', '20mV', '50mV', '100mV', '200mV', '500mV', '1V']

Possible potential ranges.

See the device documentation or query the instrument manager for supported potential ranges.

AllowedReadingStatus module-attribute 

AllowedReadingStatus = Literal['OK', 'Overload', 'Underload', 'OverloadWarning']

Possible values for current or potential readings.

AllowedTimingStatus module-attribute 

AllowedTimingStatus = Literal['Unknown', 'OK', 'OverStep']

Possible values for measurement timing status.