Skip to main content

LDF Language support for Python

Project description

LDF Parser

Workflow PyPI version PyPI - Python Version codecov.io 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.


Disclaimer

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.

Since the LDF usually contains sensitive information try to provide either an anonymized version with signals and frames obfuscated or just the relevant segments in an example LDF.


Example

import ldfparser

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

# Get baudrate from LDF
print(ldf.baudrate)

# Encode signal values into frame
message = frame.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.parse(received))
# >> {"Signal_1": 123, "Signal_2": 0}

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

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

  • Capturing comments

Currently not supported

  • Scheduling table

  • Diagnostics


Installation

Install via pip install ldfparser


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.6.0.tar.gz (15.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ldfparser-0.6.0-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ldfparser-0.6.0.tar.gz
  • Upload date:
  • Size: 15.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.6.12

File hashes

Hashes for ldfparser-0.6.0.tar.gz
Algorithm Hash digest
SHA256 3e51c3ddbc312e71e6b76df82b376b654540352434ca0e3df8dc73e1e259fe1d
MD5 5e3f3362c4a0047ce7e9252b784918ae
BLAKE2b-256 b7883cd2360e7739e45b6c598a514c06121ccc2f7c2772c8367a162e8e6e3a37

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ldfparser-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 18.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.6.12

File hashes

Hashes for ldfparser-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ffa65c64ce4f5698a491e97ac4994f5ed2a338d4cfbced894b1859ba7ab94343
MD5 bb05499c706a9234bc4c5dd18477c7ee
BLAKE2b-256 517ec28b6b8586e1fb4485ad446e2c993e7a84c5ff819e08a58010e35ccdd246

See more details on using hashes here.

Supported by

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