<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/>
[](https://pypi.org/project/can-explorer/)
[](https://pypi.org/project/can-explorer/)
[](https://github.com/Tbruno25/can-explorer/stargazers)
</div>
---
## About
`can-explorer` is a CAN bus visualization tool designed to aid in reverse engineering.
### 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
[](https://github.com/hoffstadt/DearPyGui)
[](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.
Raw data
{
"_id": null,
"home_page": "https://github.com/Tbruno25/can-explorer",
"name": "can-explorer",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "can, bus, canbus, can_bus, dbc",
"author": "TJ",
"author_email": "tbruno25@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/6e/18/60090e0e51e23e7abff04d05d7001ba4b8ce4b79c8875bbc8c8f7a029f54/can_explorer-0.2.0.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">\n <a href=\"https://github.com/tbruno25/can-explorer\">\n <!-- Please provide path to your logo here -->\n <img src=\"https://github.com/Tbruno25/can-explorer/raw/main/docs/images/logo.png\" alt=\"Logo\" width=\"200\" height=\"200\">\n </a>\n</h1>\n\n<div align=\"center\">\n can-explorer\n <br />\n <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>\n \u00b7\n <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>\n \u00b7\n <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>\n</div>\n\n<div align=\"center\">\n<br/>\n\n\n[](https://pypi.org/project/can-explorer/)\n[](https://pypi.org/project/can-explorer/)\n[](https://github.com/Tbruno25/can-explorer/stargazers)\n</div>\n\n---\n\n## About\n\n`can-explorer` is a CAN bus visualization tool designed to aid in reverse engineering.\n\n\n\n### How does this help me?\nBy continuously plotting all payloads for each CAN id, spotting trends that correspond to a specific action can become signicantly easier to identify. \n\nPlease 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.\n\n\n### Built With\n\n\n[](https://github.com/hoffstadt/DearPyGui)\n[](https://github.com/hardbyte/python-can)\n\n## Getting Started\n\n### Installation\n\n[pipx](https://pypa.github.io/pipx/) is recommended although any package manager that supports `pyproject.toml` files can be used.\n\n```sh\npipx install can-explorer\n``` \n\n## Usage\n\nThe gui can be launched by running one of the below commands from a terminal.\n```sh \ncan-explorer\n``` \n\n```sh \npython3 -m can_explorer\n``` \n\nBefore 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. \n\nThe 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.\n\n```sh \ncan-explorer --demo\n``` \n\n## Support\n\nReach out to the maintainer at one of the following places:\n- [GitHub issues](https://github.com/tbruno25/can-explorer/issues/new?assignees=&labels=question&template=04_SUPPORT_QUESTION.md&title=support%3A+)\n- Contact options listed on [this GitHub profile](https://github.com/tbruno25)\n\nIf 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.\n\n\n## Contributing\n\nPlease read [our contribution guidelines](docs/CONTRIBUTING.md)\n\nFor a full list of all authors and contributors, see [the contributors page](https://github.com/tbruno25/can-explorer/contributors).\n\n## License\n\nThis project is licensed under the **GNU General Public License v3**.\n\nSee [LICENSE](LICENSE) for more information.\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Visualize CAN bus payloads in real time",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/Tbruno25/can-explorer",
"Repository": "https://github.com/Tbruno25/can-explorer"
},
"split_keywords": [
"can",
" bus",
" canbus",
" can_bus",
" dbc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0b17c0a1b9afaeb94ce4cbe479b72a72d371fac758cba379e902744c597c2deb",
"md5": "b3f47d67a92e7c9866d6330c4733dab1",
"sha256": "562435c5ceea863ea1627d5719fea125b8751326415be7d0491460842b3ac16a"
},
"downloads": -1,
"filename": "can_explorer-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b3f47d67a92e7c9866d6330c4733dab1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 19946726,
"upload_time": "2024-07-19T17:32:00",
"upload_time_iso_8601": "2024-07-19T17:32:00.816165Z",
"url": "https://files.pythonhosted.org/packages/0b/17/c0a1b9afaeb94ce4cbe479b72a72d371fac758cba379e902744c597c2deb/can_explorer-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6e1860090e0e51e23e7abff04d05d7001ba4b8ce4b79c8875bbc8c8f7a029f54",
"md5": "97993e199977f481242309b12afb7895",
"sha256": "4a98692a23e2b335c137ed839a28418d7bd0e14272472afa496c1a23d1f341e5"
},
"downloads": -1,
"filename": "can_explorer-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "97993e199977f481242309b12afb7895",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 19935199,
"upload_time": "2024-07-19T17:32:03",
"upload_time_iso_8601": "2024-07-19T17:32:03.755573Z",
"url": "https://files.pythonhosted.org/packages/6e/18/60090e0e51e23e7abff04d05d7001ba4b8ce4b79c8875bbc8c8f7a029f54/can_explorer-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-19 17:32:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Tbruno25",
"github_project": "can-explorer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "can-explorer"
}
JSON
