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

py_canoe/core/child_elements/application_specific_modules.py

@@ -0,0 +1,16 @@
+import win32com.client
+
+from py_canoe.core.child_elements.application_specific_module import ApplicationSpecificModule
+
+
+class ApplicationSpecificModules:
+    """Represents the collection of available application specific modules."""
+    def __init__(self, app_specific_modules_com_obj):
+        self.com_object = win32com.client.Dispatch(app_specific_modules_com_obj)
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'ApplicationSpecificModule':
+        return ApplicationSpecificModule(self.com_object.Item(index))

py_canoe/core/child_elements/audio_interface.py

@@ -0,0 +1,28 @@
+from typing import Union
+
+
+class AudioInterface:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    def mute(self, line_in_out: int, mute: Union[int, None]=None) -> int:
+        if mute is None:
+            return self.com_object.Mute(line_in_out)
+        else:
+            obj = self.com_object.Mute(line_in_out)
+            obj = mute
+            return self.com_object.Mute(line_in_out)
+
+    def volume(self, line_in_out: int, volume: Union[int, None]=None) -> int:
+        if volume is None:
+            return self.com_object.Volume(line_in_out)
+        else:
+            obj = self.com_object.Volume(line_in_out)
+            obj = volume
+            return self.com_object.Volume(line_in_out)
+
+    def connect_to_label(self, line_in_out: int, connection_label: int):
+        self.com_object.ConnectToLabel(line_in_out, connection_label)
+
+    def disconnect_from_label(self, line_in_out: int, connection_label: int):
+        self.com_object.DisconnectFromLabel(line_in_out, connection_label)

py_canoe/core/child_elements/available_modules.py

@@ -0,0 +1,22 @@
+import win32com.client
+
+from py_canoe.core.child_elements.application_specific_modules import ApplicationSpecificModules
+from py_canoe.core.child_elements.basic_modules import BasicModules
+
+
+class AvailableModules:
+    """
+    Represents the collection of known VT module types that can be added to VT System.
+    """
+    def __init__(self, available_modules_com_obj):
+        self.com_object = win32com.client.Dispatch(available_modules_com_obj)
+
+    @property
+    def application_specific_modules(self) -> 'ApplicationSpecificModules':
+        """Returns the collection of available application specific modules."""
+        return ApplicationSpecificModules(self.com_object.ApplicationSpecificModules)
+
+    @property
+    def basic_modules(self) -> 'BasicModules':
+        """Returns the collection of available basic modules."""
+        return BasicModules(self.com_object.BasicModules)

py_canoe/core/child_elements/basic_module.py

@@ -0,0 +1,19 @@
+import win32com.client
+
+
+class BasicModule:
+    """
+    Represents a basic VT System module (e.g., VT1004, VT2004, etc.).
+    """
+    def __init__(self, basic_module_com_obj):
+        self.com_object = win32com.client.Dispatch(basic_module_com_obj)
+
+    @property
+    def name(self) -> str:
+        """The name of the module."""
+        return self.com_object.Name
+
+    @property
+    def type(self) -> int:
+        """The type of the module (e.g. 1004)."""
+        return self.com_object.Type

py_canoe/core/child_elements/basic_modules.py

@@ -0,0 +1,16 @@
+import win32com.client
+
+from py_canoe.core.child_elements.basic_module import BasicModule
+
+
+class BasicModules:
+    """Represents the collection of available basic modules."""
+    def __init__(self, basic_modules_com_obj):
+        self.com_object = win32com.client.Dispatch(basic_modules_com_obj)
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'BasicModule':
+        return BasicModule(self.com_object.Item(index))

py_canoe/core/child_elements/c_libraries.py

@@ -0,0 +1,28 @@
+import win32com.client
+
+from py_canoe.core.child_elements.c_library import CLibrary
+
+
+class CLibraries:
+    """
+    Represents the collection of C libraries in a CANoe configuration.
+    """
+    def __init__(self, com_object) -> None:
+        self.com_object = win32com.client.Dispatch(com_object)
+
+    @property
+    def count(self) -> int:
+        """Returns the number of CLibrary objects in the collection."""
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'CLibrary':
+        """Returns the CLibrary object at the specified index (1-based)."""
+        return CLibrary(self.com_object.Item(index))
+
+    def add(self, file_path: str) -> 'CLibrary':
+        """Adds a new C library to the collection and returns the CLibrary object."""
+        return CLibrary(self.com_object.Add(file_path))
+
+    def remove(self, clibrary: 'CLibrary'):
+        """Removes the specified CLibrary object from the collection."""
+        self.com_object.Remove(clibrary.com_object)

py_canoe/core/child_elements/c_library.py

@@ -0,0 +1,33 @@
+import win32com.client
+
+
+class CLibrary:
+    """
+    Represents a single C library in a CANoe configuration.
+    """
+    def __init__(self, com_object) -> None:
+        self.com_object = win32com.client.Dispatch(com_object)
+
+    @property
+    def enabled(self) -> bool:
+        """Get or set whether the library is enabled."""
+        return self.com_object.Enabled
+
+    @enabled.setter
+    def enabled(self, value: bool):
+        self.com_object.Enabled = value
+
+    @property
+    def full_name(self) -> str:
+        """Returns the complete path to the C library file."""
+        return self.com_object.FullName
+
+    @property
+    def name(self) -> str:
+        """Returns the name of the C library file."""
+        return self.com_object.Name
+
+    @property
+    def path(self) -> str:
+        """Returns the path to the C library file."""
+        return self.com_object.Path

py_canoe/core/child_elements/can_controller.py

@@ -0,0 +1,74 @@
+import win32com.client
+
+
+class CanController:
+    def __init__(self, com_object):
+        self.com_object = win32com.client.Dispatch(com_object)
+
+    @property
+    def acknowledge(self):
+        return self.com_object.Acknowledge
+
+    @acknowledge.setter
+    def acknowledge(self, value: bool):
+        self.com_object.Acknowledge = value
+
+    @property
+    def baudrate(self):
+        return self.com_object.Baudrate
+
+    @baudrate.setter
+    def baudrate(self, value: int):
+        self.com_object.Baudrate = value
+
+    @property
+    def btr0(self):
+        return self.com_object.BTR0
+
+    @property
+    def btr1(self):
+        return self.com_object.BTR1
+
+    @property
+    def output_control(self):
+        return self.com_object.OutputControl
+
+    @output_control.setter
+    def output_control(self, value: int):
+        self.com_object.OutputControl = value
+
+    @property
+    def samples(self):
+        return self.com_object.Samples
+
+    @samples.setter
+    def samples(self, value: int):
+        self.com_object.Samples = value
+
+    @property
+    def self_ack_enabled(self):
+        return self.com_object.SelfAckEnabled
+
+    @self_ack_enabled.setter
+    def self_ack_enabled(self, value: bool):
+        self.com_object.SelfAckEnabled = value
+
+    @property
+    def synchronisation(self):
+        return self.com_object.Synchronisation
+
+    @synchronisation.setter
+    def synchronisation(self, value: int):
+        self.com_object.Synchronisation = value
+
+    def can_set_config(self, baudrate: int, tseg1: int, tseg2: int, sjw: int, sam: int, flags: int):
+        self.com_object.CANSetConfig(baudrate, tseg1, tseg2, sjw, sam, flags)
+
+    def can_set_fd_arb_phase_config(self, baudrate: int, tseg1: int, tseg2: int, sjw: int, sam: int, flags: int):
+        self.com_object.CANSetFDArbPhaseConfig(baudrate, tseg1, tseg2, sjw, sam, flags)
+
+    def can_set_fd_data_phase_config(self, baudrate: int, tseg1: int, tseg2: int, sjw: int, sam: int, flags: int):
+        self.com_object.CANSetFDDataPhaseConfig(baudrate, tseg1, tseg2, sjw, sam, flags)
+
+    def set_btr(self, btr0: int, btr1: int):
+        self.com_object.SetBTR(btr0, btr1)

py_canoe/core/child_elements/capl_function.py

@@ -0,0 +1,17 @@
+class CaplFunction:
+    """
+    The CAPLFunction object represents a CAPL function.
+    """
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def parameter_count(self) -> int:
+        return self.com_object.ParameterCount
+
+    @property
+    def parameter_types(self) -> list:
+        return self.com_object.ParameterTypes
+
+    def call(self, *parameters):
+        return self.com_object.Call(*parameters)

py_canoe/core/child_elements/ccp_setup.py

@@ -0,0 +1,15 @@
+import win32com.client
+
+from py_canoe.core.child_elements.mc_ecus import McECUs
+
+
+class CCPSetup:
+    """
+    The CCPSetup object represents the CCP settings of a CANoe configuration.
+    """
+    def __init__(self, com_object) -> None:
+        self.com_object = com_object
+
+    @property
+    def ecus(self) -> 'McECUs':
+        return McECUs(self.com_object.ECUs)

py_canoe/core/child_elements/channel.py

@@ -0,0 +1,20 @@
+import win32com.client
+
+from py_canoe.core.child_elements.can_controller import CanController
+
+
+class Channel:
+    def __init__(self, com_object):
+        self.com_object = win32com.client.Dispatch(com_object)
+
+    @property
+    def bus_type(self) -> int:
+        return self.com_object.BusType
+
+    @property
+    def controller(self) -> 'CanController':
+        return CanController(self.com_object.Controller)
+
+    @property
+    def number(self) -> int:
+        return self.com_object.Number

py_canoe/core/child_elements/channels.py

@@ -0,0 +1,19 @@
+from py_canoe.core.child_elements.channel import Channel
+
+
+class Channels:
+    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) -> 'Channel':
+        return Channel(self.com_object.Item(index))
+
+    def add(self, type: int, number: int) -> 'Channel':
+        return Channel(self.com_object.Add(type, number))
+
+    def remove(self, index: int):
+        self.com_object.Remove(index)

py_canoe/core/child_elements/communication_setup.py

@@ -0,0 +1,23 @@
+from py_canoe.core.child_elements.application_model_setup import ApplicationModelSetup
+from py_canoe.core.child_elements.data_source_setup import DataSourceSetup
+from py_canoe.core.child_elements.vtt_sut_import_result import VttSutImportResult
+
+
+class CommunicationSetup:
+    """
+    Provides access to CANoe's System and Communication Setup via COM.
+    """
+    def __init__(self, com_object) -> None:
+        self.com_object = com_object
+
+    @property
+    def application_model_setup(self) -> 'ApplicationModelSetup':
+        return ApplicationModelSetup(self.com_object.ApplicationModelSetup)
+
+    @property
+    def data_source_setup(self) -> 'DataSourceSetup':
+        return DataSourceSetup(self.com_object.DataSourceSetup)
+
+    @property
+    def import_vtt_sut(self, sut_manifest_path: str) -> 'VttSutImportResult':
+        return VttSutImportResult(self.com_object.ImportVttSut(sut_manifest_path))

py_canoe/core/child_elements/compile_result.py

@@ -0,0 +1,22 @@
+class CompileResult:
+    """
+    The CompileResult object represents the result of the last compilation of the CAPL object.
+    """
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def error_message(self) -> str:
+        return self.com_object.ErrorMessage
+
+    @property
+    def node_name(self) -> str:
+        return self.com_object.NodeName
+
+    @property
+    def result(self) -> int:
+        return self.com_object.result
+
+    @property
+    def source_file(self) -> str:
+        return self.com_object.SourceFile

py_canoe/core/child_elements/configured_channel.py

@@ -0,0 +1,48 @@
+import win32com.client
+
+
+class ConfiguredChannel:
+    """
+    Python wrapper for CANoe COM ConfiguredChannel object.
+    Represents a VT System channel in the current configuration.
+    """
+    def __init__(self, com_object):
+        self.com_object = win32com.client.Dispatch(com_object)
+
+    @property
+    def comment(self):
+        return self.com_object.Comment
+    @comment.setter
+    def comment(self, value):
+        self.com_object.Comment = value
+
+    @property
+    def measurement_values(self):
+        return self.com_object.MeasurementValues
+
+    @property
+    def name(self):
+        return self.com_object.Name
+    @name.setter
+    def name(self, value):
+        self.com_object.Name = value
+
+    @property
+    def pin_labels(self):
+        return self.com_object.PinLabels
+
+    @property
+    def relay_constraints(self):
+        return self.com_object.RelayConstraints
+
+    @property
+    def start_state(self):
+        return self.com_object.StartState
+
+    @property
+    def user_measurement_values(self):
+        return self.com_object.UserMeasurementValues
+
+    @property
+    def value_constraints(self):
+        return self.com_object.ValueConstraints

py_canoe/core/child_elements/configured_channels.py

@@ -0,0 +1,21 @@
+from py_canoe.core.child_elements.configured_channel import ConfiguredChannel
+
+
+class ConfiguredChannels:
+    """
+    Python wrapper for CANoe COM ConfiguredChannels object.
+    Represents the collection of channels on a configured VT System module.
+    """
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def count(self):
+        """Returns the number of channels in the collection."""
+        return self.com_object.Count
+
+    def item(self, index) -> ConfiguredChannel:
+        """
+        Returns the ConfiguredChannel object at the given index (1-based).
+        """
+        return ConfiguredChannel(self.com_object.Item(index))

py_canoe/core/child_elements/configured_module.py

@@ -0,0 +1,82 @@
+import win32com.client
+
+
+class ConfiguredModule:
+    """
+    Python wrapper for CANoe COM ConfiguredModule object.
+    Represents a VT System module in the current configuration.
+    """
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def channels(self):
+        return self.com_object.Channels
+
+    @property
+    def comment(self):
+        return self.com_object.Comment
+
+    @comment.setter
+    def comment(self, value):
+        self.com_object.Comment = value
+
+    @property
+    def connectors(self):
+        return self.com_object.Connectors
+
+    @property
+    def internal_voltage(self):
+        return self.com_object.InternalVoltage
+
+    @property
+    def is_offline(self):
+        return self.com_object.IsOffline
+
+    @property
+    def lvds_voltage(self):
+        return self.com_object.LVDSVoltage
+
+    @property
+    def lvds_voltage_output_enabled(self):
+        return self.com_object.LVDSVoltageOutputEnabled
+
+    @property
+    def measurement_values(self):
+        return self.com_object.MeasurementValues
+
+    @property
+    def name(self):
+        return self.com_object.Name
+
+    @name.setter
+    def name(self, value):
+        self.com_object.Name = value
+
+    @property
+    def piggy_type(self):
+        return self.com_object.PiggyType
+
+    @property
+    def pin_labels(self):
+        return self.com_object.PinLabels
+
+    @property
+    def relay_constraints(self):
+        return self.com_object.RelayConstraints
+
+    @property
+    def start_state(self):
+        return self.com_object.StartState
+
+    @property
+    def type(self):
+        return self.com_object.Type
+
+    @property
+    def user_measurement_values(self):
+        return self.com_object.UserMeasurementValues
+
+    @property
+    def value_constraints(self):
+        return self.com_object.ValueConstraints

py_canoe/core/child_elements/configured_modules.py

@@ -0,0 +1,61 @@
+import win32com.client
+
+from py_canoe.core.child_elements.configured_module import ConfiguredModule
+
+
+class ConfiguredModules:
+    """
+    Python wrapper for CANoe COM ConfiguredModules object.
+    Represents the collection of VT System modules currently configured.
+    """
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def count(self):
+        """Returns the number of modules in the collection."""
+        return self.com_object.Count
+
+    def item(self, index) -> 'ConfiguredModule':
+        """
+        Returns the ConfiguredModule object at the given index (1-based).
+        Args:
+            index (int): Index of the module (1-based)
+        Returns:
+            ConfiguredModule COM object
+        """
+        return ConfiguredModule(self.com_object.Item(index))
+
+    def add_application_specific_module(self, module_id) -> 'ConfiguredModule':
+        """
+        Adds an application specific module to the configuration.
+        Args:
+            module_id (int): ID of the application specific module to add
+        Returns:
+            ConfiguredModule COM object
+        """
+        return ConfiguredModule(self.com_object.AddApplicationSpecificModule(module_id))
+
+    def add_basic_module(self, module_type) -> 'ConfiguredModule':
+        """
+        Adds a basic module to the configuration.
+        Args:
+            module_type (int): Type of the module to add (e.g. 1004)
+        Returns:
+            ConfiguredModule COM object
+        """
+        return ConfiguredModule(self.com_object.AddBasicModule(module_type))
+
+    def remove(self, index):
+        """
+        Removes a single module from the configuration.
+        Args:
+            index (int): 1-based index of the module to remove
+        """
+        self.com_object.Remove(index)
+
+    def remove_all(self):
+        """
+        Removes all modules from the configuration.
+        """
+        self.com_object.RemoveAll()

py_canoe/core/child_elements/connected_modules.py

@@ -0,0 +1,14 @@
+import win32com.client
+
+
+class ConnectedModules:
+    """Represents the collection of VT System modules currently connected to the computer."""
+    def __init__(self, connected_modules_com_obj):
+        self.com_object = win32com.client.Dispatch(connected_modules_com_obj)
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int):
+        return self.com_object.Item(index)  # Returns a ConnectedModule object

py_canoe/core/child_elements/data_source.py

@@ -0,0 +1,42 @@
+import win32com.client
+
+from py_canoe.core.child_elements.data_source_issues import DataSourceIssues
+
+
+class DataSource:
+    """
+    Provides access to the base interface of all data sources.
+    """
+    def __init__(self, com_object) -> None:
+        self.com_object = win32com.client.Dispatch(com_object)
+
+    @property
+    def id(self) -> int:
+        return self.com_object.Id
+
+    @property
+    def import_issues(self) -> 'DataSourceIssues':
+        return DataSourceIssues(self.com_object.ImportIssues)
+
+    @property
+    def import_parameters_raw(self) -> str:
+        return self.com_object.ImportParametersRaw
+
+    @property
+    def import_status(self) -> int:
+        return self.com_object.ImportStatus
+
+    @property
+    def is_group_source(self) -> bool:
+        return self.com_object.IsGroupSource
+
+    @property
+    def source_format(self) -> int:
+        return self.com_object.SourceFormat
+
+    @property
+    def source_type(self) -> int:
+        return self.com_object.SourceType
+
+    def import_data_source(self, merge_strategy: int) -> int:
+        return self.com_object.Import(merge_strategy)

py_canoe/core/child_elements/data_source_file.py

@@ -0,0 +1,21 @@
+import win32com.client
+
+
+class DataSourceFile:
+    """
+    Represents a single file in a DataSourceFiles collection.
+    """
+    def __init__(self, com_object) -> None:
+        self.com_object = win32com.client.Dispatch(com_object)
+
+    @property
+    def full_name(self) -> str:
+        return self.com_object.FullName
+
+    @property
+    def name(self) -> str:
+        return self.com_object.Name
+
+    @property
+    def path(self) -> str:
+        return self.com_object.Path