qmi.instruments.thorlabs.tsp01b
Instrument driver for the Thorlabs TSP01 RevB temperature/humidity sensor.
The Thorlabs TSP01 RevB is not compatible with the original Thorlabs TSP01. The two instruments have different USB IDs and use different protocols.
This driver supports only the TSP01 RevB (also called TSP01B). New devices sold by Thorlabs after 2018 are RevB devices.
The TSP01 RevB uses a binary protocol on top of USB-HID. This driver is based on partial reverse-engineering of the binary protocol.
This driver uses PyUSB and libusb to access the instrument, and is therefore expected to work only under Linux.
Classes
|
Instrument driver for the Thorlabs TSP01 RevB temperature/humidity sensor. |
- class qmi.instruments.thorlabs.tsp01b.Thorlabs_TSP01B(context: QMI_Context, name: str, serial_number: str)
Instrument driver for the Thorlabs TSP01 RevB temperature/humidity sensor.
The TSP01 RevB measures temperature and humidity. Up to two external temperature probes can be connected to the instrument to measure two additional temperature channels.
The Thorlabs TSP01 RevB is not compatible with the original Thorlabs TSP01. This driver supports only the TSP01 RevB (also called TSP01B).
- static list_instruments() List[str]
Return a list of serial numbers of attached TSP01 RevB instruments.
- 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_idn() QMI_InstrumentIdentification
Read instrument type and version and return QMI_InstrumentIdentification instance.
- reset()
Reset the instrument.
- get_humidity() float
Perform a humidity measurement.
- Returns:
Relative humidity as a percentage (range 0 to 100).
- get_internal_temperature() float
Measure the temperature of the internal sensor.
- Returns:
Temperature in Celsius.
- get_external_temperature(ext_channel: int) float
Measure the temperature of an external sensor.
- Parameters:
ext_channel – External sensor channel number (1 or 2).
- Returns:
Temperature in Celsius.
- 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.