RsInstrument Python
Contents:
Revision History
Welcome to the RsInstrument Python Step-by-step Guide
Introduction
Installation
Finding available instruments
Initiating instrument session
Checking the installed options
Basic I/O communication
Error Checking
Exception Handling
OPC-synchronized I/O Communication
Universal I/O Execution
Querying Arrays
Querying Binary Data
Writing Binary Data
Transferring Files
Transferring Big Data with Progress
Multithreading
Logging
MCP Server
OpenTelemetry Tracing and Metrics
RsInstrument package
RsInstrument.logger
RsInstrument.events
RsInstrument.ivi_direct_io
RsInstrument.ivi_utility
RsInstrument Python
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
A
abbreviated_max_len_ascii (ScpiLogger attribute)
abbreviated_max_len_bin (ScpiLogger attribute)
abbreviated_max_len_list (ScpiLogger attribute)
add_builtin_tools() (in module RsInstrument.mcp)
add_instr_option() (RsInstrument method)
annotations (ToolSpec attribute)
assert_minimum_version() (RsInstrument static method)
assign_lock() (RsInstrument method)
B
batch_policy (BuiltinToolSettings attribute)
BatchScpiCommand (class in RsInstrument.mcp)
before_query_handler (Events property)
before_write_handler (Events property)
bin_float_numbers_format (RsInstrument property)
bin_int_numbers_format (RsInstrument property)
bin_line_block_size (ScpiLogger attribute)
BuiltinToolSettings (class in RsInstrument.mcp)
C
check_status() (RsInstrument method)
clear_cached_entries() (ScpiLogger method)
clear_global_logging_relative_timestamp() (RsInstrument class method)
clear_lock() (RsInstrument method)
clear_relative_timestamp() (ScpiLogger method)
clear_replacers() (LogInfoReplacer method)
clear_status() (RsInstrument method)
close() (RsInstrument method)
collect_errors (ScpiBatchPolicy attribute)
command (BatchScpiCommand attribute)
create() (BuiltinToolSettings class method)
create_builtin_tool_specs() (in module RsInstrument.mcp)
create_fastmcp_server() (in module RsInstrument.mcp)
D
data_chunk_size (RsInstrument property)
default_mode (ScpiLogger attribute)
defaults() (DeviceIoProfileRegistry class method)
(ScpiBatchPolicy class method)
(ScpiWritePolicy class method)
description (ToolSpec attribute)
device_name (ScpiLogger attribute)
device_profiles (BuiltinToolSettings attribute)
DeviceIoProfile (class in RsInstrument.mcp)
DeviceIoProfileRegistry (class in RsInstrument.mcp)
disabled() (FileTransferPolicy class method)
discovery() (RsInstrument static method)
driver_vendor (IviUtility property)
driver_version (IviUtility property)
(RsInstrument property)
E
enabled (FileTransferPolicy attribute)
(ScpiInstrumentor property)
encoding (RsInstrument property)
error() (ScpiLogger method)
error_query() (IviUtility method)
error_query_all() (IviUtility method)
evaluate() (ScpiWritePolicy method)
Events (class in RsInstrument.Fixed_Files.Events)
events (RsInstrument property)
excluded_tools (BuiltinToolSettings attribute)
execute() (RsInstrument method)
F
file_exists() (RsInstrument method)
file_transfer (BuiltinToolSettings attribute)
FileTransferPolicy (class in RsInstrument.mcp)
flush() (ScpiLogger method)
fn (ToolSpec attribute)
for_model() (DeviceIoProfileRegistry method)
from_existing_session() (RsInstrument class method)
from_file() (ScpiWritePolicy class method)
full_instrument_model_name (RsInstrument property)
G
get_driver_version() (RsInstrument class method)
get_file_size() (RsInstrument method)
get_global_logging_relative_timestamp() (RsInstrument class method)
get_global_logging_target() (RsInstrument class method)
get_last_sent_cmd() (RsInstrument method)
get_lock() (RsInstrument method)
get_logging_target() (ScpiLogger method)
get_relative_timestamp() (ScpiLogger method)
get_session_handle() (RsInstrument method)
get_total_execution_time() (RsInstrument method)
get_total_time() (RsInstrument method)
get_total_time_startpoint() (RsInstrument method)
go_to_local() (RsInstrument method)
go_to_remote() (RsInstrument method)
H
has_instr_option() (RsInstrument method)
has_instr_option_k0() (RsInstrument method)
has_instr_option_regex() (RsInstrument method)
I
idn_string (RsInstrument property)
info() (ScpiLogger method)
info_raw() (ScpiLogger method)
instr_err_suppressor() (RsInstrument method)
instrument_allowed_dirs (FileTransferPolicy attribute)
instrument_firmware_version (RsInstrument property)
instrument_manufacturer (IviUtility property)
instrument_model (IviUtility property)
instrument_model_name (RsInstrument property)
instrument_options (RsInstrument property)
instrument_serial_number (RsInstrument property)
instrument_status_checking (RsInstrument property)
interaction_commands (DeviceIoProfile attribute)
io_events_include_data (Events property)
io_timeout_ms (IviDirectIo property)
is_connection_active() (RsInstrument method)
ivi_direct_io (RsInstrument property)
ivi_utility (RsInstrument property)
IviDirectIo (class in RsInstrument.Fixed_Files.ivi_direct_io)
IviUtility (class in RsInstrument.Fixed_Files.ivi_utility)
L
list_resources() (RsInstrument static method)
local_root (FileTransferPolicy attribute)
lock_resource() (RsInstrument method)
log_info_replacer (ScpiLogger attribute)
log_status_check_ok (ScpiLogger attribute)
log_to_console (ScpiLogger attribute)
log_to_console_and_udp (ScpiLogger attribute)
log_to_udp (ScpiLogger attribute)
logger (RsInstrument property)
LogInfoReplacer (class in RsInstrument.Internal.ScpiLogger)
M
main() (in module RsInstrument.mcp)
manufacturer (RsInstrument property)
max_inline_read_bytes (FileTransferPolicy attribute)
max_transfer_bytes (FileTransferPolicy attribute)
merge_tool_specs() (in module RsInstrument.mcp)
mode (ScpiLogger attribute)
model_pattern (DeviceIoProfile attribute)
module
RsInstrument.mcp
RsInstrument.otel
RsInstrument.otel.instrumentor
RsInstrument.otel.patcher
RsInstrument.RsInstrument
N
name (DeviceIoProfile attribute)
(ToolSpec attribute)
needs_opc() (ScpiBatchPolicy method)
O
on_read_handler (Events property)
on_write_handler (Events property)
opc_command_headers (ScpiBatchPolicy attribute)
opc_query_after_write (RsInstrument property)
opc_sync_query_mechanism (RsInstrument property)
opc_timeout (BatchScpiCommand attribute)
(RsInstrument property)
optimize_opc_execute (RsInstrument property)
P
pattern_rules (ScpiWritePolicy attribute)
pop_full_replacer_item() (LogInfoReplacer method)
pop_regex_sr_replacer_item() (LogInfoReplacer method)
process_all_commands() (RsInstrument method)
profiles (DeviceIoProfileRegistry attribute)
put_full_replacer_item() (LogInfoReplacer method)
put_regex_sr_replacer_item() (LogInfoReplacer method)
Q
query() (RsInstrument method)
query_all_errors() (RsInstrument method)
query_all_errors_with_codes() (RsInstrument method)
query_bin_block() (RsInstrument method)
query_bin_block_to_file() (RsInstrument method)
query_bin_block_to_file_with_opc() (RsInstrument method)
query_bin_block_with_opc() (RsInstrument method)
query_bin_or_ascii_float_list() (RsInstrument method)
query_bin_or_ascii_float_list_with_opc() (RsInstrument method)
query_bin_or_ascii_int_list() (RsInstrument method)
query_bin_or_ascii_int_list_with_opc() (RsInstrument method)
query_bool() (RsInstrument method)
query_bool_list() (RsInstrument method)
query_bool_list_with_opc() (RsInstrument method)
query_bool_with_opc() (RsInstrument method)
query_float() (RsInstrument method)
query_float_with_opc() (RsInstrument method)
query_instrument_status_enabled (IviUtility property)
query_int() (RsInstrument method)
query_int_with_opc() (RsInstrument method)
query_opc() (RsInstrument method)
query_str() (RsInstrument method)
query_str_list() (RsInstrument method)
query_str_list_with_opc() (RsInstrument method)
query_str_stripped() (RsInstrument method)
query_str_with_opc() (RsInstrument method)
query_stripped() (RsInstrument method)
query_with_opc() (RsInstrument method)
R
raise_on_device_error() (IviUtility method)
read_bytes() (IviDirectIo method)
read_file_from_instrument_to_pc() (RsInstrument method)
read_string() (IviDirectIo method)
reconnect() (RsInstrument method)
remove_instr_option() (RsInstrument method)
reset() (IviUtility method)
(RsInstrument method)
reset_time_statistics() (RsInstrument method)
resource_name (RsInstrument property)
restore_format_string() (ScpiLogger method)
RsInstrument (class in RsInstrument.RsInstrument)
RsInstrument.mcp
module
RsInstrument.otel
module
RsInstrument.otel.instrumentor
module
RsInstrument.otel.patcher
module
RsInstrument.RsInstrument
module
run() (in module RsInstrument.mcp)
S
safe_tool() (in module RsInstrument.mcp)
scpi_span() (ScpiInstrumentor method)
ScpiBatchPolicy (class in RsInstrument.mcp)
ScpiInstrumentor (class in RsInstrument.otel.instrumentor)
ScpiLogger (class in RsInstrument.Internal.ScpiLogger)
ScpiWritePolicy (class in RsInstrument.mcp)
screenshot_strategy (DeviceIoProfile attribute)
self_test() (RsInstrument method)
send_file_from_pc_to_instrument() (RsInstrument method)
session (IviDirectIo property)
set_format_string() (ScpiLogger method)
set_full_replacer() (LogInfoReplacer method)
set_global_logging_relative_time_of_first_entry() (RsInstrument class method)
set_global_logging_relative_timestamp() (RsInstrument class method)
set_global_logging_relative_timestamp_now() (RsInstrument class method)
set_global_logging_target() (RsInstrument class method)
set_logging_target() (ScpiLogger method)
set_logging_target_global() (ScpiLogger method)
set_regex_sr_replacer() (LogInfoReplacer method)
set_relative_timestamp() (ScpiLogger method)
set_relative_timestamp_now() (ScpiLogger method)
set_time_offset_zero_on_first_entry() (ScpiLogger method)
setup_otel() (in module RsInstrument.otel)
(in module RsInstrument.otel.patcher)
simulation_enabled (IviUtility property)
start() (ScpiLogger method)
status_error_suppression_add_rule() (RsInstrument method)
status_error_suppression_add_rules() (RsInstrument method)
status_error_suppression_clear_all_rules() (RsInstrument method)
status_error_suppression_get_rules() (RsInstrument method)
status_error_suppression_remove_rule() (RsInstrument method)
stop() (ScpiLogger method)
supported_instrument_models (IviUtility property)
supported_models (RsInstrument property)
sync_from() (Events method)
(IviDirectIo method)
(IviUtility method)
(ScpiLogger method)
T
target_auto_flushing (ScpiLogger attribute)
teardown_otel() (in module RsInstrument.otel)
(in module RsInstrument.otel.patcher)
ToolSpec (class in RsInstrument.mcp)
U
udp_port (ScpiLogger attribute)
unlock_resource() (RsInstrument method)
V
value_rules (ScpiWritePolicy attribute)
visa_manufacturer (RsInstrument property)
visa_timeout (RsInstrument property)
visa_tout_suppressor() (RsInstrument method)
W
without_rules() (ScpiWritePolicy method)
write() (RsInstrument method)
write_bin_block() (RsInstrument method)
write_bin_block_from_file() (RsInstrument method)
write_bool() (RsInstrument method)
write_bool_with_opc() (RsInstrument method)
write_bytes() (IviDirectIo method)
write_float() (RsInstrument method)
write_float_with_opc() (RsInstrument method)
write_int() (RsInstrument method)
write_int_with_opc() (RsInstrument method)
write_policy (BuiltinToolSettings attribute)
write_str() (RsInstrument method)
write_str_with_opc() (RsInstrument method)
write_string() (IviDirectIo method)
write_with_opc() (RsInstrument method)