This is the Interface class to define the controls for the simple microwave hardware. More...
Public Member Functions | |
| def | off (self) |
| def | get_status (self) |
| def | get_power (self) |
| Gets the microwave output power for the currently active mode. More... | |
| def | get_frequency (self) |
| def | cw_on (self) |
| def | set_cw (self, frequency=None, power=None) |
| Configures the device for cw-mode and optionally sets frequency and/or power. More... | |
| def | list_on (self) |
| def | set_list (self, frequency=None, power=None) |
| Configures the device for list-mode and optionally sets frequencies and/or power. More... | |
| def | reset_listpos (self) |
| Reset of MW list mode position to start (first frequency step) More... | |
| def | sweep_on (self) |
| Switches on the sweep mode. More... | |
| def | set_sweep (self, start=None, stop=None, step=None, power=None) |
| def | reset_sweeppos (self) |
| Reset of MW sweep mode position to start (start frequency) 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 | get_limits (self) |
| Return the device-specific limits in a nested dictionary. More... | |
 Public Member Functions inherited from core.module.ModuleMeta | |
| def | __new__ (cls, name, bases, attrs) |
| Collect declared Connectors, ConfigOptions and StatusVars into dictionaries. More... | |
Detailed Description
This is the Interface class to define the controls for the simple microwave hardware.
Member Function Documentation
◆ get_limits()
| def microwave_interface.MicrowaveInterface.get_limits | ( | self | ) |
Return the device-specific limits in a nested dictionary.
- Returns
- MicrowaveLimits: Microwave limits object
◆ get_power()
| def microwave_interface.MicrowaveInterface.get_power | ( | self | ) |
Gets the microwave output power for the currently active mode.
- Returns
- float: the output power in dBm
◆ reset_listpos()
| def microwave_interface.MicrowaveInterface.reset_listpos | ( | self | ) |
Reset of MW list mode position to start (first frequency step)
- Returns
- int: error code (0:OK, -1:error)
◆ reset_sweeppos()
| def microwave_interface.MicrowaveInterface.reset_sweeppos | ( | self | ) |
Reset of MW sweep mode position to start (start frequency)
- Returns
- int: error code (0:OK, -1:error)
◆ set_cw()
| def microwave_interface.MicrowaveInterface.set_cw | ( | self, | |
frequency = None, |
|||
power = 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 microwave_interface.MicrowaveInterface.set_ext_trigger | ( | self, | |
| pol, | |||
| timing | |||
| ) |
Set the external trigger for this device with proper polarization.
- Parameters
-
TriggerEdge pol: polarisation of the trigger (basically rising edge or falling edge) timing estimated time between triggers
- Returns
- object, float: current trigger polarity [TriggerEdge.RISING, TriggerEdge.FALLING], trigger timing as queried from device
◆ set_list()
| def microwave_interface.MicrowaveInterface.set_list | ( | self, | |
frequency = None, |
|||
power = None |
|||
| ) |
Configures the device for list-mode and optionally sets frequencies and/or power.
- Parameters
-
list frequency: list of frequencies in Hz float power: MW power of the frequency list in dBm
- Returns
- list, float, str: current frequencies in Hz, current power in dBm, current mode
◆ sweep_on()
| def microwave_interface.MicrowaveInterface.sweep_on | ( | self | ) |
Switches on the sweep mode.
- Returns
- int: error code (0:OK, -1:error)
◆ trigger()
| def microwave_interface.MicrowaveInterface.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:
- interface/microwave_interface.py
