tm_devices configuration file

Definition of the configuration file of the tm_devices Python package. Documentation: https://tm-devices.readthedocs.io/stable/configuration/

Type object
File match tm_devices.yml tm_devices.yaml tm_devices.toml
Schema URL https://catalog.lintel.tools/schemas/schemastore/tm-devices-configuration-file/latest.json
Source https://raw.githubusercontent.com/tektronix/tm_devices/main/src/tm_devices/tm_devices_config_schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Configuration options for the tm_devices Python package https://github.com/tektronix/tm_devices

Properties

devices object[]

A list of devices for the DeviceManager to connect to https://tm-devices.readthedocs.io/stable/configuration/#device-configuration

options object
16 nested properties
check_for_updates boolean | null

Indicate if the package should check for updates on creation of the DeviceManager https://tm-devices.readthedocs.io/stable/configuration/#check_for_updates

Default: null
default_visa_timeout integer | null

The default VISA timeout value (in milliseconds) to use when creating VISA connections https://tm-devices.readthedocs.io/stable/configuration/#default_visa_timeout

Default: null
disable_command_verification boolean | null

Indicate if command verification should be disabled for all devices https://tm-devices.readthedocs.io/stable/configuration/#disable_command_verification

Default: null
log_colored_output boolean | null

Indicate if colored output should be used for the console logging https://tm-devices.readthedocs.io/stable/configuration/#log_colored_output

Default: null
log_console_level string | null

Set the logging level for the console https://tm-devices.readthedocs.io/stable/configuration/#log_console_level

Default: null
log_file_directory string | null

Set the directory to save log files to https://tm-devices.readthedocs.io/stable/configuration/#log_file_directory

Default: null
log_file_level string | null

Set the logging level for the log file https://tm-devices.readthedocs.io/stable/configuration/#log_file_level

Default: null
log_file_name string | null

Set the name of the log file to save the logs to https://tm-devices.readthedocs.io/stable/configuration/#log_file_name

Default: null
log_pyvisa_messages boolean | null

Indicate if PyVISA logs should be included in the log file https://tm-devices.readthedocs.io/stable/configuration/#log_pyvisa_messages

Default: null
log_uncaught_exceptions boolean | null

Indicate if uncaught exceptions should be logged to the log file with full tracebacks https://tm-devices.readthedocs.io/stable/configuration/#log_uncaught_exceptions

Default: null
retry_visa_connection boolean | null

Indicate if the VISA connection attempt should be retried after a failure https://tm-devices.readthedocs.io/stable/configuration/#retry_visa_connection

Default: null
setup_cleanup boolean | null

Indicate if a device's cleanup() method should be run when opening the connection https://tm-devices.readthedocs.io/stable/configuration/#setup_cleanup

Default: null
standalone boolean | null

Indicate if PyVISA-py's pure Python VISA backend should be used https://tm-devices.readthedocs.io/stable/configuration/#standalone

Default: null
teardown_cleanup boolean | null

Indicate if a device's cleanup() method should be run when closing the connection https://tm-devices.readthedocs.io/stable/configuration/#teardown_cleanup

Default: null
verbose_mode boolean | null

Indicate if more verbose output should be printed to stdout instead of just the log file https://tm-devices.readthedocs.io/stable/configuration/#verbose_mode

Default: null
verbose_visa boolean | null

Indicate if verbose VISA logging should be printed to stdout instead of just the log file https://tm-devices.readthedocs.io/stable/configuration/#verbose_visa

Default: null

Definitions

ConnectionTypes enum
DMConfigOptions object
check_for_updates boolean | null

Indicate if the package should check for updates on creation of the DeviceManager https://tm-devices.readthedocs.io/stable/configuration/#check_for_updates

Default: null
default_visa_timeout integer | null

The default VISA timeout value (in milliseconds) to use when creating VISA connections https://tm-devices.readthedocs.io/stable/configuration/#default_visa_timeout

Default: null
disable_command_verification boolean | null

Indicate if command verification should be disabled for all devices https://tm-devices.readthedocs.io/stable/configuration/#disable_command_verification

Default: null
log_colored_output boolean | null

Indicate if colored output should be used for the console logging https://tm-devices.readthedocs.io/stable/configuration/#log_colored_output

Default: null
log_console_level string | null

Set the logging level for the console https://tm-devices.readthedocs.io/stable/configuration/#log_console_level

Default: null
log_file_directory string | null

Set the directory to save log files to https://tm-devices.readthedocs.io/stable/configuration/#log_file_directory

Default: null
log_file_level string | null

Set the logging level for the log file https://tm-devices.readthedocs.io/stable/configuration/#log_file_level

Default: null
log_file_name string | null

Set the name of the log file to save the logs to https://tm-devices.readthedocs.io/stable/configuration/#log_file_name

Default: null
log_pyvisa_messages boolean | null

Indicate if PyVISA logs should be included in the log file https://tm-devices.readthedocs.io/stable/configuration/#log_pyvisa_messages

Default: null
log_uncaught_exceptions boolean | null

Indicate if uncaught exceptions should be logged to the log file with full tracebacks https://tm-devices.readthedocs.io/stable/configuration/#log_uncaught_exceptions

Default: null
retry_visa_connection boolean | null

Indicate if the VISA connection attempt should be retried after a failure https://tm-devices.readthedocs.io/stable/configuration/#retry_visa_connection

Default: null
setup_cleanup boolean | null

Indicate if a device's cleanup() method should be run when opening the connection https://tm-devices.readthedocs.io/stable/configuration/#setup_cleanup

Default: null
standalone boolean | null

Indicate if PyVISA-py's pure Python VISA backend should be used https://tm-devices.readthedocs.io/stable/configuration/#standalone

Default: null
teardown_cleanup boolean | null

Indicate if a device's cleanup() method should be run when closing the connection https://tm-devices.readthedocs.io/stable/configuration/#teardown_cleanup

Default: null
verbose_mode boolean | null

Indicate if more verbose output should be printed to stdout instead of just the log file https://tm-devices.readthedocs.io/stable/configuration/#verbose_mode

Default: null
verbose_visa boolean | null

Indicate if verbose VISA logging should be printed to stdout instead of just the log file https://tm-devices.readthedocs.io/stable/configuration/#verbose_visa

Default: null
DeviceConfigEntry object
address string required

The address to use to connect to the device https://tm-devices.readthedocs.io/stable/configuration/#address

device_type enum required
Values: "AFG" "AWG" "DAQ" "DMM" "MF" "MT" "PSU" "SCOPE" "SMU" "SS" "UNSUPPORTED"
alias string | null

An alias used to access the device via the DeviceManager https://tm-devices.readthedocs.io/stable/configuration/#alias

Default: null
connection_type enum
Values: "REST_API" "SERIAL" "SOCKET" "TCPIP" "USB" "GPIB" "MOCK"
device_driver string | null

The name of a specific device driver class to use for the device, only used for REST_API connections https://tm-devices.readthedocs.io/stable/configuration/#device_driver

Default: null
gpib_board_number integer | null

The GPIB board number to use, only used for GPIB connections https://tm-devices.readthedocs.io/stable/configuration/#gpib_board_number

Default: null
lan_device_endpoint string | null

The LAN device endpoint (e.g. 'inst0') to connect via, used for TCPIP connections https://tm-devices.readthedocs.io/stable/configuration/#lan_device_endpoint

Default: null
lan_port integer | null

The LAN port number to connect on, used for SOCKET/REST_API connections https://tm-devices.readthedocs.io/stable/configuration/#lan_port

Default: null
serial_config object | null

The configuration options for SERIAL (ASRL) connections https://tm-devices.readthedocs.io/stable/configuration/#serial_config

Default: null
DeviceTypes enum
SerialConfig object
baud_rate integer | null

The baud rate of the communication, this controls the communication frequency https://tm-devices.readthedocs.io/stable/configuration/#serial_config

Default: null
data_bits enum | null

The number of data bits in each character https://tm-devices.readthedocs.io/stable/configuration/#serial_config

Default: null
end_input number | enum | null

The specific character(s) that indicate the end of a message transmission https://tm-devices.readthedocs.io/stable/configuration/#serial_config

Default: null
flow_control number | enum | null

The control for pausing/resuming data streaming between slower devices https://tm-devices.readthedocs.io/stable/configuration/#serial_config

Default: null
parity number | enum | null

Define if and where a checksum bit should be added to each data character https://tm-devices.readthedocs.io/stable/configuration/#serial_config

Default: null
stop_bits number | enum | null

The number of bits to use to indicate the end of a frame/character https://tm-devices.readthedocs.io/stable/configuration/#serial_config

Default: null