package reference manual
Source code in src\py_canoe\canoe.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 | |
__enter__()
Enter context manager.
Source code in src\py_canoe\canoe.py
37 38 39 40 41 | |
__exit__(exc_type, exc_val, exc_tb)
Exit context manager and cleanup resources. Explicitly release resources and uninitialize COM.
Source code in src\py_canoe\canoe.py
43 44 45 46 47 48 49 50 51 52 53 | |
add_database(database_file, database_channel, database_network=None)
adds database file to a network channel
| Parameters: |
|
|---|
Source code in src\py_canoe\canoe.py
555 556 557 558 559 560 561 562 563 | |
add_filters_to_exporter(logger_index, full_names)
Add messages and symbols to exporter filter by their full names.
| Parameters: |
|
|---|
Source code in src\py_canoe\canoe.py
613 614 615 616 617 618 619 620 | |
add_logging_block(full_name)
adds a new logging block to configuration measurement setup.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
578 579 580 581 582 583 584 585 586 587 | |
add_offline_source_log_file(absolute_log_file_path)
Adds an offline source log file to the configuration.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
391 392 393 394 395 396 397 398 399 400 401 | |
attach_to_active_application()
Attach to a active instance of the CANoe application.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
129 130 131 132 133 134 135 136 137 138 139 | |
break_measurement_in_offline_mode()
Breaks the measurement in offline mode.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
755 756 757 758 759 760 761 762 | |
call_capl_function(name, *arguments)
Calls a CAPL function.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
353 354 355 356 357 358 359 360 361 362 363 364 | |
check_j1939_signal_online(bus, channel, message, signal, source_addr, dest_addr)
Checks if a J1939 signal is online.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 | |
check_j1939_signal_state(bus, channel, message, signal, source_addr, dest_addr)
Checks the state of a J1939 signal.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 | |
check_signal_online(bus, channel, message, signal)
Checks if a signal is online.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
219 220 221 222 223 224 225 226 227 228 229 230 231 232 | |
check_signal_state(bus, channel, message, signal)
Checks the state of a signal.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
234 235 236 237 238 239 240 241 242 243 244 245 246 247 | |
clear_write_window_content()
Clears the content of the write window.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
933 934 935 936 937 938 939 940 | |
compile_all_capl_nodes(wait_time=5)
Compiles all CAPL nodes in the application.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
341 342 343 344 345 346 347 348 349 350 351 | |
control_replay_block(block_name, start_stop)
Controls the replay block.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
428 429 430 431 432 433 434 435 436 437 438 439 | |
control_tester_present(diag_ecu_qualifier_name, value)
Controls the tester present signal.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
820 821 822 823 824 825 826 827 828 829 830 831 | |
copy_write_window_content()
Copies the content of the write window.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
942 943 944 945 946 947 948 949 | |
define_system_variable(sys_var_name, value, read_only=False)
Defines a system variable.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
833 834 835 836 837 838 839 840 841 842 843 844 845 | |
disable_write_window_output_file(tab_index=None)
Disables the write window output file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
964 965 966 967 968 969 970 971 972 973 974 | |
enable_disable_replay_block(block_name, enable_disable)
Enables or disables a replay block.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
441 442 443 444 445 446 447 448 449 450 451 452 | |
enable_write_window_output_file(output_file, tab_index=None)
Enables the write window output file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
951 952 953 954 955 956 957 958 959 960 961 962 | |
execute_all_test_configurations(wait_for_completion=True)
executes all test configurations available in test setup.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
458 459 460 461 462 463 464 465 466 467 | |
execute_all_test_environments()
executes all test environments available in test setup.
Source code in src\py_canoe\canoe.py
547 548 549 | |
execute_all_test_modules_in_test_env(env_name)
executes all test modules available in test environment.
| Parameters: |
|
|---|
Source code in src\py_canoe\canoe.py
531 532 533 534 535 536 537 | |
execute_test_configuration(test_configuration_name, wait_for_completion=True)
executes a specific test configuration.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
477 478 479 480 481 482 483 484 485 486 487 | |
execute_test_module(test_module_name)
use this method to execute test module.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
512 513 514 515 516 517 518 519 520 521 | |
get_bus_databases_info(bus='CAN', log_info=False)
Gets the bus databases information.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
141 142 143 144 145 146 147 148 149 150 151 152 | |
get_bus_nodes_info(bus='CAN', log_info=False)
Gets the bus nodes information.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
154 155 156 157 158 159 160 161 162 163 164 165 | |
get_can_bus_statistics(channel)
Gets the CAN bus statistics.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
403 404 405 406 407 408 409 410 411 412 413 | |
get_canoe_version_info()
Gets the version information of the CANoe application.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
976 977 978 979 980 981 982 983 | |
get_environment_variable_value(env_var_name, return_timestamp=False)
returns a environment variable value.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 | |
get_j1939_signal_full_name(bus, channel, message, signal, source_addr, dest_addr)
Gets the full name of a J1939 signal.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 | |
get_j1939_signal_value(bus, channel, message, signal, source_addr, dest_addr, raw_value=False, return_timestamp=False)
Gets the value of a J1939 signal.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 | |
get_logging_blocks()
Return all available logging blocks.
Source code in src\py_canoe\canoe.py
574 575 576 | |
get_measurement_index()
Gets the measurement index.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
782 783 784 785 786 787 788 789 | |
get_measurement_running_status()
Gets the running status of the measurement.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
733 734 735 736 737 738 739 740 | |
get_messages(logger_index)
Return all messages from given logger.
Source code in src\py_canoe\canoe.py
609 610 611 | |
get_signal_full_name(bus, channel, message, signal)
Gets the full name of a signal.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
204 205 206 207 208 209 210 211 212 213 214 215 216 217 | |
get_signal_value(bus, channel, message, signal, raw_value=False, return_timestamp=False)
Gets the value of a signal.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 | |
get_symbols(logger_index)
Return all exporter symbols from given logger.
Source code in src\py_canoe\canoe.py
605 606 607 | |
get_system_variable_value(sys_var_name, return_symbolic_name=False, return_timestamp=False)
Gets the value of a system variable.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 | |
get_test_configurations()
returns dictionary of test configuration names and its class object.
Source code in src\py_canoe\canoe.py
454 455 456 | |
get_test_environments()
returns dictionary of test environment names and class.
Source code in src\py_canoe\canoe.py
500 501 502 | |
get_test_modules(env_name)
returns dictionary of test environment test module names and its class object.
| Parameters: |
|
|---|
Source code in src\py_canoe\canoe.py
504 505 506 507 508 509 510 | |
load_logs_for_exporter(logger_index)
Load all source files of exporter and determine symbols/messages.
| Parameters: |
|
|---|
Source code in src\py_canoe\canoe.py
597 598 599 600 601 602 603 | |
new(auto_save=False, prompt_user=False, timeout=5)
Creates a new configuration.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | |
open(canoe_cfg, visible=True, auto_save=True, prompt_user=False, auto_stop=True, timeout=30)
Loads a configuration.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 | |
quit(timeout=30)
Quits the application.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
115 116 117 118 119 120 121 122 123 124 125 126 127 | |
read_text_from_write_window()
Reads text from the write window.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
924 925 926 927 928 929 930 931 | |
remove_database(database_file, database_channel)
remove database file from a channel
| Parameters: |
|
|---|
Source code in src\py_canoe\canoe.py
565 566 567 568 569 570 571 572 | |
remove_logging_block(index)
removes a logging block from configuration measurement setup.
| Parameters: |
|
|---|
Source code in src\py_canoe\canoe.py
589 590 591 592 593 594 595 | |
reset_measurement(timeout=30)
Restarts the measurement if running.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 | |
reset_measurement_in_offline_mode()
Resets the measurement in offline mode.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
764 765 766 767 768 769 770 771 | |
save_configuration()
Saves the current configuration.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
366 367 368 369 370 371 372 373 | |
save_configuration_as(path, major, minor, prompt_user=False, create_dir=True)
Saves the current configuration as a new file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 | |
send_diag_request(diag_ecu_qualifier_name, request, request_in_bytes=True, return_sender_name=False, response_in_bytearray=False)
Sends a diagnostic request.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 | |
set_configuration_modified(modified)
Change status of configuration.
| Parameters: |
|
|---|
Source code in src\py_canoe\canoe.py
642 643 644 645 646 647 648 | |
set_environment_variable_value(env_var_name, value)
Sets the value of an environment variable.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
666 667 668 669 670 671 672 673 674 675 676 677 | |
set_j1939_signal_value(bus, channel, message, signal, source_addr, dest_addr, value, raw_value=False)
Sets the value of a J1939 signal.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 | |
set_measurement_index(index)
Sets the measurement index.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
791 792 793 794 795 796 797 798 799 800 801 802 | |
set_replay_block_file(block_name, recording_file_path)
Sets the replay block file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
415 416 417 418 419 420 421 422 423 424 425 426 | |
set_signal_value(bus, channel, message, signal, value, raw_value=False)
Sets the value of a signal.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 | |
set_system_variable_array_values(sys_var_name, value, index=0)
Sets the values of a system variable array.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
877 878 879 880 881 882 883 884 885 886 887 888 889 | |
set_system_variable_value(sys_var_name, value)
Sets the value of a system variable.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
864 865 866 867 868 869 870 871 872 873 874 875 | |
start_export(logger_index)
Starts the export/conversion of exporter.
| Parameters: |
|
|---|
Source code in src\py_canoe\canoe.py
622 623 624 625 626 627 628 | |
start_measurement(timeout=30)
Starts the measurement.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
679 680 681 682 683 684 685 686 687 688 689 | |
start_measurement_in_animation_mode(animation_delay=100, timeout=30)
Starts the measurement in animation mode.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
742 743 744 745 746 747 748 749 750 751 752 753 | |
start_stop_online_logging_block(full_name, start_stop)
start / stop online measurement setup logging block.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
630 631 632 633 634 635 636 637 638 639 640 | |
step_measurement_event_in_single_step()
Steps the measurement event in single step mode.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
773 774 775 776 777 778 779 780 | |
stop_all_test_configurations()
stops execution of all test configurations available in test setup.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
469 470 471 472 473 474 475 | |
stop_all_test_environments()
stops execution of all test environments available in test setup.
Source code in src\py_canoe\canoe.py
551 552 553 | |
stop_all_test_modules_in_test_env(env_name)
stops execution of all test modules available in test environment.
| Parameters: |
|
|---|
Source code in src\py_canoe\canoe.py
539 540 541 542 543 544 545 | |
stop_ex_measurement(timeout=30)
Stops the measurement.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
703 704 705 706 707 708 709 710 711 712 713 | |
stop_measurement(timeout=30)
Stops the measurement.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
691 692 693 694 695 696 697 698 699 700 701 | |
stop_test_configuration(test_configuration_name)
stops execution of a specific test configuration.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
489 490 491 492 493 494 495 496 497 498 | |
stop_test_module(test_module_name)
stops execution of test module.
| Parameters: |
|
|---|
Source code in src\py_canoe\canoe.py
523 524 525 526 527 528 529 | |
ui_activate_desktop(name)
Activates a desktop by name.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
891 892 893 894 895 896 897 898 899 900 901 | |
ui_open_baudrate_dialog()
Opens the baudrate dialog.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
903 904 905 906 907 908 909 910 | |
write_text_in_write_window(text)
Writes text in the write window.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
912 913 914 915 916 917 918 919 920 921 922 | |