qmi.instruments.instru_tech.instrutech_agc302

Instrument driver for the AGC302 Active Vacuum Gauge Controller.

Classes

InstruTech_AGC302(context, name, transport)

Instrument driver for the AGC302 Active Vacuum Gauge Controller.

class qmi.instruments.instru_tech.instrutech_agc302.InstruTech_AGC302(context: QMI_Context, name: str, transport: str | QMI_Transport, timeout: float = 1)

Instrument driver for the AGC302 Active Vacuum Gauge Controller.

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.

read_gauge() → float

Read the current gauge pressure.

Returns:

The device will return a pressure value in units of TORR, MBAR, or PASCAL depending on the current settings. Use read_pressure_unit to obtain the current used unit.

Raises:

QMI_InstrumentException – When sensor is off or when a device does not exists.

read_pressure_unit() → str

Read the current set pressure unit.

Returns:

The gauge reports the measured pressure in Torr, mbar or Pascal. The return values are in capital letters so either TORR, MBAR, or PASCAL.

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.

set_pressure_unit(unit: str) → None

Set pressure unit for display and RD response.

Parameters:

• unit (str) – pressure unit to use. A single letter needs to be provided that is either T = Torr, M = mBar, or

• Pascal. (P =)

Raises:

ValueError – when provided pressure unit letter is not T, M, or P.

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.