qmi.instruments.edwards.turbo_instrument_controller
Instrument driver for the Edwards Turbo Instrument Controller.
Classes
|
Alert ID for instrument. |
|
Error code for the instrument. |
Pressure read by the gauge. |
|
|
Gauge state of the instrument. |
|
Priority level for instrument. |
|
Speed of the pump. |
|
Speed of the pump. |
|
Pump state of instrument. |
|
State of the pump. |
|
State of a device in the instrument. |
|
State of a device of the instrument. |
Status of the instument. |
|
System on/off setup config of the instrument. |
|
|
Instrument driver for the Edwards Turbo Instrument Controller. |
- class qmi.instruments.edwards.turbo_instrument_controller.EdwardsVacuum_TIC_ErrorCode(value)
Error code for the instrument.
- class qmi.instruments.edwards.turbo_instrument_controller.EdwardsVacuum_TIC_Priority(value)
Priority level for instrument.
- class qmi.instruments.edwards.turbo_instrument_controller.EdwardsVacuum_TIC_AlertId(value)
Alert ID for instrument.
- class qmi.instruments.edwards.turbo_instrument_controller.EdwardsVacuum_TIC_State(value)
State of a device in the instrument.
- class qmi.instruments.edwards.turbo_instrument_controller.EdwardsVacuum_TIC_PumpState(value)
Pump state of instrument.
- class qmi.instruments.edwards.turbo_instrument_controller.EdwardsVacuum_TIC_GaugeState(value)
Gauge state of the instrument.
- class qmi.instruments.edwards.turbo_instrument_controller.EdwardsVacuum_TIC_PumpStateResponse(state: EdwardsVacuum_TIC_PumpState, alert: EdwardsVacuum_TIC_AlertId, priority: EdwardsVacuum_TIC_Priority)
State of the pump.
- state
State of the pump.
- alert
Alert given by the system.
- priority
Priority level of the system.
- state: EdwardsVacuum_TIC_PumpState
Alias for field number 0
- alert: EdwardsVacuum_TIC_AlertId
Alias for field number 1
- priority: EdwardsVacuum_TIC_Priority
Alias for field number 2
- 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.edwards.turbo_instrument_controller.EdwardsVacuum_TIC_PumpSpeedResponse(speed: float, alert: EdwardsVacuum_TIC_AlertId, priority: EdwardsVacuum_TIC_Priority)
Speed of the pump.
- speed
Speed as a percentage of the maximum value [0-100%].
- Type:
float
- alert
Alert given by the system.
- priority
Priority level of the system.
- speed: float
Alias for field number 0
- alert: EdwardsVacuum_TIC_AlertId
Alias for field number 1
- priority: EdwardsVacuum_TIC_Priority
Alias for field number 2
- 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.edwards.turbo_instrument_controller.EdwardsVacuum_TIC_PumpPowerResponse(power: float, alert: EdwardsVacuum_TIC_AlertId, priority: EdwardsVacuum_TIC_Priority)
Speed of the pump.
- power
Power of the pump in Watts.
- Type:
float
- alert
Alert given by the system.
- priority
Priority level of the system.
- power: float
Alias for field number 0
- alert: EdwardsVacuum_TIC_AlertId
Alias for field number 1
- priority: EdwardsVacuum_TIC_Priority
Alias for field number 2
- 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.edwards.turbo_instrument_controller.EdwardsVacuum_TIC_GaugePressureResponse(pressure: float, unit: str, state: EdwardsVacuum_TIC_GaugeState, alert: EdwardsVacuum_TIC_AlertId, priority: EdwardsVacuum_TIC_Priority)
Pressure read by the gauge.
- pressure
Pressure.
- Type:
float
- unit
Unit of the value.
- Type:
str
- state
State of the gauge.
- alert
Alert given by the system.
- priority
Priority level of the system.
- pressure: float
Alias for field number 0
- unit: str
Alias for field number 1
- state: EdwardsVacuum_TIC_GaugeState
Alias for field number 2
- alert: EdwardsVacuum_TIC_AlertId
Alias for field number 3
- priority: EdwardsVacuum_TIC_Priority
Alias for field number 4
- 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.edwards.turbo_instrument_controller.EdwardsVacuum_TIC_StateResponse(state: EdwardsVacuum_TIC_State, alert: EdwardsVacuum_TIC_AlertId, priority: EdwardsVacuum_TIC_Priority)
State of a device of the instrument.
- state
State of the device.
- alert
Alert given by the system.
- priority
Priority level of the system.
- state: EdwardsVacuum_TIC_State
Alias for field number 0
- alert: EdwardsVacuum_TIC_AlertId
Alias for field number 1
- priority: EdwardsVacuum_TIC_Priority
Alias for field number 2
- 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.edwards.turbo_instrument_controller.EdwardsVacuum_TIC_StatusResponse(turbo_pump_state: EdwardsVacuum_TIC_PumpState, backing_pump_state: EdwardsVacuum_TIC_PumpState, gauge_1_state: EdwardsVacuum_TIC_GaugeState, gauge_2_state: EdwardsVacuum_TIC_GaugeState, gauge_3_state: EdwardsVacuum_TIC_GaugeState, relay_1_state: EdwardsVacuum_TIC_State, relay_2_state: EdwardsVacuum_TIC_State, relay_3_state: EdwardsVacuum_TIC_State, alert: EdwardsVacuum_TIC_AlertId, priority: EdwardsVacuum_TIC_Priority)
Status of the instument.
- turbo_pump_state
State of the turbo pump.
- backing_pump_state
State of the backing pump.
- gauge_1_state
State of gauge 1.
- gauge_2_state
State of gauge 2.
- gauge_3_state
State of gauge 3.
- relay_1_state
State of relay 1.
- relay_2_state
State of relay 2.
- relay_3_state
State of relay 3.
- alert
Alert given by the system.
- priority
Priority level of the system.
- turbo_pump_state: EdwardsVacuum_TIC_PumpState
Alias for field number 0
- backing_pump_state: EdwardsVacuum_TIC_PumpState
Alias for field number 1
- gauge_1_state: EdwardsVacuum_TIC_GaugeState
Alias for field number 2
- gauge_2_state: EdwardsVacuum_TIC_GaugeState
Alias for field number 3
- gauge_3_state: EdwardsVacuum_TIC_GaugeState
Alias for field number 4
- relay_1_state: EdwardsVacuum_TIC_State
Alias for field number 5
- relay_2_state: EdwardsVacuum_TIC_State
Alias for field number 6
- relay_3_state: EdwardsVacuum_TIC_State
Alias for field number 7
- alert: EdwardsVacuum_TIC_AlertId
Alias for field number 8
- priority: EdwardsVacuum_TIC_Priority
Alias for field number 9
- 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.edwards.turbo_instrument_controller.EdwardsVacuum_TIC_SystemOnOffSetupConfigResponse(turbo_pump_setup: Tuple[bool, bool], backing_pump_setup: Tuple[bool, bool], gauge_1_setup: Tuple[bool, bool], gauge_2_setup: Tuple[bool, bool], gauge_3_setup: Tuple[bool, bool], relay_1_setup: Tuple[bool, bool], relay_2_setup: Tuple[bool, bool], relay_3_setup: Tuple[bool, bool])
System on/off setup config of the instrument.
- turbo_pump_setup
On/off setup config of the turbo pump. First entry of tuple is the on config and second is the off config.
- Type:
Tuple[bool, bool]
- backing_pump_setup
On/off setup config of the backing pump. First entry of tuple is the on config and second is the off config.
- Type:
Tuple[bool, bool]
- gauge_1_setup
On/off setup config of gauge 1. First entry of tuple is the on config and second is the off config.
- Type:
Tuple[bool, bool]
- gauge_2_setup
On/off setup config of gauge 2. First entry of tuple is the on config and second is the off config.
- Type:
Tuple[bool, bool]
- gauge_3_setup
On/off setup config of gauge 3. First entry of tuple is the on config and second is the off config.
- Type:
Tuple[bool, bool]
- relay_1_setup
On/off setup config of relay 1. First entry of tuple is the on config and second is the off config.
- Type:
Tuple[bool, bool]
- relay_2_setup
On/off setup config of relay 2. First entry of tuple is the on config and second is the off config.
- Type:
Tuple[bool, bool]
- relay_3_setup
On/off setup config of relay 3. First entry of tuple is the on config and second is the off config.
- Type:
Tuple[bool, bool]
- turbo_pump_setup: Tuple[bool, bool]
Alias for field number 0
- backing_pump_setup: Tuple[bool, bool]
Alias for field number 1
- gauge_1_setup: Tuple[bool, bool]
Alias for field number 2
- gauge_2_setup: Tuple[bool, bool]
Alias for field number 3
- gauge_3_setup: Tuple[bool, bool]
Alias for field number 4
- relay_1_setup: Tuple[bool, bool]
Alias for field number 5
- relay_2_setup: Tuple[bool, bool]
Alias for field number 6
- relay_3_setup: Tuple[bool, bool]
Alias for field number 7
- 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.edwards.turbo_instrument_controller.Edwards_TurboInstrumentController(context: QMI_Context, name: str, transport: str)
Instrument driver for the Edwards Turbo Instrument 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.
- get_idn() QMI_InstrumentIdentification
Read instrument type and version and return QMI_InstrumentIdentification instance.
- Returns:
Instrument identification.
- get_tic_status() EdwardsVacuum_TIC_StatusResponse
Get the status of the turbo pump, backing pump and pressure gauge attached to the TIC.
- Returns:
An instance of EdwardsVacuum_TIC_StatusResponse.
- get_turbo_pump_state() EdwardsVacuum_TIC_PumpStateResponse
Get the state of the turbo pump.
- Returns:
An instance of EdwardsVacuum_TIC_PumpStateResponse.
- get_backing_pump_state() EdwardsVacuum_TIC_PumpStateResponse
Get the state of the backing pump.
- Returns:
An instance of EdwardsVacuum_TIC_PumpStateResponse.
- turn_on_turbo_pump() None
Turn on the turbo pump.
- turn_off_turbo_pump() None
Turn off the turbo pump.
- turn_on_backing_pump() None
Turn on the turbo pump.
- turn_off_backing_pump() None
Turn off the turbo pump.
- get_turbo_pump_speed() EdwardsVacuum_TIC_PumpSpeedResponse
Get the speed of the turbo pump as a percentage of the maximum speed.
- Returns:
An instance of EdwardsVacuum_TIC_PumpSpeedResponse.
- get_backing_pump_speed() EdwardsVacuum_TIC_PumpSpeedResponse
Get the speed of the backing pump as a percentage of the maximum speed.
- Returns:
An instance of EdwardsVacuum_TIC_PumpStateResponse.
- get_turbo_pump_power() EdwardsVacuum_TIC_PumpPowerResponse
Get the power of the turbo pump.
- Returns:
An instance of EdwardsVacuum_TIC_PumpPowerResponse.
- get_backing_pump_power() EdwardsVacuum_TIC_PumpPowerResponse
Get the power of the backing pump.
- Returns:
An instance of EdwardsVacuum_TIC_PumpPowerResponse.
- get_pressure(gauge_num: int) EdwardsVacuum_TIC_GaugePressureResponse
Get the pressure from the pressure gauge.
- Parameters:
gauge_num – Gauge to address.
- Returns:
An instance of EdwardsVacuum_TIC_GaugePressureResponse.
- get_relay_state(relay_num: int) EdwardsVacuum_TIC_StateResponse
Get the state of the relay.
- Parameters:
relay_num – Relay to address.
- Returns:
An instance of EdwardsVacuum_TIC_StateResponse.
- turn_on_relay(relay_num: int) None
Turn on the relay.
- Parameters:
relay_num – Relay to address.
- turn_off_relay(relay_num: int) None
Turn off the relay.
- get_system_on_off_setup_config() EdwardsVacuum_TIC_SystemOnOffSetupConfigResponse
Get the on/off setup config of the system.
- Returns:
An instance of EdwardsVacuum_TIC_SystemOnOffSetupConfigResponse.
- set_system_on_off_setup_config(config: Dict[int, Tuple[bool, bool]]) None
Set the on/off setup config of the system.
- Parameters:
config – The object to setup. The first entry in the tuple is the object id. the second is a tuple for the on off setup.
- get_system_state() EdwardsVacuum_TIC_StateResponse
Get the state of the system.
- Returns:
An instance of EdwardsVacuum_TIC_StateResponse.
- turn_on_system() None
Turn on the system.
- turn_off_system() None
Turn off the system.
- 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.