Skip to main content

Windows CAN simulator and testing tool with GUI and CLI.

Project description

🚌 WIN CAN TOOL

Windows CAN-Bus Simulator & Testing Tool

GUI + CLI • J1939-style messages • Real hardware output • Windows EXE auto-builds

License Python PyPI Platform


🚀 Overview

WIN CAN TOOL is a CAN-Bus simulator with both a GUI and CLI interface. It allows you to:

  • simulate engine, GNSS, and vehicle messages
  • output CAN traffic to real hardware (ValueCAN, Kvaser, Peak, virtual, ICS, etc.)
  • test dashboards, gateways, CDL devices, or software decoders
  • run dynamic simulation profiles
  • build custom message streams with Python

Every version tag automatically produces a Windows EXE release.


📥 Download the Windows EXE

Latest release: 👉 https://github.com/kfafard/win_can_tool/releases/latest

Download win_can_tool.zip, unzip, and run win_can_tool.exe.


📦 Install via PyPI

Prefer the Python version?

pip install win-can-tool

Run GUI:

win-can-gui

Run CLI:

win-can-cli --interface virtual --channel 0

🖥 GUI Features

  • Live GNSS position manipulation
  • Real-time engine RPM, hours, speed, load, fuel, temps
  • Clean PyQt6 interface
  • Status bar + event log
  • Auto-generated CAN frames at realistic frequencies
  • Selectable python-can backend interface

🖥 GUI Preview

🌙 Dark Mode

Dark Mode

☀️ Light Mode

Light Mode


🛠 CLI Usage Example

Send simulated CAN frames over a selected hardware interface:

win-can-cli --interface neovi --channel 1

Run the virtual interface:

win-can-cli --interface virtual --channel 0

📁 Project Structure

win_can_tool/
 ├── bus.py              # CAN interface layer (python-can)
 ├── engine.py           # Engine + GNSS simulation models
 ├── gui.py              # PyQt6 GUI application
 ├── cli.py              # CLI interface
 ├── profiles.py         # Simulation profiles
 ├── can_gui_launcher.py # PyInstaller entrypoint for EXE builds

⚙ Simulation Profiles

Profiles define preset simulation states. Example:

{
    "engine": {"rpm": 1500, "speed_kph": 12.4},
    "gnss":   {"lat": 51.23456, "lon": -102.34567}
}

🔧 Development

Clone the repo:

git clone https://github.com/kfafard/win_can_tool
cd win_can_tool

Install in editable mode:

pip install -e .

Run GUI manually:

python -m win_can_tool.gui

🏗 Auto-Build Pipeline

GitHub Actions automatically:

  1. Builds the EXE using PyInstaller
  2. Zips the executable
  3. Creates a GitHub Release
  4. Uploads the binary

Triggered by pushing a version tag:

git tag v1.0.9
git push origin v1.0.9

🤝 Contributing

Pull requests and issues are welcome.


📜 License

This project is licensed under the MIT License – see the LICENSE file for details.


📝 Changelog

All notable changes are documented in the CHANGELOG.md.

Latest release: v1.1.0


⚡ Credits

Developed by Kurtis Fafard Built for real-world CAN-Bus testing, simulation, and rapid development.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

win_can_tool-1.2.1.tar.gz (19.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

win_can_tool-1.2.1-py3-none-any.whl (19.4 kB view details)

Uploaded Python 3

File details

Details for the file win_can_tool-1.2.1.tar.gz.

File metadata

  • Download URL: win_can_tool-1.2.1.tar.gz
  • Upload date:
  • Size: 19.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for win_can_tool-1.2.1.tar.gz
Algorithm Hash digest
SHA256 48308af40f9ed642f4226459e9eefe9896ab910e518c7121ca5bb889458492d2
MD5 609ca054d3c6060564ecf15fb52e1ef0
BLAKE2b-256 5d28363a778b2847cdea430a84ffee594ca099c3efa1ad1fb8ed195c7d205f02

See more details on using hashes here.

File details

Details for the file win_can_tool-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: win_can_tool-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 19.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for win_can_tool-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 392ffea4f0ad0b6f75d4e11309b180e67faa3a17ba3598956d4821a295e71c55
MD5 fc4629a6f1c558016423053c95e0f21a
BLAKE2b-256 c7708db1819f6c967bb79a02ed7d69a1d54f1031c872fbe8af3d00f90df4c3f9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page