Agilent B2980 Series, Femto/Picoammeter Electrometer/High Resistance Meter

class pymeasure.instruments.agilent.AgilentB2981(adapter, name='Agilent/Keysight B2980A/B series', **kwargs)

Bases: SCPIMixin, Instrument

A class representing the Agilent/Keysight B2981A/B.

The B2981 is a Femto/Picoammeter.

abort()

Abort the all actions.

abort_acquisition()

Abort action ‘ACQuire’.

arm()

Send an immediate arm trigger for all actions.

When the status of all actions is initiated, the arm trigger causes a layer change from arm to trigger.

arm_acquisition()

Send an immediate arm trigger for action ‘ACQuire’.

When the status of action ‘ACQuire’ is initiated, the arm trigger causes a layer change from arm to trigger.

property arm_acquisition_bypass_once_enabled: Any

Control the bypass for the event detector in the arm layer for action ‘ACQuire’ (bool).

property arm_acquisition_count: Any

Control the arm trigger count for action ‘ACQuire’.

Type:
  • int, strictly from 1 to 100000 or

  • str, strictly in MIN, MAX, DEF, INF

INF is equivalent to 2147483647

property arm_acquisition_delay: Any

Control the arm trigger delay for action ‘ACQuire’ in seconds.

Type:
  • float, strictly from 0 to 1E5 or

  • str, strictly in MIN, MAX, DEF

property arm_acquisition_output_enabled: Any

Control the arm trigger output for action ‘ACQuire’ (bool).

It is for the status change between the idle state and the arm layer.

property arm_acquisition_output_signal: Any

Control the arm trigger output for action ‘ACQuire’.

Type:

str, strictly in INT1, INT2, LAN, TOUT, EXT1 to EXT7

  • INT1 or INT2 selects the internal bus 1 or 2.

  • LAN selects a LAN port.

  • EXT1 to EXT7 selects the GPIO pin n, which is an output port of the Digital I/O D-sub connector on the rear panel. n = 1 to 7.

  • TOUT selects the BNC Trigger Out.

It is for the status change between the idle state and the arm layer.

property arm_acquisition_source: Any

Control the arm trigger source for action ‘ACQuire’.

Type:

str, strictly in AINT, BUS, TIM, INT1, INT2, LAN, TIN, EXT1 to EXT7

  • AINT automatically selects the arm source most suitable for the present operating mode by using internal algorithms.

  • BUS selects the remote interface trigger command such as the group execute trigger (GET) and the TRG command.

  • TIM selects a signal internally generated every interval set by the arm_timer command.

  • INT1 and INT2 selects a signal from the internal bus 1 or 2.

  • LAN selects the LXI trigger specified by the arm_source_lan_id command.

  • EXT1 to EXT7 selects a signal from the GPIO pin n, which is an input port of the Digital I/O D-sub connector on the rear panel. n = 1 to 7.

  • TIN selects the BNC Trigger In.

property arm_acquisition_source_lan_id: Any

Control the source for LAN arm triggers for action ‘ACQuire’.

Type:

str, strictly from LAN0 to LAN7

property arm_acquisition_timer: Any

Control the timer interval of the arm trigger source for action ‘ACQuire’ in seconds.

Type:
  • float, strictly from 1E-5 to 1E5

  • str, strictly in MIN, MAX, DEF

property arm_all_bypass_once_enabled: Any

Set the bypass for the event detector in the arm layer for action ‘ALL’ (bool).

property arm_all_count: Any

Set the arm trigger counter for action ‘ALL’.

Type:
  • int, strictly from 1 to 100000 or

  • str, strictly in MIN, MAX, DEF, INF

INF is equivalent to 2147483647.

property arm_all_delay: Any

Set the arm trigger delay for action ‘ALL’ in seconds.

Type:
  • float, strictly from 0 to 1E5 or

  • str, strictly in MIN, MAX, DEF

property arm_all_output_enabled: Any

Set the arm trigger output for action ‘ALL’ (bool).

It is for the status change between the idle state and the arm layer.

property arm_all_output_signal: Any

Set the arm trigger output for action ‘ALL’.

Type:

str, strictly in INT1, INT2, LAN, TOUT, EXT1 to EXT7

  • INT1 and INT2 selects the internal bus 1 or 2.

  • LAN selects a LAN port.

  • EXT1 to EXT7 selects the GPIO pin n, which is an output port of the Digital I/O D-sub connector on the rear panel. n = 1 to 7.

  • TOUT selects the BNC Trigger Out.

It is for the status change between the idle state and the arm layer.

property arm_all_source: Any

Set the arm trigger source for action ‘ALL’.

Type:

str, strictly in AINT, BUS, TIM, INT1, INT2, LAN, TIN, EXT1 to EXT7

  • AINT automatically selects the arm source most suitable for the present operating mode by using internal algorithms.

  • BUS selects the remote interface trigger command such as the group execute trigger (GET) and the TRG command.

  • TIM selects a signal internally generated every interval set by attr:arm_all_timer.

  • INT1 and INT2 selects a signal from the internal bus 1 or 2.

  • LAN selects the LXI trigger specified by arm_all_source_lan_id.

  • EXT1 to EXT7 selects a signal from the GPIO pin n, which is an input port of the Digital I/O D-sub connector on the rear panel. n = 1 to 7.

  • TIN selects the BNC Trigger In.

property arm_all_source_lan_id: Any

Set the source for LAN arm triggers for action ‘ALL’.

Type:

str, strictly from LAN0 to LAN7

property arm_all_timer: Any

Set the timer interval of the arm trigger source for action ‘ALL’ in seconds.

Type:
  • float, strictly from 1E-5 to 1E5 or

  • str, strictly in MIN, MAX, DEF

property current: Any

Measure current with a spot measurement in Amps.

Returns:

float

property current_range: Any

Control the range for the current measurement in Amps.

Type:
  • float, strictly from 2E-12 to 20E-3 or

  • str, strictly in MIN, MAX, DEF, UP, DOWN

property data_buffer_size: Any

Get the data buffer size (int).

init()

Initiate a trigger for all actions.

init_acquisition()

Initiate a trigger for action ‘ACQuire’.

property input_enabled: Any

Control the instrument input relay (bool).

property interlock_enabled: Any

Get the interlock status (bool).

property measure: Any

Measure the defined parameter(s) with a spot measurement.

Returns:

float or list of float

property trigger_acquisition_bypass_once_enabled: Any

Control the bypass for the event detector in the trigger layer for action ‘ACQuire’ (bool).

property trigger_acquisition_count: Any

Control the trigger count for action ‘ACQuire’.

Type:
  • int, strictly from 1 to 100000 or

  • str, strictly in MIN, MAX, DEF, INF

INF is equivalent to 2147483647.

property trigger_acquisition_delay: Any

Control the trigger delay for action ‘ACQuire’ in seconds.

Type:
  • float, strictly from 0 to 1E5 or

  • str, strictly in MIN, MAX, DEF

property trigger_acquisition_is_idle: Any

Get the idle status of action ‘ACQuire’ (bool).

The command waits until the status is changed to idle.

property trigger_acquisition_output_enabled: Any

Control the trigger output for action ‘ACQuire’ (bool).

It is for the status change between the idle state and the trigger layer.

property trigger_acquisition_output_signal: Any

Control the trigger signal output for action ‘ACQuire’.

Type:

str, strictly in INT1, INT2, LAN, TOUT, EXT1 to EXT7

  • INT1 and INT2 selects the internal bus 1 or 2.

  • LAN selects a LAN port.

  • EXT1 to EXT7 selects the GPIO pin n, which is an output port of the Digital I/O D-sub connector on the rear panel. n = 1 to 7.

  • TOUT: selects the BNC Trigger Out.

It is for the status change between the idle state and the trigger layer.

property trigger_acquisition_source: Any

Control the trigger source for action ‘ACQuire’.

Type:

str, strictly in AINT, BUS, TIM, INT1, INT2, LAN, TIN, EXT1 to EXT7

  • AINT automatically selects the trigger source most suitable for the present operating mode by using internal algorithms.

  • BUS selects the remote interface trigger command such as the group execute trigger (GET) and the TRG command.

  • TIM selects a signal internally generated every interval set by the trigger_acquisition_timer.

  • INT1 and INT2 selects a signal from the internal bus 1 or 2.

  • LAN selects the LXI trigger specified by trigger_acquisition_source_lan_id.

  • EXT1 to EXT7 selects a signal from the GPIO pin n, which is an input port of the Digital I/O D-sub connector on the rear panel. n = 1 to 7.

  • TIN selects the BNC Trigger In.

property trigger_acquisition_source_lan_id: Any

Control the source for LAN triggers for action ‘ACQuire’.

Type:

str, strictly from LAN0 to LAN7

property trigger_acquisition_timer: Any

Control the timer interval of the trigger source for action ‘ACQuire’ in seconds.

Type:
  • float, strictly from 1E-5 to 1E5 or

  • str, strictly in MIN, MAX, DEF

property trigger_all_bypass_once_enabled: Any

Set the bypass for the event detector in the trigger layer for action ‘ALL’ (bool).

property trigger_all_count: Any

Set the trigger count for action ‘ALL’.

Type:
  • int, strictly from 1 to 100000 or

  • str, strictly in MIN, MAX, DEF, INF

INF is equivalent to 2147483647.

property trigger_all_delay: Any

Set the trigger delay for action ‘ALL’ in seconds.

Type:
  • float, strictly from 0 to 1E5 or

  • str, strictly in MIN, MAX, DEF

property trigger_all_is_idle: Any

Get the trigger idle status for action ‘ALL’ (bool).

The command waits until the status is changed to idle.

property trigger_all_output_enabled: Any

Set the trigger output for action ‘ALL’ (bool).

It is for the status change between the idle state and the trigger layer.

property trigger_all_output_signal: Any

Set the trigger signal output for action ‘ALL’.

Type:

str, strictly in INT1, INT2, LAN, TOUT, EXT1 to EXT7

  • INT1 and INT2 selects the internal bus 1 or 2.

  • LAN selects a LAN port.

  • EXT1 to EXT7 selects the GPIO pin n, which is an output port of the Digital I/O D-sub connector on the rear panel. n = 1 to 7.

  • TOUT selects the BNC Trigger Out.

It is for the status change between the idle state and the trigger layer.

property trigger_all_source: Any

Set the trigger source for action ‘ALL’.

Type:

str, strictly in AINT, BUS, TIM, INT1, INT2, LAN, TIN, EXT1 to EXT7

  • AINT automatically selects the trigger source most suitable for the present operating mode by using internal algorithms.

  • BUS selects the remote interface trigger command such as the group execute trigger (GET) and the TRG command.

  • TIM selects a signal internally generated every interval set by trigger_all_timer.

  • INT1 and INT2 selects a signal from the internal bus 1 or 2.

  • LAN selects the LXI trigger specified by trigger_all_source_lan_id.

  • EXT1 to EXT7 selects a signal from the GPIO pin n, which is an input port of the Digital I/O D-sub connector on the rear panel. n = 1 to 7.

  • TIN selects the BNC Trigger In.

property trigger_all_source_lan_id: Any

Set the source for LAN triggers for action ‘ALL’.

Type:

str, strictly from LAN0 to LAN7

property trigger_all_timer: Any

Set the timer interval of the trigger source for action ‘ALL’ in seconds.

Type:
  • float, strictly from 1E-5 to 1E5 or

  • str, strictly in MIN, MAX, DEF

property zero_corrected: Any

Control the zero correction function (bool).

class pymeasure.instruments.agilent.AgilentB2983(adapter, name='Agilent/Keysight B2980A/B series', **kwargs)

Bases: AgilentB2981, BatteryMixin

A class representing the Agilent/Keysight B2983A/B.

The B2983 is a Femto/Picoammeterwith with battery operation.

class pymeasure.instruments.agilent.AgilentB2985(adapter, name='Agilent/Keysight B2980A/B series', **kwargs)

Bases: AgilentB2981

A class representing the Agilent/Keysight B2985A/B.

The B2985 is a Femto/Picoammeter and Electrometer/High Resistance Meter.

abort_transient()

Abort action ‘TRANSient’.

arm_transient()

Send an immediate arm trigger for action ‘TRANSient’.

When the status of the specified action is initiated, the arm trigger causes a layer change from arm to trigger.

property arm_transient_bypass_once_enabled: Any

Control the bypass for the event detector in the arm layer for action ‘TRANSient’ (bool).

property arm_transient_count: Any

Control the arm trigger count for action ‘TRANSient’.

Type:
  • int, strictly from 1 to 100000 or

  • str, strictly in MIN, MAX, DEF, INF

INF is equivalent to 2147483647.

property arm_transient_delay: Any

Control the arm trigger delay for action ‘TRANSient’ in seconds.

Type:
  • float, strictly from 0 to 1E5 or

  • str, strictly in MIN, MAX, DEF

property arm_transient_output_enabled: Any

Control the arm trigger output for action ‘TRANSient’ (bool).

It is for the status change between the idle state and the arm layer.

property arm_transient_output_signal: Any

Control the arm trigger output for action ‘TRANSient’.

Type:

str, strictly in INT1, INT2, LAN, TOUT, EXT1 to EXT7

  • INT1 and INT2 selects the internal bus 1 or 2.

  • LAN selects a LAN port.

  • EXT1 to EXT7 selects the GPIO pin n, which is an output port of the Digital I/O D-sub connector on the rear panel. n = 1 to 7.

  • TOUT selects the BNC Trigger Out.

It is for the status change between the idle state and the arm layer.

property arm_transient_source: Any

Control the arm trigger source for action ‘TRANSient’.

Type:

str, strictly in AINT, BUS, TIM, INT1, INT2, LAN, TIN, EXT1 to EXT7

  • AINT automatically selects the arm source most suitable for the present operating mode by using internal algorithms.

  • BUS selects the remote interface trigger command such as the group execute trigger (GET) and the TRG command.

  • TIM selects a signal internally generated every interval set by arm_transient_timer.

  • INT1 and INT2 selects a signal from the internal bus 1 or 2.

  • LAN selects the LXI trigger specified by arm_transient_source_lan_id.

  • EXT1 to EXT7 selects a signal from the GPIO pin n, which is an input port of the Digital I/O D-sub connector on the rear panel. n = 1 to 7.

  • TIN selects the BNC Trigger In.

property arm_transient_source_lan_id: Any

Control the source for LAN arm triggers for action ‘TRANSient’.

Type:

str, strictly from LAN0 to LAN7

property arm_transient_timer: Any

Control the timer interval of the arm trigger source for action ‘TRANSient’ in seconds.

Type:
  • float, strictly from 1E-5 to 1E5

  • str, strictly in MIN, MAX, DEF

property charge: Any

Measure charge with a spot measurement in Coulombs.

Returns:

float

property charge_range: Any

Control the range for the charge measurement in Coulombs.

Type:
  • float, strictly from 2E-9 to 2E-6 or

  • str, strictly in MIN, MAX, DEF, UP, DOWN

property function: Any

Control the measurement function.

Type:

str, strictly in CURR, CHAR, VOLT, RES

property humidity: Any

Measure the relative humidity in percent.

Returns:

float

init_transient()

Initiate a trigger for action ‘TRANSient’.

property resistance: Any

Measure resistance with a spot measurement in Ohms.

Returns:

float

property resistance_range: Any

Control the range for the resistance measurement.

Type:
  • float, strictly from 1E6 to 1E15 or

  • str, strictly in MIN, MAX, DEF, UP, DOWN

property source_enabled: Any

Control the voltage source output relay (bool).

property source_low_state: Any

Control the voltage source low terminal state.

Type:

str, strictly FLO or COMM

  • FLO: low terminal is floating.

  • COMM: low terminal is connected to Common.

property source_off_state: Any

Control the voltage source off condition.

Type:

str, strictly in ZERO, HIZ, NORM

HIGH Z

  • Output relay: off (open)

  • The voltage source setting is not changed.

  • This status is available only when the 20 V range is used.

NORMAL

  • Output voltage: 0 V

  • Output relay: off (open)

ZERO

  • Output voltage: 0 V in the present voltage range

property source_voltage: Any

Control the source voltage in Volts.

Type:

float, strictly from -1050 to 1050

For voltages > 20V the interlock must be closed.

Range

Resolution

Output voltage

Maximum current

20 V

700 µV

-21 V ≤ V ≤ 21 V

+/-20 mA

1000 V

35 mV

-1 V ≤ V ≤ 1000 V

+/-1.0 mA

-1000 V

35 mV

-1000 V ≤ V ≤ 1 V

+/-1.0 mA

property source_voltage_range: Any

Control the source voltage range.

Type:
  • float, strictly from -1000 to 1000 or

  • str, strictly in MIN, MAX, DEF

property temperature: Any

Measure the temperature.

Returns:

float

The unit of temperature is controlled by temperature_unit:

property temperature_sensor: Any

Control the tempertature sensor.

Type:

str, strictly in TC, HSEN

  • TC selects the thermocouple.

  • HSEN selects the temperature sensor within the humidity sensor.

property temperature_unit: Any

Control the tempertature unit.

Type:

str, strictly in C, CEL, F, FAR, K

  • C, CEL selects degree Celsius.

  • F, FAR selects degree Fahrenheit.

  • K selects Kelvin.

property trigger_transient_bypass_once_enabled: Any

Control the bypass for the event detector in trigger layer for action ‘TRANSient’ (bool).

property trigger_transient_count: Any

Control the trigger count for action ‘TRANSient’.

Type:
  • int, strictly from 1 to 100000 or

  • str, strictly in MIN, MAX, DEF, INF

INF is equivalent to 2147483647.

property trigger_transient_delay: Any

Control the trigger delay for action ‘TRANSient’ in seconds.

Type:
  • float, strictly from 0 to 1E5 or

  • str, strictly in MIN, MAX, DEF

property trigger_transient_is_idle: Any

Get idle the status of action ‘TRANSient’ (bool).

The command waits until the status is changed to idle.

property trigger_transient_output_enabled: Any

Control the trigger output for action ‘TRANSient’ (bool).

It is for the status change between the idle state and the trigger layer.

property trigger_transient_output_signal: Any

Control the trigger signal output for action ‘TRANSient’.

Type:

str, strictly in INT1, INT2, LAN, TOUT, EXT1 to EXT7

  • INT1, INT2 selects the internal bus 1 or 2.

  • LAN selects a LAN port.

  • EXT1 to EXT7 selects the GPIO pin n, which is an output port of the Digital I/O D-sub connector on the rear panel. n = 1 to 7.

  • TOUT selects the BNC Trigger Out.

It is for the status change between the idle state and the trigger layer.

property trigger_transient_source: Any

Control the trigger source for action ‘TRANSient’.

Type:

str, strictly in AINT, BUS, TIM, INT1, INT2, LAN, TIN, EXT1 to EXT7

  • AINT automatically selects the trigger source most suitable for the present operating mode by using internal algorithms.

  • BUS selects the remote interface trigger command such as the group execute trigger (GET) and the TRG command.

  • TIM selects a signal internally generated every interval set by trigger_transient_timer.

  • INT1 and INT2 selects a signal from the internal bus 1 or 2.

  • LAN selects the LXI trigger specified by trigger_transient_source_lan_id.

  • EXT1 to EXT7 selects a signal from the GPIO pin n, which is an input port of the Digital I/O D-sub connector on the rear panel. n = 1 to 7.

  • TIN selects the BNC Trigger In.

property trigger_transient_source_lan_id: Any

Control the source for LAN triggers for action ‘TRANSient’.

Type:

str, strictly from LAN0 to LAN7

property trigger_transient_timer: Any

Control the timer interval of the trigger source for action ‘TRANSient’.

Type:
  • float, strictly from 1E-5 to 1E5 or

  • str, strictly in MIN, MAX, DEF

property voltage: Any

Measure voltage with a spot (one-shot) measurement in Volts.

Returns:

float

property voltage_range: Any

Control the range for the voltage measurement in Volts.

Type:
  • float, strictly from 2 to 20 or

  • str, strictly in MIN, MAX, DEF, UP, DOWN

class pymeasure.instruments.agilent.AgilentB2987(adapter, name='Agilent/Keysight B2980A/B series', **kwargs)

Bases: AgilentB2985, BatteryMixin

A class representing the Agilent/Keysight B2987A/B.

The B2987 is a Femto/Picoammeter and Electrometer/High Resistance Meter with battery operation.

class pymeasure.instruments.agilent.agilentB298x.BatteryMixin

Bases: object

A class representing the B2983/7 battery functions.

property battery_cycles: Any

Get the battery cycle count (int).

property battery_level: Any

Get the percentage of the remaining battery capacity (int).

property battery_selftest_passed: Any

Get the battery self-test result (bool).