Skip to content

Commit b04ebf0

Browse files
committed
update um can
1 parent 1adbc8f commit b04ebf0

File tree

13 files changed

+118
-47
lines changed

13 files changed

+118
-47
lines changed

.vitepress/config.mts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ export default defineConfig({
6767
text: 'User Manual',
6868
link: '/docs/um/concept',
6969
items: [
70-
{ text: 'Lin', link: '/docs/um/lin/lin.md' },
70+
{ text: 'CAN', link: '/docs/um/can/can.md' },
71+
{ text: 'LIN', link: '/docs/um/lin/lin.md' },
7172
{ text: 'Graph', link: '/docs/um/graph/graph.md' },
7273
{ text: 'CLI', link: '/docs/um/cli' },
7374
{

README.md

Lines changed: 42 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -21,84 +21,82 @@
2121
Document: <a href="https://app.whyengineer.com">https://app.whyengineer.com</a>
2222
</div>
2323

24-
## Introduction
24+
## Overview
2525

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:
2727

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
3434

35-
### Key Features
35+
### Core Features
3636

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).
3838

3939
#### Hardware Support
4040

41-
| Vendor | Supported Protocols |
41+
| Manufacturer | Supported Protocols |
4242
|--------|-------------------|
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) |
4747

48-
#### Software Features
48+
#### Software Capabilities
4949

50-
| Feature | Capabilities |
50+
| Feature | Description |
5151
|---------|-------------|
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 |
5757

58-
### Visual Overview
58+
### Feature Highlights
5959

60-
#### CAN
60+
#### CAN Communication
6161
![base1](./docs/about/base1.gif)
6262

63-
#### UDS
63+
#### UDS Diagnostics
6464
![base1](./docs/about/uds.gif)
6565

66-
#### Graph Signal
66+
#### Signal Analysis
6767
![base1](./docs/about/graph.gif)
6868

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
7474

7575
![base1](./docs/um/script1.gif)
7676

7777
### Command Line Interface
78-
Streamline your workflow with CLI support for UDS sequences:
78+
Streamline your workflow with powerful CLI support:
7979
![base1](./docs/about/seq.png)
8080

81-
## Support this project
81+
## Support & Sponsorship
8282

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. 🙏
8484

85-
### Technical support
85+
### Professional Support
8686

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:
8888

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)
9292

93-
## Thanks
93+
## Contributors
9494

95-
This project exists thanks to all the people who have contributed:
95+
Thanks to all the contributors who have helped shape EcuBus-Pro:
9696

9797
<a href="https://github.com/ecubus/EcuBus-Pro/graphs/contributors"><img src="https://opencollective.com/ecubus/contributors.svg?width=890&amp;button=false"></a>
9898

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.
102100

103101
## License
104102
Apache-2.0

docs/um/can/can.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# CAN
2+
3+
CAN/CAN-FD is an industry-standard vehicle bus protocol designed for reliable ECU communication in automotive applications.
4+
5+
> [!IMPORTANT]
6+
> All features described in this section require a CAN DBC file. For more information about DBC files, please refer to our [database documentation](../dbc).
7+
8+
> [!NOTE]
9+
> Supported Hardware:
10+
> | Manufacturer | Protocols |
11+
> |--------|-------------------|
12+
> | PEAK | CAN, CAN-FD |
13+
> | KVASER | CAN, CAN-FD |
14+
> | ZLG | CAN, CAN-FD |
15+
> | Toomoss | CAN, CAN-FD (Coming Soon) |
16+
17+
## Device Configuration
18+
19+
For demonstration purposes, we'll use a simulated device. You can configure the baud rate and sample point in the device settings.
20+
21+
![alt text](image.png)
22+
23+
## Interactive Mode and Node Scripts
24+
25+
EcuBus-Pro offers two primary methods for CAN communication:
26+
* Interactive Mode: For manual frame transmission
27+
* Node Scripts: For automated communication using custom scripts
28+
29+
![alt text](image-1.png)
30+
31+
### Interactive Mode
32+
33+
Each frame can be configured for periodic transmission or manual triggering (single-shot or key-bound).
34+
![alt text](image-2.png)
35+
36+
You can add frames in two ways:
37+
* Manual frame configuration
38+
* Import from DBC database
39+
![alt text](image-3.png)
40+
41+
### Node Scripts
42+
43+
Nodes can be configured with UDS capabilities (tester) and custom scripts.
44+
![alt text](image-4.png)
45+
46+
Example script for periodic signal updates:
47+
```typescript
48+
import {setSignal} from 'ECB'
49+
let val = 0;
50+
// Update signal value every second
51+
setInterval(() => {
52+
setSignal("Model3CAN.VCLEFT_liftgateLatchRequest", (val++) % 5);
53+
}, 1000);
54+
```
55+
56+
## Diagnostic Operations
57+
58+
1. **Tester Configuration**
59+
- Configure addressing
60+
- Set diagnostic parameters
61+
![alt text](image-5.png)
62+
63+
2. **Diagnostic Services**
64+
- Configure diagnostic services
65+
- Create schedule tables and sequences
66+
![alt text](image-6.png)
67+
68+
3. **Message Monitoring**
69+
- View transmitted and received messages in the trace window
70+
![alt text](image-7.png)
71+
72+

docs/um/can/image-1.png

78.1 KB
Loading

docs/um/can/image-2.png

32.3 KB
Loading

docs/um/can/image-3.png

38.1 KB
Loading

docs/um/can/image-4.png

30 KB
Loading

docs/um/can/image-5.png

102 KB
Loading

docs/um/can/image-6.png

142 KB
Loading

docs/um/can/image-7.png

70.5 KB
Loading

0 commit comments

Comments
 (0)