Home

Awesome

<h1 align="center"> <a href="https://github.com/tbruno25/can-explorer"> <!-- Please provide path to your logo here --> <img src="https://github.com/Tbruno25/can-explorer/raw/main/docs/images/logo.png" alt="Logo" width="200" height="200"> </a> </h1> <div align="center"> can-explorer <br /> <a href="https://github.com/tbruno25/can-explorer/issues/new?assignees=&labels=bug&template=01_BUG_REPORT.md&title=bug%3A+">Report a Bug</a> · <a href="https://github.com/tbruno25/can-explorer/issues/new?assignees=&labels=enhancement&template=02_FEATURE_REQUEST.md&title=feature%3A+">Request a Feature</a> · <a href="https://github.com/tbruno25/can-explorer/issues/new?assignees=&labels=question&template=04_SUPPORT_QUESTION.md&title=support%3A+">Ask a Question</a> </div> <div align="center"> <br/>

PyPI version Python Versions Stars

</div>

About

can-explorer is a CAN bus visualization tool designed to aid in reverse engineering.

Demo

How does this help me?

By continuously plotting all payloads for each CAN id, spotting trends that correspond to a specific action can become signicantly easier to identify.

Please refer to this prior article I wrote for a working example of how this approach can be used to find which id includes speedometer data.

Built With

DearPyGui PythonCan

Getting Started

Installation

pipx is recommended although any package manager that supports pyproject.toml files can be used.

pipx install can-explorer

Usage

The gui can be launched by running one of the below commands from a terminal.

can-explorer

python3 -m can_explorer

Before starting the viewer, you must navigate to the settings tab and input your interface adapter configuration to create a bus instance. Please refer to the python-can docs for more information regarding the various interfaces supported.

The gui can also be launched with a demo flag which will auto select the virtual interface option and start streaming simulated CAN data in a background process.

can-explorer --demo

Support

Reach out to the maintainer at one of the following places:

If you want to say thank you or/and support active development of can-explorer consider adding a GitHub Star to the project.

Contributing

Please read our contribution guidelines

For a full list of all authors and contributors, see the contributors page.

License

This project is licensed under the GNU General Public License v3.

See LICENSE for more information.