odxtools 5.2.6__py3-none-any.whl → 5.3.1__py3-none-any.whl

odxtools/templates/macros/printParam.xml.jinja2

@@ -3,6 +3,7 @@
  # SPDX-License-Identifier: MIT
 -#}
 
+{%- import('macros/printElementID.xml.jinja2') as peid %}
 {%- import('macros/printDOP.xml.jinja2') as pdop %}
 {%- import('macros/printSpecialData.xml.jinja2') as psd %}
 
@@ -19,13 +20,7 @@
 {%- else %}
 <PARAM {{semattrib}} xsi:type="{{param.parameter_type}}">
 {%- endif%}
- <SHORT-NAME>{{param.short_name}}</SHORT-NAME>
-{%- if param.long_name %}
- <LONG-NAME>{{param.long_name|e}}</LONG-NAME>
-{%- endif %}
-{%- if param.description %}
- <DESC>{{param.description}}</DESC>
-{%- endif %}
+ {{ peid.printElementID(param)|indent(1) }}
  {{- psd.printSpecialDataGroups(param.sdgs)|indent(1, first=True) }}
 {%- if param.byte_position is not none %}
  <BYTE-POSITION>{{param.byte_position}}</BYTE-POSITION>

odxtools/templates/macros/printRequest.xml.jinja2

@@ -3,21 +3,14 @@
  # SPDX-License-Identifier: MIT
 -#}
 
+{%- import('macros/printElementID.xml.jinja2') as peid %}
 {%- import('macros/printDOP.xml.jinja2') as pdop %}
 {%- import('macros/printParam.xml.jinja2') as pp %}
 {%- import('macros/printSpecialData.xml.jinja2') as psd %}
 
 {%- macro printRequest(request) -%}
 <REQUEST ID="{{request.odx_id.local_id}}">
- <SHORT-NAME>{{request.short_name}}</SHORT-NAME>
-{%- if request.long_name %}
- <LONG-NAME>{{request.long_name|e}}</LONG-NAME>
-{%- endif %}
-{%- if request.description and request.description.strip() %}
- <DESC>
- {{request.description}}
- </DESC>
-{%- endif %}
+ {{ peid.printElementID(request)|indent(1) }}
 {%- if request.parameters %}
  <PARAMS>
  {%- for param in request.parameters -%}

odxtools/templates/macros/printResponse.xml.jinja2

@@ -3,20 +3,13 @@
  # SPDX-License-Identifier: MIT
 -#}
 
+{%- import('macros/printElementID.xml.jinja2') as peid %}
 {%- import('macros/printParam.xml.jinja2') as pp %}
 {%- import('macros/printSpecialData.xml.jinja2') as psd %}
 
 {%- macro printResponse(resp, tag_name="POS-RESPONSE") -%}
 <{{tag_name}} ID="{{resp.odx_id.local_id}}">
- <SHORT-NAME>{{resp.short_name}}</SHORT-NAME>
-{%- if resp.long_name %}
- <LONG-NAME>{{resp.long_name|e}}</LONG-NAME>
-{%- endif %}
-{%- if resp.description and resp.description.strip() %}
- <DESC>
- {{resp.description}}
- </DESC>
-{%- endif %}
+ {{ peid.printElementID(resp)|indent(1) }}
 {%- if resp.parameters %}
  <PARAMS>
 {%- for param in resp.parameters -%}

odxtools/templates/macros/printService.xml.jinja2

@@ -3,6 +3,7 @@
  # SPDX-License-Identifier: MIT
 -#}
 
+{%- import('macros/printElementID.xml.jinja2') as peid %}
 {%- import('macros/printAdminData.xml.jinja2') as pad %}
 {%- import('macros/printAudience.xml.jinja2') as paud %}
 {%- import('macros/printSpecialData.xml.jinja2') as psd %}
@@ -14,15 +15,7 @@
 {%-  set semattrib = " SEMANTIC=\"UNKNOWN\"" -%}
 {%- endif -%}
 <DIAG-SERVICE ID="{{service.odx_id.local_id}}" {{semattrib}}>
- <SHORT-NAME>{{service.short_name}}</SHORT-NAME>
-{%- if service.long_name and service.long_name.strip() %}
- <LONG-NAME>{{service.long_name|e}}</LONG-NAME>
-{%- endif %}
-{%- if service.description and service.description.strip() %}
- <DESC>
- {{service.description}}
- </DESC>
-{%- endif %}
+ {{ peid.printElementID(service)|indent(1) }}
  {%- if service.admin_data %}
  {{- pad.printAdminData(service.admin_data)|indent(1, first=True) }}
  {%- endif %}

odxtools/templates/macros/printSpecialData.xml.jinja2

@@ -18,7 +18,7 @@
 
 {%- macro printSdgCaption(sdg_caption) %}
 <SDG-CAPTION ID="{{sdg_caption.odx_id.local_id}}">
- {{ peid.printElementID(sdg_caption) | indent(1) }}
+ {{ peid.printElementID(sdg_caption)|indent(1) }}
 </SDG-CAPTION>
 {%- endmacro %}
 

odxtools/templates/macros/printState.xml.jinja2

@@ -3,16 +3,10 @@
  # SPDX-License-Identifier: MIT
 -#}
 
+{%- import('macros/printElementID.xml.jinja2') as peid %}
+
 {%- macro printState(state) -%}
 <STATE ID="{{state.odx_id.local_id}}">
- <SHORT-NAME>{{state.short_name}}</SHORT-NAME>
- {%- if state.long_name %}
- <LONG-NAME>{{state.long_name}}</LONG-NAME>
- {%- endif %}
- {%- if state.description is string and state.description.strip() %}
- <DESC>
-{{state.description}}
- </DESC>
- {%- endif %}
+ {{ peid.printElementID(state)|indent(1) }}
 </STATE>
 {%- endmacro -%}

odxtools/templates/macros/printStateChart.xml.jinja2

@@ -3,19 +3,13 @@
  # SPDX-License-Identifier: MIT
 -#}
 
+{%- import('macros/printElementID.xml.jinja2') as peid %}
 {%- import('macros/printState.xml.jinja2') as ps %}
 {%- import('macros/printStateTransition.xml.jinja2') as pst %}
 
 {%- macro printStateChart(state_chart) -%}
 <STATE-CHART ID="{{state_chart.odx_id.local_id}}">
- <SHORT-NAME>{{state_chart.short_name}}</SHORT-NAME>
-{%- if state_chart.long_name %}
- <LONG-NAME>{{state_chart.long_name}}</LONG-NAME>
-{%- endif %}
-{%- if state_chart.description is string and state_chart.description.strip() %}
- <DESC>
-{{state_chart.description}}
- </DESC>
+ {{ peid.printElementID(state_chart)|indent(1) }}
  <SEMANTIC>{{state_chart.semantic}}</SEMANTIC>
  {%- if state_chart.state_transitions %}
  <STATE-TRANSITIONS>
@@ -32,6 +26,5 @@
   {%- endfor %}
  </STATES>
  {%- endif %}
-{%- endif %}
 </STATE-CHART>
 {%- endmacro -%}

odxtools/templates/macros/printStateTransition.xml.jinja2

@@ -3,17 +3,11 @@
  # SPDX-License-Identifier: MIT
 -#}
 
+{%- import('macros/printElementID.xml.jinja2') as peid %}
+
 {%- macro printStateTransition(state_transition) -%}
 <STATE-TRANSITION ID="{{state_transition.odx_id.local_id}}">
- <SHORT-NAME>{{state_transition.short_name}}</SHORT-NAME>
- {%- if state_transition.long_name %}
- <LONG-NAME>{{state_transition.long_name}}</LONG-NAME>
- {%- endif %}
- {%- if state_transition.description is string and state_transition.description.strip() %}
- <DESC>
-{{state_transition.description}}
- </DESC>
- {%- endif %}
+ {{ peid.printElementID(state_transition)|indent(1) }}
  <SOURCE-SNREF SHORT-NAME="{{state_transition.source_snref}}" />
  <TARGET-SNREF SHORT-NAME="{{state_transition.target_snref}}" />
 </STATE-TRANSITION>

odxtools/templates/macros/printStructure.xml.jinja2

@@ -3,14 +3,12 @@
  # SPDX-License-Identifier: MIT
 -#}
 
+{%- import('macros/printElementID.xml.jinja2') as peid %}
 {%- import('macros/printParam.xml.jinja2') as pp %}
 
 {%- macro printStructure(st) -%}
 <STRUCTURE ID="{{st.odx_id.local_id}}">
- <SHORT-NAME>{{st.short_name}}</SHORT-NAME>
-{%- if st.long_name %}
- <LONG-NAME>{{st.long_name|e}}</LONG-NAME>
-{%- endif %}
+ {{ peid.printElementID(st)|indent(1) }}
 {%- if st.byte_size is not none %}
  <BYTE-SIZE>{{st.byte_size}}</BYTE-SIZE>
 {%- endif %}

odxtools/templates/macros/printTable.xml.jinja2

@@ -3,18 +3,13 @@
  # SPDX-License-Identifier: MIT
 -#}
 
+{%- import('macros/printElementID.xml.jinja2') as peid %}
 {%- import('macros/printSpecialData.xml.jinja2') as psd %}
 
 {%- macro printTable(table) %}
 <TABLE ID="{{table.odx_id.local_id}}"
        {{-make_xml_attrib("SEMANTIC", table.semantic)}}>
- <SHORT-NAME>{{table.short_name}}</SHORT-NAME>
-{%- if table.long_name %}
-  <LONG-NAME>{{table.long_name|e}}</LONG-NAME>
-{%- endif %}
-{%- if table.description %}
-  <DESC>{{table.description}}</DESC>
-{%- endif %}
+ {{ peid.printElementID(table)|indent(1) }}
 {%- if table.key_dop_ref %}
  <KEY-DOP-REF ID-REF="{{ table.key_dop_ref.ref_id }}" />
 {%- endif %}

odxtools/templates/macros/printUnitSpec.xml.jinja2

@@ -37,7 +37,7 @@
 {%- macro printUnit(unit) -%}
 <UNIT ID="{{unit.odx_id.local_id}}"
       {{-make_xml_attrib("OID", unit.oid)}}>
- {{ peid.printElementID(unit) }}
+ {{ peid.printElementID(unit)|indent(1) }}
  <DISPLAY-NAME>{{ unit.display_name }}</DISPLAY-NAME>
  {%- if unit.factor_si_to_unit is not none %}
  <FACTOR-SI-TO-UNIT>{{ unit.factor_si_to_unit }}</FACTOR-SI-TO-UNIT>
@@ -53,7 +53,7 @@
 
 {%- macro printUnitGroup(group) -%}
 <UNIT-GROUP {%- if group.oid %} OID="{{group.oid}}" {%- endif %}>
- {{ peid.printElementID(group) }}
+ {{ peid.printElementID(group)|indent(1) }}
  <CATEGORY>{{ group.category.value }}</CATEGORY>
  {%- if group.unit_refs %}
  <UNIT-REFS>
@@ -68,7 +68,7 @@
 {%- macro printPhysicalDimesion(dim) -%}
 <PHYSICAL-DIMENSION ID="{{dim.odx_id.local_id}}"
                     {{-make_xml_attrib("OID",dim.oid)}}>
- {{ peid.printElementID(dim) }}
+ {{ peid.printElementID(dim)|indent(1) }}
  {%- if dim.length_exp %}
  <LENGTH-EXP>{{ dim.length_exp }}</LENGTH-EXP>
  {%- endif %}

odxtools/templates/macros/printVariant.xml.jinja2

@@ -3,11 +3,13 @@
  # SPDX-License-Identifier: MIT
 -#}
 
+{%- import('macros/printElementID.xml.jinja2') as peid %}
 {%- import('macros/printDOP.xml.jinja2') as pdop %}
 {%- import('macros/printTable.xml.jinja2') as pt %}
 {%- import('macros/printFunctionalClass.xml.jinja2') as pfc %}
 {%- import('macros/printStructure.xml.jinja2') as pst %}
 {%- import('macros/printEndOfPdu.xml.jinja2') as peopdu %}
+{%- import('macros/printDynamicLengthField.xml.jinja2') as pdlf %}
 {%- import('macros/printMux.xml.jinja2') as pm %}
 {%- import('macros/printEnvData.xml.jinja2') as ped %}
 {%- import('macros/printEnvDataDesc.xml.jinja2') as pedd %}
@@ -25,15 +27,7 @@
 {%- macro printVariant(dl) -%}
 {%- set dlr = dl.diag_layer_raw %}
 <{{dlr.variant_type.value}} ID="{{dlr.odx_id.local_id}}">
- <SHORT-NAME>{{dlr.short_name}}</SHORT-NAME>
-{%- if dlr.long_name %}
- <LONG-NAME>{{dlr.long_name|e}}</LONG-NAME>
-{%- endif %}
-{%- if dlr.description is string and dlr.description.strip() %}
- <DESC>
-{{dlr.description}}
- </DESC>
-{%- endif %}
+ {{ peid.printElementID(dlr)|indent(1) }}
 {%- if dlr.functional_classes %}
  <FUNCT-CLASSS>
 {%- for fc in dlr.functional_classes %}
@@ -72,6 +66,13 @@
      {%- endfor %}
    </STRUCTURES>
    {%- endif %}
+   {%- if ddds.dynamic_length_fields %}
+   <DYNAMIC-LENGTH-FIELDS>
+     {%- for dlf in ddds.dynamic_length_fields %}
+     {{ pdlf.printDynamicLengthField(dlf)|indent(3) }}
+     {%- endfor %}
+   </DYNAMIC-LENGTH-FIELDS>
+   {%- endif %}
    {%- if ddds.end_of_pdu_fields %}
    <END-OF-PDU-FIELDS>
      {%- for eopdu in ddds.end_of_pdu_fields %}

odxtools/version.py

@@ -1,4 +1,6 @@
 # file generated by setuptools_scm
 # don't change, don't track in version control
-__version__ = version = '5.2.6'
-__version_tuple__ = version_tuple = (5, 2, 6)
+from __future__ import annotations
+
+__version__ = version = '5.3.1'  # type: str
+__version_tuple__ = version_tuple = (5, 3, 1)  # type: tuple[int | str, ...]

{odxtools-5.2.6.dist-info → odxtools-5.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: odxtools
-Version: 5.2.6
+Version: 5.3.1
 Summary: Utilities to work with the ODX standard for automotive diagnostics
 Author-email: Katrin Bauer <katrin.bauer@mbition.io>, Andreas Lauser <andreas.lauser@mbition.io>, Ayoub Kaanich <kayoub5@live.com>
 Maintainer-email: Andreas Lauser <andreas.lauser@mbition.io>, Ayoub Kaanich <kayoub5@live.com>
@@ -312,7 +312,7 @@ using `odxtools --help`:
 
 ```bash
 $ odxtools --help
-usage: odxtools [-h] [-c] {list,browse,snoop,find,encode-message,decode-message} ...
+usage: odxtools [-h] [--version] {list,browse,snoop,find} ...
 
 Utilities to interact with automotive diagnostic descriptions based on the ODX standard.
 
@@ -323,20 +323,16 @@ Examples:
    odxtools browse ./path/to/database.pdx
 
 positional arguments:
-  {list,browse,snoop,find,encode-message,decode-message}
+  {list,browse,snoop,find}
                         Select a sub command
     list                Print a summary of automotive diagnostic files.
     browse              Interactively browse the content of automotive diagnostic files.
     snoop               Live decoding of a diagnostic session.
     find                Find & display services by hex-data, or name, can also decodes requests.
-    encode-message      Encode a message. Interactively asks for parameter values.
-                        This is a short cut through the browse command to directly encode a message.
-    decode-message      Decode a message. Interactively asks for parameter values.
-                        This is a short cut through the browse command to directly encode a message.
 
 optional arguments:
   -h, --help            show this help message and exit
-  -c, --conformant      The input file fully confirms to the standard, i.e., disable work-arounds for bugs of the CANdela tool
+  --version             Print the odxtools version
 ```
 
 All subcommands accept the `--help` parameter:
@@ -391,7 +387,7 @@ the `--all` parameter prints all data of the file that is recognized
 by `odxtools`. Example:
 
 ```bash
-$ odxtools --conformant list $BASE_DIR/odxtools/examples/somersault.pdx --variants somersault_lazy --services do_forward_flips --params
+$ odxtools list $BASE_DIR/odxtools/examples/somersault.pdx --variants somersault_lazy --services do_forward_flips --params
 ECU-VARIANT 'somersault_lazy' (Receive ID: 0x7b, Send ID: 0x1c8)
  num services: 5, num DOPs: 6, num communication parameters: 11.
 The services of the ECU-VARIANT 'somersault_lazy' are:
@@ -451,7 +447,7 @@ navigate through the database of a `.pdx` file. For example, using the
 spamming the terminal:
 
 ```bash
-$ odxtools --conformant browse $BASE_DIR/odxtools/examples/somersault.pdx
+$ odxtools browse $BASE_DIR/odxtools/examples/somersault.pdx
 ? Select a Variant.  somersault_lazy
 ECU-VARIANT 'somersault_lazy' (Receive ID: 0x7b, Send ID: 0x1c8)
 ? The variant somersault_lazy offers the following services. Select one!  do_forward_flips
@@ -475,15 +471,39 @@ ECU-VARIANT 'somersault_lazy' (Receive ID: 0x7b, Send ID: 0x1c8)
 ### The `snoop` subcommand
 
 The `snoop` subcommand can be used to decode a trace of a or a
-currently running diagnostic session:
+currently running diagnostic session.
 
+```bash
+$ odxtools snoop -h
+usage: odxtools snoop [-h] [--active] [--channel CHANNEL] [--rx RX] [--tx TX] [--variant VARIANT]
+                      [--protocol PROTOCOL]
+                      PDX_FILE
+
+Live decoding of a diagnostic session.
+
+positional arguments:
+  PDX_FILE              path to the .pdx file
+
+options:
+  -h, --help            show this help message and exit
+  --active, -a          Active mode, sends flow control messages to receive ISO-TP telegrams successfully
+  --channel CHANNEL, -c CHANNEL
+                        CAN interface name to be used (required in active mode)
+  --rx RX, -r RX        CAN ID in which the ECU listens for diagnostic messages
+  --tx TX, -t TX        CAN ID in which the ECU sends replys to diagnostic messages  (required in active mode)
+  --variant VARIANT, -v VARIANT
+                        Name of the ECU variant which the decode process ought to be based on
+  --protocol PROTOCOL, -p PROTOCOL
+                        Name of the protocol used for decoding
+```
+Example:
 ```bash
 # create a socketcan `vcan0` interface
 sudo ip link add dev vcan0 type vcan
 sudo ip link set vcan0 up
 
 # start the snooping on vcan0
-odxtools --conformant snoop -c vcan0 --variant "somersault_lazy" $BASE_DIR/odxtools/examples/somersault.pdx
+odxtools snoop -c vcan0 --variant "somersault_lazy" $BASE_DIR/odxtools/examples/somersault.pdx
 
 # on a different terminal, run the diagnostic session
 $BASE_DIR/odxtools/examples/somersaultlazy.py -c vcan0
@@ -492,7 +512,7 @@ $BASE_DIR/odxtools/examples/somersaultlazy.py -c vcan0
 The snoop command will then output the following:
 
 ```bash
-$ odxtools --conformant snoop -c vcan0 --variant "somersault_lazy" $BASE_DIR/odxtools/examples/somersault.pdx
+$ odxtools snoop -c vcan0 --variant "somersault_lazy" $BASE_DIR/odxtools/examples/somersault.pdx
 Decoding messages on channel vcan0
 Tester: do_forward_flips(forward_soberness_check=18, num_flips=1)
  -> 7fba7f (bytearray(b'\x7f\xba\x7f'), 3 bytes)
@@ -516,6 +536,43 @@ information by either a hex request, or partial name via cli.
 In addition, it can also decode a hex request and display its parameters 
 mapped to a service. 
 
+```bash
+$ odxtools find -h
+usage: odxtools find [-h] [-v VARIANT [VARIANT ...]] [-d [DATA ...]] [-D [DECODE ...]] [-s [SERVICES ...]] [-nd]
+                     [-ro]
+                     PDX_FILE
+
+Find & print services by hex-data, or name, can also decodes requests
+
+Examples:
+  For displaying the service associated with the request 10 01:
+    odxtools find ./path/to/database.pdx -d 10 01
+  For displaying the service associated with the request 10 01, and decoding it:
+    odxtools find ./path/to/database.pdx -D 10 01
+  For displaying the services associated with the partial name 'Reset' without details:
+    odxtools find ./path/to/database.pdx -s "Reset" --no-details
+  For more information use:
+    odxtools find -h
+
+positional arguments:
+  PDX_FILE              path to the .pdx file
+
+options:
+  -h, --help            show this help message and exit
+  -v VARIANT [VARIANT ...], --variants VARIANT [VARIANT ...]
+                        Specifies which ecu variants should be included.
+  -d [DATA ...], --data [DATA ...]
+                        Print a list of diagnostic services associated with the hex request.
+  -D [DECODE ...], --decode [DECODE ...]
+                        Print a list of diagnostic services associated with the hex request and decode the request.
+  -s [SERVICES ...], --service-names [SERVICES ...]
+                        Print a list of diagnostic services partially matching given service names
+  -nd, --no-details     Don't show all service details
+  -ro, --relaxed-output
+                        Relax output formatting rules (allow unknown bitlengths for ascii representation)
+```
+Example: Find diagnostic services associated with the hex request `10 00`
+
 ```bash
 $ odxtools find $BASE_DIR/odxtools/examples/somersault.pdx -D 10 00