Skip to main content

LDF Language support for Python

Project description

LDF Parser

Workflow Github Pages PyPI version PyPI - Python Version codecov.io Total alerts Language grade: Python GitHub last commit License: MIT

This tool is able parse LIN Description Files, retrieve signal names and frames from them, as well as encoding messages using frame definitions and decoding them.


Disclaimers

The library is still in a pre-release state, therefore features may break between minor versions. For this reason it's recommended that productive environments pin to the exact version of the library and do an integration test or review when updating the version. Breaking changes and how to migrate to the new version will be documented in the changelog and on the Github releases page.

The tool has been written according the LIN standards 1.3, 2.0, 2.1 and 2.2A, but due to errors in the documentation there's no guarantee that the library will be able to parse your LDF. In such cases if possible first verify the LDF with a commercial tool such as Vector LDF Explorer or the tool that was used to create the LDF. If the LDF seems to be correct then open a new issue. I also recommend trying the LDF to JSON conversion mechanism, see if that succeeds.

The LIN standard is now known as ISO 17987 which clears up some of the confusing parts in the 2.2A specification. Since this new standard is not freely available this library won't support the modifications present in ISO 17987. I don't think it's going to a huge problem because the LIN 2.2A released in 2010 has overall better adoption.

The LDF usually contains sensitive information, if you need to open an issue related to the parser then try to provide either an anonymized version with signals and frames obfuscated or just the relevant segments in an example LDF when opening issues.


Installation

You can install this library from PyPI using pip.

pip install ldfparser

Examples

import ldfparser
import binascii

# Load LDF
ldf = ldfparser.parse_ldf(path = "network.ldf")
frame = ldf.get_unconditional_frame('Frame_1')

# Get baudrate from LDF
print(ldf.get_baudrate())

# Encode signal values into frame
message = frame.encode_raw({"Signal_1": 123, "Signal_2": 0})
print(binascii.hexlify(message))
>>> 0x7B00

# Decode message into dictionary of signal names and values
received = bytearray([0x7B, 0x00])
print(frame.decode(received))
>>> {"Signal_1": 123, "Signal_2": 0}

# Encode signal values through converters
message = frame.encode({"MotorRPM": 100, "FanState": "ON"})
print(binascii.hexlify(message))
>>> 0xFE01

More examples can be found in the examples directory.


Documentation

Documentation is published to Github Pages.


Features

  • Semantic validation of LDF files

  • Retrieve header information (version, baudrate)

  • Retrieve Signal and Frame information

  • Retrieve Signal encoding types and use them to convert values

  • Retrieve Node attributes

  • Retrieve schedule table information

  • Command Line Interface

  • Capturing comments

  • Encode and decode standard diagnostic frames

  • Saving LDF object as an .ldf file (experimental)

Known issues / missing features

  • Certain parsing related errors are unintuitive

  • Checksum calculation for frames

  • Token information is not preserved


Development

Install the library locally by running pip install -e .[dev]

Pytest is used for testing, to execute all tests run pytest -m 'not snapshot'

Flake8 is used for linting, run flake8 to print out all linting errors.


Contributors

@c4deszes (Author)


Credits

Inspired by uCAN-LIN LinUSBConverter, specifically the LDF parsing mechanism via Lark. Previously the library included most of the lark file, parsing code and examples, since 0.5.0 they've been completely rewritten to better accomodate the different LIN standards.


License

License: MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ldfparser-0.26.0.tar.gz (28.8 kB view details)

Uploaded Source

Built Distribution

ldfparser-0.26.0-py3-none-any.whl (32.1 kB view details)

Uploaded Python 3

File details

Details for the file ldfparser-0.26.0.tar.gz.

File metadata

  • Download URL: ldfparser-0.26.0.tar.gz
  • Upload date:
  • Size: 28.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.10.0 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/1.0.0 urllib3/1.26.20 tqdm/4.64.1 importlib-metadata/4.2.0 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.5 CPython/3.6.15

File hashes

Hashes for ldfparser-0.26.0.tar.gz
Algorithm Hash digest
SHA256 dfc9ef0c4dd35d4e33d187b14cbc111f3b829eb8902a408391156cd59b16833a
MD5 4d31de4030635d5c325899fb862a0591
BLAKE2b-256 14a606f90c9519aced67c5b85392fb4227f37f22dce0efa09a9a91ef8ee7e1e7

See more details on using hashes here.

File details

Details for the file ldfparser-0.26.0-py3-none-any.whl.

File metadata

  • Download URL: ldfparser-0.26.0-py3-none-any.whl
  • Upload date:
  • Size: 32.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.10.0 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/1.0.0 urllib3/1.26.20 tqdm/4.64.1 importlib-metadata/4.2.0 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.5 CPython/3.6.15

File hashes

Hashes for ldfparser-0.26.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b8ac077653df30c27835ec5c0b0e5f9499d763eafb3834e6aab57b9b79f4d6a1
MD5 40d9825f0531cdc5dbe03fd9168db435
BLAKE2b-256 15a127c234c74f338e367762837e1d9ddef9ba3bcb8066c1ccce028d7747eaa0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page