[python source code]

buffer

The buffer commands module.

These commands are used in the following models: DMM7510

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

Please report an issue if one is found.

Attributes and Functions 
- buffer.clearstats()
- buffer.delete()
- buffer.make()
- buffer.save()
- buffer.saveappend()
- buffer.write.format()

Buffer

Bases: BaseTSPCmd

The buffer command tree.

Constants
  • .COL_ALL: Save all data from the specified reading buffer.
  • .COL_BRIEF: Save reading and relative time data from the specified reading buffer.
  • .COL_DISPLAY_DIGITS: Save display digits from the specified reading buffer.
  • .COL_EXTRA: Relative time and additional values if they exist (such as the sense voltage from a dc voltage ratio measurement).
  • .COL_EXTRA_RANGE: Save sxtra value range digits from the specified reading buffer.
  • .COL_EXTRA_UNIT: Save extra value units from the specified reading buffer.
  • .COL_EXTRA_VALUE: Save extra values from the specified reading buffer.
  • .COL_INDEX: Save index into buffer from the specified reading buffer.
  • .COL_LIMITS: The status of all limits.
  • .COL_MATH: Math enabled (F is math is not enabled; T if math is enabled) and relative time.
  • .COL_ORIGIN: Save origin status from the specified reading buffer.
  • .COL_QUESTIONABLE: Save questionable status from the specified reading buffer.
  • .COL_RANGE_DIGITS: Save range digits from the specified reading buffer.
  • .COL_READING: Save the measurement reading from the specified reading buffer.
  • .COL_STANDARD: Save the relative time, reading, channel, and source value from the specified reading buffer.
  • .COL_START: Save the status of the start group from the specified reading buffer.
  • .COL_STATUS: Save the status information associated with the measurement from the specified reading buffer.
  • .COL_TERMINAL: Save the terminal status from the specified reading buffer.
  • .COL_TIMESTAMP_READING: Save the timestamp reading from the specified reading buffer.
  • .COL_TIME_ABSOLUTE: Save the time when the data point was measured as an absolute from the specified reading buffer.
  • .COL_TIME_PARTS: Save absolute time in multiple columns from the specified reading buffer.
  • .COL_TIME_RAW: Save absolute time in seconds from the specified reading buffer.
  • .COL_TIME_RELATIVE: Save the relative time when the data point was measured in seconds from the specified reading buffer.
  • .COL_UNIT: Save the reading and the unit of measure from the specified reading buffer.
  • .DIGITS_3_5: The number of digits to use for the first measurement.
  • .DIGITS_4_5: The number of digits to use for the first measurement.
  • .DIGITS_5_5: The number of digits to use for the first measurement.
  • .DIGITS_6_5: The number of digits to use for the first measurement.
  • .DIGITS_7_5: The number of digits to use for the first measurement.
  • .DIGITS_8_5: The number of digits to use for the first measurement.
  • .EXPR_ADD: Add the present and previous measurements.
  • .EXPR_AVERAGE: Average the present and previous measurements.
  • .EXPR_DIVIDE: Divide the present reading by the previous reading.
  • .EXPR_EXPONENT: Exponent (10^present reading).
  • .EXPR_LOG10: Log10 (log10(present reading)).
  • .EXPR_MULTIPLY: Multiply the present and previous measurements.
  • .EXPR_NONE: Remove the math expression.
  • .EXPR_POLY: Polynomial where r is present reading and c is constant.
  • .EXPR_POWER: Present reading raised to power of defined constant.
  • .EXPR_RATE: Rate of change (present reading - previous reading)/(timestamp of present reading - timestamp of previous reading).
  • .EXPR_RECIPROCAL: Reciprocal (1/present reading).
  • .EXPR_SQROOT: Square root of the present reading.
  • .EXPR_SUBTRACT: Present reading - previous reading.
  • .FILL_CONTINUOUS: Fill the buffer continuously.
  • .FILL_ONCE: Fill the buffer, then stop.
  • .OFF: Do not log information events.
  • .ON: Log information events.
  • .SAVE_FORMAT_TIME: Include dates, times, and fractional seconds in the buffer.
  • .SAVE_RAW_TIME: Include seconds and fractional seconds in the buffer.
  • .SAVE_RELATIVE_TIME: Include relative timestamps in the buffer.
  • .SAVE_TIMESTAMP_TIME: Include timestamps in the buffer.
  • .STAT_LIMIT1_HIGH: Reading is above high limit 1.
  • .STAT_LIMIT1_LOW: Reading is below low limit 1.
  • .STAT_LIMIT2_HIGH: Reading is above high limit 2.
  • .STAT_LIMIT2_LOW: Reading is below low limit 2.
  • .STAT_ORIGIN: A/D converter from which reading originated; for most instruments, this will always be 0 (main). For digitizing instruments, can be 2 (digitize).
  • .STAT_QUESTIONABLE: Measure status questionable.
  • .STAT_REL: Relative offset.
  • .STAT_SCAN: Scan.
  • .STAT_START_GROUP: First reading in a group.
  • .STAT_TERMINAL: Measure terminal, front is 1, rear is 0.
  • .STYLE_COMPACT: Store readings with reduced accuracy (6.5 digits) with no formatting information, 1 μs accurate timestamp.
  • .STYLE_FULL: Store the same information with full accuracy with formatting, plus additional information.
  • .STYLE_STANDARD: Store readings with full accuracy with formatting.
  • .STYLE_WRITABLE: Store external reading buffer data.
  • .STYLE_WRITABLE_FULL: Store external reading buffer data with two reading values.
  • .UNIT_AMP: Set units of measure to dc current.
  • .UNIT_AMP_AC: Set units of measure to ac current.
  • .UNIT_CELSIUS: Set units of measure to Celsius.
  • .UNIT_CUSTOM1: Custom unit 1 (defined by buffer.unit()).
  • .UNIT_CUSTOM2: Custom unit 2 (defined by buffer.unit()).
  • .UNIT_CUSTOM3: Custom unit 3 (defined by buffer.unit()).
  • .UNIT_DAC: Set units of measure to DAC (voltage).
  • .UNIT_DBM: Set units of measure to decibel-milliwatts.
  • .UNIT_DECIBEL: Set units of measure to decibels.
  • .UNIT_DIO: Set units of measure to digital I/O.
  • .UNIT_FAHRENHEIT: Set units of measure to Fahrenheit.
  • .UNIT_FARAD: Set units of measure to capacitance.
  • .UNIT_HERTZ: Set units of measure to frequency.
  • .UNIT_KELVIN: Set units of measure to Kelvin.
  • .UNIT_NONE: Set units of measure to no units.
  • .UNIT_OHM: Set units of measure to ohms.
  • .UNIT_PERCENT: Set units of measure to percent.
  • .UNIT_RATIO: Set units of measure to dc voltage ratio.
  • .UNIT_RECIPROCAL: Set units of measure to reciprocal.
  • .UNIT_SECOND: Set units of measure to period.
  • .UNIT_TOT: Set units of measure to totalizer.
  • .UNIT_VOLT: Set units of measure to dc voltage.
  • .UNIT_VOLT_AC: Set units of measure to ac voltage.
  • .UNIT_WATT: Set units of measure to watts.
  • .UNIT_X: Set units of measure to buffer.UNIT_X.
Properties and methods
  • .clearstats(): The buffer.clearstats() function.
  • .delete(): The buffer.delete() function.
  • .make(): The buffer.make() function.
  • .save(): The buffer.save() function.
  • .saveappend(): The buffer.saveappend() function.
  • .write: The buffer.write command tree.

COL_ALL class-attribute instance-attribute 

COL_ALL = 'buffer.COL_ALL'

COL_BRIEF class-attribute instance-attribute 

COL_BRIEF = 'buffer.COL_BRIEF'

COL_DISPLAY_DIGITS class-attribute instance-attribute 

COL_DISPLAY_DIGITS = 'buffer.COL_DISPLAY_DIGITS'

COL_EXTRA class-attribute instance-attribute 

COL_EXTRA = 'buffer.COL_EXTRA'

COL_EXTRA_RANGE class-attribute instance-attribute 

COL_EXTRA_RANGE = 'buffer.COL_EXTRA_RANGE'

COL_EXTRA_UNIT class-attribute instance-attribute 

COL_EXTRA_UNIT = 'buffer.COL_EXTRA_UNIT'

COL_EXTRA_VALUE class-attribute instance-attribute 

COL_EXTRA_VALUE = 'buffer.COL_EXTRA_VALUE'

COL_INDEX class-attribute instance-attribute 

COL_INDEX = 'buffer.COL_INDEX'

COL_LIMITS class-attribute instance-attribute 

COL_LIMITS = 'buffer.COL_LIMITS'

COL_MATH class-attribute instance-attribute 

COL_MATH = 'buffer.COL_MATH'

COL_ORIGIN class-attribute instance-attribute 

COL_ORIGIN = 'buffer.COL_ORIGIN'

COL_QUESTIONABLE class-attribute instance-attribute 

COL_QUESTIONABLE = 'buffer.COL_QUESTIONABLE'

COL_RANGE_DIGITS class-attribute instance-attribute 

COL_RANGE_DIGITS = 'buffer.COL_RANGE_DIGITS'

COL_READING class-attribute instance-attribute 

COL_READING = 'buffer.COL_READING'

COL_STANDARD class-attribute instance-attribute 

COL_STANDARD = 'buffer.COL_STANDARD'

COL_START class-attribute instance-attribute 

COL_START = 'buffer.COL_START'

COL_STATUS class-attribute instance-attribute 

COL_STATUS = 'buffer.COL_STATUS'

COL_TERMINAL class-attribute instance-attribute 

COL_TERMINAL = 'buffer.COL_TERMINAL'

COL_TIMESTAMP_READING class-attribute instance-attribute 

COL_TIMESTAMP_READING = 'buffer.COL_TIMESTAMP_READING'

COL_TIME_ABSOLUTE class-attribute instance-attribute 

COL_TIME_ABSOLUTE = 'buffer.COL_TIME_ABSOLUTE'

COL_TIME_PARTS class-attribute instance-attribute 

COL_TIME_PARTS = 'buffer.COL_TIME_PARTS'

COL_TIME_RAW class-attribute instance-attribute 

COL_TIME_RAW = 'buffer.COL_TIME_RAW'

COL_TIME_RELATIVE class-attribute instance-attribute 

COL_TIME_RELATIVE = 'buffer.COL_TIME_RELATIVE'

COL_UNIT class-attribute instance-attribute 

COL_UNIT = 'buffer.COL_UNIT'

DIGITS_3_5 class-attribute instance-attribute 

DIGITS_3_5 = 'buffer.DIGITS_3_5'

DIGITS_4_5 class-attribute instance-attribute 

DIGITS_4_5 = 'buffer.DIGITS_4_5'

DIGITS_5_5 class-attribute instance-attribute 

DIGITS_5_5 = 'buffer.DIGITS_5_5'

DIGITS_6_5 class-attribute instance-attribute 

DIGITS_6_5 = 'buffer.DIGITS_6_5'

DIGITS_7_5 class-attribute instance-attribute 

DIGITS_7_5 = 'buffer.DIGITS_7_5'

DIGITS_8_5 class-attribute instance-attribute 

DIGITS_8_5 = 'buffer.DIGITS_8_5'

EXPR_ADD class-attribute instance-attribute 

EXPR_ADD = 'buffer.EXPR_ADD'

EXPR_AVERAGE class-attribute instance-attribute 

EXPR_AVERAGE = 'buffer.EXPR_AVERAGE'

EXPR_DIVIDE class-attribute instance-attribute 

EXPR_DIVIDE = 'buffer.EXPR_DIVIDE'

EXPR_EXPONENT class-attribute instance-attribute 

EXPR_EXPONENT = 'buffer.EXPR_EXPONENT'

EXPR_LOG10 class-attribute instance-attribute 

EXPR_LOG10 = 'buffer.EXPR_LOG10'

EXPR_MULTIPLY class-attribute instance-attribute 

EXPR_MULTIPLY = 'buffer.EXPR_MULTIPLY'

EXPR_NONE class-attribute instance-attribute 

EXPR_NONE = 'buffer.EXPR_NONE'

EXPR_POLY class-attribute instance-attribute 

EXPR_POLY = 'buffer.EXPR_POLY'

EXPR_POWER class-attribute instance-attribute 

EXPR_POWER = 'buffer.EXPR_POWER'

EXPR_RATE class-attribute instance-attribute 

EXPR_RATE = 'buffer.EXPR_RATE'

EXPR_RECIPROCAL class-attribute instance-attribute 

EXPR_RECIPROCAL = 'buffer.EXPR_RECIPROCAL'

EXPR_SQROOT class-attribute instance-attribute 

EXPR_SQROOT = 'buffer.EXPR_SQROOT'

EXPR_SUBTRACT class-attribute instance-attribute 

EXPR_SUBTRACT = 'buffer.EXPR_SUBTRACT'

FILL_CONTINUOUS class-attribute instance-attribute 

FILL_CONTINUOUS = 'buffer.FILL_CONTINUOUS'

FILL_ONCE class-attribute instance-attribute 

FILL_ONCE = 'buffer.FILL_ONCE'

OFF class-attribute instance-attribute 

OFF = 'buffer.OFF'

ON class-attribute instance-attribute 

ON = 'buffer.ON'

SAVE_FORMAT_TIME class-attribute instance-attribute 

SAVE_FORMAT_TIME = 'buffer.SAVE_FORMAT_TIME'

SAVE_RAW_TIME class-attribute instance-attribute 

SAVE_RAW_TIME = 'buffer.SAVE_RAW_TIME'

SAVE_RELATIVE_TIME class-attribute instance-attribute 

SAVE_RELATIVE_TIME = 'buffer.SAVE_RELATIVE_TIME'

SAVE_TIMESTAMP_TIME class-attribute instance-attribute 

SAVE_TIMESTAMP_TIME = 'buffer.SAVE_TIMESTAMP_TIME'

STAT_LIMIT1_HIGH class-attribute instance-attribute 

STAT_LIMIT1_HIGH = 'buffer.STAT_LIMIT1_HIGH'

STAT_LIMIT1_LOW class-attribute instance-attribute 

STAT_LIMIT1_LOW = 'buffer.STAT_LIMIT1_LOW'

STAT_LIMIT2_HIGH class-attribute instance-attribute 

STAT_LIMIT2_HIGH = 'buffer.STAT_LIMIT2_HIGH'

STAT_LIMIT2_LOW class-attribute instance-attribute 

STAT_LIMIT2_LOW = 'buffer.STAT_LIMIT2_LOW'

STAT_ORIGIN class-attribute instance-attribute 

STAT_ORIGIN = 'buffer.STAT_ORIGIN'

STAT_QUESTIONABLE class-attribute instance-attribute 

STAT_QUESTIONABLE = 'buffer.STAT_QUESTIONABLE'

STAT_REL class-attribute instance-attribute 

STAT_REL = 'buffer.STAT_REL'

STAT_SCAN class-attribute instance-attribute 

STAT_SCAN = 'buffer.STAT_SCAN'

STAT_START_GROUP class-attribute instance-attribute 

STAT_START_GROUP = 'buffer.STAT_START_GROUP'

STAT_TERMINAL class-attribute instance-attribute 

STAT_TERMINAL = 'buffer.STAT_TERMINAL'

STYLE_COMPACT class-attribute instance-attribute 

STYLE_COMPACT = 'buffer.STYLE_COMPACT'

STYLE_FULL class-attribute instance-attribute 

STYLE_FULL = 'buffer.STYLE_FULL'

STYLE_STANDARD class-attribute instance-attribute 

STYLE_STANDARD = 'buffer.STYLE_STANDARD'

STYLE_WRITABLE class-attribute instance-attribute 

STYLE_WRITABLE = 'buffer.STYLE_WRITABLE'

STYLE_WRITABLE_FULL class-attribute instance-attribute 

STYLE_WRITABLE_FULL = 'buffer.STYLE_WRITABLE_FULL'

UNIT_AMP class-attribute instance-attribute 

UNIT_AMP = 'buffer.UNIT_AMP'

UNIT_AMP_AC class-attribute instance-attribute 

UNIT_AMP_AC = 'buffer.UNIT_AMP_AC'

UNIT_CELSIUS class-attribute instance-attribute 

UNIT_CELSIUS = 'buffer.UNIT_CELSIUS'

UNIT_CUSTOM1 class-attribute instance-attribute 

UNIT_CUSTOM1 = 'buffer.UNIT_CUSTOM1'

UNIT_CUSTOM2 class-attribute instance-attribute 

UNIT_CUSTOM2 = 'buffer.UNIT_CUSTOM2'

UNIT_CUSTOM3 class-attribute instance-attribute 

UNIT_CUSTOM3 = 'buffer.UNIT_CUSTOM3'

UNIT_DAC class-attribute instance-attribute 

UNIT_DAC = 'buffer.UNIT_DAC'

UNIT_DBM class-attribute instance-attribute 

UNIT_DBM = 'buffer.UNIT_DBM'

UNIT_DECIBEL class-attribute instance-attribute 

UNIT_DECIBEL = 'buffer.UNIT_DECIBEL'

UNIT_DIO class-attribute instance-attribute 

UNIT_DIO = 'buffer.UNIT_DIO'

UNIT_FAHRENHEIT class-attribute instance-attribute 

UNIT_FAHRENHEIT = 'buffer.UNIT_FAHRENHEIT'

UNIT_FARAD class-attribute instance-attribute 

UNIT_FARAD = 'buffer.UNIT_FARAD'

UNIT_HERTZ class-attribute instance-attribute 

UNIT_HERTZ = 'buffer.UNIT_HERTZ'

UNIT_KELVIN class-attribute instance-attribute 

UNIT_KELVIN = 'buffer.UNIT_KELVIN'

UNIT_NONE class-attribute instance-attribute 

UNIT_NONE = 'buffer.UNIT_NONE'

UNIT_OHM class-attribute instance-attribute 

UNIT_OHM = 'buffer.UNIT_OHM'

UNIT_PERCENT class-attribute instance-attribute 

UNIT_PERCENT = 'buffer.UNIT_PERCENT'

UNIT_RATIO class-attribute instance-attribute 

UNIT_RATIO = 'buffer.UNIT_RATIO'

UNIT_RECIPROCAL class-attribute instance-attribute 

UNIT_RECIPROCAL = 'buffer.UNIT_RECIPROCAL'

UNIT_SECOND class-attribute instance-attribute 

UNIT_SECOND = 'buffer.UNIT_SECOND'

UNIT_TOT class-attribute instance-attribute 

UNIT_TOT = 'buffer.UNIT_TOT'

UNIT_VOLT class-attribute instance-attribute 

UNIT_VOLT = 'buffer.UNIT_VOLT'

UNIT_VOLT_AC class-attribute instance-attribute 

UNIT_VOLT_AC = 'buffer.UNIT_VOLT_AC'

UNIT_WATT class-attribute instance-attribute 

UNIT_WATT = 'buffer.UNIT_WATT'

UNIT_X class-attribute instance-attribute 

UNIT_X = 'buffer.UNIT_X'

write property 

write: BufferWrite

Return the buffer.write command tree.

Sub-properties and sub-methods
  • .format(): The buffer.write.format() function.

clearstats 

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

Run the buffer.clearstats() function.

Description
  • This function clears the statistical information associated with the specified buffer.
TSP Syntax 
- buffer.clearstats()
Parameters:
  • buffer_var (optional, default: None ) –

    The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1 if not specified.
Raises:

delete 

delete(buffer_name: str) -> None

Run the buffer.delete() function.

Description
  • This function deletes a user-defined reading buffer.
TSP Syntax 
- buffer.delete()
Parameters:
  • buffer_name (str) –

    The name of a user-defined reading buffer.
Raises:

make 

make(buffer_size: int, style: str | None = None, *, buffer_name: str | None = None) -> Buffervar

Run the buffer.make() function.

Description
  • This function creates a user-defined reading buffer.
TSP Syntax 
- buffer.make()
Parameters:
  • buffer_size (int) –

    The maximum number of readings that can be stored in bufferVar; minimum is 10; 0 to maximize buffer size (see Details).

  • style (optional, default: None ) –

    The type of reading buffer to create.

  • 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:

save 

save(
    buffer_var: str,
    file_name: str,
    what: str | None = None,
    start: str | None = None,
    end: str | None = None,
) -> None

Run the buffer.save() function.

Description
  • This function saves data from the specified reading buffer to a USB flash drive.
TSP Syntax 
- buffer.save()
Parameters:
  • buffer_var (str) –

    The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer.

  • file_name (str) –

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

  • what (optional, default: None ) –

    Defines which information is saved in the file on the USB flash drive.

  • start (optional, default: None ) –

    Defines the starting point in the buffer to start saving data.

  • end (optional, default: None ) –

    Defines the ending point in the buffer to stop saving data.
Raises:

saveappend 

saveappend(
    buffer_var: str,
    file_name: str,
    time_format: str | None = None,
    start: str | None = None,
    end: str | None = None,
) -> None

Run the buffer.saveappend() function.

Description
  • This function appends data from the reading buffer to a file on the USB flash drive.
TSP Syntax 
- buffer.saveappend()
Parameters:
  • buffer_var (str) –

    Indicates the reading buffer to use; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, defbuffer1 is used.

  • 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 ) –

    Indicates how date and time information from the buffer is saved in the file on the USB flash drive; the options are.

  • start (optional, default: None ) –

    Defines the starting point in the buffer to start saving data.

  • end (optional, default: None ) –

    Defines the ending point in the buffer to stop saving data.
Raises:

BufferWrite

Bases: BaseTSPCmd

The buffer.write command tree.

Properties and methods
  • .format(): The buffer.write.format() function.

format 

format(
    buffer_var: str,
    units: str,
    display_digits: int,
    extra_units: str | None = None,
    extra_digits: int | None = None,
) -> None

Run the buffer.write.format() function.

Description
  • This function sets the units and number of digits of the readings that are written into the reading buffer.
TSP Syntax 
- buffer.write.format()
Parameters:
  • buffer_var (str) –

    The name of the buffer.

  • units (str) –

    The units for the first measurement in the buffer index.

  • display_digits (int) –

    The number of digits to use for the first measurement.

  • extra_units (optional, default: None ) –

    The units for the second measurement in the buffer index; the selections are the same as units (only valid for buffer style WRITABLE_FULL); if not specified, uses the value for units.

  • extra_digits (optional, default: None ) –

    The number of digits to use for the second measurement; the selections are the same as displayDigits (only valid for buffer style WRITABLE_FULL); if not specified, uses the value for displayDigits.
Raises: