py_canoe.CANoe
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
608 609 610 611 612 613 614 615 616 | |
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
666 667 668 669 670 671 672 673 | |
add_logging_block(full_name)
adds a new logging block to configuration measurement setup.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
631 632 633 634 635 636 637 638 639 640 | |
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
436 437 438 439 440 441 442 443 444 445 446 | |
attach_to_active_application()
Attach to a active instance of the CANoe application.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
131 132 133 134 135 136 137 138 139 140 141 | |
break_measurement_in_offline_mode()
Breaks the measurement in offline mode.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
808 809 810 811 812 813 814 815 | |
call_capl_function(name, *arguments)
Calls a CAPL function.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
398 399 400 401 402 403 404 405 406 407 408 409 | |
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
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 | |
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
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 | |
check_signal_online(bus, channel, message, signal)
Checks if a signal is online.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
264 265 266 267 268 269 270 271 272 273 274 275 276 277 | |
check_signal_state(bus, channel, message, signal)
Checks the state of a signal.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
279 280 281 282 283 284 285 286 287 288 289 290 291 292 | |
clear_write_window_content()
Clears the content of the write window.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
1001 1002 1003 1004 1005 1006 1007 1008 | |
compile_all_capl_nodes(wait_time=5)
Compiles all CAPL nodes in the application.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
386 387 388 389 390 391 392 393 394 395 396 | |
control_replay_block(block_name, start_stop)
Controls the replay block.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
473 474 475 476 477 478 479 480 481 482 483 484 | |
control_tester_present(diag_ecu_qualifier_name, value)
Controls the tester present signal.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
879 880 881 882 883 884 885 886 887 888 889 890 | |
copy_write_window_content()
Copies the content of the write window.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
1010 1011 1012 1013 1014 1015 1016 1017 | |
define_system_variable(sys_var_name, value, read_only=False)
Defines a system variable.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
892 893 894 895 896 897 898 899 900 901 902 903 904 | |
disable_write_window_output_file(tab_index=None)
Disables the write window output file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 | |
enable_disable_replay_block(block_name, enable_disable)
Enables or disables a replay block.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
486 487 488 489 490 491 492 493 494 495 496 497 | |
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
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 | |
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
511 512 513 514 515 516 517 518 519 520 | |
execute_all_test_environments()
executes all test environments available in test setup.
Source code in src\py_canoe\canoe.py
600 601 602 | |
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
584 585 586 587 588 589 590 | |
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
530 531 532 533 534 535 536 537 538 539 540 | |
execute_test_module(test_module_name)
use this method to execute test module.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
565 566 567 568 569 570 571 572 573 574 | |
get_all_namespace_names()
Returns all namespace names from the current application.
Source code in src\py_canoe\canoe.py
924 925 926 | |
get_all_network_names()
Returns all network names in the current application.
Source code in src\py_canoe\canoe.py
169 170 171 | |
get_all_variables_in_namespace(namespace_name)
Returns all variables in the specified namespace.
Source code in src\py_canoe\canoe.py
928 929 930 | |
get_bus_databases_info(bus='CAN', log_info=False)
Gets the bus databases information.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
143 144 145 146 147 148 149 150 151 152 153 154 | |
get_bus_nodes_info(bus='CAN', log_info=False)
Gets the bus nodes information.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
156 157 158 159 160 161 162 163 164 165 166 167 | |
get_can_bus_statistics(channel)
Gets the CAN bus statistics.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
448 449 450 451 452 453 454 455 456 457 458 | |
get_canoe_version_info()
Gets the version information of the CANoe application.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
1044 1045 1046 1047 1048 1049 1050 1051 | |
get_capl_compilation_result()
Returns the current configuration compilation result.
Source code in src\py_canoe\canoe.py
503 504 505 | |
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
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 | |
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
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 | |
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
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 | |
get_logging_blocks()
Return all available logging blocks.
Source code in src\py_canoe\canoe.py
627 628 629 | |
get_measurement_index()
Gets the measurement index.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
835 836 837 838 839 840 841 842 | |
get_measurement_running_status()
Gets the running status of the measurement.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
786 787 788 789 790 791 792 793 | |
get_messages(logger_index)
Return all messages from given logger.
Source code in src\py_canoe\canoe.py
662 663 664 | |
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
249 250 251 252 253 254 255 256 257 258 259 260 261 262 | |
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
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 | |
get_simulation_bus_names()
Returns all simulation bus names from the current application.
Source code in src\py_canoe\canoe.py
173 174 175 | |
get_simulation_database_paths()
Returns all simulation database paths from the current application.
Source code in src\py_canoe\canoe.py
177 178 179 | |
get_symbols(logger_index)
Return all exporter symbols from given logger.
Source code in src\py_canoe\canoe.py
658 659 660 | |
get_system_variable_value(sys_var_name, return_symbolic_name=False, return_timestamp=False, enable_events=True)
Gets the value of a system variable.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 | |
get_test_configurations()
returns dictionary of test configuration names and its class object.
Source code in src\py_canoe\canoe.py
499 500 501 | |
get_test_environments()
returns dictionary of test environment names and class.
Source code in src\py_canoe\canoe.py
553 554 555 | |
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
557 558 559 560 561 562 563 | |
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
650 651 652 653 654 655 656 | |
new(auto_save=False, prompt_user=False, timeout=5)
Creates a new configuration.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 | |
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
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | |
profile_signal_value(bus, channel, message, signal, duration=1.0, interval=0.0, raw_value=False, max_samples=None, include_samples=False, include_timestamps=False)
Profiles a signal by sampling it repeatedly and returning basic stats.
This is useful for quickly observing signal stability, typical value range, and timing characteristics without storing all the samples in memory.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
quit(timeout=30)
Quits the application.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
117 118 119 120 121 122 123 124 125 126 127 128 129 | |
read_text_from_write_window()
Reads text from the write window.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
992 993 994 995 996 997 998 999 | |
remove_database(database_file, database_channel)
remove database file from a channel
| Parameters: |
|
|---|
Source code in src\py_canoe\canoe.py
618 619 620 621 622 623 624 625 | |
remove_logging_block(index)
removes a logging block from configuration measurement setup.
| Parameters: |
|
|---|
Source code in src\py_canoe\canoe.py
642 643 644 645 646 647 648 | |
reset_measurement(timeout=30)
Restarts the measurement if running.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 | |
reset_measurement_in_offline_mode()
Resets the measurement in offline mode.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
817 818 819 820 821 822 823 824 | |
run_capl_compilation()
Runs compilation for the current configuration.
Source code in src\py_canoe\canoe.py
507 508 509 | |
save_configuration()
Saves the current configuration.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
411 412 413 414 415 416 417 418 | |
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
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 | |
send_diag_request(diag_ecu_qualifier_name, request, request_in_bytes=True, return_sender_name=False, response_in_bytearray=False, timeout=30, poll_s=0.01, **kwargs)
Sends a diagnostic request.
| Parameters: |
|
|---|
Returns: Union[str, dict]: The response from the diagnostic request.
Example
self.send_diag_request("ECU", "WritePropulsionType", False, PropulsionType="BatteryElectric")
Source code in src\py_canoe\canoe.py
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 | |
set_configuration_modified(modified)
Change status of configuration.
| Parameters: |
|
|---|
Source code in src\py_canoe\canoe.py
695 696 697 698 699 700 701 | |
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
719 720 721 722 723 724 725 726 727 728 729 730 | |
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
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 | |
set_measurement_index(index)
Sets the measurement index.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
844 845 846 847 848 849 850 851 852 853 854 855 | |
set_replay_block_file(block_name, recording_file_path)
Sets the replay block file.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
460 461 462 463 464 465 466 467 468 469 470 471 | |
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
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 | |
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
945 946 947 948 949 950 951 952 953 954 955 956 957 | |
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
932 933 934 935 936 937 938 939 940 941 942 943 | |
start_export(logger_index)
Starts the export/conversion of exporter.
| Parameters: |
|
|---|
Source code in src\py_canoe\canoe.py
675 676 677 678 679 680 681 | |
start_measurement(timeout=30)
Starts the measurement.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
732 733 734 735 736 737 738 739 740 741 742 | |
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
795 796 797 798 799 800 801 802 803 804 805 806 | |
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
683 684 685 686 687 688 689 690 691 692 693 | |
step_measurement_event_in_single_step()
Steps the measurement event in single step mode.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
826 827 828 829 830 831 832 833 | |
stop_all_test_configurations()
stops execution of all test configurations available in test setup.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
522 523 524 525 526 527 528 | |
stop_all_test_environments()
stops execution of all test environments available in test setup.
Source code in src\py_canoe\canoe.py
604 605 606 | |
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
592 593 594 595 596 597 598 | |
stop_ex_measurement(timeout=30)
Stops the measurement.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
756 757 758 759 760 761 762 763 764 765 766 | |
stop_measurement(timeout=30)
Stops the measurement.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
744 745 746 747 748 749 750 751 752 753 754 | |
stop_test_configuration(test_configuration_name)
stops execution of a specific test configuration.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
542 543 544 545 546 547 548 549 550 551 | |
stop_test_module(test_module_name)
stops execution of test module.
| Parameters: |
|
|---|
Source code in src\py_canoe\canoe.py
576 577 578 579 580 581 582 | |
ui_activate_desktop(name)
Activates a desktop by name.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
959 960 961 962 963 964 965 966 967 968 969 | |
ui_open_baudrate_dialog()
Opens the baudrate dialog.
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
971 972 973 974 975 976 977 978 | |
write_text_in_write_window(text)
Writes text in the write window.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in src\py_canoe\canoe.py
980 981 982 983 984 985 986 987 988 989 990 | |