qmi.instruments.ozoptics.dd100mc

Instrument driver for the OZ Optics 100MC attenuator.

Classes

`OZO_AttenuatorPosition`(steps, attenuation)	Representation of attenuator setpoint.
`OZOptics_DD100MC`(context, name, transport)	Instrument driver for the OzOptics DD-100-MC attenuator.

class qmi.instruments.ozoptics.dd100mc.OZO_AttenuatorPosition(steps: int, attenuation: float)

Representation of attenuator setpoint.

steps

Piezo position.

Type:: int

attenuation

Realized attenuation in decibels.

Type:: float

steps: int: Alias for field number 0

attenuation: float: Alias for field number 1

count(value, /): Return number of occurrences of value.

index(value, start=0, stop=9223372036854775807, /)

Return first index of value.

Raises ValueError if the value is not present.

class qmi.instruments.ozoptics.dd100mc.OZOptics_DD100MC(context: QMI_Context, name: str, transport: str)

Instrument driver for the OzOptics DD-100-MC attenuator.

NOTE: the device expects commands ending with a Carriage Return character (’

‘) and responds: with lines ending in CR/LF (’

‘).

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.

get_configuration_display() → List[str]

Get display configuration string.

Returns:: A list of strings showing current display configuration.
Return type:: response

home() → None: Move attenuator to home position. Using extra long timeout.

get_position() → OZO_AttenuatorPosition

Get current attenuator position.

Raises:: QMI_InstrumentException – On bad response to query command.
Returns:: Piezo position in steps and realized attenuation in decibel.
Return type:: response

set_attenuation(value: float) → int

Set new target attenuation value in Decibel.

Parameters:: value – The target attenuation.
Raises:: QMI_InstrumentException – On bad response to command.
Returns:: Attenuator state (0 = IDLE).

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.