[python source code]

dmm

The dmm commands module.

These commands are used in the following models: SS3706A

THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.

Please report an issue if one is found.

Attributes and Functions 
- dmm.adjustment.count
- dmm.aperture
- dmm.appendbuffer()
- dmm.autorange
- dmm.autozero
- dmm.buffer.info()
- dmm.buffer.maxcapacity
- dmm.buffer.usedcapacity
- dmm.calibration.ac()
- dmm.calibration.dc()
- dmm.calibration.lock()
- dmm.calibration.password
- dmm.calibration.save()
- dmm.calibration.unlock()
- dmm.close()
- dmm.configure.delete()
- dmm.configure.query()
- dmm.configure.recall()
- dmm.configure.set()
- dmm.connect
- dmm.dbreference
- dmm.detectorbandwidth
- dmm.displaydigits
- dmm.drycircuit
- dmm.filter.count
- dmm.filter.enable
- dmm.filter.type
- dmm.filter.window
- dmm.fourrtd
- dmm.func
- dmm.getconfig()
- dmm.inputdivider
- dmm.limit[Y].autoclear
- dmm.limit[Y].clear()
- dmm.limit[Y].enable
- dmm.limit[Y].high.fail
- dmm.limit[Y].high.value
- dmm.limit[Y].low.fail
- dmm.limit[Y].low.value
- dmm.linesync
- dmm.makebuffer()
- dmm.math.enable
- dmm.math.format
- dmm.math.mxb.bfactor
- dmm.math.mxb.mfactor
- dmm.math.mxb.units
- dmm.math.percent
- dmm.measure()
- dmm.measurecount
- dmm.measurewithptp()
- dmm.measurewithtime()
- dmm.nplc
- dmm.offsetcompensation
- dmm.open()
- dmm.opendetector
- dmm.range
- dmm.refjunction
- dmm.rel.acquire()
- dmm.rel.enable
- dmm.rel.level
- dmm.reset()
- dmm.rtdalpha
- dmm.rtdbeta
- dmm.rtddelta
- dmm.rtdzero
- dmm.savebuffer()
- dmm.setconfig()
- dmm.simreftemperature
- dmm.thermocouple
- dmm.threertd
- dmm.threshold
- dmm.transducer

Dmm

Bases: BaseTSPCmd

The dmm command tree.

Properties and methods
  • .adjustment: The dmm.adjustment command tree.
  • .aperture: The dmm.aperture attribute.
  • .appendbuffer(): The dmm.appendbuffer() function.
  • .autorange: The dmm.autorange attribute.
  • .autozero: The dmm.autozero attribute.
  • .buffer: The dmm.buffer command tree.
  • .calibration: The dmm.calibration command tree.
  • .close(): The dmm.close() function.
  • .configure: The dmm.configure command tree.
  • .connect: The dmm.connect attribute.
  • .dbreference: The dmm.dbreference attribute.
  • .detectorbandwidth: The dmm.detectorbandwidth attribute.
  • .displaydigits: The dmm.displaydigits attribute.
  • .drycircuit: The dmm.drycircuit attribute.
  • .filter: The dmm.filter command tree.
  • .fourrtd: The dmm.fourrtd attribute.
  • .func: The dmm.func attribute.
  • .getconfig(): The dmm.getconfig() function.
  • .inputdivider: The dmm.inputdivider attribute.
  • .limit: The dmm.limit[Y] command tree.
  • .linesync: The dmm.linesync attribute.
  • .makebuffer(): The dmm.makebuffer() function.
  • .math: The dmm.math command tree.
  • .measure(): The dmm.measure() function.
  • .measurecount: The dmm.measurecount attribute.
  • .measurewithptp(): The dmm.measurewithptp() function.
  • .measurewithtime(): The dmm.measurewithtime() function.
  • .nplc: The dmm.nplc attribute.
  • .offsetcompensation: The dmm.offsetcompensation attribute.
  • .open(): The dmm.open() function.
  • .opendetector: The dmm.opendetector attribute.
  • .range: The dmm.range attribute.
  • .refjunction: The dmm.refjunction attribute.
  • .rel: The dmm.rel command tree.
  • .reset(): The dmm.reset() function.
  • .rtdalpha: The dmm.rtdalpha attribute.
  • .rtdbeta: The dmm.rtdbeta attribute.
  • .rtddelta: The dmm.rtddelta attribute.
  • .rtdzero: The dmm.rtdzero attribute.
  • .savebuffer(): The dmm.savebuffer() function.
  • .setconfig(): The dmm.setconfig() function.
  • .simreftemperature: The dmm.simreftemperature attribute.
  • .thermocouple: The dmm.thermocouple attribute.
  • .threertd: The dmm.threertd attribute.
  • .threshold: The dmm.threshold attribute.
  • .transducer: The dmm.transducer attribute.

adjustment property 

adjustment: DmmAdjustment

Return the dmm.adjustment command tree.

Sub-properties and sub-methods
  • .count: The dmm.adjustment.count attribute.

aperture property writable 

aperture: str

Access the dmm.aperture attribute.

Description
  • This attribute determines the aperture setting for the selected function.
Usage
  • Accessing this property will send the print(dmm.aperture) query.
  • Setting this property to a value will send the dmm.aperture = value command.
TSP Syntax 
- dmm.aperture = value
- print(dmm.aperture)
Raises:

autorange property writable 

autorange: str

Access the dmm.autorange attribute.

Description
  • This attribute specifies the autorange setting for the active function
Usage
  • Accessing this property will send the print(dmm.autorange) query.
  • Setting this property to a value will send the dmm.autorange = value command.
TSP Syntax 
- dmm.autorange = value
- print(dmm.autorange)
Raises:

autozero property writable 

autozero: str

Access the dmm.autozero attribute.

Description
  • This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument
Usage
  • Accessing this property will send the print(dmm.autozero) query.
  • Setting this property to a value will send the dmm.autozero = value command.
TSP Syntax 
- dmm.autozero = value
- print(dmm.autozero)
Raises:

buffer property 

buffer: DmmBuffer

Return the dmm.buffer command tree.

Sub-properties and sub-methods
  • .info(): The dmm.buffer.info() function.
  • .maxcapacity: The dmm.buffer.maxcapacity attribute.
  • .usedcapacity: The dmm.buffer.usedcapacity attribute.

calibration property 

calibration: DmmCalibration

Return the dmm.calibration command tree.

Sub-properties and sub-methods
  • .ac(): The dmm.calibration.ac() function.
  • .dc(): The dmm.calibration.dc() function.
  • .lock(): The dmm.calibration.lock() function.
  • .password: The dmm.calibration.password attribute.
  • .save(): The dmm.calibration.save() function.
  • .unlock(): The dmm.calibration.unlock() function.

configure property 

configure: DmmConfigure

Return the dmm.configure command tree.

Sub-properties and sub-methods
  • .delete(): The dmm.configure.delete() function.
  • .query(): The dmm.configure.query() function.
  • .recall(): The dmm.configure.recall() function.
  • .set(): The dmm.configure.set() function.

connect property writable 

connect: str

Access the dmm.connect attribute.

Description
  • This attribute indicates how the DMM relays should be connected to the analog backplane.
Usage
  • Accessing this property will send the print(dmm.connect) query.
  • Setting this property to a value will send the dmm.connect = value command.
TSP Syntax 
- dmm.connect = value
- print(dmm.connect)
Raises:

dbreference property writable 

dbreference: str

Access the dmm.dbreference attribute.

Description
  • This attribute defines the decibel (dB) reference setting for the DMM in volts.
Usage
  • Accessing this property will send the print(dmm.dbreference) query.
  • Setting this property to a value will send the dmm.dbreference = value command.
TSP Syntax 
- dmm.dbreference = value
- print(dmm.dbreference)
Raises:

detectorbandwidth property writable 

detectorbandwidth: str

Access the dmm.detectorbandwidth attribute.

Description
  • This attribute sets the AC detector bandwidth setting for the DMM in Hertz.
Usage
  • Accessing this property will send the print(dmm.detectorbandwidth) query.
  • Setting this property to a value will send the dmm.detectorbandwidth = value command.
TSP Syntax 
- dmm.detectorbandwidth = value
- print(dmm.detectorbandwidth)
Raises:

displaydigits property writable 

displaydigits: str

Access the dmm.displaydigits attribute.

Description
  • This attribute determines the number of digits that are displayed for measurements on the front panel.
Usage
  • Accessing this property will send the print(dmm.displaydigits) query.
  • Setting this property to a value will send the dmm.displaydigits = value command.
TSP Syntax 
- dmm.displaydigits = value
- print(dmm.displaydigits)
Raises:

drycircuit property writable 

drycircuit: str

Access the dmm.drycircuit attribute.

Description
  • This attribute enables or disables the dry circuit feature of the 4-wire resistance measure function.
Usage
  • Accessing this property will send the print(dmm.drycircuit) query.
  • Setting this property to a value will send the dmm.drycircuit = value command.
TSP Syntax 
- dmm.drycircuit = value
- print(dmm.drycircuit)
Raises:

filter property 

filter: DmmFilter

Return the dmm.filter command tree.

Sub-properties and sub-methods
  • .count: The dmm.filter.count attribute.
  • .enable: The dmm.filter.enable attribute.
  • .type: The dmm.filter.type attribute.
  • .window: The dmm.filter.window attribute.

fourrtd property writable 

fourrtd: str

Access the dmm.fourrtd attribute.

Description
  • This attribute sets the type of 4-wire RTD that is being used.
Usage
  • Accessing this property will send the print(dmm.fourrtd) query.
  • Setting this property to a value will send the dmm.fourrtd = value command.
TSP Syntax 
- dmm.fourrtd = value
- print(dmm.fourrtd)
Raises:

func property writable 

func: str

Access the dmm.func attribute.

Description
  • This attribute selects the active measure function.
Usage
  • Accessing this property will send the print(dmm.func) query.
  • Setting this property to a value will send the dmm.func = value command.
TSP Syntax 
- dmm.func = value
- print(dmm.func)
Raises:

inputdivider property writable 

inputdivider: str

Access the dmm.inputdivider attribute.

Description
  • This attribute determines when the 10 MΩ input divider is enabled.
Usage
  • Accessing this property will send the print(dmm.inputdivider) query.
  • Setting this property to a value will send the dmm.inputdivider = value command.
TSP Syntax 
- dmm.inputdivider = value
- print(dmm.inputdivider)
Raises:

limit property 

limit: dict[int, DmmLimitItem]

Return the dmm.limit[Y] command tree.

Info
  • Y, the limit number: 1 or 2.
Sub-properties and sub-methods
  • .autoclear: The dmm.limit[Y].autoclear attribute.
  • .clear(): The dmm.limit[Y].clear() function.
  • .enable: The dmm.limit[Y].enable attribute.
  • .high: The dmm.limit[Y].high command tree.
  • .low: The dmm.limit[Y].low command tree.

linesync property writable 

linesync: str

Access the dmm.linesync attribute.

Description
  • This attribute determines if line synchronization is used during the measurement.
Usage
  • Accessing this property will send the print(dmm.linesync) query.
  • Setting this property to a value will send the dmm.linesync = value command.
TSP Syntax 
- dmm.linesync = value
- print(dmm.linesync)
Raises:

math property 

math: DmmMath

Return the dmm.math command tree.

Sub-properties and sub-methods
  • .enable: The dmm.math.enable attribute.
  • .format: The dmm.math.format attribute.
  • .mxb: The dmm.math.mxb command tree.
  • .percent: The dmm.math.percent attribute.

measurecount property writable 

measurecount: str

Access the dmm.measurecount attribute.

Description
  • This attribute sets the number of measurements to take when a measurement is requested by a DMM measure command.
Usage
  • Accessing this property will send the print(dmm.measurecount) query.
  • Setting this property to a value will send the dmm.measurecount = value command.
TSP Syntax 
- dmm.measurecount = value
- print(dmm.measurecount)
Info
  • count, the number of measurements to take when a DMM measure function is used (maximum 450,000).
Raises:

nplc property writable 

nplc: str

Access the dmm.nplc attribute.

Description
  • This attribute sets the integration rate in line cycles for the DMM for the function selected by dmm.func.
Usage
  • Accessing this property will send the print(dmm.nplc) query.
  • Setting this property to a value will send the dmm.nplc = value command.
TSP Syntax 
- dmm.nplc = value
- print(dmm.nplc)
Raises:

offsetcompensation property writable 

offsetcompensation: str

Access the dmm.offsetcompensation attribute.

Description
  • This attribute specifies the offset compensation setting for the DMM for the function selected by dmm.func.
Usage
  • Accessing this property will send the print(dmm.offsetcompensation) query.
  • Setting this property to a value will send the dmm.offsetcompensation = value command.
TSP Syntax 
- dmm.offsetcompensation = value
- print(dmm.offsetcompensation)
Raises:

opendetector property writable 

opendetector: str

Access the dmm.opendetector attribute.

Description
  • This attributes determines if the detection of open leads is enabled or disabled.
Usage
  • Accessing this property will send the print(dmm.opendetector) query.
  • Setting this property to a value will send the dmm.opendetector = value command.
TSP Syntax 
- dmm.opendetector = value
- print(dmm.opendetector)
Raises:

range property writable 

range: str

Access the dmm.range attribute.

Description
  • Indicates the range of DMM for the selected function.
Usage
  • Accessing this property will send the print(dmm.range) query.
  • Setting this property to a value will send the dmm.range = value command.
TSP Syntax 
- dmm.range = value
- print(dmm.range)
Raises:

refjunction property writable 

refjunction: str

Access the dmm.refjunction attribute.

Description
  • This attribute defines the type of the thermocouple reference junction.
Usage
  • Accessing this property will send the print(dmm.refjunction) query.
  • Setting this property to a value will send the dmm.refjunction = value command.
TSP Syntax 
- dmm.refjunction = value
- print(dmm.refjunction)
Raises:

rel property 

rel: DmmRel

Return the dmm.rel command tree.

Sub-properties and sub-methods
  • .acquire(): The dmm.rel.acquire() function.
  • .enable: The dmm.rel.enable attribute.
  • .level: The dmm.rel.level attribute.

rtdalpha property writable 

rtdalpha: str

Access the dmm.rtdalpha attribute.

Description
  • This attribute contains the alpha value of a user-defined RTD.
Usage
  • Accessing this property will send the print(dmm.rtdalpha) query.
  • Setting this property to a value will send the dmm.rtdalpha = value command.
TSP Syntax 
- dmm.rtdalpha = value
- print(dmm.rtdalpha)
Raises:

rtdbeta property writable 

rtdbeta: str

Access the dmm.rtdbeta attribute.

Description
  • This attribute contains the beta value of a user-defined RTD.
Usage
  • Accessing this property will send the print(dmm.rtdbeta) query.
  • Setting this property to a value will send the dmm.rtdbeta = value command.
TSP Syntax 
- dmm.rtdbeta = value
- print(dmm.rtdbeta)
Raises:

rtddelta property writable 

rtddelta: str

Access the dmm.rtddelta attribute.

Description
  • This attribute contains the delta value of a user-defined RTD.
Usage
  • Accessing this property will send the print(dmm.rtddelta) query.
  • Setting this property to a value will send the dmm.rtddelta = value command.
TSP Syntax 
- dmm.rtddelta = value
- print(dmm.rtddelta)
Raises:

rtdzero property writable 

rtdzero: str

Access the dmm.rtdzero attribute.

Description
  • This attribute contains the zero value of a user-defined RTD.
Usage
  • Accessing this property will send the print(dmm.rtdzero) query.
  • Setting this property to a value will send the dmm.rtdzero = value command.
TSP Syntax 
- dmm.rtdzero = value
- print(dmm.rtdzero)
Raises:

simreftemperature property writable 

simreftemperature: str

Access the dmm.simreftemperature attribute.

Description
  • This attribute sets the simulated reference temperature of the thermocouple reference junction.
Usage
  • Accessing this property will send the print(dmm.simreftemperature) query.
  • Setting this property to a value will send the dmm.simreftemperature = value command.
TSP Syntax 
- dmm.simreftemperature = value
- print(dmm.simreftemperature)
Raises:

thermocouple property writable 

thermocouple: str

Access the dmm.thermocouple attribute.

Description
  • This attribute indicates the thermocouple type.
Usage
  • Accessing this property will send the print(dmm.thermocouple) query.
  • Setting this property to a value will send the dmm.thermocouple = value command.
TSP Syntax 
- dmm.thermocouple = value
- print(dmm.thermocouple)
Raises:

threertd property writable 

threertd: str

Access the dmm.threertd attribute.

Description
  • This attribute defines the type of three-wire RTD that is being used.
Usage
  • Accessing this property will send the print(dmm.threertd) query.
  • Setting this property to a value will send the dmm.threertd = value command.
TSP Syntax 
- dmm.threertd = value
- print(dmm.threertd)
Raises:

threshold property writable 

threshold: str

Access the dmm.threshold attribute.

Description
  • This attribute determines the signal level where the instrument makes frequency or period measurements.
Usage
  • Accessing this property will send the print(dmm.threshold) query.
  • Setting this property to a value will send the dmm.threshold = value command.
TSP Syntax 
- dmm.threshold = value
- print(dmm.threshold)
Raises:

transducer property writable 

transducer: str

Access the dmm.transducer attribute.

Description
  • This attribute contains the transducer type.
Usage
  • Accessing this property will send the print(dmm.transducer) query.
  • Setting this property to a value will send the dmm.transducer = value command.
TSP Syntax 
- dmm.transducer = value
- print(dmm.transducer)
Raises:

appendbuffer 

appendbuffer(buffer_var: str, file_name: str, time_format: str | None = None) -> None

Run the dmm.appendbuffer() function.

Description
  • This function appends data from the reading buffer to a file on the USB flash drive. If no file exists, this function creates a file.
TSP Syntax 
- dmm.appendbuffer()
Parameters:
  • buffer_var (str) –

    A string with the name of a DMM reading buffer from which you want to append data to the specified file.

  • file_name (str) –

    A string with the file name of the file on the USB flash drive to which reading buffer data will be appended.

  • time_format (optional, default: None ) –

    How the date and time information should be saved. The values for timeFormat are.
Raises:

close 

close(channel_list: str) -> None

Run the dmm.close() function.

Description
  • This function closes the specified channel or channel pattern to prepare for a measurement.
TSP Syntax 
- dmm.close()
Parameters:
  • channel_list (str) –

    A string that lists the channel or channel pattern to close.
Raises:

getconfig 

getconfig(channel_list: str) -> str

Run the dmm.getconfig() function.

Description
  • This function queries for the DMM configurations that are associated with the specified channels or channel patterns.
TSP Syntax 
- dmm.getconfig()
Parameters:
  • channel_list (str) –

    The channels or channel patterns to query.
Returns:
  • str –

    The result of the function call.
Raises:

makebuffer 

makebuffer(buffer_size: str, *, buffer_name: str | None = None) -> Buffervar

Run the dmm.makebuffer() function.

Description
  • This function creates a user buffer for storing readings. Reading buffers are allocated dynamically.
TSP Syntax 
- dmm.makebuffer()
Parameters:
  • buffer_size (str) –

    Maximum number of readings that the buffer can store.

  • buffer_name (optional, default: None ) –

    The name of the buffer variable to create. If not provided, an auto-generated variable will be used.
Returns:
Raises:

measure 

measure(buffer_var: str | None = None) -> str

Run the dmm.measure() function.

Description
  • This function returns the last reading of the measurement process without using the trigger model.
TSP Syntax 
- dmm.measure()
Parameters:
  • buffer_var (optional, default: None ) –

    A previously created reading buffer where all readings are stored.
Returns:
  • str –

    The result of the function call.
Raises:

measurewithptp 

measurewithptp(buffer_var: str | None = None) -> str

Run the dmm.measurewithptp() function.

Description
  • This function returns the last actual measurement and time information in PTP format without using the trigger model. You can also use a reading buffer to store additional information that is acquired while making a measurement.
TSP Syntax 
- dmm.measurewithptp()
Parameters:
  • buffer_var (optional, default: None ) –

    A previously created reading buffer variable in which all readings are stored.
Returns:
  • str –

    The result of the function call.
Raises:

measurewithtime 

measurewithtime(buffer_var: str | None = None) -> str

Run the dmm.measurewithtime() function.

Description
  • This function returns the last actual measurement and time information in UTC format without using the trigger model. You can also use a reading buffer to store additional information that is acquired while making a measurement.
TSP Syntax 
- dmm.measurewithtime()
Parameters:
  • buffer_var (optional, default: None ) –

    A previously created reading buffer variable in which all readings are stored.
Returns:
  • str –

    The result of the function call.
Raises:

open 

open(channel_list: str) -> None

Run the dmm.open() function.

Description
  • Opens the specified channel or channel pattern.
TSP Syntax 
- dmm.open()
Parameters:
  • channel_list (str) –

    A string that lists the channel or channel pattern to open.
Raises:

reset 

reset(scope: str) -> None

Run the dmm.reset() function.

Description
  • Resets the DMM functions and attributes in the instrument, as indicated by the parameter.
TSP Syntax 
- dmm.reset()
Parameters:
  • scope (str) –

    A string equaling ‘active’ to set the active function only to factory default settings or ‘all’ to set all functions back to factory default settings.
Raises:

savebuffer 

savebuffer(buffer_var: str, file_name: str, time_format: str | None = None) -> None

Run the dmm.savebuffer() function.

Description
  • Saves data from the specified reading buffer to a USB flash drive using the specified filename.
TSP Syntax 
- dmm.savebuffer()
Parameters:
  • buffer_var (str) –

    A string that specifies the name of the DMM reading buffer that was created by dmm.makebuffer().

  • file_name (str) –

    A string that indicates the name of the file on the USB flash drive in which to save the reading buffer.

  • time_format (optional, default: None ) –

    How date and time information from the buffer is saved in the file on the USB flash drive; the values are.
Raises:

setconfig 

setconfig(channel_list: str, dmm_configuration: str) -> None

Run the dmm.setconfig() function.

Description
  • Associates a DMM configuration with items specified in parameter channel list.
TSP Syntax 
- dmm.setconfig()
Parameters:
  • channel_list (str) –

    A string that lists the channels and channel patterns to change.

  • dmm_configuration (str) –

    A string with the name of the DMM configuration that will be assigned to items in channelList.
Raises:

DmmAdjustment

Bases: BaseTSPCmd

The dmm.adjustment command tree.

Properties and methods
  • .count: The dmm.adjustment.count attribute.

count property 

count: str

Access the dmm.adjustment.count attribute.

Description
  • This attribute indicates the number of times the instrument has been adjusted (calibrated).
Usage
  • Accessing this property will send the print(dmm.adjustment.count) query.
TSP Syntax 
- print(dmm.adjustment.count)
Raises:

DmmBuffer

Bases: BaseTSPCmd

The dmm.buffer command tree.

Properties and methods
  • .info(): The dmm.buffer.info() function.
  • .maxcapacity: The dmm.buffer.maxcapacity attribute.
  • .usedcapacity: The dmm.buffer.usedcapacity attribute.

maxcapacity property 

maxcapacity: str

Access the dmm.buffer.maxcapacity attribute.

Description
  • This attribute returns the overall maximum capacity for reading buffers in the instrument.
Usage
  • Accessing this property will send the print(dmm.buffer.maxcapacity) query.
TSP Syntax 
- print(dmm.buffer.maxcapacity)
Raises:

usedcapacity property 

usedcapacity: str

Access the dmm.buffer.usedcapacity attribute.

Description
  • This attribute indicates how much of the maximum capacity for reading buffers in the instrument is used.
Usage
  • Accessing this property will send the print(dmm.buffer.usedcapacity) query.
TSP Syntax 
- print(dmm.buffer.usedcapacity)
Raises:

info 

info(buffer_var: str) -> str

Run the dmm.buffer.info() function.

Description
  • This function returns the size and capacity of the reading buffer parameter.
TSP Syntax 
- dmm.buffer.info()
Parameters:
  • buffer_var (str) –

    String representing the reading buffer name that you want to query for size and capacity.
Returns:
  • str –

    The result of the function call.
Raises:

DmmCalibration

Bases: BaseTSPCmd

The dmm.calibration command tree.

Properties and methods
  • .ac(): The dmm.calibration.ac() function.
  • .dc(): The dmm.calibration.dc() function.
  • .lock(): The dmm.calibration.lock() function.
  • .password: The dmm.calibration.password attribute.
  • .save(): The dmm.calibration.save() function.
  • .unlock(): The dmm.calibration.unlock() function.

password property writable 

password: str

Access the dmm.calibration.password attribute.

Description
  • This attribute sets the password that must be entered before you can unlock calibration.
Usage
  • Setting this property to a value will send the dmm.calibration.password = value command.
TSP Syntax 
- dmm.calibration.password = value
Raises:

ac 

ac(step: str, value: str | None = None) -> None

Run the dmm.calibration.ac() function.

Description
  • This function begins the specified AC adjustment step on the DMM.
TSP Syntax 
- dmm.calibration.ac()
Parameters:
  • step (str) –

    The AC adjustment step to perform.

  • value (optional, default: None ) –

    The value for this adjustment step (if the adjustment step has a value).
Raises:

dc 

dc(step: str, value: str | None = None) -> None

Run the dmm.calibration.dc() function.

Description
  • This function begins a DC adjustment step on the DMM.
TSP Syntax 
- dmm.calibration.dc()
Parameters:
  • step (str) –

    The DC adjustment step to perform.

  • value (optional, default: None ) –

    The value for this adjustment step (if the adjustment step has a value).
Raises:

lock 

lock() -> None

Run the dmm.calibration.lock() function.

Description
  • This function locks calibration to prevent unintended changes.
TSP Syntax 
- dmm.calibration.lock()
Raises:

save 

save() -> None

Run the dmm.calibration.save() function.

Description
  • This function saves calibration data.
TSP Syntax 
- dmm.calibration.save()
Raises:

unlock 

unlock(password: str) -> None

Run the dmm.calibration.unlock() function.

Description
  • This function unlocks calibration if calibration was locked.
TSP Syntax 
- dmm.calibration.unlock()
Parameters:
  • password (str) –

    A string representing the password to unlock calibration.
Raises:

DmmConfigure

Bases: BaseTSPCmd

The dmm.configure command tree.

Properties and methods
  • .delete(): The dmm.configure.delete() function.
  • .query(): The dmm.configure.query() function.
  • .recall(): The dmm.configure.recall() function.
  • .set(): The dmm.configure.set() function.

delete 

delete(name: str) -> None

Run the dmm.configure.delete() function.

Description
  • This function deletes a user-created DMM configuration from memory.
TSP Syntax 
- dmm.configure.delete()
Parameters:
  • name (str) –

    String that contains the name of the DMM configuration to delete.
Raises:

query 

query(user_configuration: str, user_separator: str | None = None) -> str

Run the dmm.configure.query() function.

Description
  • This function lists DMM settings associated with a configuration.
TSP Syntax 
- dmm.configure.query()
Parameters:
  • user_configuration (str) –

    A string that contains the name for the DMM configuration to be listed; to query the settings for the active function, set this parameter to ‘active’.

  • user_separator (optional, default: None ) –

    A string that represents the two-character separator that is inserted between items; the default value is a comma followed by a space (, ).
Returns:
  • str –

    The result of the function call.
Raises:

recall 

recall(configuration: str) -> None

Run the dmm.configure.recall() function.

Description
  • This function recalls a user or factory DMM configuration and replaces attributes in the present configuration with attributes from the recalled version.
TSP Syntax 
- dmm.configure.recall()
Parameters:
  • configuration (str) –

    A string that represents the name of the DMM configuration to recall.
Raises:

set_ 

set_(name: str) -> None

Run the dmm.configure.set() function.

Description
  • This function creates a named DMM configuration for the selected function. The configuration includes pertinent attributes for that function.
TSP Syntax 
- dmm.configure.set()
Parameters:
  • name (str) –

    A string that contains the name of the DMM configuration that you are creating.
Raises:

DmmFilter

Bases: BaseTSPCmd

The dmm.filter command tree.

Properties and methods
  • .count: The dmm.filter.count attribute.
  • .enable: The dmm.filter.enable attribute.
  • .type: The dmm.filter.type attribute.
  • .window: The dmm.filter.window attribute.

count property writable 

count: str

Access the dmm.filter.count attribute.

Description
  • This attribute sets the filter count setting for the selected DMM function.
Usage
  • Accessing this property will send the print(dmm.filter.count) query.
  • Setting this property to a value will send the dmm.filter.count = value command.
TSP Syntax 
- dmm.filter.count = value
- print(dmm.filter.count)
Raises:

enable property writable 

enable: str

Access the dmm.filter.enable attribute.

Description
  • This attribute enables or disables the averaging filter for measurements of the selected function.
Usage
  • Accessing this property will send the print(dmm.filter.enable) query.
  • Setting this property to a value will send the dmm.filter.enable = value command.
TSP Syntax 
- dmm.filter.enable = value
- print(dmm.filter.enable)
Raises:

type property writable 

type: str

Access the dmm.filter.type attribute.

Description
  • This attribute defines the type of averaging filter that is used for the selected measure function when the measurement filter is enabled.
Usage
  • Accessing this property will send the print(dmm.filter.type) query.
  • Setting this property to a value will send the dmm.filter.type = value command.
TSP Syntax 
- dmm.filter.type = value
- print(dmm.filter.type)
Raises:

window property writable 

window: str

Access the dmm.filter.window attribute.

Description
  • This attribute sets the window for the averaging filter that is used for measurements for the selected function.
Usage
  • Accessing this property will send the print(dmm.filter.window) query.
  • Setting this property to a value will send the dmm.filter.window = value command.
TSP Syntax 
- dmm.filter.window = value
- print(dmm.filter.window)
Raises:

DmmLimitItem

Bases: ValidatedDynamicNumberCmd, BaseTSPCmd

The dmm.limit[Y] command tree.

Info
  • Y, the limit number: 1 or 2.
Properties and methods
  • .autoclear: The dmm.limit[Y].autoclear attribute.
  • .clear(): The dmm.limit[Y].clear() function.
  • .enable: The dmm.limit[Y].enable attribute.
  • .high: The dmm.limit[Y].high command tree.
  • .low: The dmm.limit[Y].low command tree.

autoclear property writable 

autoclear: str

Access the dmm.limit[Y].autoclear attribute.

Description
  • This attribute indicates if the test result for limit Y should be cleared automatically or not.
Usage
  • Accessing this property will send the print(dmm.limit[Y].autoclear) query.
  • Setting this property to a value will send the dmm.limit[Y].autoclear = value command.
TSP Syntax 
- dmm.limit[Y].autoclear = value
- print(dmm.limit[Y].autoclear)
Info
  • Y, the limit number: 1 or 2.
Raises:

enable property writable 

enable: str

Access the dmm.limit[Y].enable attribute.

Description
  • This attribute enables or disables a limit test on the measurement from the selected measure function.
Usage
  • Accessing this property will send the print(dmm.limit[Y].enable) query.
  • Setting this property to a value will send the dmm.limit[Y].enable = value command.
TSP Syntax 
- dmm.limit[Y].enable = value
- print(dmm.limit[Y].enable)
Info
  • Y, the limit number: 1 or 2.
Raises:

high property 

high: DmmLimitItemHigh

Return the dmm.limit[Y].high command tree.

Info
  • Y, the limit number: 1 or 2.
Sub-properties and sub-methods
  • .fail: The dmm.limit[Y].high.fail attribute.
  • .value: The dmm.limit[Y].high.value attribute.

low property 

low: DmmLimitItemLow

Return the dmm.limit[Y].low command tree.

Info
  • Y, the 1 or 2 for limit number.
Sub-properties and sub-methods
  • .fail: The dmm.limit[Y].low.fail attribute.
  • .value: The dmm.limit[Y].low.value attribute.

clear 

clear() -> None

Run the dmm.limit[Y].clear() function.

Description
  • This function clears the results of the limit test defined by Y.
TSP Syntax 
- dmm.limit[Y].clear()
Info
  • Y, the limit number: 1 or 2.
Raises:

DmmLimitItemHigh

Bases: BaseTSPCmd

The dmm.limit[Y].high command tree.

Info
  • Y, the limit number: 1 or 2.
Properties and methods
  • .fail: The dmm.limit[Y].high.fail attribute.
  • .value: The dmm.limit[Y].high.value attribute.

fail property 

fail: str

Access the dmm.limit[Y].high.fail attribute.

Description
  • This attribute queries for the high test results of limit Y.
Usage
  • Accessing this property will send the print(dmm.limit[Y].high.fail) query.
TSP Syntax 
- print(dmm.limit[Y].high.fail)
Info
  • Y, the limit number: 1 or 2.
Raises:

value property writable 

value: str

Access the dmm.limit[Y].high.value attribute.

Description
  • This attribute specifies the upper limit for a limit test.
Usage
  • Accessing this property will send the print(dmm.limit[Y].high.value) query.
  • Setting this property to a value will send the dmm.limit[Y].high.value = value command.
TSP Syntax 
- dmm.limit[Y].high.value = value
- print(dmm.limit[Y].high.value)
Info
  • Y, the limit number: 1 or 2.
Raises:

DmmLimitItemLow

Bases: BaseTSPCmd

The dmm.limit[Y].low command tree.

Info
  • Y, the 1 or 2 for limit number.
Properties and methods
  • .fail: The dmm.limit[Y].low.fail attribute.
  • .value: The dmm.limit[Y].low.value attribute.

fail property 

fail: str

Access the dmm.limit[Y].low.fail attribute.

Description
  • This attribute queries for the low test results of limit Y.
Usage
  • Accessing this property will send the print(dmm.limit[Y].low.fail) query.
TSP Syntax 
- print(dmm.limit[Y].low.fail)
Info
  • Y, the 1 or 2 for limit number.
Raises:

value property writable 

value: str

Access the dmm.limit[Y].low.value attribute.

Description
  • This attribute specifies the lower limit for a limit test.
Usage
  • Accessing this property will send the print(dmm.limit[Y].low.value) query.
  • Setting this property to a value will send the dmm.limit[Y].low.value = value command.
TSP Syntax 
- dmm.limit[Y].low.value = value
- print(dmm.limit[Y].low.value)
Info
  • Y, the limit number 1 or 2.
Raises:

DmmMath

Bases: BaseTSPCmd

The dmm.math command tree.

Properties and methods
  • .enable: The dmm.math.enable attribute.
  • .format: The dmm.math.format attribute.
  • .mxb: The dmm.math.mxb command tree.
  • .percent: The dmm.math.percent attribute.

enable property writable 

enable: str

Access the dmm.math.enable attribute.

Description
  • This attribute enables or disables math operations on measurements for the selected measurement function.
Usage
  • Accessing this property will send the print(dmm.math.enable) query.
  • Setting this property to a value will send the dmm.math.enable = value command.
TSP Syntax 
- dmm.math.enable = value
- print(dmm.math.enable)
Raises:

format property writable 

format: str

Access the dmm.math.format attribute.

Description
  • This attribute specifies which math operation is performed on measurements when math operations are enabled.
Usage
  • Accessing this property will send the print(dmm.math.format) query.
  • Setting this property to a value will send the dmm.math.format = value command.
TSP Syntax 
- dmm.math.format = value
- print(dmm.math.format)
Raises:

mxb property 

mxb: DmmMathMxb

Return the dmm.math.mxb command tree.

Sub-properties and sub-methods
  • .bfactor: The dmm.math.mxb.bfactor attribute.
  • .mfactor: The dmm.math.mxb.mfactor attribute.
  • .units: The dmm.math.mxb.units attribute.

percent property writable 

percent: str

Access the dmm.math.percent attribute.

Description
  • This attribute specifies the reference constant that is used when math operations are set to percent.
Usage
  • Accessing this property will send the print(dmm.math.percent) query.
  • Setting this property to a value will send the dmm.math.percent = value command.
TSP Syntax 
- dmm.math.percent = value
- print(dmm.math.percent)
Raises:

DmmMathMxb

Bases: BaseTSPCmd

The dmm.math.mxb command tree.

Properties and methods
  • .bfactor: The dmm.math.mxb.bfactor attribute.
  • .mfactor: The dmm.math.mxb.mfactor attribute.
  • .units: The dmm.math.mxb.units attribute.

bfactor property writable 

bfactor: str

Access the dmm.math.mxb.bfactor attribute.

Description
  • This attribute specifies the offset, b, for the y = mx + b operation.
Usage
  • Accessing this property will send the print(dmm.math.mxb.bfactor) query.
  • Setting this property to a value will send the dmm.math.mxb.bfactor = value command.
TSP Syntax 
- dmm.math.mxb.bfactor = value
- print(dmm.math.mxb.bfactor)
Raises:

mfactor property writable 

mfactor: str

Access the dmm.math.mxb.mfactor attribute.

Description
  • This attribute specifies the scale factor, m, for the y = mx + b math operation.
Usage
  • Accessing this property will send the print(dmm.math.mxb.mfactor) query.
  • Setting this property to a value will send the dmm.math.mxb.mfactor = value command.
TSP Syntax 
- dmm.math.mxb.mfactor = value
- print(dmm.math.mxb.mfactor)
Raises:

units property writable 

units: str

Access the dmm.math.mxb.units attribute.

Description
  • This attribute specifies the unit character for the y = mX + b operation.
Usage
  • Accessing this property will send the print(dmm.math.mxb.units) query.
  • Setting this property to a value will send the dmm.math.mxb.units = value command.
TSP Syntax 
- dmm.math.mxb.units = value
- print(dmm.math.mxb.units)
Raises:

DmmRel

Bases: BaseTSPCmd

The dmm.rel command tree.

Properties and methods
  • .acquire(): The dmm.rel.acquire() function.
  • .enable: The dmm.rel.enable attribute.
  • .level: The dmm.rel.level attribute.

enable property writable 

enable: str

Access the dmm.rel.enable attribute.

Description
  • Enables or disables relative measurement control for the function selected by dmm.func.
Usage
  • Accessing this property will send the print(dmm.rel.enable) query.
  • Setting this property to a value will send the dmm.rel.enable = value command.
TSP Syntax 
- dmm.rel.enable = value
- print(dmm.rel.enable)
Raises:

level property writable 

level: str

Access the dmm.rel.level attribute.

Description
  • The offset value for relative measurements for the function selected by dmm.func.
Usage
  • Accessing this property will send the print(dmm.rel.level) query.
  • Setting this property to a value will send the dmm.rel.level = value command.
TSP Syntax 
- dmm.rel.level = value
- print(dmm.rel.level)
Raises:

acquire 

acquire() -> str

Run the dmm.rel.acquire() function.

Description
  • This function acquires a measurement and stores it as the relative offset value.
TSP Syntax 
- dmm.rel.acquire()
Returns:
  • str –

    The result of the function call.
Raises: