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

py_canoe/core/child_elements/variables.py

@@ -0,0 +1,29 @@
+from typing import Union
+from py_canoe.core.child_elements.variable import Variable
+
+
+class Variables:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def count(self):
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'Variable':
+        return Variable(self.com_object.Item(index))
+
+    def add(self, name: str):
+        return self.com_object.Add(name)
+
+    def add_ex(self, name: str, initial_value: Union[int, float], min_value: Union[int, float], max_value: Union[int, float]):
+        return self.com_object.AddEx(name, initial_value, min_value, max_value)
+
+    def add_writeable(self, name: str, initial_value: Union[int, float]):
+        return self.com_object.AddWriteable(name, initial_value)
+
+    def add_writable_ex(self, name: str, initial_value: Union[int, float], min_value: Union[int, float] = None, max_value: Union[int, float] = None):
+        return self.com_object.AddWritableEx(name, initial_value, min_value, max_value)
+
+    def remove(self, variable):
+        return self.com_object.Remove(variable)

py_canoe/core/child_elements/variables_file.py

@@ -0,0 +1,15 @@
+class VariablesFile:
+    def __init__(self, com_object):
+        self.com_object = 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

py_canoe/core/child_elements/variables_files.py

@@ -0,0 +1,19 @@
+from py_canoe.core.child_elements.variables_file import VariablesFile
+
+
+class VariablesFiles:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def count(self):
+        return self.com_object.Count
+
+    def item(self, index: int) -> VariablesFile:
+        return VariablesFile(self.com_object.Item(index))
+
+    def add(self, name: str):
+        return self.com_object.Add(name)
+
+    def remove(self, variable_file):
+        return self.com_object.Remove(variable_file)

py_canoe/core/child_elements/visual_sequence_setup.py

@@ -0,0 +1,46 @@
+import win32com.client
+
+
+class VisualSequenceSetup:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def visual_sequences(self) -> 'VisualSequences':
+        return VisualSequences(self.com_object.VisualSequences)
+
+
+class VisualSequences:
+    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) -> 'VisualSequence':
+        return VisualSequence(self.com_object.Item(index))
+
+    def import_visual_sequence(self, name: str, file_name: str):
+        return self.com_object.Import(name, file_name)
+
+    def remove(self, index: int):
+        self.com_object.Remove(index)
+
+
+class VisualSequence:
+    def __init__(self, com_object):
+        self.com_object = win32com.client.Dispatch(com_object)
+
+    @property
+    def name(self) -> str:
+        return self.com_object.Name
+
+    def is_running(self) -> bool:
+        return self.com_object.IsRunning()
+
+    def start(self):
+        self.com_object.Start()
+
+    def stop(self):
+        self.com_object.Stop()

py_canoe/core/child_elements/vt_system.py

@@ -0,0 +1,83 @@
+
+import win32com.client
+from .available_modules import AvailableModules
+from .configured_modules import ConfiguredModules, ConfiguredChannel, ConfiguredModule
+from .connected_modules import ConnectedModules
+from .network_adapters import NetworkAdapters
+
+class VTSystem:
+	"""
+	Represents the VT System configuration in CANoe.
+	"""
+	def __init__(self, vt_system_com_object) -> None:
+		self.com_object = win32com.client.Dispatch(vt_system_com_object)
+
+	@property
+	def available_modules(self) -> AvailableModules:
+		"""Collection of known module types which can be added to VT System."""
+		return AvailableModules(self.com_object.AvailableModules)
+
+	@property
+	def configured_modules(self) -> ConfiguredModules:
+		"""Collection of VT System modules currently configured in CANoe."""
+		return ConfiguredModules(self.com_object.ConfiguredModules)
+
+	@property
+	def connected_modules(self) -> ConnectedModules:
+		"""Collection of VT System modules currently connected to the computer."""
+		return ConnectedModules(self.com_object.ConnectedModules)
+
+	@property
+	def module_description_folder(self) -> str:
+		"""Absolute path to the folder where CANoe stores VT System module description files."""
+		return self.com_object.ModuleDescriptionFolder
+
+	@property
+	def network_adapters(self) -> NetworkAdapters:
+		"""Collection of available network adapters for VT System communication."""
+		return NetworkAdapters(self.com_object.NetworkAdapters)
+
+	@property
+	def selected_network_adapter_id(self) -> int:
+		"""ID of the network adapter used for VT System communication."""
+		return self.com_object.SelectedNetworkAdapterID
+
+	@selected_network_adapter_id.setter
+	def selected_network_adapter_id(self, value: int):
+		self.com_object.SelectedNetworkAdapterID = value
+
+	def adapt_to_hardware(self):
+		"""Adapts the VT System configuration to the actually connected modules."""
+		self.com_object.AdaptToHardware()
+
+	def export_configuration(self, file_name: str):
+		"""Exports the current VT System configuration to a VTCFG file."""
+		self.com_object.ExportConfiguration(file_name)
+
+	def import_configuration(self, file_name: str, mode: int):
+		"""Imports a previously exported VTCFG file. Mode: 0=Merge, 1=Replace."""
+		self.com_object.ImportConfiguration(file_name, mode)
+
+	def import_module_description(self, file_name: str):
+		"""Imports a module description XML file into CANoe."""
+		self.com_object.ImportModuleDescription(file_name)
+
+	def new_configuration_from_hardware(self):
+		"""Creates a new configuration matching the currently connected VT System modules."""
+		self.com_object.NewConfigurationFromHardware()
+
+	def set_all_modules_offline(self):
+		"""Switches all configured modules to offline mode."""
+		self.com_object.SetAllModulesOffline()
+
+	def set_all_modules_online(self):
+		"""Switches all configured modules to online mode."""
+		self.com_object.SetAllModulesOnline()
+
+	def get_channel_by_name(self, channel_name: str) -> ConfiguredChannel:
+		"""Returns a ConfiguredChannel object for the given channel name."""
+		return ConfiguredChannel(self.com_object.GetChannelByName(channel_name))
+
+	def get_module_by_name(self, module_name: str) -> ConfiguredModule:
+		"""Returns a ConfiguredModule object for the given module name."""
+		return ConfiguredModule(self.com_object.GetModuleByName(module_name))

py_canoe/core/child_elements/vtt_sut_import_result.py

@@ -0,0 +1,21 @@
+from py_canoe.core.child_elements.application_models import ApplicationModels
+from py_canoe.core.child_elements.data_source import DataSource
+
+
+class VttSutImportResult:
+    """
+    The VttSutImportResult object encapsulates the results of the import vVIRTUALtarget SUTs.
+    """
+    def __init__(self, com_object) -> None:
+        self.com_object = com_object
+
+    @property
+    def created_application_models(self) -> 'ApplicationModels':
+        return ApplicationModels(self.com_object.CreatedApplicationModels)
+
+    @property
+    def created_data_source(self) -> 'DataSource':
+        return DataSource(self.com_object.CreatedDataSource)
+
+    def success(self) -> bool:
+        return self.com_object.Success

py_canoe/core/child_elements/write.py

@@ -0,0 +1,71 @@
+from typing import Union
+
+from py_canoe.helpers.common import logger
+
+
+class Write:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def text(self) -> Union[str, None]:
+        try:
+            text_data: str = self.com_object.Text
+            logger.info("📖 Text read successfully from write window")
+            for line in text_data.splitlines():
+                logger.info(f"    {line}")
+            return text_data
+        except Exception as e:
+            logger.error(f"❌ Error getting text from write window: {e}")
+            return None
+
+    def clear(self) -> bool:
+        try:
+            self.com_object.Clear()
+            logger.info("🧹 Write window cleared successfully")
+            return True
+        except Exception as e:
+            logger.error(f"❌ Error clearing write window: {e}")
+            return False
+
+    def copy(self) -> bool:
+        try:
+            self.com_object.Copy()
+            logger.info("📷 Write Window content copied to clipboard successfully")
+            return True
+        except Exception as e:
+            logger.error(f"❌ Error copying write window content: {e}")
+            return False
+
+    def enable_output_file(self, output_file: str, tab_index=None) -> bool:
+        try:
+            if tab_index is not None:
+                self.com_object.EnableOutputFile(output_file, tab_index)
+            else:
+                self.com_object.EnableOutputFile(output_file)
+            logger.info(f"✔️ Enabled write window output file: {output_file}")
+            return True
+        except Exception as e:
+            logger.error(f"❌ Error enabling write window output file '{output_file}': {e}")
+            return False
+
+    def disable_output_file(self, tab_index=None) -> bool:
+        try:
+            if tab_index is not None:
+                self.com_object.DisableOutputFile(tab_index)
+            else:
+                self.com_object.DisableOutputFile()
+            logger.info("⏹️ Disabled write window output file")
+            return True
+        except Exception as e:
+            logger.error(f"❌ Error disabling write window output file: {e}")
+            return False
+
+    def output(self, text: str) -> bool:
+        try:
+            self.com_object.Output(text)
+            logger.info(f"✍️ Text written in write window: {text}")
+            return True
+        except Exception as e:
+            logger.error(f"❌ Error writing text in write window: {e}")
+            return False

py_canoe/core/child_elements/xcp_setup.py

@@ -0,0 +1,12 @@
+import win32com.client
+
+from py_canoe.core.child_elements.mc_ecus import McECUs
+
+
+class XCPSetup:
+    def __init__(self, com_object) -> None:
+        self.com_object = com_object
+
+    @property
+    def mcus(self) -> 'McECUs':
+        return McECUs(self.com_object.MCUs)