Autosar Config Reader

The asrGenerator package provides the option to read Autosar compliant ecu configuration files by:

Generating python classes based on the autosar module definition file
- Generate a python package and classes corresponding to the module/containers/parameters/references with exactly the same name as in the definition file.
- Using the generated classes, users could simply access the complete configuration through a list of getter methods.
- The package will be handy:
  - In writing code generators for the autosar modules where user would be benefitted from accessing the containers/parameter values as python objects instead of manually reading the autosar module configuration file.
  - In an automated test environment, where user could simply modify the value of parameters without the need of using any professional tooling and save the changes to a file and use it for the next steps.

How to use

Clone the repository.
Manually install the package.

$ python setup.py install

use python3 if you have both python2 and python3 installed.

Generate the code for your desired autosar module, by calling asrGenerator with relevant arguments.

$ python -m asrGenerator -i <input_file> -m <module_name> -o <output_folder>

use python3 if you have both python2 and python3 installed.

<input_file>: Provide the path to the autosar definition file.
<module_name>: Provide the module name for which the code needs to be generated.For eg: Rte
<output_folder>: Provide the location where the code needs to be generated.

Using the generated python classes

The generated package can be used for reading/creating/modifying the autosar module configuration.

Simply include the package inside one of your scripts and call the function read(file) with the input configuration file.

Example: Lets say we generated python package for Rte and now we want to read the Rte module configuration of the file passed as a commandline argument. The equivalent python code will look like:

from Rte import Rte
import sys

rteNode = Rte.read(sys.argv[1])
if rteNode is not None:
    print('read sucessfull')
else:
    print('read failed')

Additionaly there also exists a helper function get_node(path) which returns the python object for the given autosar path.

Lets consider a simple autosar definition file for an imgainary module named 'demo'.

<?xml version="1.0" encoding="UTF-8"?>
<AUTOSAR xmlns="http://autosar.org/schema/r4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://autosar.org/schema/r4.0 AUTOSAR_00049.xsd">
  <AR-PACKAGES>
    <AR-PACKAGE UUID="ECUC:ModuleDef">
      <SHORT-NAME>ModuleDef</SHORT-NAME>
      <ELEMENTS>
        <ECUC-MODULE-DEF>
            <SHORT-NAME>demo</SHORT-NAME>
            <DESC>
                <L-2 L="EN">Configuration of the demo module.</L-2>
            </DESC>
            <LOWER-MULTIPLICITY>0</LOWER-MULTIPLICITY>
            <UPPER-MULTIPLICITY>1</UPPER-MULTIPLICITY>
            <POST-BUILD-VARIANT-SUPPORT>true</POST-BUILD-VARIANT-SUPPORT>
            <SUPPORTED-CONFIG-VARIANTS>
                <SUPPORTED-CONFIG-VARIANT>VARIANT-POST-BUILD</SUPPORTED-CONFIG-VARIANT>
                <SUPPORTED-CONFIG-VARIANT>VARIANT-PRE-COMPILE</SUPPORTED-CONFIG-VARIANT>
            </SUPPORTED-CONFIG-VARIANTS>
            <CONTAINERS>
                <ECUC-PARAM-CONF-CONTAINER-DEF>
                    <SHORT-NAME>contA</SHORT-NAME>
                    <LOWER-MULTIPLICITY>1</LOWER-MULTIPLICITY>
                    <UPPER-MULTIPLICITY>1</UPPER-MULTIPLICITY>
                    <PARAMETERS>
                        <ECUC-BOOLEAN-PARAM-DEF>
                            <SHORT-NAME>boolParam</SHORT-NAME>
                            <DEFAULT-VALUE>false</DEFAULT-VALUE>
                        </ECUC-BOOLEAN-PARAM-DEF>
                        <ECUC-ENUMERATION-PARAM-DEF>
                            <SHORT-NAME>enumParam</SHORT-NAME>
                            <DEFAULT-VALUE>GREEN</DEFAULT-VALUE>
                            <LITERALS>
                                <ECUC-ENUMERATION-LITERAL-DEF>
                                    <SHORT-NAME>RED</SHORT-NAME>
                                </ECUC-ENUMERATION-LITERAL-DEF>
                                <ECUC-ENUMERATION-LITERAL-DEF>
                                    <SHORT-NAME>YELLOW</SHORT-NAME>
                                </ECUC-ENUMERATION-LITERAL-DEF>
                                <ECUC-ENUMERATION-LITERAL-DEF>
                                    <SHORT-NAME>GREEN</SHORT-NAME>
                                </ECUC-ENUMERATION-LITERAL-DEF>
                            </LITERALS>
                        </ECUC-ENUMERATION-PARAM-DEF>
                    </PARAMETERS>
                </ECUC-PARAM-CONF-CONTAINER-DEF>
                <ECUC-PARAM-CONF-CONTAINER-DEF>
                    <SHORT-NAME>ContB</SHORT-NAME>
                    <LOWER-MULTIPLICITY>0</LOWER-MULTIPLICITY>
                    <UPPER-MULTIPLICITY-INFINITE>true</UPPER-MULTIPLICITY-INFINITE>
                    <SUB-CONTAINERS>
                        <ECUC-PARAM-CONF-CONTAINER-DEF>
                            <SHORT-NAME>ContBSubCont1</SHORT-NAME>
                            <LOWER-MULTIPLICITY>0</LOWER-MULTIPLICITY>
                            <UPPER-MULTIPLICITY-INFINITE>true</UPPER-MULTIPLICITY-INFINITE>
                            <PARAMETERS>
                                <ECUC-INTEGER-PARAM-DEF>
                                    <SHORT-NAME>intParam</SHORT-NAME>
                                    <LOWER-MULTIPLICITY>1</LOWER-MULTIPLICITY>
                                    <UPPER-MULTIPLICITY>1</UPPER-MULTIPLICITY>
                                    <MAX>65535</MAX>
                                    <MIN>0</MIN>
                                </ECUC-INTEGER-PARAM-DEF>
                            </PARAMETERS>
                            <REFERENCES>
                                <ECUC-REFERENCE-DEF>
                                    <SHORT-NAME>ref1</SHORT-NAME>
                                    <DESTINATION-REF DEST="ECUC-PARAM-CONF-CONTAINER-DEF">/ModuleDef/demo/contA</DESTINATION-REF>
                                </ECUC-REFERENCE-DEF>
                            </REFERENCES>
                        </ECUC-PARAM-CONF-CONTAINER-DEF>
                    </SUB-CONTAINERS>
                </ECUC-PARAM-CONF-CONTAINER-DEF>
            </CONTAINERS>
        </ECUC-MODULE-DEF>
      </ELEMENTS>
    </AR-PACKAGE>
  </AR-PACKAGES>
</AUTOSAR>

As mentioned earlier, when this file is provided to the asrGenerator, it generates the classes for the containers, parameters and references for the 'demo' module. For eg: The class 'demo' has getter methods to get the containers 'contA' and 'contB'. Similarly the class 'contA' has getter methods to get the parameters 'boolParam' and 'enumParam'.

Once the package for 'demo' is generated, lets build up the model for 'demo' by providing the a sample module configuration(as shown below).

<?xml version="1.0" encoding="UTF-8"?>
<AUTOSAR xmlns="http://autosar.org/schema/r4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://autosar.org/schema/r4.0 AUTOSAR_00049.xsd">
  <AR-PACKAGES>
    <AR-PACKAGE>
      <SHORT-NAME>ModuleConfig</SHORT-NAME>
      <ELEMENTS>
        <ECUC-MODULE-CONFIGURATION-VALUES>
          <SHORT-NAME>demo</SHORT-NAME>
          <DEFINITION-REF DEST="ECUC-MODULE-DEF">/ModuleDef/demo</DEFINITION-REF>
          <CONTAINERS>
            <ECUC-CONTAINER-VALUE>
              <SHORT-NAME>ContA_conf</SHORT-NAME>
              <DEFINITION-REF DEST="ECUC-PARAM-CONF-CONTAINER-DEF">/ModuleDef/demo/contA</DEFINITION-REF>
              <PARAMETER-VALUES>
                <ECUC-NUMERICAL-PARAM-VALUE>
                  <DEFINITION-REF DEST="ECUC-BOOLEAN-PARAM-DEF">/ModuleDef/demo/contA/boolParam</DEFINITION-REF>
                  <VALUE>1</VALUE>
                </ECUC-NUMERICAL-PARAM-VALUE>
                <ECUC-TEXTUAL-PARAM-VALUE>
                  <DEFINITION-REF DEST="ECUC-ENUMERATION-PARAM-DEF">/ModuleDef/demo/contA/enumParam</DEFINITION-REF>
                  <VALUE>RED</VALUE>
                </ECUC-TEXTUAL-PARAM-VALUE>
              </PARAMETER-VALUES>
            </ECUC-CONTAINER-VALUE>
            <ECUC-CONTAINER-VALUE>
              <SHORT-NAME>ContB_conf</SHORT-NAME>
              <DEFINITION-REF DEST="ECUC-PARAM-CONF-CONTAINER-DEF">/ModuleDef/demo/contB</DEFINITION-REF>
              <SUB-CONTAINERS>
                <ECUC-CONTAINER-VALUE>
                  <SHORT-NAME>subCont_conf</SHORT-NAME>
                  <DEFINITION-REF DEST="ECUC-PARAM-CONF-CONTAINER-DEF">/ModuleDef/demo/contB/subCont</DEFINITION-REF>
                </ECUC-CONTAINER-VALUE>
              </SUB-CONTAINERS>
              <PARAMETER-VALUES>
                <ECUC-NUMERICAL-PARAM-VALUE>
                  <DEFINITION-REF DEST="ECUC-INTEGER-PARAM-DEF">/ModuleDef/demo/contB/subCont/intParam</DEFINITION-REF>
                  <VALUE>255</VALUE>
                </ECUC-NUMERICAL-PARAM-VALUE>
              </PARAMETER-VALUES>
              <REFERENCE-VALUES>
                <ECUC-REFERENCE-VALUE>
                    <DEFINITION-REF DEST="ECUC-REFERENCE-DEF">/ModuleDef/demo/contB/subCont/ref1</DEFINITION-REF>
                    <VALUE-REF DEST="ECUC-CONTAINER-VALUE">/ModuleConfig/demo/ContA_conf</VALUE-REF>
                </ECUC-REFERENCE-VALUE>
              </REFERENCE-VALUES>
            </ECUC-CONTAINER-VALUE>
          </CONTAINERS>
        </ECUC-MODULE-CONFIGURATION-VALUES>
      </ELEMENTS>
    </AR-PACKAGE>
  </AR-PACKAGES>
</AUTOSAR>

Python code to build the model:

from demo import demo

Autosarconfigreader

Install / Use

README

Autosar Config Reader

How to use

Using the generated python classes