pymavlog 0.4.2

A lightweight python library to parse MavLink log files

pymavlog

A lightweight python library to parse log files from ArduPilot vehicles based on the MavLink protocol. It is built on top of pymavlink and uses NumPy under the hood to vectorize messages.

Installation

Installation with pip:

pip install pymavlog

or via Poetry

poetry add pymavlog

Development

Install the package in editable mode:

pip install -e .

Pymavlog is built using Poetry, so make sure to have it in your local development environment

pip install poetry

Lastly, install the pre-commit hooks

pip install pre-commit
pre-commit install

Testing

poetry run pytest tests --cov pymavlog

or

make tests

Usage

Mavlink log files are parsed using MavLog, which iterates through the logged messages and saves them in-memory as NumPy arrays. You can parse a file like:

from pymavlog import MavLog


filepath = "foo/bar.bin"
mavlog = MavLog("foo/bar.bin")
mavlog.parse()

and access the messages like:

imu_messages = mavlog.get("IMU")

and do some calculations, for example calculating the average value:

avg_gyr_x = imu_messages["GyrX"].mean()

alternatively, you can access a specific attribute like:

gyr_y = mavlog["IMU"]["Gyrx"]

Pymavlog also supports telemetry log files. You can read a tlog file .tlog in a similar way as binary log files, like:

from pymavlog import MavTLog


filepath = "foo/bar.tlog"
tlog = MavTLog("foo/bar.tlog")
tlog.parse()