|
21 | 21 | Document: <a href="https://app.whyengineer.com">https://app.whyengineer.com</a>
|
22 | 22 | </div>
|
23 | 23 |
|
24 |
| -## Introduction |
| 24 | +## Overview |
25 | 25 |
|
26 |
| -EcuBus-Pro is a free and open source alternative to `CAN-OE`, designed for automotive ECU development. Our tool offers: |
| 26 | +EcuBus-Pro is an open-source alternative to commercial automotive diagnostic tools like `CAN-OE`. It provides a comprehensive solution for ECU development and testing with: |
27 | 27 |
|
28 |
| -* 🆓 Open source and free |
29 |
| -* 🚀 Intuitive user interface |
30 |
| -* 💻 Cross-platform compatibility |
31 |
| -* 🔌 Multi-vendor USB dongle support (PEAK, Kvaser, ZLG, etc.) |
32 |
| -* 📝 TypeScript-based scripting capabilities |
33 |
| -* ⌨️ Comprehensive CLI support |
| 28 | +* 🆓 Open-source and free to use |
| 29 | +* 🚀 Modern, intuitive user interface |
| 30 | +* 💻 Cross-platform support (Windows, Linux) |
| 31 | +* 🔌 Extensive hardware compatibility (PEAK, Kvaser, ZLG, and more) |
| 32 | +* 📝 Powerful TypeScript-based scripting engine |
| 33 | +* ⌨️ Full-featured command-line interface |
34 | 34 |
|
35 |
| -### Key Features |
| 35 | +### Core Features |
36 | 36 |
|
37 |
| -See our [User Manual](./docs/um/concept.md) for detailed documentation. |
| 37 | +For detailed information, please refer to our [User Manual](./docs/um/concept.md). |
38 | 38 |
|
39 | 39 | #### Hardware Support
|
40 | 40 |
|
41 |
| -| Vendor | Supported Protocols | |
| 41 | +| Manufacturer | Supported Protocols | |
42 | 42 | |--------|-------------------|
|
43 |
| -| PEAK | CAN CAN-FD LIN | |
44 |
| -| KVASER | CAN CAN-FD | |
45 |
| -| ZLG | CAN CAN-FD | |
46 |
| -| Toomoss | CAN CAN-FD (Coming Soon) | |
| 43 | +| PEAK | CAN, CAN-FD, LIN | |
| 44 | +| KVASER | CAN, CAN-FD | |
| 45 | +| ZLG | CAN, CAN-FD | |
| 46 | +| Toomoss | CAN, CAN-FD (Coming Soon) | |
47 | 47 |
|
48 |
| -#### Software Features |
| 48 | +#### Software Capabilities |
49 | 49 |
|
50 |
| -| Feature | Capabilities | |
| 50 | +| Feature | Description | |
51 | 51 | |---------|-------------|
|
52 |
| -| Platform Support | Windows (exe,portable) Linux (deb) | |
53 |
| -| UDS | CAN/CAN-FD DoIP LIN | |
54 |
| -| Scripting | see [Scripting](./docs/um/script.md) | |
55 |
| -| Database | LIN LDF (edit and export), CAN DBC (view only), see [Database](./docs/um/database.md) | |
56 |
| -| Graph | Signal Graph | |
| 52 | +| Platform Support | Windows (installer, portable), Linux (deb package) | |
| 53 | +| Diagnostic Protocols | CAN/CAN-FD, DoIP, LIN | |
| 54 | +| Scripting | Advanced TypeScript-based automation - [Documentation](./docs/um/script.md) | |
| 55 | +| Database Support | LIN LDF (edit & export), CAN DBC (view) - [Details](./docs/um/database.md) | |
| 56 | +| Data Visualization | Real-time signal graphing and analysis | |
57 | 57 |
|
58 |
| -### Visual Overview |
| 58 | +### Feature Highlights |
59 | 59 |
|
60 |
| -#### CAN |
| 60 | +#### CAN Communication |
61 | 61 | 
|
62 | 62 |
|
63 |
| -#### UDS |
| 63 | +#### UDS Diagnostics |
64 | 64 | 
|
65 | 65 |
|
66 |
| -#### Graph Signal |
| 66 | +#### Signal Analysis |
67 | 67 | 
|
68 | 68 |
|
69 |
| -### Script Capabilities |
70 |
| -Our script engine leverages `Node.js`, enabling you to: |
71 |
| -- Use standard Node.js functions |
72 |
| -- Access EcuBus-Pro's extensive API |
73 |
| -- Automate testing and diagnostics |
| 69 | +### Scripting Engine |
| 70 | +Built on Node.js, our scripting engine enables: |
| 71 | +- Full access to Node.js ecosystem |
| 72 | +- Comprehensive EcuBus-Pro API integration |
| 73 | +- Advanced test automation capabilities |
74 | 74 |
|
75 | 75 | 
|
76 | 76 |
|
77 | 77 | ### Command Line Interface
|
78 |
| -Streamline your workflow with CLI support for UDS sequences: |
| 78 | +Streamline your workflow with powerful CLI support: |
79 | 79 | 
|
80 | 80 |
|
81 |
| -## Support this project |
| 81 | +## Support & Sponsorship |
82 | 82 |
|
83 |
| -Support this project by [becoming a sponsor](./docs/about/sponsor). Your logo will show up here with a link to your website. 🙏 |
| 83 | +Consider [becoming a sponsor](./docs/about/sponsor) to support ongoing development. Sponsors receive prominent logo placement with website links. 🙏 |
84 | 84 |
|
85 |
| -### Technical support |
| 85 | +### Professional Support |
86 | 86 |
|
87 |
| -You can also consider sponsoring us to get extra technical support services. If you do, you can get access to the [ecubus/technical-support](https://github.com/ecubus/technical-support) repository, which has the following benefits: |
| 87 | +We offer premium technical support for sponsors, including access to the private [ecubus/technical-support](https://github.com/ecubus/technical-support) repository with these benefits: |
88 | 88 |
|
89 |
| -- [X] Handling Issues with higher priority |
90 |
| -- [X] One-to-one technical consulting service |
91 |
| -- [X] Help to write addon code to access 0x27,0x29 dll functions |
| 89 | +- [X] Priority issue resolution |
| 90 | +- [X] One-on-one technical consultation |
| 91 | +- [X] Custom development support for Security Access (0x27) and Authentication (0x29) |
92 | 92 |
|
93 |
| -## Thanks |
| 93 | +## Contributors |
94 | 94 |
|
95 |
| -This project exists thanks to all the people who have contributed: |
| 95 | +Thanks to all the contributors who have helped shape EcuBus-Pro: |
96 | 96 |
|
97 | 97 | <a href="https://github.com/ecubus/EcuBus-Pro/graphs/contributors"><img src="https://opencollective.com/ecubus/contributors.svg?width=890&button=false"></a>
|
98 | 98 |
|
99 |
| -Your contributions are always welcome! Please have a look at the [contribution guidelines](./.github/contributing.md) first. |
100 |
| - |
101 |
| -Your logo will show up here. |
| 99 | +We welcome contributions! Please review our [contribution guidelines](./.github/contributing.md) before getting started. |
102 | 100 |
|
103 | 101 | ## License
|
104 | 102 | Apache-2.0
|
|
0 commit comments