RobotFramework-UDS 0.1.1__tar.gz

RobotFramework_UDS-0.1.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

RobotFramework_UDS-0.1.1/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.1
+Name: RobotFramework_UDS
+Version: 0.1.1
+Summary: Robot Framework keywords for UDS (Unified Diagnostic Services) communication
+Home-page: https://github.com/test-fullautomation/robotframework-uds
+Author: Mai Minh Tri
+Author-email: tri.maiMinh@vn.bosch.com
+License: UNKNOWN
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development
+Requires-Python: >=3.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+RobotFramework\_UDS Package Description
+=======================================
+
+Getting Started
+---------------
+
+The library **RobotFramework\_UDS** provides a set of Robot Framework
+keywords for sending UDS (UnifiedDiagnostic Services) requests and
+interpreting responses from automotive electronic control units (ECUs).
+
+Whether you're testing diagnostic sessions, reading data, or controlling
+routines on an ECU, the UDS Library simplifies these tasks by offering
+specific keywords for almost any UDS service as defined in [ISO
+14229](https://automotive.wiki/index.php/ISO_14229).
+
+These keywords are designed to handle the complexity of UDS
+communication, enabling you to write efficient and reliable automated
+tests.
+
+How to install
+--------------
+
+The **RobotFramework\_UDS** can be installed in two different ways.
+
+1.  Installation via PyPi (recommended for users)
+
+    ``` {.}
+    pip install RobotFramework_UDS
+    ```
+
+    [RobotFramework\_UDS in
+    PyPi](https://pypi.org/project/RobotFramework_UDS/)
+
+2.  Installation via GitHub (recommended for developers)
+
+    -   Clone the **robotframework-uds** repository to your machine.
+
+        ``` {.}
+        git clone https://github.com/test-fullautomation/robotframework-uds.git
+        ```
+
+        [RobotFramework\_UDS in
+        GitHub](https://github.com/test-fullautomation/robotframework-uds)
+
+    -   Install dependencies
+
+        **RobotFramework\_UDS** requires some additional Python
+        libraries. Before you install the cloned repository sources you
+        have to install the dependencies manually. The names of all
+        related packages you can find in the file `requirements.txt` in
+        the repository root folder. Use pip to install them:
+
+        ``` {.}
+        pip install -r ./requirements.txt
+        ```
+
+        Additionally install **LaTeX** (recommended: TeX Live). This is
+        used to render the documentation.
+
+    -   Configure dependencies
+
+        The installation of **RobotFramework\_UDS** includes to generate
+        the documentation in PDF format. This is done by an application
+        called **GenPackageDoc**, that is part of the installation
+        dependencies (see `requirements.txt`).
+
+        **GenPackageDoc** uses **LaTeX** to generate the documentation
+        in PDF format. Therefore **GenPackageDoc** needs to know where
+        to find **LaTeX**. This is defined in the **GenPackageDoc**
+        configuration file
+
+        ``` {.}
+        packagedoc\packagedoc_config.json
+        ```
+
+        Before you start the installation you have to introduce the
+        following environment variable, that is used in
+        `packagedoc_config.json`:
+
+        -   `GENDOC_LATEXPATH` : path to `pdflatex` executable
+
+    -   Use the following command to install **RobotFramework\_UDS**:
+
+        ``` {.}
+        setup.py install
+        ```
+
+Package Documentation
+---------------------
+
+A detailed documentation of the RobotFramework\_UDS package can be found
+here:
+[RobotFramework\_UDS.pdf](https://github.com/test-fullautomation/robotframework-uds/blob/develop/RobotFramework_UDS/RobotFramework_UDS.pdf)
+
+Feedback
+--------
+
+To give us a feedback, you can send an email to [Thomas
+Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)
+
+In case you want to report a bug or request any interesting feature,
+please don\'t hesitate to raise a ticket.
+
+Maintainers
+-----------
+
+[Thomas Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)
+
+[Mai Minh Tri](mailto:tri.maiminh@vn.bosch.com)
+
+Contributors
+------------
+
+[Holger Queckenstedt](mailto:holger.queckenstedt@de.bosch.com)
+
+[Tran Duy Ngoan](mailto:ngoan.tranduy@vn.bosch.com)
+
+License
+-------
+
+Copyright 2020-2024 Robert Bosch GmbH
+
+Licensed under the Apache License, Version 2.0 (the \"License\"); you
+may not use this file except in compliance with the License. You may
+obtain a copy of the License at
+
+> [![License: Apache
+> v2](https://img.shields.io/pypi/l/robotframework.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an \"AS IS\" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+

RobotFramework_UDS-0.1.1/README.rst

@@ -0,0 +1,138 @@
+.. Copyright 2020-2024 Robert Bosch GmbH
+
+.. Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+.. http://www.apache.org/licenses/LICENSE-2.0
+
+.. Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+RobotFramework_UDS Package Description
+======================================
+
+Getting Started
+---------------
+
+The library **RobotFramework_UDS** provides a set of Robot Framework keywords 
+for sending UDS (UnifiedDiagnostic Services) requests and interpreting responses 
+from automotive electronic control units (ECUs).
+
+Whether you’re testing diagnostic sessions, reading data, or controlling 
+routines on an ECU, the UDS Library simplifies these tasks by offering specific 
+keywords for almost any UDS service as defined in 
+`ISO 14229 <https://automotive.wiki/index.php/ISO_14229>`_. 
+
+These keywords are designed to handle the complexity of UDS communication, 
+enabling you to write efficient and reliable automated tests.
+
+How to install
+--------------
+
+The **RobotFramework_UDS** can be installed in two different ways.
+
+1. Installation via PyPi (recommended for users)
+
+   .. code::
+
+      pip install RobotFramework_UDS
+
+   `RobotFramework_UDS in PyPi <https://pypi.org/project/RobotFramework_UDS/>`_
+
+2. Installation via GitHub (recommended for developers)
+
+   * Clone the **robotframework-uds** repository to your machine.
+
+     .. code::
+
+        git clone https://github.com/test-fullautomation/robotframework-uds.git
+
+     `RobotFramework_UDS in GitHub <https://github.com/test-fullautomation/robotframework-uds>`_
+
+   * Install dependencies
+
+     **RobotFramework_UDS** requires some additional Python libraries. Before you install the cloned repository sources
+     you have to install the dependencies manually. The names of all related packages you can find in the file ``requirements.txt``
+     in the repository root folder. Use pip to install them:
+
+     .. code::
+
+        pip install -r ./requirements.txt
+
+     Additionally install **LaTeX** (recommended: TeX Live). This is used to render the documentation.
+
+   * Configure dependencies
+
+     The installation of **RobotFramework_UDS** includes to generate the documentation in PDF format. This is done by
+     an application called **GenPackageDoc**, that is part of the installation dependencies (see ``requirements.txt``).
+
+     **GenPackageDoc** uses **LaTeX** to generate the documentation in PDF format. Therefore **GenPackageDoc** needs to know where to find
+     **LaTeX**. This is defined in the **GenPackageDoc** configuration file
+
+     .. code::
+
+        packagedoc\packagedoc_config.json
+
+     Before you start the installation you have to introduce the following environment variable, that is used in ``packagedoc_config.json``:
+
+     - ``GENDOC_LATEXPATH`` : path to ``pdflatex`` executable
+
+   * Use the following command to install **RobotFramework_UDS**:
+
+     .. code::
+
+        setup.py install
+
+
+Package Documentation
+---------------------
+
+A detailed documentation of the RobotFramework_UDS package can be found here: `RobotFramework_UDS.pdf <https://github.com/test-fullautomation/robotframework-uds/blob/develop/RobotFramework_UDS/RobotFramework_UDS.pdf>`_
+
+Feedback
+--------
+
+To give us a feedback, you can send an email to `Thomas Pollerspöck <mailto:Thomas.Pollerspoeck@de.bosch.com>`_
+
+In case you want to report a bug or request any interesting feature, please don't
+hesitate to raise a ticket.
+
+Maintainers
+-----------
+
+`Thomas Pollerspöck <mailto:Thomas.Pollerspoeck@de.bosch.com>`_
+
+`Mai Minh Tri <mailto:tri.maiminh@vn.bosch.com>`_
+
+Contributors
+------------
+
+`Holger Queckenstedt <mailto:holger.queckenstedt@de.bosch.com>`_
+
+`Tran Duy Ngoan <mailto:ngoan.tranduy@vn.bosch.com>`_
+
+License
+-------
+
+Copyright 2020-2024 Robert Bosch GmbH
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    |License: Apache v2|
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+
+.. |License: Apache v2| image:: https://img.shields.io/pypi/l/robotframework.svg
+   :target: http://www.apache.org/licenses/LICENSE-2.0.html
+

RobotFramework_UDS-0.1.1/RobotFramework_UDS/DiagnosticServices.py

@@ -0,0 +1,52 @@
+from robot.api import logger
+import odxtools
+
+
+class DiagnosticServices:
+    def __init__(self, pdx_file, variant):
+        self.variant = variant
+        self.pdx_file = pdx_file
+        # load pdx file
+        odxtools.exceptions.strict_mode = False
+        self.odx_db = odxtools.load_pdx_file(self.pdx_file)
+        odxtools.exceptions.strict_mode = True
+        self.odx_ecu = self.odx_db.ecus[self.variant]
+        self.diag_services = self.odx_db.ecus[self.variant].services
+
+    def get_data_by_name(self, service_name_list):
+        diag_service_list = []
+        for service_name in service_name_list:
+            try:
+                diag_service = getattr(self.diag_services, service_name)
+                diag_service_list.append(diag_service)
+            except:
+                logger.error(f"Diagnostic service does not contain an item named {service_name}")
+
+        return diag_service_list
+
+    def get_encoded_request_message(self, diag_service_list, parameters=None):
+        uds_list = []
+        for diag_service in diag_service_list:
+            param_dict = {}
+            uds = ""
+            logger.info(f"[uds] Service name: {diag_service}")
+            if parameters:
+                for param in parameters:
+                    isolate_list = param.split("=")
+                    param_dict[isolate_list[0]] = eval(isolate_list[1])
+
+                logger.info(f"[uds] Parameters: {param_dict}")
+                try:
+                    uds = diag_service(**param_dict).hex()
+                    uds_list.append(uds)
+                except:
+                    logger.info(f"UDS: Retrieve uds failed.")
+            else:
+                uds = diag_service().hex()
+                if len(uds) > 0:
+                    logger.info(f"UDS: {uds}")
+                    uds_list.append(uds)
+                else:
+                    logger.info("UDS: Retrieve uds failed.")
+
+        return uds_list