pylab_ml.dmm.natinst.pxie40xx.PXIe40xx

class PXIe40xx(addr=None, identify=False, instName=None)[source]

Bases: NatInst

Interface to the Digital Multimeter (DMM) NI PXIe-40xx (e.q. 4081).

Date:: June 16, 2026
Author:: Semi-ATE <info@Semi-ATE.org>

todo:

| in work
| only base functions implemented
| for more properties or functios see:    https://nimi-python.readthedocs.io/en/master/nidmm.html
| call the misssing function with dmm.inst.functionname

The PXI-4081 can measure voltage and current precisely

__init__(addr=None, identify=False, instName=None)[source]

Initialise the instrument.

Parameters:

(string) (addr) – name from the PXI-Slot e.q. ‘PXI1Slot3’ or ‘SMU’.
(bool (identify) – Defaults to False.
optional) – Defaults to False.
(string (instName) – Instance Name from top.
optional) – Instance Name from top.

Example: Initialization

>>> dmm = PXIe41xx('PXI1Slot5',instName='dmm')   # connect and initialize instrument

Example: Current measurement

>>> i = dmm.current              # measure (supply) current

Example: Voltage measurement

>>> v = dmm.voltage              # measure voltage

Methods

`__init__`([addr, identify, instName])	Initialise the instrument.
`abort`()	Set state from Instrument to uncommitted.
`checkstate`(value)	Compare actual state with value and set it to value if compare false.
`clear`()	Clear error status.
`close`([force])	Close connection to instrument.
`close_session`()	Close the session (=inst).
`commit`()	Set state from Instrument to commit.
`createattributes`(dictionary[, parent, ...])	Create attributes or methods from a dictionary.
`disable`()	Set state from Instrument to uncommitted.
`error_list`()	List of outstanding errors.
`find_names`()	find_names() returns list of identifiers strings, lhs of = assignments
`help`()	Print the docstring of the instrument class.
`identify`([showInstName])	Identify message.
`init`([identify])	Optional init for interlock startup after identification.
`initiate`()	Set state from Instrument to running.
`local`()	Not possible, always remote control.
`measure`(nsamples)	Start to fetch data from the DMM.
`message`([message])	Device has no display, message display to logger.info.
`mfilter`(input)
`mqtt_add`(client, instrument[, liste, qos])	Add the instrument to mqtt.
`mqtt_disconnect`()	Remove the instrument from mqtt.
`plot_dmm_data`(time, voltage)	Plot graph between Time and Voltage.
`publish`(topic, value)	Publish topic as type='cmd' with payload=value.
`publish_get`(function_name, value)	Publish function_name as type='get' with paylad=value.
`publish_set`(function_name, value)	Publish function_name as type='set' with paylad=value.
`reopen_session`(channels)	Reopen last session with channels.
`reset`()	Reset, and set folowing attributes.
`self_cal`([force])	Perform self calibration if last self calibration is older than 1 day.
`setup_inst`()	Set setup instrument settings.

Attributes

`adc_calibration`	Get or set adc_calibration.
`aperture_time`	Specifiy the measurement aperture time for the channel configuration.
`aperture_time_units`	Specifiy the units of the aperture_time property for the channel configuration.
`auto_zero`	Get or set auto_zero.
`channel`	Set/get channel number if the instrument have more than one channel.
`command`
`current`	Get current.
`function`	Get or set measurement method.
`has_nidmm`
`id`	Get the id from the device.
`instName`	Return with instname or instname[ch] if it has channels.
`interchoices`
`measurecnt`	Set/get the number of measurement to be carried out in a loop.
`mqtt_enable`
`mqtt_list`
`mqtt_status`	Getter for the mqtt_status.
`read`	Get measurement from measurement method.
`runningmode`	Set/get runningmode.
`selftest`	Perform the device self-test routine and return pass, otherwise raise an exception.
`state`	Set/get state, only set state if necessary.
`voltage`	Get voltage.
`ATTR_ERROR`	if something wrong with your called methode, than set the result to self.ATTR_ERROR
`attrLast`	last set/get attribute name.
`attrLastvalue`	last set attribute value.

ATTR_ERROR: if something wrong with your called methode, than set the result to self.ATTR_ERROR

class Runningmode(value)

Bases: Enum

Possible Modes for state handling.

auto = 0: handle commit, uncommit, running automatically

man = 1: do it by yourselve

class State(value)

Bases: Enum

Possible states for the instrument.

actual state

send command

new state

Comment

uncommitted state

commit

committed state

uncommitted state

initiate

running state

committed state

modify any property

uncommitted state

laut Beschreibung, ist das wirklich so?? es wird normalerweise immer eine exception ausglöst

running state

abort

uncommitted state

running state

commit

running state

committed = 1: committed state

disabled = -1: reset instrument, output switched off

running = 2: running state

uncommitted = 0: uncommitted state

abort()

Set state from Instrument to uncommitted.

usually handle automatically, if runningmode==’auto’.

property adc_calibration

Get or set adc_calibration.

AUTO = The DMM enables or disables ADC calibration for you. OFF = The DMM does not compensate for changes to the gain. ON = The DMM measures an internal reference to calculate the correct gain for the measurement.

property aperture_time

Specifiy the measurement aperture time for the channel configuration.

Aperture time is specified in the units set by the aperture_time_units property see: http://nimi-python.readthedocs.io/en/master/nidmm/class.html#aperture-time

property aperture_time_units: Specifiy the units of the aperture_time property for the channel configuration.

SECONDS or POWER_LINE_CYCLES.

see: http://nimi-python.readthedocs.io/en/master/nidmm/class.html#aperture-time-units

attrLast: last set/get attribute name.

attrLastvalue: last set attribute value.

property auto_zero: Get or set auto_zero.

AUTO = The drivers chooses the AutoZero setting based on the configured method and resolution.

OFF = Disables AutoZero.

ON = The DMM internally disconnects the input signal following each measurement and takes a zero reading. It then subtracts the zero reading from the preceding reading.

ONCE = The DMM internally disconnects the input signal for the first measurement and takes a zero reading. It then subtracts the zero reading from the first reading and the following readings.

property channel

Set/get channel number if the instrument have more than one channel.

One can also use:

>>> vdd[0].voltage = 5           # set voltage from channel 0
>>> vdd[1].current = 0.1         # set current from channel 1
>>> v = vdd[1].voltage           # measure voltage from channel 1

checkstate(value)[source]

Compare actual state with value and set it to value if compare false.

Parameters:: value (str) – State to compare with actual state.
Return type:: None

clear(): Clear error status.

close(force=False): Close connection to instrument.

close_session(): Close the session (=inst).

commit()

Set state from Instrument to commit.

usually handle automatically, if runningmode==’auto’.

createattributes(dictionary, parent=None, child=None, childname='')

Create attributes or methods from a dictionary.

Syntax from the dictionary see example in the class documentation.

Parameters:

dictionary (dict) – The dictionary with the syntax: {attribute/methode name : (Device command for read/write) , range, call functions}.
parent (create_attributes, optional) – If you want to create a child, than you have to set the parent, otherwise None, by default None.
child (str, optional) – The name of the child, by default None.
childname (str, optional) – The name of the child, by default ‘’.

Return type:

None.

property current: Get current.

disable()

Set state from Instrument to uncommitted.

usually handle automtically, if runningmode==’auto’.

error_list(): List of outstanding errors.

find_names()

find_names() returns list of identifiers strings, lhs of = assignments

Returns:: obj_names – List of identifier strings
Return type:: list of str

property function

Get or set measurement method.

DC_VOLTS =    DC Voltage
AC_VOLTS =    AC Voltage
DC_CURRENT =  DC Current
AC_CURRENT =  AC Current
TWO_WIRE_RES  = 2-Wire Resistance
FOUR_WIRE_RES = 4-Wire Resistance
FREQ = Frequency
PERIOD = Period
TEMPERATURE = tempearture,  NI 4065, NI 4070/4071/4072, and NI 4080/4081/4182 supported.
AC_VOLTS_DC_COUPLED = AC Voltage with DC Coupling
DIODE = Diode
WAVEFORM_VOLTAGE = Waveform voltage
WAVEFORM_CURRENT = Waveform current
CAPACITANCE = Capacitance
INDUCTANCE =    Inductance

see https://nimi-python.readthedocs.io/en/master/nidmm/class.html#function

help(): Print the docstring of the instrument class.

property id: Get the id from the device.

identify(showInstName=False): Identify message.

init(identify=False): Optional init for interlock startup after identification.

initiate()

Set state from Instrument to running.

usually handle automatically, if runningmode==’auto’.

property instName: Return with instname or instname[ch] if it has channels.

json = <module 'json' from '/home/runner/miniconda3/envs/test/lib/python3.9/json/__init__.py'>

local(): Not possible, always remote control.

measure(nsamples)[source]

Start to fetch data from the DMM.

Parameters:

nsamples (int) – Number of Data-points to fetch.

Returns:

time (list) – Contains list of Time values.
voltage (list) – Contains list of Voltage values.

property measurecnt

Set/get the number of measurement to be carried out in a loop.

TODO: this function is not running yet, it is only a dummy

if the result == None than this function not implemented. The return value for the measurement is calculated togetheer with the mfilter setting.

message(message=None): Device has no display, message display to logger.info.

mqtt_add(client, instrument, liste='#', qos=0)

Add the instrument to mqtt. Calling from base_instrument, after the instrument (device) has been create. Normally you have not to use this function, only base_instrument use it.

Parameters:

client (mqtt_init) – The MQTT client instance to which the instrument should be added.
instrument (object) – The instrument to be added to the MQTT client.
liste (list or str) – A list of attributes for which MQTT messages should be sent. If set to “#”, all attributes will be included (default: “#”).
qos (int) – The Quality of Service level for MQTT messages (default: 0).

Return type:

None

mqtt_disconnect(): Remove the instrument from mqtt. Calling from base_instrument, if the instrument are closing. Normally you have not to use this function, only base_instrument use it.

property mqtt_status: Getter for the mqtt_status.

plot_dmm_data(time, voltage)[source]

Plot graph between Time and Voltage.

Parameters:

time (list) – Input a list of Time values for x-axis.
voltage (list) – Input a list of Voltage values for y-axis.

Return type:

None

publish(topic, value)

Publish topic as type=’cmd’ with payload=value.

Parameters:

topic (str) – The name of the topic to publish.
value (any) – The value to be published.

Return type:

None

publish_get(function_name, value)

Publish function_name as type=’get’ with paylad=value.

Parameters:

function_name (str) – The name of the function to be published as a ‘get’ command.
value (any) – The value to be published as the payload of the ‘get’ command.

Return type:

None

publish_set(function_name, value)

Publish function_name as type=’set’ with paylad=value.

Parameters:

function_name (str) – The name of the function to be published as a ‘set’ command.
value (any) – The value to be published as the payload of the ‘set’ command.

Return type:

None

property read: Get measurement from measurement method.

reopen_session(channels): Reopen last session with channels.

reset()[source]

Reset, and set folowing attributes.

power_line_frequency = 50.0
aperture_time_units = POWER_LINE_CYCLES
aperture_time = 2
inst.auto_zero = OFF
dc_noise_rejection = SECOND_ORDER

property runningmode: Set/get runningmode.

self_cal(force=True)

Perform self calibration if last self calibration is older than 1 day.

Parameters:

force (TYPE, optional) – if force==True -> perform self calibration independent from last calibration. The default is True.

Returns:

None.
gives information about the calibration

property selftest

Perform the device self-test routine and return pass, otherwise raise an exception.

After selftest the device is in reset state.

Returns:: result – state from selftest.
Return type:: bool

setup_inst()[source]: Set setup instrument settings.

property state

Set/get state, only set state if necessary.

Parameters:

newstate: str or State
state to be set, must be in self.State list.

Returns:

state: State
current state of the instrument.

property voltage: Get voltage.