powertrain-build 1.13.1__py3-none-any.whl → 1.13.3.dev3__py3-none-any.whl

powertrain_build/interface/ems.py

@@ -1,67 +1,67 @@
-# Copyright 2024 Volvo Car Corporation
-# Licensed under Apache 2.0.
-
-"""Module for extraction Energy Management System"""
-import os
-
-from powertrain_build.interface.base import BaseApplication, Signal
-from powertrain_build.lib import logger
-from powertrain_build.signal_interfaces import CsvSignalInterfaces
-from powertrain_build.build_proj_config import BuildProjConfig
-
-LOGGER = logger.create_logger(__file__)
-
-
-class CsvEMS(BaseApplication, CsvSignalInterfaces):
-    """Supplier part of the ECM"""
-    def __init__(self):
-        self._signals = {}
-        self.interfaces = {}
-        self._insignals = None
-        self._outsignals = None
-        self.projects = {}
-
-    def parse_definition(self, definition):
-        """Read the interface files.
-
-        Args:
-            definition (Path): Path to ProjectCfg.json
-        """
-        self.build_cfg = BuildProjConfig(os.path.normpath(str(definition)))
-        CsvSignalInterfaces.__init__(self, self.build_cfg, [])
-        self.projects[self.build_cfg.name] = self.build_cfg
-        self.config_path = self.build_cfg.get_if_cfg_dir()
-        self.name = self.build_cfg.name  # Set name for CsvSignalInterfaces
-        self._parse_io_cnfg(self.config_path)
-        self.name = 'Supplier_' + self.build_cfg.name  # set name for BaseApplication
-
-    def _get_signals(self):
-        """Look through interfaces and create Signal objects"""
-        self._insignals = set()
-        self._outsignals = set()
-        for interface_name, data in self.interfaces.items():
-            for signal_name, signal_data in data.items():
-                if signal_data['IOType'] == '-':
-                    # Signal is inactive
-                    continue
-                if signal_name in self._signals:
-                    signal = self._signals[signal_name]
-                else:
-                    signal = Signal(signal_name, self)
-                    self._signals.update({signal_name: signal})
-                if 'output' in interface_name.lower():
-                    # outport from ECM. Inport in EMS (from SPM)
-                    self._insignals.add(signal_name)
-                    signal.consumers = interface_name
-                else:
-                    signal.producers = interface_name
-                    self._outsignals.add(signal_name)
-
-    def get_signal_properties(self, signal):
-        """Find properties for a signal from interface files"""
-        for interface_name, interface_data in self.interfaces.items():
-            if signal.name in interface_data.keys():
-                properties = interface_data[signal.name]
-                properties['interface'] = interface_name
-                return properties
-        return {}
+# Copyright 2024 Volvo Car Corporation
+# Licensed under Apache 2.0.
+
+"""Module for extraction Energy Management System"""
+import os
+
+from powertrain_build.interface.base import BaseApplication, Signal
+from powertrain_build.lib import logger
+from powertrain_build.signal_interfaces import CsvSignalInterfaces
+from powertrain_build.build_proj_config import BuildProjConfig
+
+LOGGER = logger.create_logger(__file__)
+
+
+class CsvEMS(BaseApplication, CsvSignalInterfaces):
+    """Supplier part of the ECM"""
+    def __init__(self):
+        self._signals = {}
+        self.interfaces = {}
+        self._insignals = None
+        self._outsignals = None
+        self.projects = {}
+
+    def parse_definition(self, definition):
+        """Read the interface files.
+
+        Args:
+            definition (Path): Path to ProjectCfg.json
+        """
+        self.build_cfg = BuildProjConfig(os.path.normpath(str(definition)))
+        CsvSignalInterfaces.__init__(self, self.build_cfg, [])
+        self.projects[self.build_cfg.name] = self.build_cfg
+        self.config_path = self.build_cfg.get_if_cfg_dir()
+        self.name = self.build_cfg.name  # Set name for CsvSignalInterfaces
+        self._parse_io_cnfg(self.config_path)
+        self.name = 'Supplier_' + self.build_cfg.name  # set name for BaseApplication
+
+    def _get_signals(self):
+        """Look through interfaces and create Signal objects"""
+        self._insignals = set()
+        self._outsignals = set()
+        for interface_name, data in self.interfaces.items():
+            for signal_name, signal_data in data.items():
+                if signal_data['IOType'] == '-':
+                    # Signal is inactive
+                    continue
+                if signal_name in self._signals:
+                    signal = self._signals[signal_name]
+                else:
+                    signal = Signal(signal_name, self)
+                    self._signals.update({signal_name: signal})
+                if 'output' in interface_name.lower():
+                    # outport from ECM. Inport in EMS (from SPM)
+                    self._insignals.add(signal_name)
+                    signal.consumers = interface_name
+                else:
+                    signal.producers = interface_name
+                    self._outsignals.add(signal_name)
+
+    def get_signal_properties(self, signal):
+        """Find properties for a signal from interface files"""
+        for interface_name, interface_data in self.interfaces.items():
+            if signal.name in interface_data.keys():
+                properties = interface_data[signal.name]
+                properties['interface'] = interface_name
+                return properties
+        return {}

powertrain_build/interface/export_global_vars.py

@@ -1,121 +1,121 @@
-# Copyright 2024 Volvo Car Corporation
-# Licensed under Apache 2.0.
-
-"""Module to export information of global variables from powertrain_build projects."""
-
-import argparse
-import os
-import sys
-from typing import Dict, List, Optional, Tuple
-
-from ruamel.yaml import YAML
-
-from powertrain_build.build_proj_config import BuildProjConfig
-from powertrain_build.feature_configs import FeatureConfigs
-from powertrain_build.unit_configs import UnitConfigs
-
-
-PARSER_HELP = "Export global variables."
-
-
-def get_global_variables(project_config_path: str) -> Dict:
-    """Get global variables connected to PyBuild project.
-
-    Args:
-        project_config_path (str): Path to ProjectCfg.json file.
-    Returns:
-        (Dict): Dict containing project name and its global variables (name, type).
-    """
-    project_name, project_unit_config = _get_project_data(project_config_path)
-
-    variable_types = ["outports", "local_vars", "calib_consts", "nvm"]
-    variables = []
-    for variable_type in variable_types:
-        if variable_type not in project_unit_config:
-            continue
-
-        variables_info = [
-            {"name": variable, "type": _get_variable_type(variable_info)}
-            for variable, variable_info in project_unit_config[variable_type].items()
-        ]
-        variables.extend(variables_info)
-    return {"name": project_name, "variables": variables}
-
-
-def _get_variable_type(variable_info: Dict) -> str:
-    """Get variable type from variable info.
-
-    Args:
-        variable_info (Dict): Dictionary with the variable info.
-
-    Returns:
-        str: Variable type.
-    """
-    unit_name = list(variable_info.keys())[0]  # Getting any unit name, since variable type should be the same
-    return variable_info[unit_name]["type"]
-
-
-def _get_project_data(project_config_path: str) -> Tuple[str, Dict]:
-    """Gets data for a powertrain-build project.
-
-    Args:
-        project_config_path (str): Path to ProjectCfg.json file.
-    Returns:
-        project_name (str): Name of PyBuild project.
-        project_unit_config (dict): Dict mapping variable types to variables and their data.
-    """
-    build_cfg = BuildProjConfig(os.path.normpath(project_config_path))
-    feature_cfg = FeatureConfigs(build_cfg)
-    unit_cfg = UnitConfigs(build_cfg, feature_cfg)
-    project_unit_config = unit_cfg.get_per_cfg_unit_cfg()
-    return build_cfg.name, project_unit_config
-
-
-def _export_yaml(data: Dict, file_path: str) -> None:
-    """Exports data from dictionary to a yaml file.
-
-    Args:
-        data (Dict): Dictionary with data.
-        file_path (str): Path of the file to export data.
-    """
-    with open(file_path, "w", encoding="utf-8") as yaml_file:
-        yaml = YAML()
-        yaml.default_flow_style = False
-        yaml.dump(data, yaml_file)
-
-
-def export_global_vars(args: argparse.Namespace):
-    """Exports global variables as yaml file."""
-    global_variables = get_global_variables(args.project_config)
-    _export_yaml(global_variables, args.output_file)
-
-
-def _main(argv: Optional[List[str]] = None):
-    """Main function for CLI."""
-    parser = argparse.ArgumentParser(description=PARSER_HELP)
-    configure_parser(parser)
-    args = parser.parse_args(argv)
-    args.func(args)
-
-
-def configure_parser(parser: argparse.ArgumentParser):
-    """Configures the argument parser for the script.
-
-    Args:
-        parser (argparse.ArgumentParser): Argument parser.
-    """
-    parser.add_argument(
-        "--project-config",
-        help="Project root configuration file.",
-        required=True,
-    )
-    parser.add_argument(
-        "--output-file",
-        help="Output file to export global variables.",
-        required=True,
-    )
-    parser.set_defaults(func=export_global_vars)
-
-
-if __name__ == "__main__":
-    sys.exit(_main(sys.argv[1:]))
+# Copyright 2024 Volvo Car Corporation
+# Licensed under Apache 2.0.
+
+"""Module to export information of global variables from powertrain_build projects."""
+
+import argparse
+import os
+import sys
+from typing import Dict, List, Optional, Tuple
+
+from ruamel.yaml import YAML
+
+from powertrain_build.build_proj_config import BuildProjConfig
+from powertrain_build.feature_configs import FeatureConfigs
+from powertrain_build.unit_configs import UnitConfigs
+
+
+PARSER_HELP = "Export global variables."
+
+
+def get_global_variables(project_config_path: str) -> Dict:
+    """Get global variables connected to PyBuild project.
+
+    Args:
+        project_config_path (str): Path to ProjectCfg.json file.
+    Returns:
+        (Dict): Dict containing project name and its global variables (name, type).
+    """
+    project_name, project_unit_config = _get_project_data(project_config_path)
+
+    variable_types = ["outports", "local_vars", "calib_consts", "nvm"]
+    variables = []
+    for variable_type in variable_types:
+        if variable_type not in project_unit_config:
+            continue
+
+        variables_info = [
+            {"name": variable, "type": _get_variable_type(variable_info)}
+            for variable, variable_info in project_unit_config[variable_type].items()
+        ]
+        variables.extend(variables_info)
+    return {"name": project_name, "variables": variables}
+
+
+def _get_variable_type(variable_info: Dict) -> str:
+    """Get variable type from variable info.
+
+    Args:
+        variable_info (Dict): Dictionary with the variable info.
+
+    Returns:
+        str: Variable type.
+    """
+    unit_name = list(variable_info.keys())[0]  # Getting any unit name, since variable type should be the same
+    return variable_info[unit_name]["type"]
+
+
+def _get_project_data(project_config_path: str) -> Tuple[str, Dict]:
+    """Gets data for a powertrain-build project.
+
+    Args:
+        project_config_path (str): Path to ProjectCfg.json file.
+    Returns:
+        project_name (str): Name of PyBuild project.
+        project_unit_config (dict): Dict mapping variable types to variables and their data.
+    """
+    build_cfg = BuildProjConfig(os.path.normpath(project_config_path))
+    feature_cfg = FeatureConfigs(build_cfg)
+    unit_cfg = UnitConfigs(build_cfg, feature_cfg)
+    project_unit_config = unit_cfg.get_per_cfg_unit_cfg()
+    return build_cfg.name, project_unit_config
+
+
+def _export_yaml(data: Dict, file_path: str) -> None:
+    """Exports data from dictionary to a yaml file.
+
+    Args:
+        data (Dict): Dictionary with data.
+        file_path (str): Path of the file to export data.
+    """
+    with open(file_path, "w", encoding="utf-8") as yaml_file:
+        yaml = YAML()
+        yaml.default_flow_style = False
+        yaml.dump(data, yaml_file)
+
+
+def export_global_vars(args: argparse.Namespace):
+    """Exports global variables as yaml file."""
+    global_variables = get_global_variables(args.project_config)
+    _export_yaml(global_variables, args.output_file)
+
+
+def _main(argv: Optional[List[str]] = None):
+    """Main function for CLI."""
+    parser = argparse.ArgumentParser(description=PARSER_HELP)
+    configure_parser(parser)
+    args = parser.parse_args(argv)
+    args.func(args)
+
+
+def configure_parser(parser: argparse.ArgumentParser):
+    """Configures the argument parser for the script.
+
+    Args:
+        parser (argparse.ArgumentParser): Argument parser.
+    """
+    parser.add_argument(
+        "--project-config",
+        help="Project root configuration file.",
+        required=True,
+    )
+    parser.add_argument(
+        "--output-file",
+        help="Output file to export global variables.",
+        required=True,
+    )
+    parser.set_defaults(func=export_global_vars)
+
+
+if __name__ == "__main__":
+    sys.exit(_main(sys.argv[1:]))

powertrain_build/interface/generate_adapters.py

@@ -1,132 +1,132 @@
-# Copyright 2024 Volvo Car Corporation
-# Licensed under Apache 2.0.
-
-# -*- coding: utf-8 -*-
-"""Python module used for calculating interfaces for CSP"""
-import argparse
-import sys
-from pathlib import Path
-from os import path
-from typing import List, Optional
-
-from powertrain_build.interface.hal import HALA
-from powertrain_build.interface.device_proxy import DPAL
-from powertrain_build.interface.service import ServiceFramework
-from powertrain_build.interface import simulink
-from powertrain_build.lib import logger
-from powertrain_build.interface import generation_utils
-from powertrain_build.lib.helper_functions import deep_json_update
-
-LOGGER = logger.create_logger("CSP adapters")
-
-PARSER_HELP = "Generate adapters"
-
-
-def configure_parser(parser: argparse.ArgumentParser):
-    generation_utils.add_base_args(parser)
-    parser.add_argument(
-        "--dp-interface",
-        help="Add dp interface to adapter specification",
-        action="store_true"
-    )
-    parser.add_argument(
-        "--hal-interface",
-        help="Add dp interface to adapter specification",
-        action="store_true"
-    )
-    parser.add_argument(
-        "--service-interface",
-        help="Add sfw interface to adapter specification",
-        action="store_true"
-    )
-    parser.add_argument(
-        "output",
-        help="Output file with interface specifications",
-        type=Path
-    )
-    parser.add_argument(
-        "--update-config",
-        help="Update project config file with path to adapter specifications",
-        action="store_true"
-    )
-    parser.set_defaults(func=generate_adapters)
-
-
-def main(argv: Optional[List[str]] = None):
-    """ Main function for stand alone execution.
-    Mostly useful for testing and generation of dummy hal specifications
-    """
-    parser = argparse.ArgumentParser(description=PARSER_HELP)
-    configure_parser(parser)
-    args = parser.parse_args(argv)
-    args.func(args)
-
-
-def generate_adapters(args: argparse.Namespace):
-    app = generation_utils.process_app(args.config)
-    adapters(args, app)
-
-
-def update_project_config(args):
-    """ Update project config file with relative location to adapter specification file, linux styled path.
-
-    Args:
-        args (Namespace): Arguments from command line
-    """
-    config_dir = Path(args.config).resolve().parents[0]
-    output_dir = Path(args.output).resolve().parents[0]
-    rel_dir = Path(path.relpath(output_dir, config_dir))
-    rel_path = rel_dir / Path(args.output).name
-    rel_path_linux = rel_path.as_posix()
-    deep_json_update(
-        args.config,
-        {'ProjectInfo': {'adapterSpec': rel_path_linux}}
-    )
-
-
-def adapters(args, app):
-    """ Generate specification for adapter generation.
-
-    Args:
-        args (Namespace): Arguments from command line
-        app (Application): Application to generate specification for
-    """
-
-    if args.dp_interface:
-        dp = DPAL(app)
-        dp_interface = generation_utils.get_interface(app, dp)
-    else:
-        dp_interface = {}
-
-    if args.hal_interface:
-        hala = HALA(app)
-        hal_interface = generation_utils.get_interface(app, hala)
-    else:
-        hal_interface = {}
-
-    if args.service_interface:
-        sfw = ServiceFramework(app)
-        sfw_interface = generation_utils.get_interface(app, sfw)
-        method_interface = generation_utils.get_method_interface(app)
-    else:
-        sfw_interface = {}
-        method_interface = {}
-
-    interface_data_types = app.pybuild['user_defined_types'].get_interface_data_types()
-
-    adapters = simulink.get_interface(
-        interface_data_types,
-        dp_interface,
-        hal_interface,
-        sfw_interface,
-        method_interface
-    )
-
-    generation_utils.write_to_file(adapters, args.output, is_yaml=True)
-
-    if args.update_config:
-        update_project_config(args)
-
-
-if __name__ == "__main__":
-    main(sys.argv[1:])
+# Copyright 2024 Volvo Car Corporation
+# Licensed under Apache 2.0.
+
+# -*- coding: utf-8 -*-
+"""Python module used for calculating interfaces for CSP"""
+import argparse
+import sys
+from pathlib import Path
+from os import path
+from typing import List, Optional
+
+from powertrain_build.interface.hal import HALA
+from powertrain_build.interface.device_proxy import DPAL
+from powertrain_build.interface.service import ServiceFramework
+from powertrain_build.interface import simulink
+from powertrain_build.lib import logger
+from powertrain_build.interface import generation_utils
+from powertrain_build.lib.helper_functions import deep_json_update
+
+LOGGER = logger.create_logger("CSP adapters")
+
+PARSER_HELP = "Generate adapters"
+
+
+def configure_parser(parser: argparse.ArgumentParser):
+    generation_utils.add_base_args(parser)
+    parser.add_argument(
+        "--dp-interface",
+        help="Add dp interface to adapter specification",
+        action="store_true"
+    )
+    parser.add_argument(
+        "--hal-interface",
+        help="Add dp interface to adapter specification",
+        action="store_true"
+    )
+    parser.add_argument(
+        "--service-interface",
+        help="Add sfw interface to adapter specification",
+        action="store_true"
+    )
+    parser.add_argument(
+        "output",
+        help="Output file with interface specifications",
+        type=Path
+    )
+    parser.add_argument(
+        "--update-config",
+        help="Update project config file with path to adapter specifications",
+        action="store_true"
+    )
+    parser.set_defaults(func=generate_adapters)
+
+
+def main(argv: Optional[List[str]] = None):
+    """ Main function for stand alone execution.
+    Mostly useful for testing and generation of dummy hal specifications
+    """
+    parser = argparse.ArgumentParser(description=PARSER_HELP)
+    configure_parser(parser)
+    args = parser.parse_args(argv)
+    args.func(args)
+
+
+def generate_adapters(args: argparse.Namespace):
+    app = generation_utils.process_app(args.config)
+    adapters(args, app)
+
+
+def update_project_config(args):
+    """ Update project config file with relative location to adapter specification file, linux styled path.
+
+    Args:
+        args (Namespace): Arguments from command line
+    """
+    config_dir = Path(args.config).resolve().parents[0]
+    output_dir = Path(args.output).resolve().parents[0]
+    rel_dir = Path(path.relpath(output_dir, config_dir))
+    rel_path = rel_dir / Path(args.output).name
+    rel_path_linux = rel_path.as_posix()
+    deep_json_update(
+        args.config,
+        {'ProjectInfo': {'adapterSpec': rel_path_linux}}
+    )
+
+
+def adapters(args, app):
+    """ Generate specification for adapter generation.
+
+    Args:
+        args (Namespace): Arguments from command line
+        app (Application): Application to generate specification for
+    """
+
+    if args.dp_interface:
+        dp = DPAL(app)
+        dp_interface = generation_utils.get_interface(app, dp)
+    else:
+        dp_interface = {}
+
+    if args.hal_interface:
+        hala = HALA(app)
+        hal_interface = generation_utils.get_interface(app, hala)
+    else:
+        hal_interface = {}
+
+    if args.service_interface:
+        sfw = ServiceFramework(app)
+        sfw_interface = generation_utils.get_interface(app, sfw)
+        method_interface = generation_utils.get_method_interface(app)
+    else:
+        sfw_interface = {}
+        method_interface = {}
+
+    interface_data_types = app.pybuild['user_defined_types'].get_interface_data_types()
+
+    adapters = simulink.get_interface(
+        interface_data_types,
+        dp_interface,
+        hal_interface,
+        sfw_interface,
+        method_interface
+    )
+
+    generation_utils.write_to_file(adapters, args.output, is_yaml=True)
+
+    if args.update_config:
+        update_project_config(args)
+
+
+if __name__ == "__main__":
+    main(sys.argv[1:])