Hardware control class to controls SRS SG390 devices. More...
Inheritance diagram for mw_source_srssg.MicrowaveSRSSG:
Collaboration diagram for mw_source_srssg.MicrowaveSRSSG:
Public Member Functions | |
| def | on_activate (self) |
| Initialisation performed during activation of the module. More... | |
| def | on_deactivate (self) |
| Deinitialisation performed during deactivation of the module. More... | |
| def | cw_on (self) |
| def | get_status (self) |
| def | get_limits (self) |
| Return the device-specific limits in a nested dictionary. More... | |
| def | off (self) |
| Switches off any microwave output. More... | |
| def | get_power (self) |
| Gets the microwave output power. More... | |
| def | get_frequency (self) |
| Gets the frequency of the microwave output. More... | |
| def | set_cw (self, frequency=None, power=None, useinterleave=None) |
| Configures the device for cw-mode and optionally sets frequency and/or power. More... | |
| def | list_on (self) |
| Switches on the list mode. More... | |
| def | set_list (self, frequency=None, power=None) |
| Sets the MW mode to list mode. More... | |
| def | reset_listpos (self) |
| Reset of MW List Mode position to start from first given frequency. More... | |
| def | sweep_on (self) |
| Switches on the sweep mode. More... | |
| def | set_sweep (self, start, stop, step, power) |
| Sweep from frequency start to frequency sto pin steps of width stop with power. | |
| def | reset_sweeppos (self) |
| Reset of MW sweep position to start. More... | |
| def | set_ext_trigger (self, pol, timing) |
| Set the external trigger for this device with proper polarization. More... | |
| def | trigger (self) |
| Trigger the next element in the list or sweep mode programmatically. More... | |
| def | on (self) |
| Switches on any preconfigured microwave output. More... | |
| def | set_power (self, power=0.) |
| Sets the microwave output power. More... | |
| def | set_frequency (self, freq=0.) |
| Sets the frequency of the microwave output. More... | |
| def | reset_device (self) |
| Resets the device and sets the default values. More... | |
 Public Member Functions inherited from core.module.BaseMixin | |
| def | __init__ (self, manager, name, config=None, callbacks=None, kwargs) |
| Initialise Base class object and set up its state machine. More... | |
| def | log (self) |
| Returns a logger object. | |
| def | is_module_threaded (self) |
| Returns whether the module shall be started in a thread. | |
| def | on_activate (self) |
| Method called when module is activated. More... | |
| def | on_deactivate (self) |
| Method called when module is deactivated. More... | |
| def | getStatusVariables (self) |
| Return a dict of variable names and their content representing the module state for saving. More... | |
| def | setStatusVariables (self, variableDict) |
| Give a module a dict of variable names and their content representing the module state. More... | |
| def | getConfiguration (self) |
| Return the configration dictionary for this module. More... | |
| def | get_connector (self, connector_name) |
| Return module connected to the given named connector. More... | |
| Public Member Functions inherited from core.module.ModuleMeta | |
| def | __new__ (cls, name, bases, attrs) |
| Collect declared Connectors, ConfigOptions and StatusVars into dictionaries. More... | |
Public Attributes | |
| rm | |
| Public Attributes inherited from core.module.BaseMixin | |
| module_state | |
| connectors | |
Detailed Description
Hardware control class to controls SRS SG390 devices.
Example config for copy-paste:
mw_source_srssg: module 'microwave.mw_source_srssg.MicrowaveSRSSG' gpib_address 'GPIB0::12::INSTR' gpib_timeout 10
Member Function Documentation
◆ get_frequency()
| def mw_source_srssg.MicrowaveSRSSG.get_frequency | ( | self | ) |
Gets the frequency of the microwave output.
- Returns
- float: frequency (in Hz), which is currently set for this device
◆ get_limits()
| def mw_source_srssg.MicrowaveSRSSG.get_limits | ( | self | ) |
Return the device-specific limits in a nested dictionary.
- Returns
- MicrowaveLimits: object containing Microwave limits
◆ get_power()
| def mw_source_srssg.MicrowaveSRSSG.get_power | ( | self | ) |
Gets the microwave output power.
- Returns
- float: the power set at the device in dBm
◆ list_on()
| def mw_source_srssg.MicrowaveSRSSG.list_on | ( | self | ) |
Switches on the list mode.
- Returns
- int: error code (0:OK, -1:error)
◆ off()
| def mw_source_srssg.MicrowaveSRSSG.off | ( | self | ) |
Switches off any microwave output.
Must return AFTER the device is actually stopped.
- Returns
- int: error code (0:OK, -1:error)
◆ on()
| def mw_source_srssg.MicrowaveSRSSG.on | ( | self | ) |
Switches on any preconfigured microwave output.
- Returns
- int: error code (0:OK, -1:error)
◆ on_activate()
| def mw_source_srssg.MicrowaveSRSSG.on_activate | ( | self | ) |
Initialisation performed during activation of the module.
◆ on_deactivate()
| def mw_source_srssg.MicrowaveSRSSG.on_deactivate | ( | self | ) |
Deinitialisation performed during deactivation of the module.
◆ reset_device()
| def mw_source_srssg.MicrowaveSRSSG.reset_device | ( | self | ) |
Resets the device and sets the default values.
◆ reset_listpos()
| def mw_source_srssg.MicrowaveSRSSG.reset_listpos | ( | self | ) |
Reset of MW List Mode position to start from first given frequency.
- Returns
- int: error code (0:OK, -1:error)
◆ reset_sweeppos()
| def mw_source_srssg.MicrowaveSRSSG.reset_sweeppos | ( | self | ) |
Reset of MW sweep position to start.
- Returns
- int: error code (0:OK, -1:error)
◆ set_cw()
| def mw_source_srssg.MicrowaveSRSSG.set_cw | ( | self, | |
frequency = None, |
|||
power = None, |
|||
useinterleave = None |
|||
| ) |
Configures the device for cw-mode and optionally sets frequency and/or power.
- Parameters
-
float frequency: frequency to set in Hz float power: power to set in dBm
- Returns
- tuple(float, float, str): with the relation current frequency in Hz, current power in dBm, current mode
◆ set_ext_trigger()
| def mw_source_srssg.MicrowaveSRSSG.set_ext_trigger | ( | self, | |
| pol, | |||
| timing | |||
| ) |
Set the external trigger for this device with proper polarization.
- Parameters
-
float timing: estimated time between triggers TriggerEdge pol: polarisation of the trigger (basically rising edge or falling edge)
- Returns
- object, float: current trigger polarity [TriggerEdge.RISING, TriggerEdge.FALLING], trigger timing
◆ set_frequency()
| def mw_source_srssg.MicrowaveSRSSG.set_frequency | ( | self, | |
freq = 0. |
|||
| ) |
Sets the frequency of the microwave output.
- Parameters
-
float freq: the frequency (in Hz) set for this device
- Returns
- int: error code (0:OK, -1:error)
◆ set_list()
| def mw_source_srssg.MicrowaveSRSSG.set_list | ( | self, | |
frequency = None, |
|||
power = None |
|||
| ) |
Sets the MW mode to list mode.
- Parameters
-
list freq: list of frequencies in Hz float power: MW power of the frequency list in dBm
- Returns
- int: error code (0:OK, -1:error)
◆ set_power()
| def mw_source_srssg.MicrowaveSRSSG.set_power | ( | self, | |
power = 0. |
|||
| ) |
Sets the microwave output power.
- Parameters
-
float power: the power (in dBm) set for this device
- Returns
- int: error code (0:OK, -1:error)
◆ sweep_on()
| def mw_source_srssg.MicrowaveSRSSG.sweep_on | ( | self | ) |
Switches on the sweep mode.
- Returns
- int: error code (0:OK, -1:error)
◆ trigger()
| def mw_source_srssg.MicrowaveSRSSG.trigger | ( | self | ) |
Trigger the next element in the list or sweep mode programmatically.
- Returns
- int: error code (0:OK, -1:error)
Ensure that the Frequency was set AFTER the function returns, or give the function at least a save waiting time corresponding to the frequency switching speed.
The documentation for this class was generated from the following file:
- hardware/microwave/mw_source_srssg.py
