rminstr.instruments.KS_E8257D

Classes

SignalGenerator

Signal generator implementation of KS_E8257D.

Package Contents

class rminstr.instruments.KS_E8257D.SignalGenerator(visa_resource: str, resource_manager: pyvisa.ResourceManager = None, log_path: str = None)

Bases: rminstr.instruments.communications.Instrument, rminstr.instruments.measurement_functionalities.ABC_SignalGenerator

Signal generator implementation of KS_E8257D.

Initialize KS_E8257D as a signal generator.

Parameters:
visa_resourcevisa.Resource

visa resource for the instrument.

resource_managervisa.ResourceManager, optional

Pyvisa resource manager for opening visa resources. The default is None.

log_pathstr, optional

If provided, will log at the specified path. The default is None.

Returns:
None.
info_dict
default_settings
trigger_count = 0
initial_setup(**kwargs)

Initialize instrument.

Parameters:
**kwargslist, optional

List of strings, commands to be sent directly to machine. The default is None.

Returns:
None.
setup(dBm: float = None, f_GHz: float = None, source_on: bool = None, AM: bool = None, AM_ext_port: int = None, AM_ext_sensitivity_percent_per_volt: float = None, AM_installed: bool = True, **kwargs)

Adjust settings on the machine.

Parameters:
dBmfloat, optional

Power setting in dBm. The default is None.

f_GHzfloat, optional

Frequency setting in GHz. The default is None.

source_onbool, optional

Turns source on when True, off when False. The default is None.

portint, optional

Determines which port is used for the commands. The default is None.

AMbool, optional

Turns on or off the Amplitude Modulation. The default is None.

AM_ext_portint, optional

What port to use for Amplitude Modulation. The default is None.

AM_ext_sensitivity_percent_per_voltfloat, optional

Sensitivity of the Amplitude Modulation in percent per volt. The default is None.

other_commandslist, optional

List of other command not covered by keyword arguments. Written directly to instrument. The default is None.

Returns:
None.
query_state() → str

Check the state.

Returns:
str

Current state of the instrument.

raise_errors()

Query the status of the instrument. If there are errors, raise them as Python errors.

Returns:
None.
Raises:
InstrumentError

Will raise the error in the instrument as a python error if present.

get_errors()

Query the status of the instrument. If there are errors, returns the error message.

Returns:
str

Instruments error message.

fetch_data()

Do nothing, this class collects no data.

get_frequency()

Return the frequency in GHz.