py_canoe 3.0.4__py3-none-any.whl → 26.0.0__py3-none-any.whl

py_canoe/core/child_elements/data_source_files.py

@@ -0,0 +1,22 @@
+from py_canoe.core.child_elements.data_source_file import DataSourceFile
+
+
+class DataSourceFiles:
+    """
+    Collection of DataSourceFile objects for a FileGroupDataSource.
+    """
+    def __init__(self, com_object) -> None:
+        self.com_object = com_object
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'DataSourceFile':
+        return DataSourceFile(self.com_object.Item(index))
+
+    def add(self, source_file_path: str) -> 'DataSourceFile':
+        return DataSourceFile(self.com_object.Add(source_file_path))
+
+    def remove(self, index: int):
+        self.com_object.Remove(index)

py_canoe/core/child_elements/data_source_issue.py

@@ -0,0 +1,22 @@
+import win32com.client
+
+
+class DataSourceIssue:
+    """
+    Represents a single issue from a DataSource import operation.
+    """
+    def __init__(self, com_object) -> None:
+        self.com_object = win32com.client.Dispatch(com_object)
+
+    @property
+    def description(self) -> str:
+        return self.com_object.Description
+
+    @property
+    def emitter(self):
+        from py_canoe.core.child_elements.data_source import DataSource
+        return DataSource(self.com_object.Emitter)
+
+    @property
+    def severity(self) -> int:
+        return self.com_object.Severity

py_canoe/core/child_elements/data_source_issues.py

@@ -0,0 +1,16 @@
+from py_canoe.core.child_elements.data_source_issue import DataSourceIssue
+
+
+class DataSourceIssues:
+    """
+    Collection of DataSourceIssue objects from the last import operation.
+    """
+    def __init__(self, com_object) -> None:
+        self.com_object = com_object
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'DataSourceIssue':
+        return DataSourceIssue(self.com_object.Item(index))

py_canoe/core/child_elements/data_source_setup.py

@@ -0,0 +1,17 @@
+from py_canoe.core.child_elements.data_source import DataSource
+from py_canoe.core.child_elements.data_sources import DataSources
+
+
+class DataSourceSetup:
+    """
+    Provides the data source management API.
+    """
+    def __init__(self, com_object) -> None:
+        self.com_object = com_object
+
+    @property
+    def data_sources(self) -> 'DataSources':
+        return DataSources(self.com_object.DataSources)
+
+    def get_data_source_by_id(self, data_source_id: int) -> 'DataSource':
+        return DataSource(self.com_object.GetDataSourceById(data_source_id))

py_canoe/core/child_elements/data_sources.py

@@ -0,0 +1,27 @@
+from py_canoe.core.child_elements.data_source import DataSource
+from py_canoe.core.child_elements.file_group_data_source import FileGroupDataSource
+from py_canoe.core.child_elements.single_file_data_source import SingleFileDataSource
+
+
+class DataSources:
+    """
+    Collection of DataSource objects.
+    """
+    def __init__(self, com_object) -> None:
+        self.com_object = com_object
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'DataSource':
+        return DataSource(self.com_object.Item(index))
+
+    def add_group_data_source(self, name: str) -> 'FileGroupDataSource':
+        return FileGroupDataSource(self.com_object.AddGroupDataSource(name))
+
+    def add_single_file_data_source(self, source_file_path: str) -> 'SingleFileDataSource':
+        return SingleFileDataSource(self.com_object.AddSingleFileDataSource(source_file_path))
+
+    def remove(self, index: int):
+        self.com_object.Remove(index)

py_canoe/core/child_elements/database_setup.py

@@ -0,0 +1,62 @@
+import win32com.client
+
+
+class DatabaseSetup:
+    def __init__(self, com_object) -> None:
+        self.com_object = com_object
+
+    @property
+    def databases(self) -> 'Databases':
+        return Databases(self.com_object.Databases)
+
+
+class Databases:
+    """The Databases object represents the assigned databases of CANoe."""
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'Database':
+        return Database(self.com_object.Item(index))
+
+    def add(self, full_name: str) -> 'Database':
+        return Database(self.com_object.Add(full_name))
+
+    def add_network(self, database_name: str, network_name: str) -> 'Database':
+        return Database(self.com_object.AddNetwork(database_name, network_name))
+
+    def remove(self, index: int) -> None:
+        self.com_object.Remove(index)
+
+
+class Database:
+    """The Database object represents the assigned database of the CANoe application."""
+    def __init__(self, com_object):
+        self.com_object = win32com.client.Dispatch(com_object)
+
+    @property
+    def channel(self) -> int:
+        return self.com_object.Channel
+
+    @channel.setter
+    def channel(self, channel: int) -> None:
+        self.com_object.Channel = channel
+
+    @property
+    def full_name(self) -> str:
+        return self.com_object.FullName
+
+    @full_name.setter
+    def full_name(self, full_name: str) -> None:
+        self.com_object.FullName = full_name
+
+    @property
+    def name(self) -> str:
+        return self.com_object.Name
+
+    @property
+    def path(self) -> str:
+        return self.com_object.Path

py_canoe/core/child_elements/device.py

@@ -0,0 +1,34 @@
+from py_canoe.core.child_elements.audio_interface import AudioInterface
+from py_canoe.core.child_elements.diagnostic import Diagnostic
+from py_canoe.core.child_elements.most_disassembler import MostDisassembler
+from py_canoe.core.child_elements.most_network_interface import MostNetworkInterface
+from py_canoe.core.child_elements.application_socket import ApplicationSocket
+
+
+class Device:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def application_socket(self) -> ApplicationSocket:
+        return ApplicationSocket(self.com_object.ApplicationSocket)
+
+    @property
+    def audio_interface(self) -> AudioInterface:
+        return AudioInterface(self.com_object.AudioInterface)
+
+    @property
+    def diagnostic(self) -> Diagnostic:
+        return Diagnostic(self.com_object.Diagnostic)
+
+    @property
+    def disassembler(self) -> MostDisassembler:
+        return MostDisassembler(self.com_object.Disassembler)
+
+    @property
+    def name(self) -> str:
+        return self.com_object.Name
+
+    @property
+    def network_interface(self) -> MostNetworkInterface:
+        return MostNetworkInterface(self.com_object.NetworkInterface)

py_canoe/core/child_elements/devices.py

@@ -0,0 +1,13 @@
+from py_canoe.core.child_elements.device import Device
+
+
+class Devices:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'Device':
+        return Device(self.com_object.Item(index))

py_canoe/core/child_elements/diagnostic.py

@@ -0,0 +1,22 @@
+from py_canoe.core.child_elements.diagnostic_request import DiagnosticRequest
+
+
+class Diagnostic:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def tester_present_status(self) -> bool:
+        return self.com_object.TesterPresentStatus
+
+    def create_request(self, primitive_path) -> DiagnosticRequest:
+        return DiagnosticRequest(self.com_object.CreateRequest(primitive_path))
+
+    def create_request_from_stream(self, byte_stream: bytearray) -> DiagnosticRequest:
+        return DiagnosticRequest(self.com_object.CreateRequestFromStream(byte_stream))
+
+    def diag_start_tester_present(self):
+        self.com_object.DiagStartTesterPresent()
+
+    def diag_stop_tester_present(self):
+        self.com_object.DiagStopTesterPresent()

py_canoe/core/child_elements/diagnostic_request.py

@@ -0,0 +1,59 @@
+from typing import Union
+
+from py_canoe.core.child_elements.diagnostic_responses import DiagnosticResponses
+from py_canoe.core.child_elements.diagnostic_response import DiagnosticResponse
+
+DIAGNOSTIC_RESPONSE_TIMEOUT_VALUE = 300 # 5 minutes
+
+
+
+class DiagnosticRequestEvents:
+    def __init__(self) -> None:
+        self.TIMEOUT: bool = False
+        self.RECEIVED_RESPONSE: bool = False
+        self.RESPONSE: Union['DiagnosticResponse', None] = None
+
+    def OnCompletion(self):
+        pass
+
+    def OnConfirmation(self):
+        pass
+
+    def OnResponse(self, response):
+        self.RECEIVED_RESPONSE = True
+        self.RESPONSE = DiagnosticResponse(response)
+
+    def OnTimeout(self):
+        self.TIMEOUT = True
+
+
+class DiagnosticRequest:
+    def __init__(self, com_object):
+        self.com_object = com_object
+        # self.diagnostic_request_events: DiagnosticRequestEvents = win32com.client.WithEvents(self.com_object, DiagnosticRequestEvents)
+
+    @property
+    def pending(self) -> bool:
+        return self.com_object.Pending
+
+    @property
+    def responses(self) -> 'DiagnosticResponses':
+        return DiagnosticResponses(self.com_object.Responses)
+
+    @property
+    def suppress_positive_response(self) -> bool:
+        return self.com_object.SuppressPositiveResponse
+
+    @suppress_positive_response.setter
+    def suppress_positive_response(self, value: bool):
+        self.com_object.SuppressPositiveResponse = value
+
+    def send(self):
+        self.com_object.Send()
+        # DoEventsUntil(lambda: self.pending, DIAGNOSTIC_RESPONSE_TIMEOUT_VALUE, "Diagnostic Request Response")
+
+    def set_complex_parameter(self, qualifier, iteration, sub_parameter, value):
+        self.com_object.SetComplexParameter(qualifier, iteration, sub_parameter, value)
+
+    def set_parameter(self, qualifier, value):
+        self.com_object.SetParameter(qualifier, value)

py_canoe/core/child_elements/diagnostic_response.py

@@ -0,0 +1,34 @@
+from typing import Union
+
+
+class DiagnosticResponse:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def positive(self) -> bool:
+        return self.com_object.Positive
+
+    @property
+    def response_code(self) -> int:
+        return self.com_object.ResponseCode
+
+    @property
+    def sender(self) -> str:
+        return self.com_object.Sender
+
+    @property
+    def stream(self) -> bytearray:
+        return bytearray(self.com_object.Stream)
+
+    def get_complex_iteration_count(self, qualifier: str) -> int:
+        return self.com_object.GetComplexIterationCount(qualifier)
+
+    def get_complex_parameter(self, qualifier: str, iteration: int, sub_parameter: str, mode: int) -> Union[bytearray, int, str]:
+        return self.com_object.GetComplexParameter(qualifier, iteration, sub_parameter, mode)
+
+    def get_parameter(self, qualifier: str, mode: int) -> Union[bytearray, int, str]:
+        return self.com_object.GetParameter(qualifier, mode)
+
+    def is_complex_parameter(self, qualifier: str) -> bool:
+        return self.com_object.IsComplexParameter(qualifier)

py_canoe/core/child_elements/diagnostic_responses.py

@@ -0,0 +1,13 @@
+from py_canoe.core.child_elements.diagnostic_response import DiagnosticResponse
+
+
+class DiagnosticResponses:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'DiagnosticResponse':
+        return DiagnosticResponse(self.com_object.item(index))

py_canoe/core/child_elements/diagnostics_setup.py

@@ -0,0 +1,254 @@
+import win32com.client
+
+
+class DiagnosticsSetup:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def diag_descriptions(self) -> 'DiagDescriptions':
+        return DiagDescriptions(self.com_object.DiagDescriptions)
+
+
+class DiagDescriptions:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'DiagDescription':
+        return DiagDescription(self.com_object.Item(index))
+
+    def add(self, network: str, file_path: str, ecu_identifier: str=None) -> 'DiagDescription':
+        if ecu_identifier is None:
+            return DiagDescription(self.com_object.Add(network, file_path))
+        else:
+            return DiagDescription(self.com_object.AddEx(network, file_path, ecu_identifier))
+
+    def add_diag_access(self, network: str, file_path: str, ecu_identifier: str=None) -> 'DiagDescription':
+        if ecu_identifier is None:
+            return DiagDescription(self.com_object.AddDiagAccess(network, file_path))
+        else:
+            return DiagDescription(self.com_object.AddDiagAccessEx(network, file_path, ecu_identifier))
+
+    def remove(self, index: int):
+        self.com_object.Remove(index)
+
+
+class DiagDescription:
+    def __init__(self, com_object):
+        self.com_object = win32com.client.Dispatch(com_object)
+
+    @property
+    def additional_descriptions(self) -> 'AdditionalDescriptions':
+        return AdditionalDescriptions(self.com_object.AdditionalDescriptions)
+
+    @property
+    def diag_variants(self) -> 'DiagVariants':
+        return DiagVariants(self.com_object.DiagVariants)
+
+    @property
+    def file_path(self) -> str:
+        return self.com_object.FilePath
+
+    @property
+    def information(self) -> str:
+        return self.com_object.Information
+
+    @property
+    def interface(self) -> str:
+        return self.com_object.Interface
+
+    @interface.setter
+    def interface(self, interface_qualifier: str):
+        self.com_object.Interface = interface_qualifier
+
+    @property
+    def interpretation_order(self) -> 'InterpretationOrder':
+        return InterpretationOrder(self.com_object.InterpretationOrder)
+
+    @property
+    def language(self) -> str:
+        return self.com_object.Language
+
+    @language.setter
+    def language(self, value: str):
+        self.com_object.Language = value
+
+    @property
+    def manual_communication_parameters(self) -> bool:
+        return self.com_object.ManualCommunicationParameters
+
+    @property
+    def mode(self) -> str:
+        return self.com_object.Mode
+
+    @property
+    def name(self) -> str:
+        return self.com_object.Name
+
+    @property
+    def network(self) -> str:
+        return self.com_object.Network
+
+    @property
+    def node(self) -> str:
+        return self.com_object.Node
+
+    @property
+    def port(self) -> str:
+        return self.com_object.Port
+
+    @port.setter
+    def port(self, value: str):
+        self.com_object.Port = value
+
+    @property
+    def qualifier(self) -> str:
+        return self.com_object.Qualifier
+
+    @property
+    def seed_n_key_dll(self) -> str:
+        return self.com_object.SeedNKeyDLL
+
+    @seed_n_key_dll.setter
+    def seed_n_key_dll(self, value: str):
+        self.com_object.SeedNKeyDLL = value
+
+    @property
+    def variant(self) -> str:
+        return self.com_object.Variant
+
+    @variant.setter
+    def variant(self, variant_qualifier: str):
+        self.com_object.Variant = variant_qualifier
+
+    def close_windows(self, windows: int = None):
+        if windows is None:
+            self.com_object.CloseWindows()
+        else:
+            self.com_object.CloseWindows(windows)
+
+    def open_windows(self, windows: int = None):
+        if windows is None:
+            self.com_object.OpenWindows()
+        else:
+            self.com_object.OpenWindows(windows)
+
+    def replace_description_file(self, file_path: str):
+        self.com_object.ReplaceDescriptionFile(file_path)
+
+
+class AdditionalDescriptions:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'AdditionalDescription':
+        return AdditionalDescription(self.com_object.Item(index))
+
+    def add(self, file_path: str, ecu_identifier: str=None) -> 'AdditionalDescription':
+        if ecu_identifier is None:
+            return AdditionalDescription(self.com_object.Add(file_path))
+        else:
+            return AdditionalDescription(self.com_object.AddEx(file_path, ecu_identifier))
+
+    def remove(self, index: int):
+        self.com_object.Remove(index)
+
+
+class AdditionalDescription:
+    def __init__(self, com_object):
+        self.com_object = win32com.client.Dispatch(com_object)
+
+    @property
+    def diag_variants(self) -> 'DiagVariants':
+        return DiagVariants(self.com_object.DiagVariants)
+
+    @property
+    def file_path(self) -> str:
+        return self.com_object.FilePath
+
+    @property
+    def master_description(self) -> 'DiagDescription':
+        return DiagDescription(self.com_object.MasterDescription)
+
+    @property
+    def language(self) -> str:
+        return self.com_object.Language
+
+    @language.setter
+    def language(self, value: str):
+        self.com_object.Language = value
+
+    @property
+    def name(self) -> str:
+        return self.com_object.Name
+
+    @property
+    def qualifier(self) -> str:
+        return self.com_object.Qualifier
+
+    @property
+    def variant(self) -> str:
+        return self.com_object.Variant
+
+    @variant.setter
+    def variant(self, variant_qualifier: str):
+        self.com_object.Variant = variant_qualifier
+
+    def close_windows(self, windows: int = None):
+        if windows is None:
+            self.com_object.CloseWindows()
+        else:
+            self.com_object.CloseWindows(windows)
+
+    def open_windows(self, windows: int = None):
+        if windows is None:
+            self.com_object.OpenWindows()
+        else:
+            self.com_object.OpenWindows(windows)
+
+
+class DiagVariants:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'DiagVariant':
+        return DiagVariant(self.com_object.Item(index))
+
+
+class DiagVariant:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def name(self) -> str:
+        return self.com_object.Name
+
+    @property
+    def qualifier(self) -> str:
+        return self.com_object.Qualifier
+
+class InterpretationOrder:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'DiagDescription':
+        return DiagDescription(self.com_object.Item(index))
+
+    def move(self, from_index: int, to_index: int):
+        self.com_object.Move(from_index, to_index)

py_canoe/core/child_elements/distributed_mode.py

@@ -0,0 +1,74 @@
+import win32com.client
+
+
+class DistributedMode:
+    """
+    Provides the distributed mode management API.
+    """
+    def __init__(self, com_object) -> None:
+        self.com_object = com_object
+
+    @property
+    def auto_connect_on_program_start(self) -> bool:
+        return self.com_object.AutoConnectOnProgramStart
+
+    @auto_connect_on_program_start.setter
+    def auto_connect_on_program_start(self, value: bool):
+        self.com_object.AutoConnectOnProgramStart = value
+
+    @property
+    def auto_disconnect_on_measurement_stop(self) -> bool:
+        return self.com_object.AutoDisconnectOnMeasurementStop
+
+    @auto_disconnect_on_measurement_stop.setter
+    def auto_disconnect_on_measurement_stop(self, value: bool):
+        self.com_object.AutoDisconnectOnMeasurementStop = value
+
+    @property
+    def connected(self) -> bool:
+        return self.com_object.Connected
+
+    @property
+    def remote_time_auto_adjust(self) -> bool:
+        return self.com_object.RemoteTimeAutoAdjust
+
+    @remote_time_auto_adjust.setter
+    def remote_time_auto_adjust(self, value: bool):
+        self.com_object.RemoteTimeAutoAdjust = value
+
+    @property
+    def rt_server(self) -> str:
+        return self.com_object.RTServer
+
+    @rt_server.setter
+    def rt_server(self, value: str):
+        self.com_object.RTServer = value
+
+    def connect(self):
+        self.com_object.Connect()
+
+    def disconnect(self):
+        self.com_object.Disconnect()
+
+    def get_rt_server_occupancy_info(self, remote_address: str) -> 'RTServerOccupancyInfo':
+        return RTServerOccupancyInfo(self.com_object.GetRTServerOccupancyInfo(remote_address))
+
+
+class RTServerOccupancyInfo:
+    """
+    Represents the occupancy information of a remote test server.
+    """
+    def __init__(self, com_object) -> None:
+        self.com_object = com_object
+
+    @property
+    def client(self) -> str:
+        return self.com_object.Client
+
+    @property
+    def used_in_distributed_mode(self) -> bool:
+        return self.com_object.UsedInDistributedMode
+
+    @property
+    def used_in_standalone_mode(self) -> bool:
+        return self.com_object.UsedInStandaloneMode