Hardware class to controls a SynthHD Pro. More...
Inheritance diagram for mw_source_windfreak_synthhdpro.MicrowaveSynthHDPro:
Collaboration diagram for mw_source_windfreak_synthhdpro.MicrowaveSynthHDPro:
Public Member Functions | |
| def | on_activate (self) |
| Initialisation performed during activation of the module. | |
| def | on_deactivate (self) |
| Deinitialisation performed during deactivation of the module. | |
| def | get_limits (self) |
| SynthHD Pro limits. | |
| def | get_status (self) |
| def | off (self) |
| Switches off any microwave output. More... | |
| def | get_power (self) |
| Gets the microwave output power. 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, dwelltime) |
| 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... | |
 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 | |
| model | |
| sernr | |
| mod_hw | |
| mod_fw | |
| current_output_mode | |
| output_active | |
| mw_frequency_list | |
| Public Attributes inherited from core.module.BaseMixin | |
| module_state | |
| connectors | |
Detailed Description
Hardware class to controls a SynthHD Pro.
Example config for copy-paste:
mw_source_synthhd: module 'microwave.mw_source_windfreak_synthhdpro.MicrowaveSynthHDPro' serial_port 'COM3' serial_timeout 10 # in seconds output_channel 0 # either 0 or 1
Member Function Documentation
◆ get_power()
| def mw_source_windfreak_synthhdpro.MicrowaveSynthHDPro.get_power | ( | self | ) |
Gets the microwave output power.
- Returns
- float: the power set at the device in dBm
◆ off()
| def mw_source_windfreak_synthhdpro.MicrowaveSynthHDPro.off | ( | self | ) |
Switches off any microwave output.
- Returns
- int: error code (0:OK, -1:error)
◆ reset_listpos()
| def mw_source_windfreak_synthhdpro.MicrowaveSynthHDPro.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 mw_source_windfreak_synthhdpro.MicrowaveSynthHDPro.reset_sweeppos | ( | self | ) |
Reset of MW sweep mode position to start (start frequency)
- Returns
- int: error code (0:OK, -1:error)
◆ set_cw()
| def mw_source_windfreak_synthhdpro.MicrowaveSynthHDPro.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
- float, float, str: current frequency in Hz, current power in dBm, current mode
◆ set_ext_trigger()
| def mw_source_windfreak_synthhdpro.MicrowaveSynthHDPro.set_ext_trigger | ( | self, | |
| pol, | |||
| dwelltime | |||
| ) |
Set the external trigger for this device with proper polarization.
- Parameters
-
TriggerEdge pol: polarisation of the trigger (basically rising edge or falling edge) dwelltime minimum dwell time
- Returns
- object: current trigger polarity [TriggerEdge.RISING, TriggerEdge.FALLING]
◆ set_list()
| def mw_source_windfreak_synthhdpro.MicrowaveSynthHDPro.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 mw_source_windfreak_synthhdpro.MicrowaveSynthHDPro.sweep_on | ( | self | ) |
Switches on the sweep mode.
- Returns
- int: error code (0:OK, -1:error)
◆ trigger()
| def mw_source_windfreak_synthhdpro.MicrowaveSynthHDPro.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.
The documentation for this class was generated from the following file:
- hardware/microwave/mw_source_windfreak_synthhdpro.py
