device_manager
¶
Device manager module.
AFGAlias
module-attribute
¶
An alias to a specific Arbitrary Function Generator Python driver.
AWGAlias
module-attribute
¶
An alias to a specific Arbitrary Waveform Generator Python driver.
DataAcquisitionSystemAlias
module-attribute
¶
DataAcquisitionSystemAlias = TypeVar(
"DataAcquisitionSystemAlias", bound=DataAcquisitionSystem, default=DataAcquisitionSystem
)
An alias to a specific Data Acquisition System Python driver.
DigitalMultimeterAlias
module-attribute
¶
DigitalMultimeterAlias = TypeVar(
"DigitalMultimeterAlias", bound=DigitalMultimeter, default=DigitalMultimeter
)
An alias to a specific Digital Multimeter Python driver.
MainframeAlias
module-attribute
¶
An alias to a specific Mainframe driver.
MarginTesterAlias
module-attribute
¶
MarginTesterAlias = TypeVar('MarginTesterAlias', bound=MarginTester, default=MarginTester)
An alias to a specific Margin Tester Python driver.
PowerSupplyUnitAlias
module-attribute
¶
PowerSupplyUnitAlias = TypeVar(
"PowerSupplyUnitAlias", bound=PowerSupplyUnit, default=PowerSupplyUnit
)
An alias to a specific Power Supply Unit Python driver.
ScopeAlias
module-attribute
¶
An alias to a specific Scope driver.
SourceMeasureUnitAlias
module-attribute
¶
SourceMeasureUnitAlias = TypeVar(
"SourceMeasureUnitAlias", bound=SourceMeasureUnit, default=SourceMeasureUnit
)
An alias to a specific Source Measure Unit Python driver.
SystemsSwitchAlias
module-attribute
¶
SystemsSwitchAlias = TypeVar('SystemsSwitchAlias', bound=SystemsSwitch, default=SystemsSwitch)
An alias to a specific Systems Switch Python driver.
UnsupportedDeviceAlias
module-attribute
¶
An alias to a custom device driver for an unsupported device type.
DeviceManager
¶
DeviceManager(
verbose: bool = True,
config_options: DMConfigOptions | None = None,
external_device_drivers: Mapping[str, type[Device]] | None = None,
)
The manager for all devices.
Once instantiated, this class creates and manages connections to all devices.
This class is a singleton, meaning only one instance can ever be created. Any subsequent instantiation attempts will return a pointer to the original instance.
| Parameters: |
|
|---|
default_visa_timeout
property
writable
¶
default_visa_timeout: int
Return the default VISA timeout value.
disable_command_verification
property
writable
¶
disable_command_verification: bool
Indicate if command verification is disabled for all devices.
setup_cleanup_enabled
property
writable
¶
setup_cleanup_enabled: bool
Indicate if cleanup at setup is enabled for devices.
teardown_cleanup_enabled
property
writable
¶
teardown_cleanup_enabled: bool
Indicate if cleanup at teardown is enabled for devices.
verbose_visa
property
writable
¶
verbose_visa: bool
Return the VISA verbosity setting of the DeviceManager.
add_afg
¶
add_afg(
address: str,
*,
alias: str | None = None,
connection_type: str | None = None,
port: int | None = None,
lan_device_endpoint: str | None = None,
serial_config: SerialConfig | None = None,
gpib_board_number: int | None = None
) -> AFGAlias
Add an Arbitrary Function Generator to the DeviceManager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
add_awg
¶
add_awg(
address: str,
*,
alias: str | None = None,
connection_type: str | None = None,
port: int | None = None,
lan_device_endpoint: str | None = None,
serial_config: SerialConfig | None = None,
gpib_board_number: int | None = None
) -> AWGAlias
Add an Arbitrary Waveform Generator to the DeviceManager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
add_daq
¶
add_daq(
address: str,
*,
alias: str | None = None,
connection_type: str | None = None,
port: int | None = None,
lan_device_endpoint: str | None = None,
serial_config: SerialConfig | None = None,
gpib_board_number: int | None = None
) -> DataAcquisitionSystemAlias
Add a Data Acquisition System to the DeviceManager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
add_dmm
¶
add_dmm(
address: str,
*,
alias: str | None = None,
connection_type: str | None = None,
port: int | None = None,
lan_device_endpoint: str | None = None,
serial_config: SerialConfig | None = None,
gpib_board_number: int | None = None
) -> DigitalMultimeterAlias
Add a Digital Multimeter to the DeviceManager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
add_mf
¶
add_mf(
address: str,
*,
alias: str | None = None,
connection_type: str | None = None,
port: int | None = None,
lan_device_endpoint: str | None = None
) -> MainframeAlias
Add a Mainframe to the DeviceManager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
add_mt
¶
add_mt(
address: str, device_driver: str, *, alias: str | None = None, port: int | None = None
) -> MarginTesterAlias
Add a Margin Tester to the DeviceManager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
add_psu
¶
add_psu(
address: str,
*,
alias: str | None = None,
connection_type: str | None = None,
port: int | None = None,
lan_device_endpoint: str | None = None,
serial_config: SerialConfig | None = None,
gpib_board_number: int | None = None
) -> PowerSupplyUnitAlias
Add a Power Supply Unit to the DeviceManager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
add_scope
¶
add_scope(
address: str,
*,
alias: str | None = None,
connection_type: str | None = None,
port: int | None = None,
lan_device_endpoint: str | None = None,
serial_config: SerialConfig | None = None,
gpib_board_number: int | None = None
) -> ScopeAlias
Add a scope to the DeviceManager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
add_smu
¶
add_smu(
address: str,
*,
alias: str | None = None,
connection_type: str | None = None,
port: int | None = None,
lan_device_endpoint: str | None = None,
serial_config: SerialConfig | None = None,
gpib_board_number: int | None = None
) -> SourceMeasureUnitAlias
Add a Source Measure Unit to the DeviceManager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
add_ss
¶
add_ss(
address: str,
*,
alias: str | None = None,
connection_type: str | None = None,
port: int | None = None,
lan_device_endpoint: str | None = None,
gpib_board_number: int | None = None
) -> SystemsSwitchAlias
Add a Systems Switch to the DeviceManager.
| Parameters: |
|
|---|
| Returns: |
|
|---|
add_unsupported_device
¶
add_unsupported_device(
address: str,
*,
alias: str | None = None,
connection_type: str | None = None,
port: int | None = None,
lan_device_endpoint: str | None = None,
gpib_board_number: int | None = None
) -> UnsupportedDeviceAlias
Add a custom device to the DeviceManager that is not an officially supported device type.
Warning
This should not be used unless absolutely necessary.
| Parameters: |
|
|---|
| Returns: |
|
|---|
disable_device_command_checking
¶
disable_device_command_checking() -> None
Set the .enable_verification attribute of each device to False.
This can have the effect of speeding up automation scripts by no longer checking each
command after it is sent via the .set_and_check() method.
get_afg
¶
Get the Arbitrary Function Generator Python driver for the given AFG number or alias.
Integers are treated as a device number, strings are treated as an alias.
| Parameters: |
|---|
| Returns: |
|
|---|
get_available_devices
¶
get_available_devices(
search: str = "", configured: bool = True, local: bool = True
) -> dict[str, tuple[str, ...]]
Get tuples of local and configured devices, optionally narrowed by a search.
| Parameters: |
|---|
| Returns: |
|---|
| Raises: |
|
|---|
get_awg
¶
Get the Arbitrary Waveform Generator Python driver for the given AWG number or alias.
Integers are treated as a device number, strings are treated as an alias.
| Parameters: |
|---|
| Returns: |
|
|---|
get_current_configuration_as_environment_variable_strings
¶
get_current_configuration_as_environment_variable_strings() -> str
Return the current configuration represented as environment variables.
get_daq
¶
get_daq(number_or_alias: int | str) -> DataAcquisitionSystemAlias
Get the Data Acquisition System Python driver for the given DAQ number or alias.
Integers are treated as a device number, strings are treated as an alias.
| Parameters: |
|---|
| Returns: |
|
|---|
get_device
¶
get_device(
*,
device_type: str | None = None,
device_number: int | str | None = None,
alias: str | None = None
) -> Device
Get the driver for the given device.
Either device_type and device_number or alias must be provided when using this method.
| Parameters: |
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
get_dmm
¶
get_dmm(number_or_alias: int | str) -> DigitalMultimeterAlias
Get the Digital Multimeter Python driver for the given DMM number or alias.
Integers are treated as a device number, strings are treated as an alias.
| Parameters: |
|---|
| Returns: |
|
|---|
get_mf
¶
get_mf(number_or_alias: int | str) -> MainframeAlias
Get the Mainframe driver for the given device number or alias.
Integers are treated as a device number, strings are treated as an alias.
| Parameters: |
|---|
| Returns: |
|
|---|
get_mt
¶
get_mt(number_or_alias: int | str) -> MarginTesterAlias
Get the Margin Tester Python driver for the given Margin Tester number or alias.
Integers are treated as a device number, strings are treated as an alias.
| Parameters: |
|---|
| Returns: |
|
|---|
get_psu
¶
get_psu(number_or_alias: int | str) -> PowerSupplyUnitAlias
Get the Power Supply Unit Python driver for the given PSU number or alias.
Integers are treated as a device number, strings are treated as an alias.
| Parameters: |
|---|
| Returns: |
|
|---|
get_scope
¶
get_scope(number_or_alias: int | str) -> ScopeAlias
Get the scope driver for the given scope number or alias.
Integers are treated as a device number, strings are treated as an alias.
| Parameters: |
|---|
| Returns: |
|
|---|
get_smu
¶
get_smu(number_or_alias: int | str) -> SourceMeasureUnitAlias
Get the Source Measure Unit Python driver for the given SMU number or alias.
Integers are treated as a device number, strings are treated as an alias.
| Parameters: |
|---|
| Returns: |
|
|---|
get_ss
¶
get_ss(number_or_alias: int | str) -> SystemsSwitchAlias
Get the Systems Switch Python driver for the given Systems Switch number or alias.
Integers are treated as a device number, strings are treated as an alias.
| Parameters: |
|---|
| Returns: |
|
|---|
load_config_file
¶
open
¶
open() -> bool
Reopen all devices if the DeviceManager has been previously closed.
| Returns: |
|
|---|
remove_device
¶
remove_device(
*,
device_type: str | None = None,
device_number: int | str | None = None,
alias: str | None = None
) -> None
Remove a device from the DeviceManager.
Either device_type and device_number or alias must be provided when using this method.
| Parameters: |
|---|
write_current_configuration_to_config_file
¶
write_current_configuration_to_config_file(
config_file_path: str | PathLike[str] | None = None,
) -> None
Write a config file located at the current working directory (or custom path).
This method will overwrite any existing config file with the current devices and options.
This method also respects the TM_DEVICES_CONFIG environment variable.
| Parameters: |
|---|
print_available_visa_devices
¶
print_available_visa_devices() -> None
Print all available VISA devices to the console.