blackbox-decoder 0.3.0

The blackbox is a loggging system used within our autonomous drone system. The decoder is a tool to help decode the logs from their hex format into a human readable format.

BlackBox

Table of Contents

• BlackBox
  • Table of Contents
  • Introduction
  • Installation
    • Poetry
  • Usage

Introduction

BlackBox is a tool that allows you to decode logs from the the ALED Powerboard. The tool is written in Python and uses the following libraries:

• Pandas
• PyQt6
• Bitstring
• Matplotlib

The application works by reading the log file and decoding the data into a human readable format. The user can then view the data in multiple plots and graphs.

Installation

To install the Log Decoder, you need to have Python 3 installed on your computer. Afterwards, clone the repository and install the required dependencies using the following commands:

Pip

The BlackBox application can be installed using pip. To install the application, run the following command:

pip install blackbox-decoder

To run the application, use the following command:

blackbox-decoder

Poetry

The BlackBox application uses Poetry to manage its dependencies. To install the dependencies, run the following command:

git clone https://github.com/colerottenberg/blackbox_decoder.git
cd blackbox_decoder

poetry install

To run the application, use the following command:

poetry run python blackbox_decoder/app.py

Usage

To use the application, the user needs to open the application and select the Browse button to select the log file. The user can then select the Decode button to decode the log file. A new window will open with the decoded data. Using the Navigation bar at the top, the user can select the data they want to view.

For testing purposes, the user can use the log file provided in the repository. The log file is located in the logs folder.