qmi.instruments.cobolt.laser_06_01
Instrument driver for the Cobolt CW Laser
Classes
|
Instrument driver for the Cobolt 06-01 series diode laser. |
- class qmi.instruments.cobolt.laser_06_01.Cobolt_Laser_06_01(context: QMI_Context, name: str, transport: str)
Instrument driver for the Cobolt 06-01 series diode laser.
- open() None
Connect to the instrument hardware.
When this method returns, the instrument must be ready for interaction via calls to instrument-specific methods.
Subclasses can extend this method to implement instrument-specific initialization. If they do, they should call
super().open()as a last statement.
- close() None
Close the connection to the instrument hardware and release associated resources.
When this method returns, the instrument must not be used again unless it is first re-opened by calling the open() method.
Subclasses can extend this method if they have specific resources to close. If they do, they should call
super().close()as a last statement.
- reset() None
Reset the instrument, returning (most) settings to their defaults.
- get_idn() QMI_InstrumentIdentification
Read instrument type and version and return QMI_InstrumentIdentification instance.
- get_laser_on_state() bool
Return True if the laser is on, False if it is off.
- set_laser_on_state(value: bool) None
Set the laser on or off.
- get_operating_hours() float
Get number of hours the laser head has operated.
- get_interlock_state() bool
Return True if interlock is open, False if interlock allow laser on.
- get_output_power_setpoint() float
Get power set point [W].
- set_output_power_setpoint(value: float) None
Set laser output power [W].
- get_output_power() float
Get actual laser output power [W].
- get_drive_current() float
Get laser drive current [mA]
- set_drive_current(value: float) None
Set laser drive current [mA].
- set_constant_power_mode() None
Enter constant power mode.
- set_constant_current_mode() None
Enter constant current mode.
- get_fault() int
Get operating fault state.
See Cobolt_Laser_06_01.FAULT_CODES for the meaning of return codes.
- clear_fault() None
Clear laser fault.
- set_modulation_mode() None
Enter modulatuion mode.
- get_digital_modulation_state() bool
Return True if digital modulation is enabled.
- set_digital_modulation_state(value: bool) None
Set digital modulation enable state.
- get_analog_modulation_state() bool
Get analog modulation enable state.
- set_analog_modulation_state(value: bool) None
Set analog modulation enable state.
- get_operating_mode() int
Get current operating mode.
See Cobolt_Laser_06_01.OPERATING_MODES for the meaning of return codes.
- get_analog_low_impedance_state() bool
Return True if analog low impedance (50 Ohm) state is enabled.
- set_analog_low_impedance_state(value: bool) None
Enable or disable analog low impedance (50 Ohm) state.
- get_autostart_state() bool
Return True if autostart is enabled.
NOTE: This command is not in the manual. Private communication with Cobolt.
- set_autostart_state(value: bool) None
Enable or disable autostart mode.
NOTE: This command is not in the manual. Private communication with Cobolt.
- force_unlock() None
Forcefully unlock the remote object.
This unlocks the object, regardless of who owns the lock. This allows you to unlock an object if the locking proxy has been destroyed without unlocking.
Use this with care.
Do not override this stub method in subclasses. It has already been implemented in QMI_RpcProxy.
- classmethod get_category() str | None
Return the optional name of the category this object belongs to.
A category name is a free-form string that has no special significance. Its purpose is to distinguish between groups of RPC objects that fulfill similar roles.
- get_name() str
Return the name of this object.
- Returns:
name attribute.
- get_signals() list[SignalDescription]
Return a list of signals that can be published by this object.
- Returns:
List consisting of qmi_signals attributes.
- is_locked() bool
Query if the remote object is locked.
Do not override this stub method in subclasses. It has already been implemented in QMI_RpcProxy.
- is_open() bool
Return True if the instrument is open (ready for interaction).
- lock(timeout: float = 0.0, lock_token: str | None = None) bool
Lock the remote object. If timeout is given, try every 0.1s within the given timeout value. The remote object can be locked with an optional custom lock token by giving a string into lock_token keyword argument.
If successful, this proxy is the only proxy that can invoke RPC methods on the remote object; other proxies will receive an “object is locked” response. The return value indicates if the lock was granted; a denied lock means the object was already locked by another proxy.
Do not override this stub method in subclasses. It has already been implemented in QMI_RpcProxy.
- release_rpc_object() None
Give a warning if the instrument is removed while still open.
- unlock(lock_token: str | None = None) bool
Unlock the remote object.
Without optional parameters, this is only allowed by the proxy that initially locked the object. By giving the lock token as an input parameter, the specific object locked by this token can be unlocked. The return value indicates if the unlocking was successful.
Do not override this stub method in subclasses. It has already been implemented in QMI_RpcProxy.