# devices.keithley:Keithley2701


Interface for the Keithley 2701 multimeter.


Usage

``` python
devices.keithley:Keithley2701(
    interface,
    **kwargs,
)
```


Provides methods to configure and control the Keithley 2701 for various measurement types including resistance and voltage.


## Attributes


`config_params: dict`  
Dictionary of configuration parameters and their corresponding commands

`triggered: bool`  
Flag indicating if a measurement has been triggered


## Methods

| Name | Description |
|----|----|
| [__init__()](#__init__) | Initialize the Keithley 2701 device. |
| [configure2WireOhm()](#configure2WireOhm) | Configure the Keithley 2701 to detect 2-wire resistance. |
| [configure4WireOhm()](#configure4WireOhm) | Configure the Keithley 2701 to detect 4-wire resistance. |
| [configureVolt()](#configureVolt) | Configure the Keithley 2701 to detect voltages. |
| [getReading()](#getReading) | Get a reading from the device if it has been triggered. |
| [triggerReading()](#triggerReading) | Trigger a measurement reading from the device. |

------------------------------------------------------------------------


### \_\_init\_\_()


Initialize the Keithley 2701 device.


Usage

``` python
__init__(
    interface,
    **kwargs,
)
```


#### Parameters


`interface: str`  
VISA resource name for the instrument

`**kwargs: dict`  
Additional parameters for VISA communication


#### Notes

Default settings include: - write_termination = LF - read_termination = LF - timeout = 10000 ms

------------------------------------------------------------------------


### configure2WireOhm()


Configure the Keithley 2701 to detect 2-wire resistance.


Usage

``` python
configure2WireOhm(
    digits=None,
    count=None,
    window=None,
    NPLC=None,
    dFil=None,
    resistance_range=None,
    rangeAuto=None,
    trigBus=None,
    repeatingFilter=None,
    reset=False,
)
```


#### Parameters


`digits: int = None`  
Number of digits to display (4-8)

`count: int = None`  
Filter count for the digital filter

`window: float = None`  
Filter window for the digital filter

`NPLC: int = None`  
Number of power line cycles to integrate over

`dFil: bool = None`  
If True, turn on the digital filter. If False window and filter count are ignored

`resistance_range: float = None`  
Range of the resistance detection. Selected by the instrument to include the value

`rangeAuto: bool = None`  
Automatic detection of the measurement range. Takes additional time during measurements

`trigBus: bool = None`  
Sets trigger source to BUS if True

`repeatingFilter: bool = None`  
If True set the filter to repeating, if False to moving

`reset: bool = ``False`  
If True, the device is reset prior to configuration (default False)


#### Returns


`None`  


------------------------------------------------------------------------


### configure4WireOhm()


Configure the Keithley 2701 to detect 4-wire resistance.


Usage

``` python
configure4WireOhm(
    digits=None,
    count=None,
    window=None,
    NPLC=None,
    dFil=None,
    resistance_range=None,
    rangeAuto=None,
    trigBus=None,
    repeatingFilter=None,
    reset=False,
)
```


#### Parameters


`digits: int = None`  
Number of digits to display (4-8)

`count: int = None`  
Filter count for the digital filter

`window: float = None`  
Filter window for the digital filter

`NPLC: int = None`  
Number of power line cycles to integrate over

`dFil: bool = None`  
If True, turn on the digital filter. If False window and filter count are ignored

`resistance_range: float = None`  
Range of the resistance detection. Selected by the instrument to include the value

`rangeAuto: bool = None`  
Automatic detection of the measurement range. Takes additional time during measurements

`trigBus: bool = None`  
Sets trigger source to BUS if True

`repeatingFilter: bool = None`  
If True set the filter to repeating, if False to moving

`reset: bool = ``False`  
If True, the device is reset prior to configuration (default False)


#### Returns


`None`  


------------------------------------------------------------------------


### configureVolt()


Configure the Keithley 2701 to detect voltages.


Usage

``` python
configureVolt(
    digits=None,
    count=None,
    window=None,
    NPLC=None,
    dFil=None,
    voltage_range=None,
    rangeAuto=None,
    trigBus=None,
    repeatingFilter=None,
    reset=False,
)
```


#### Parameters


`digits: int = None`  
Number of digits to display (4-8)

`count: int = None`  
Filter count for the digital filter

`window: float = None`  
Filter window for the digital filter

`NPLC: int = None`  
Number of power line cycles to integrate over

`dFil: bool = None`  
If True, turn on the digital filter. If False window and filter count are ignored

`voltage_range: float = None`  
Range of the voltage detection. Selected by the instrument to include the value

`rangeAuto: bool = None`  
Automatic detection of the measurement range. Takes additional time during measurements

`trigBus: bool = None`  
Sets trigger source to BUS if True

`repeatingFilter: bool = None`  
If True set the filter to repeating, if False to moving

`reset: bool = ``False`  
If True, the device is reset prior to configuration (default False)


#### Returns


`None`  


------------------------------------------------------------------------


### getReading()


Get a reading from the device if it has been triggered.


Usage

``` python
getReading()
```


Retrieves the measurement data from the device, clears the triggered flag, and returns the result as a float.


#### Returns


`float`  
The measured value from the device


#### Notes

Only works if triggerReading() has been called previously.

------------------------------------------------------------------------


### triggerReading()


Trigger a measurement reading from the device.


Usage

``` python
triggerReading()
```


Sends the trigger command to the device and sets the triggered flag to True.


#### Returns


`None`