fmu-manipulation-toolbox 1.9.2b2__py3-none-any.whl → 1.9.2b4__py3-none-any.whl

fmu_manipulation_toolbox/__version__.py

@@ -1 +1 @@
-'V1.9.2b2'
+'V1.9.2b4'

fmu_manipulation_toolbox/cli/datalog2pcap.py

@@ -0,0 +1,143 @@
+import argparse
+import csv
+import logging
+import sys
+
+from pathlib import Path
+from typing import *
+
+from .utils import setup_logger, close_logger, make_wide
+from ..version import __version__ as version
+
+logger = setup_logger()
+
+class DatalogConverter:
+    def __init__(self, cvs_filename: Union[Path, str]):
+        self.csv_filename = Path(cvs_filename)
+        self.pcap_filename = self.csv_filename.with_suffix(".pcap")
+
+    def open_pcap(self):
+        logger.info(f"Creating PCAP file '{self.pcap_filename}'...")
+        file = open(self.pcap_filename, "wb")
+        file.write(int(0xA1B2C3D4).to_bytes(4, byteorder="big"))  # Magic number
+                                                                  # meaning the timestamp are in min seconds and microseconds
+
+        file.write(int(2).to_bytes(2, byteorder="big"))           # Major Version of fileformat
+        file.write(int(4).to_bytes(2, byteorder="big"))           # Minor Version
+        file.write(int(0).to_bytes(4, byteorder="big"))           # Reserved. SHOULD BE 0.
+        file.write(int(0).to_bytes(4, byteorder="big"))           # Reserved. SHOULD BE 0.
+
+        file.write(int(0xFFFF).to_bytes(4, byteorder="big"))      # snaplen indicating the maximum number of octets
+                                                                  # captured from each packet.
+
+        file.write(int(227).to_bytes(4, byteorder="big"))         # link type. his field is defined in the Section
+                                                                  # # 8.1 IANA registry.
+        return file
+
+    def open_csv(self):
+        logger.debug(f"Loading '{self.csv_filename}'")
+        file = open(self.csv_filename, "rt")
+        return file
+
+    def decode_hexstring(self, hex_string: bytes, time_s, time_us):
+        opcode = int.from_bytes(hex_string[0:4], byteorder="little")
+        length = int.from_bytes(hex_string[4:8], byteorder="little")
+        can_id = int.from_bytes(hex_string[8:12], byteorder="little")
+        if opcode == 0x10:  # TRANSMIT
+            rtr = int.from_bytes(hex_string[13:14], byteorder="little")
+            ide = int.from_bytes(hex_string[12:13], byteorder="little")
+            data_length = int.from_bytes(hex_string[14:16], byteorder="little")
+            raw_data = hex_string[16:]
+
+            logger.debug(f"time={time_s}.{time_us:06d} OP=0x{opcode:04X} len={length} {data_length} id={can_id}"
+                         f" ide={ide} rtr={rtr} len={data_length} {raw_data}")
+
+            # TimeStamp
+            self.pcapfile.write(time_s.to_bytes(4, byteorder="big"))
+            self.pcapfile.write(time_us.to_bytes(4, byteorder="big"))
+
+            # Packet length
+            packet_length = data_length + 8
+            self.pcapfile.write(packet_length.to_bytes(4, byteorder="big"))
+            self.pcapfile.write(packet_length.to_bytes(4, byteorder="big"))
+
+            # Control and flags
+            control = (can_id & 0x1FFFFFFF) | ((rtr & 0b1) << 30) | ((ide & 0b1) << 31)
+            self.pcapfile.write(control.to_bytes(4, byteorder="big"))
+
+            # Frame Length
+            self.pcapfile.write(data_length.to_bytes(1, byteorder="big"))
+
+            # Reserved
+            self.pcapfile.write(int(0).to_bytes(2, byteorder="big"))
+
+            # DLC
+            dlc = int(data_length)  # Classic CAN
+            self.pcapfile.write(dlc.to_bytes(1, byteorder="big"))
+
+            # PAYLOAD
+            self.pcapfile.write(raw_data)
+
+    def convert(self):
+        with self.open_csv() as self.csvfile, self.open_pcap() as self.pcapfile:
+            csv_reader = csv.DictReader(self.csvfile)
+
+            data_column_names = [ name for name in csv_reader.fieldnames if "_Data" in name ]
+            clock_column_names = {}
+
+            for column_name in data_column_names:
+                splitted_name = column_name.split(".")
+                splitted_name[-1] = splitted_name[-1].replace("_Data", "_Clock")
+                clock_column_name = ".".join(splitted_name)
+
+                if clock_column_name in csv_reader.fieldnames:
+                    logger.debug(f"{column_name} is clocked by {clock_column_name}")
+                    clock_column_names[column_name] = clock_column_name
+
+            for row in csv_reader:
+                time_s, time_us = divmod(float(row["time"]), 1)
+                time_s = int(time_s)
+                time_us = int(time_us * 1000000)
+
+                for names in data_column_names:
+                    hex_data = row[names]
+                    if hex_data:
+                        try:
+                            clock = row[clock_column_names[names]] == "1"
+                        except KeyError:
+                            clock = True
+                        if clock:
+                            self.decode_hexstring(bytes.fromhex(hex_data), time_s, time_us)
+
+
+def datalog2pcap():
+    logger.info(f"FMUContainer version {version}")
+    logger.warning(f"Datalog2PCAP is still experimental.")
+
+    parser = argparse.ArgumentParser(prog="datalog2pcap", description="Convert datalog from container to PCAP file.",
+                                     formatter_class=make_wide(argparse.ArgumentDefaultsHelpFormatter),
+                                     add_help=False,
+                                     epilog="see: https://github.com/grouperenault/fmu_manipulation_toolbox/blob/main/"
+                                            "doc/datalog.md")
+
+    parser.add_argument('-h', '-help', action="help")
+
+    parser.add_argument("-can", action="store", dest="can_filename", default=None,
+                        metavar="can-datalog.csv", required=True,
+                        help="Datalog with CAN data and clocks.")
+
+    parser.add_argument("-debug", action="store_true", dest="debug",
+                        help="Add lot of useful log during the process.")
+
+    config = parser.parse_args(sys.argv[1:])
+
+    if config.debug:
+        logger.setLevel(logging.DEBUG)
+
+    DatalogConverter(config.can_filename).convert()
+
+    close_logger(logger)
+
+
+if __name__ == "__main__":
+    datalog2pcap()

fmu_manipulation_toolbox/container.py

@@ -95,6 +95,7 @@ class EmbeddedFMUPort:
         self.start_value = attrs.get("start", None)
         self.initial = attrs.get("initial", None)
         self.clock = attrs.get("clocks", None)
+        self.interval_variability = attrs.get("intervalVariability", None)
 
 
     def xml(self, vr: int, name=None, causality=None, start=None, fmi_version=2) -> str:
@@ -1106,8 +1107,8 @@ class FMUContainer:
             else:
                 local_per_type["clock"].append(link.vr)
                 for cport_to in link.cport_to_list:
-                    if cport_to.fmu.ls.is_bus:
-                        logger.info(f"LS-BUS: importer scheduling for '{cport_to.fmu.name}' '{cport_to.port.name}' (clock={cport_to.port.vr}, {link.vr})")
+                    if cport_to.port.interval_variability == "countdown":
+                        logger.info(f"LS-BUS: importer scheduling for '{cport_to.fmu.name}' '{cport_to.port.name}' (clock={cport_to.port.vr}, vr={link.vr})")
                         clock_list.append(cport_to, link.vr)
                         break
 
@@ -1179,7 +1180,7 @@ class FMUContainer:
         clock_list.write_txt(txt_file)
 
     def make_datalog(self, datalog_file):
-        print(f"# Datalog filename")
+        print(f"# Datalog filename", file=datalog_file)
         print(f"{self.identifier}-datalog.csv", file=datalog_file)
 
         ports = defaultdict(list)
@@ -1188,7 +1189,11 @@ class FMUContainer:
         for output_port_name, output_port in self.outputs.items():
             ports[output_port.port.type_name].append((output_port.vr, output_port_name))
         for link in self.links.values():
-            ports[link.cport_from.port.type_name].append((link.vr, link.name))
+            if link.cport_from is None:
+                # LS-BUS allows to connected to input clocks.
+                ports[link.cport_to_list[0].port.type_name].append((link.vr, link.name))
+            else:
+                ports[link.cport_from.port.type_name].append((link.vr, link.name))
 
         for type_name in EmbeddedFMUPort.ALL_TYPES:
             print(f"# {type_name}: <VR> <NAME>" , file=datalog_file)

fmu_manipulation_toolbox/operations.py

@@ -61,7 +61,7 @@ class FMUPort:
         self.dimension = None
 
     def dict_level(self, nb):
-        return " ".join([f'{key}="{value}"' for key, value in self.attrs_list[nb].items()])
+        return " ".join([f'{key}="{Manipulation.escape(value)}"' for key, value in self.attrs_list[nb].items()])
 
     def write_xml(self, fmi_version: int, file):
         if fmi_version == 2:
@@ -177,7 +177,7 @@ class Manipulation:
                 self.current_port = FMUPort()
                 self.current_port.push_attrs(attrs)
             elif self.fmu.fmi_version == 2 and name in self.fmu.FMI2_TYPES:
-                if self.current_port: # <Enumeration> can be found before port defition. Ignored.
+                if self.current_port: # <Enumeration> can be found before port definition. Ignored.
                     self.current_port.fmi_type = name
                     self.current_port.push_attrs(attrs)
             elif self.fmu.fmi_version == 3 and name in self.fmu.FMI3_TYPES:

{fmu_manipulation_toolbox-1.9.2b2.dist-info → fmu_manipulation_toolbox-1.9.2b4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fmu_manipulation_toolbox
-Version: 1.9.2b2
+Version: 1.9.2b4
 Summary: FMU Manipulation Toolbox is a python package which helps to analyze, modify or combine Functional Mock-up Units (FMUs) without recompilation.
 Home-page: https://github.com/grouperenault/fmu_manipulation_toolbox/
 Author: Nicolas.LAURENT@Renault.com
@@ -23,7 +23,7 @@ Dynamic: requires-python
 Dynamic: summary
 
 FMU Manipulation Toolbox is a python package which helps to analyze, modify or combine
-[Functional Mock-up Units (FMUs)](http://fmi-standard.org/) without recompilation. It is highly customizable and comes with
+[Functional Mock-up Units (FMUs)](https://fmi-standard.org/) without recompilation. It is highly customizable and comes with
 a Python API.
 
 FMU Manipulation Toolbox can be used in different ways:

{fmu_manipulation_toolbox-1.9.2b2.dist-info → fmu_manipulation_toolbox-1.9.2b4.dist-info}/RECORD

@@ -1,17 +1,18 @@
 fmu_manipulation_toolbox/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 fmu_manipulation_toolbox/__main__.py,sha256=g0ZhVsMiAs5KnhyVNwTe01N2PQjAg7F9YCnXHZB-HwA,356
-fmu_manipulation_toolbox/__version__.py,sha256=dxTf1L29N2UnXoeZR07PLwi-F5jmAKLCVbVRdBuxS8g,11
+fmu_manipulation_toolbox/__version__.py,sha256=Gbo0eZjyM2y_SKH83AQYtGZD5IHxJiZo3K7RDSiIIyA,11
 fmu_manipulation_toolbox/assembly.py,sha256=QmFihza_I0hK0Ia6tWbjdZeoREhveLrv3d7ERrBUaDk,27217
 fmu_manipulation_toolbox/checker.py,sha256=Dh47b3blibCWjHCeZ61Y_w9Ug0PWvEuSiemZtp-llQA,3141
-fmu_manipulation_toolbox/container.py,sha256=5LpfqWMSkujZqkw37Y1sI2tM2BKTDOUXvyj9c-jIpqM,56680
+fmu_manipulation_toolbox/container.py,sha256=b_F6jjgnn9aWm54265KTennjslcj9YUFChUkQB1w9Kk,57017
 fmu_manipulation_toolbox/help.py,sha256=j8xmnCrwQpaW-SZ8hSqA1dlTXgaqzQWc4Yr3RH_oqck,6012
 fmu_manipulation_toolbox/ls.py,sha256=wmyoKrvDLXpL-PFz6cUhLLqxDMD5E9L_P4KswWpQHsk,975
-fmu_manipulation_toolbox/operations.py,sha256=8noR84f6Ow2sMY6d0oer5BDZ48WBRSKgwOB-aTKElzg,21154
+fmu_manipulation_toolbox/operations.py,sha256=y3QDMiLaG1TUhIQ4r_onWp1kGm8QZaFfTOdQr0oC7_A,21177
 fmu_manipulation_toolbox/remoting.py,sha256=N25MDFkIcEWe9CIT1M4L9kea3j-8E7i2I1VOI6zIAdw,3876
 fmu_manipulation_toolbox/split.py,sha256=6D99SAGNu4B3PSaSsliWc6Bb5aSBZMxL8t0v8TJBI3Y,16499
 fmu_manipulation_toolbox/terminals.py,sha256=mGGS4tdE6cJuz-2zvwc7drpmT0QJ7YPe8ENw2UGlEHA,5062
 fmu_manipulation_toolbox/version.py,sha256=L26Cc3PH97SOa4G9yiYnafrdolK0G_DCQZZTvv3YXqI,392
 fmu_manipulation_toolbox/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fmu_manipulation_toolbox/cli/datalog2pcap.py,sha256=A0KNHVTzEvzKaT5HG0zgHVRC5G1bXoIbfLRXuvOsE-U,6080
 fmu_manipulation_toolbox/cli/fmucontainer.py,sha256=ZLoC8QMVBVG2S3cdNthMIQ0gYIU9WUbYj8Aj2vxzyfs,5338
 fmu_manipulation_toolbox/cli/fmusplit.py,sha256=sLzdxiC4R5hJYJo9F2TZOMrJOHcadqCvUo9KoCjUaxE,1773
 fmu_manipulation_toolbox/cli/fmutool.py,sha256=E-CCymksBwGFlS3-zJ7DIDA8xIdp_synsxMDYXst8dc,6186
@@ -33,7 +34,7 @@ fmu_manipulation_toolbox/resources/icon_fmu.png,sha256=EuygB2xcoM2WAfKKdyKG_UvTL
 fmu_manipulation_toolbox/resources/license.txt,sha256=5ODuU8g8pIkK-NMWXu_rjZ6k7gM7b-N2rmg87-2Kmqw,1583
 fmu_manipulation_toolbox/resources/mask.png,sha256=px1U4hQGL0AmZ4BQPknOVREpMpTSejbah3ntkpqAzFA,3008
 fmu_manipulation_toolbox/resources/model.png,sha256=EAf_HnZJe8zYGZygerG1MMt2U-tMMZlifzXPj4_iORA,208788
-fmu_manipulation_toolbox/resources/darwin64/container.dylib,sha256=EpQwj07DRShKXq8lzqjFXiAWLwJXQyRPa3TrLjULZCM,230608
+fmu_manipulation_toolbox/resources/darwin64/container.dylib,sha256=BEFw77tHDaZ-D_LiCDbYF7aefPJ1z0n_G-XjGU2oN0Q,230704
 fmu_manipulation_toolbox/resources/fmi-2.0/fmi2Annotation.xsd,sha256=OGfyJtaJntKypX5KDpuZ-nV1oYLZ6HV16pkpKOmYox4,2731
 fmu_manipulation_toolbox/resources/fmi-2.0/fmi2AttributeGroups.xsd,sha256=HwyV7LBse-PQSv4z1xjmtzPU3Hjnv4mluq9YdSBNHMQ,3704
 fmu_manipulation_toolbox/resources/fmi-2.0/fmi2ModelDescription.xsd,sha256=JM4j_9q-pc40XYHb28jfT3iV3aYM5JLqD5aRjO72K1E,18939
@@ -53,19 +54,19 @@ fmu_manipulation_toolbox/resources/fmi-3.0/fmi3Type.xsd,sha256=TaHRoUBIFtmdEwBKB
 fmu_manipulation_toolbox/resources/fmi-3.0/fmi3Unit.xsd,sha256=CK_F2t5LfyQ6eSNJ8soTFMVK9DU8vD2WiMi2MQvjB0g,3746
 fmu_manipulation_toolbox/resources/fmi-3.0/fmi3Variable.xsd,sha256=3YU-3q1-c-namz7sMe5cxnmOVOJsRSmfWR02PKv3xaU,19171
 fmu_manipulation_toolbox/resources/fmi-3.0/fmi3VariableDependency.xsd,sha256=YQSBwXt4IsDlyegY8bX-qQHGSfE5TipTPfo2g2yqq1c,3082
-fmu_manipulation_toolbox/resources/linux32/client_sm.so,sha256=Cd4EwnFamF-6cmA0uNJ-xDIs5wkmhfgdeFVAJLBzumY,34756
+fmu_manipulation_toolbox/resources/linux32/client_sm.so,sha256=hkRPy649TVuT3lcae-BMXUZH6JVwTNiejv_S-FKmZZU,34664
 fmu_manipulation_toolbox/resources/linux32/server_sm,sha256=gzKU0BTeaRkvhTMQtHHj3K8uYFyEdyGGn_mZy_jG9xo,21304
-fmu_manipulation_toolbox/resources/linux64/client_sm.so,sha256=4aaTSTwCFk0iigVqw67ZMmt9Udj89W6placdTydzcAo,32592
-fmu_manipulation_toolbox/resources/linux64/container.so,sha256=8SEqRP87xhzmkgIlFbgXyyxcSml4Gl_MKmfH7nHEjd8,189944
+fmu_manipulation_toolbox/resources/linux64/client_sm.so,sha256=VTg20ibYrtPCFj71x2ciwk5Trotr39DYu74ZpH5Z_9A,32464
+fmu_manipulation_toolbox/resources/linux64/container.so,sha256=Qwmdg6IFtmbzNgGXPPnmacVAfHFgS1sh0dJjn4VW2mI,194192
 fmu_manipulation_toolbox/resources/linux64/server_sm,sha256=MZn6vITN2qpBHYt_RaK2VnFFp00hk8fTALBHmXPtLwc,22608
-fmu_manipulation_toolbox/resources/win32/client_sm.dll,sha256=WPAutfVhZ3wMOwM2nuJYaOQby-Nooz6dwX_Jv14zUgI,17920
-fmu_manipulation_toolbox/resources/win32/server_sm.exe,sha256=b6a25dyuw5E06sJwRWNTHwB8ZHwjTxybOE0H9wCHYac,15360
-fmu_manipulation_toolbox/resources/win64/client_sm.dll,sha256=FDxyTCrsryoSHLKhEIBRbNYDzQfUxYW1B2ICKeskfZo,21504
-fmu_manipulation_toolbox/resources/win64/container.dll,sha256=uV6DVwERwLDcsAl2jzgQhNLte5xjGfaUMCu2gwMIC8s,153088
-fmu_manipulation_toolbox/resources/win64/server_sm.exe,sha256=TCF38KOmVIltgBxw84fa22Zx8ZcJ_lHtAVVZzUm6Ncc,18432
-fmu_manipulation_toolbox-1.9.2b2.dist-info/licenses/LICENSE.txt,sha256=0Q8zhEwTu1K-MDmg8Khay5j56BIz2VLI6RcijIFbU_g,1255
-fmu_manipulation_toolbox-1.9.2b2.dist-info/METADATA,sha256=uHdjOJ_iuBOy-KDuoM-bM2rZu7XrVjzD_HQYeFLE-lI,1898
-fmu_manipulation_toolbox-1.9.2b2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-fmu_manipulation_toolbox-1.9.2b2.dist-info/entry_points.txt,sha256=6VNL31b5le8S9zp2H0R9ERWmzCy9WuSzVEDcHbWX_70,268
-fmu_manipulation_toolbox-1.9.2b2.dist-info/top_level.txt,sha256=9D_h-5BMjSqf9z-XFkbJL_bMppR2XNYW3WNuPkXou0k,25
-fmu_manipulation_toolbox-1.9.2b2.dist-info/RECORD,,
+fmu_manipulation_toolbox/resources/win32/client_sm.dll,sha256=6M3HnC-Yo-6K30Vz7cM2v-WmsldJrQIW1kitE7MZw2I,17920
+fmu_manipulation_toolbox/resources/win32/server_sm.exe,sha256=sGBilm9IUvn7ZyRE_TgElP6Eod7WykZ-alqQ9U2OYC8,15360
+fmu_manipulation_toolbox/resources/win64/client_sm.dll,sha256=uuZhxRU8Vhgc7coHPGePcnb7Ck3F4NWkxFzmBIJCzxs,20992
+fmu_manipulation_toolbox/resources/win64/container.dll,sha256=526FLsn7DbNnRioLc3YayPBqX_IRpgKNzfAfG1GqrTg,153088
+fmu_manipulation_toolbox/resources/win64/server_sm.exe,sha256=UamakjF0Tpd6l2SDvgwBtDIS24kO8JlI6wDv2GKwNCM,18432
+fmu_manipulation_toolbox-1.9.2b4.dist-info/licenses/LICENSE.txt,sha256=0Q8zhEwTu1K-MDmg8Khay5j56BIz2VLI6RcijIFbU_g,1255
+fmu_manipulation_toolbox-1.9.2b4.dist-info/METADATA,sha256=6QSkWxWMMoZEpMFuvOgIlzBuv7AFrgwRFp0QcpxhIK8,1899
+fmu_manipulation_toolbox-1.9.2b4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+fmu_manipulation_toolbox-1.9.2b4.dist-info/entry_points.txt,sha256=VOWf1jbG1O-2JrqXOvSoHRRfdH3RNONvz-2RIPHNX0s,338
+fmu_manipulation_toolbox-1.9.2b4.dist-info/top_level.txt,sha256=9D_h-5BMjSqf9z-XFkbJL_bMppR2XNYW3WNuPkXou0k,25
+fmu_manipulation_toolbox-1.9.2b4.dist-info/RECORD,,

{fmu_manipulation_toolbox-1.9.2b2.dist-info → fmu_manipulation_toolbox-1.9.2b4.dist-info}/entry_points.txt

@@ -1,4 +1,5 @@
 [console_scripts]
+datalog2pcap = fmu_manipulation_toolbox.cli.datalog2pcap:datalog2pcap
 fmucontainer = fmu_manipulation_toolbox.cli.fmucontainer:fmucontainer
 fmusplit = fmu_manipulation_toolbox.cli.fmusplit:fmusplit
 fmutool = fmu_manipulation_toolbox.cli.fmutool:fmutool