vblf


Namevblf JSON
Version 0.1.0a2 PyPI version JSON
download
home_pageNone
SummaryA library to read and write Vector BLF files (binary log format)
upload_time2025-01-09 22:46:46
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMIT
keywords blf vector binary log format automotive
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Binary Logging Format Library for Python

[![PyPI - Version](https://img.shields.io/pypi/v/vblf.svg)](https://pypi.org/project/vblf)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/vblf.svg)](https://pypi.org/project/vblf)

## Introduction

A Python library for reading and writing BLF files, a proprietary binary logging format of Vector Informatik GmbH. BLF files are commonly used in automotive logging and testing scenarios.

## Installation

```bash
pip install --pre vblf
```

## Usage

### Reading BLF Files

```python
from vblf.can import CanMessage, CanMessage2
from vblf.reader import BlfReader

# Open a BLF file
with BlfReader("example.blf") as reader:
    # Iterate through all objects in the file
    for obj in reader:
        print(f"Type: {obj.header.base.object_type.name}")
        print(f"Timestamp: {obj.header.object_time_stamp}")

        # Handle CAN messages
        if isinstance(obj, (CanMessage, CanMessage2)):
            print(f"CAN ID: {obj.id}")
            print(f"Data: {obj.data.hex()}")
```

### Writing BLF Files

```python
from vblf.can import CanMessage
from vblf.writer import BlfWriter

# Create a new BLF file
with BlfWriter("output.blf") as writer:
    # Create a CAN message
    msg = CanMessage(...)

    # Write the message to the file
    writer.write(msg)
```

## License

This project is licensed under the MIT License.

## Acknowledgments

- Vector Informatik GmbH for the BLF file format
- Tobias Lorenz for his C++ library [vector_blf](https://bitbucket.org/tobylorenz/vector_blf/src/master/)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "vblf",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "BLF, Vector, binary log format, Automotive",
    "author": null,
    "author_email": "Artur Drogunow <Artur.Drogunow@zf.com>",
    "download_url": "https://files.pythonhosted.org/packages/a2/0c/d75aec04141b047fa2f5732d552e81785e7427155b5ed3bc961ef2f2a532/vblf-0.1.0a2.tar.gz",
    "platform": null,
    "description": "# Binary Logging Format Library for Python\n\n[![PyPI - Version](https://img.shields.io/pypi/v/vblf.svg)](https://pypi.org/project/vblf)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/vblf.svg)](https://pypi.org/project/vblf)\n\n## Introduction\n\nA Python library for reading and writing BLF files, a proprietary binary logging format of Vector Informatik GmbH. BLF files are commonly used in automotive logging and testing scenarios.\n\n## Installation\n\n```bash\npip install --pre vblf\n```\n\n## Usage\n\n### Reading BLF Files\n\n```python\nfrom vblf.can import CanMessage, CanMessage2\nfrom vblf.reader import BlfReader\n\n# Open a BLF file\nwith BlfReader(\"example.blf\") as reader:\n    # Iterate through all objects in the file\n    for obj in reader:\n        print(f\"Type: {obj.header.base.object_type.name}\")\n        print(f\"Timestamp: {obj.header.object_time_stamp}\")\n\n        # Handle CAN messages\n        if isinstance(obj, (CanMessage, CanMessage2)):\n            print(f\"CAN ID: {obj.id}\")\n            print(f\"Data: {obj.data.hex()}\")\n```\n\n### Writing BLF Files\n\n```python\nfrom vblf.can import CanMessage\nfrom vblf.writer import BlfWriter\n\n# Create a new BLF file\nwith BlfWriter(\"output.blf\") as writer:\n    # Create a CAN message\n    msg = CanMessage(...)\n\n    # Write the message to the file\n    writer.write(msg)\n```\n\n## License\n\nThis project is licensed under the MIT License.\n\n## Acknowledgments\n\n- Vector Informatik GmbH for the BLF file format\n- Tobias Lorenz for his C++ library [vector_blf](https://bitbucket.org/tobylorenz/vector_blf/src/master/)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A library to read and write Vector BLF files (binary log format)",
    "version": "0.1.0a2",
    "project_urls": {
        "Homepage": "https://github.com/zariiii9003/vblf",
        "Issues": "https://github.com/zariiii9003/vblf/issues",
        "Source": "https://github.com/zariiii9003/vblf"
    },
    "split_keywords": [
        "blf",
        " vector",
        " binary log format",
        " automotive"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0dcc65bbdec1c10fc8d7aa0476ae7ea1380fc8416e0b25ee82cda8680c082e28",
                "md5": "141b3eb6a33840ef35e767f064a9ae20",
                "sha256": "76c223783500082fbd30e1f6c7af95df927d254951a7d30d7be8b3ae8266a999"
            },
            "downloads": -1,
            "filename": "vblf-0.1.0a2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "141b3eb6a33840ef35e767f064a9ae20",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 18624,
            "upload_time": "2025-01-09T22:46:44",
            "upload_time_iso_8601": "2025-01-09T22:46:44.673960Z",
            "url": "https://files.pythonhosted.org/packages/0d/cc/65bbdec1c10fc8d7aa0476ae7ea1380fc8416e0b25ee82cda8680c082e28/vblf-0.1.0a2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a20cd75aec04141b047fa2f5732d552e81785e7427155b5ed3bc961ef2f2a532",
                "md5": "7919a8e8c079b249a2d994f176dc3d62",
                "sha256": "58eedbb89d5c49e558b3f12c34a51f55439259d065b93869f06f5679856b3f5d"
            },
            "downloads": -1,
            "filename": "vblf-0.1.0a2.tar.gz",
            "has_sig": false,
            "md5_digest": "7919a8e8c079b249a2d994f176dc3d62",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 46482,
            "upload_time": "2025-01-09T22:46:46",
            "upload_time_iso_8601": "2025-01-09T22:46:46.121932Z",
            "url": "https://files.pythonhosted.org/packages/a2/0c/d75aec04141b047fa2f5732d552e81785e7427155b5ed3bc961ef2f2a532/vblf-0.1.0a2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-09 22:46:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "zariiii9003",
    "github_project": "vblf",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "vblf"
}
        
Elapsed time: 0.41022s