https://github.com/tbruno25/canopy

Visualize CAN Bus messages in real time
https://github.com/tbruno25/canopy

Last synced: 3 months ago
JSON representation

Visualize CAN Bus messages in real time

• Host: GitHub
• URL: https://github.com/tbruno25/canopy
• Owner: Tbruno25
• License: other
• Created: 2021-03-01T05:45:07.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-10-31T22:11:13.000Z (about 1 year ago)
• Last Synced: 2024-05-23T10:33:10.949Z (6 months ago)
• Language: Python
• Homepage:
• Size: 62.7 MB
• Stars: 199
• Watchers: 7
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: docs/CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-canbus - CanoPy - A python gui used to visualize and plot message payloads in real time. (Utils / Python Tools)

README

        


  

    

    

  





  can-explorer

  


  Report a Bug

  ·

  Request a Feature

  ·

  Ask a Question








[![PyPI version](https://img.shields.io/pypi/v/can-explorer?color=mediumseagreen)](https://pypi.org/project/can-explorer/)

[![Python Versions](https://img.shields.io/pypi/pyversions/can-explorer?color=mediumseagreen)](https://pypi.org/project/can-explorer/)

[![Stars](https://img.shields.io/github/stars/tbruno25/can-explorer?color=mediumseagreen)](https://github.com/Tbruno25/can-explorer/stargazers)



---

## About

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

![Demo](https://github.com/Tbruno25/can-explorer/raw/main/docs/images/demo.gif)

### 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](https://tbruno25.medium.com/car-hacking-faster-reverse-engineering-using-canopy-be1955843d57) I wrote for a working example of how this approach can be used to find which id includes speedometer data.

### Built With

[![DearPyGui](https://github.com/Tbruno25/can-explorer/raw/main/docs/images/dearpygui-logo.png)](https://github.com/hoffstadt/DearPyGui)

[![PythonCan](https://github.com/Tbruno25/can-explorer/raw/main/docs/images/pythoncan-logo.png)](https://github.com/hardbyte/python-can)

## Getting Started

### Installation

[pipx](https://pypa.github.io/pipx/) is recommended although any package manager that supports `pyproject.toml` files can be used.

```sh

pipx install can-explorer

``` 

## Usage

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

```sh 

can-explorer

``` 

```sh 

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](https://python-can.readthedocs.io/en/stable/index.html) 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.

```sh 

can-explorer --demo

``` 

## Support

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

- [GitHub issues](https://github.com/tbruno25/can-explorer/issues/new?assignees=&labels=question&template=04_SUPPORT_QUESTION.md&title=support%3A+)

- Contact options listed on [this GitHub profile](https://github.com/tbruno25)

If you want to say **thank you** or/and support active development of can-explorer consider adding a [GitHub Star](https://github.com/tbruno25/can-explorer) to the project.

## Contributing

Please read [our contribution guidelines](docs/CONTRIBUTING.md)

For a full list of all authors and contributors, see [the contributors page](https://github.com/tbruno25/can-explorer/contributors).

## License

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

See [LICENSE](LICENSE) for more information.