Skip to content

Commit 9c76e50

Browse files
committed
update doc, 0.8.15
1 parent 9ec22c1 commit 9c76e50

16 files changed

+143
-14
lines changed

.vitepress/config.mts

+6
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ export default defineConfig({
7878
{
7979
text: 'Database', link: '/docs/um/database', items: [
8080
{ text: 'LIN LDF', link: '/docs/um/ldf' },
81+
{ text: 'CAN DBC', link: '/docs/um/dbc' },
8182
]
8283
},
8384
]
@@ -87,6 +88,11 @@ export default defineConfig({
8788

8889
items: [
8990
{ text: 'Secure Access dll', link: '/examples/secure_access_dll/readme' },
91+
{
92+
text: 'CAN', items: [
93+
{ text: 'CAN Basic', link: '/examples/can/readme', },
94+
], collapsed: true
95+
},
9096
{
9197
text: 'LIN', items: [
9298

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ See our [User Manual](./docs/um/concept.md) for detailed documentation.
5151
|---------|-------------|
5252
| Platform Support | Windows (exe,portable) Linux (deb) |
5353
| UDS | CAN/CAN-FD DoIP LIN |
54-
| Scripting | see [script](./docs/um/script.md) |
55-
| Database | LIN LDF (edit and export) |
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) |
5656
| Graph | Signal Graph |
5757

5858
### Visual Overview

docs/dev/releases_note.md

+10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# EcuBus-Pro Release Notes
22

3+
## v0.8.15
4+
Changes from v0.8.14 to v0.8.15:
5+
6+
7+
* [feat]:add can setSingal
8+
* [feat]:opt can dbc parse
9+
* [feat]:add signal update
10+
* [feat]:add prase dbc file
11+
---
12+
313
## v0.8.14
414
Changes from v0.8.13 to v0.8.14:
515

docs/um/database.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ Data transform depending on the database information. Added database system to h
77
## Supported Databases
88

99
* [LIN LDF](./ldf)
10-
* CAN DBC, TODO
10+
* [CAN DBC](./dbc)

docs/um/dbc.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# CAN DBC
2+
3+
EcuBus-Pro supports parsing most CAN DBC files. If you encounter any DBC files that cannot be parsed correctly, please report the issue on our [Github Issues](https://github.com/ecubus/EcuBus-Pro/issues) page.
4+
5+
The application provides an efficient search interface for messages and signals.
6+
7+
> [!NOTE]
8+
> Currently, EcuBus-Pro only supports viewing DBC files and does not support editing. Please ensure your DBC file is correctly formatted before use.
9+
10+
## Select a DBC File
11+
![alt text](image-18.png)
12+
13+
## Overview
14+
The DBC viewer provides comprehensive information about:
15+
* Network Nodes
16+
* Messages
17+
* Signals
18+
19+
![alt text](image-19.png)
20+
21+
## Value Tables
22+
Value tables define the mapping between raw values and their corresponding meanings.
23+
24+
![alt text](image-20.png)
25+
26+
## Attributes
27+
View and inspect all DBC attributes.
28+
29+
![alt text](image-21.png)

docs/um/image-18.png

15.1 KB
Loading

docs/um/image-19.png

234 KB
Loading

docs/um/image-20.png

108 KB
Loading

docs/um/image-21.png

106 KB
Loading

docs/um/image-3.png

16.4 KB
Loading

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ecubuspro",
3-
"version": "0.8.14",
3+
"version": "0.8.15",
44
"description": "EcuBus-Pro",
55
"main": "./out/main/index.js",
66
"author": "[email protected]",

resources/examples/can/Can.ecb

+3
Original file line numberDiff line numberDiff line change
@@ -68629,6 +68629,9 @@
6862968629
"id": "graph",
6863068630
"options": {}
6863168631
}
68632+
},,
68633+
"example":{
68634+
"catalog":"CAN"
6863268635
}
6863368636
}
6863468637
}

resources/examples/can/image-1.png

89.2 KB
Loading

resources/examples/can/image.png

110 KB
Loading

resources/examples/can/readme.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# CAN Example
2+
3+
This example demonstrates basic CAN communication setup and usage in EcuBus-Pro.
4+
5+
## Network Structure
6+
7+
The example consists of three nodes:
8+
- Node 1 (Brown) - Signal generator node
9+
- Can IA (SkyBlue) - Interactive analysis interface
10+
- SIMULATE_0 (Blue) - CAN bus simulator
11+
12+
The nodes are connected in a CAN network topology, with Node 1 sending signals through SIMULATE_0 device, which can be monitored and analyzed in Can IA.
13+
14+
## Features Demonstrated
15+
16+
1. **Message Transmission**
17+
- Node 1 runs a script that periodically updates signal value
18+
- Signal: VCLEFT_liftgateLatchRequest (cycles through values 0-4)
19+
- Update interval: 1000ms
20+
```typescript
21+
// Node 1 script
22+
import {setSignal} from 'ECB'
23+
let val = 0;
24+
setInterval(() => {
25+
setSignal("Model3CAN.VCLEFT_liftgateLatchRequest", (val++) % 5);
26+
}, 1000);
27+
```
28+
29+
2. **Data Visualization**
30+
- Real-time signal graphing in Can IA
31+
- Message trace logging
32+
- Network topology view
33+
34+
3. **Interactive Controls**
35+
- Start/Stop frame sending
36+
- Signal value inspection
37+
![alt text](image.png)
38+
39+
4. **Graph**
40+
- graph signal `VCLEFT_liftgateLatchRequest`
41+
42+
![alt text](image-1.png)
43+
44+
## Usage
45+
46+
1. Load the example configuration file (`Can.ecb`)
47+
2. The network topology will be displayed in the Network view
48+
3. Start the simulation to see Node 1 generating signal values
49+
4. Use Can IA interface to:
50+
- Monitor signal changes
51+
- View message trace
52+
- Watch real-time signal graph
53+
- Inspect message details
54+
55+
This example demonstrates how to set up automated signal generation and monitoring in EcuBus-Pro, making it ideal for learning basic CAN communication concepts and signal analysis features.

tools/release_note.js

+36-10
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ async function make_release_note_all() {
1212
const ret = await exec('"git" tag -l --sort=-v:refname')
1313
let tagList = ret.stdout.match(/v\d+\.\d+\.\d+/g) // 匹配形如 'v1.0.0' 的版本号
1414

15-
if (!tagList || tagList.length < 2) {
16-
console.error('Insufficient tags found for release note generation.')
15+
if (!tagList) {
16+
console.error('No tags found for release note generation.')
1717
return
1818
}
1919

@@ -23,6 +23,38 @@ async function make_release_note_all() {
2323
// 初始化Markdown文件内容
2424
let md = '# EcuBus-Pro Release Notes\n\n'
2525

26+
// 检查当前commit是否有tag
27+
const { stdout: currentTag } = await exec('"git" tag --points-at HEAD')
28+
const hasCurrentTag = currentTag.trim() !== ''
29+
30+
if (!hasCurrentTag) {
31+
// 如果当前commit没有tag,添加Unreleased部分
32+
const latestTag = tagList[0]
33+
md += `## Unreleased\n`
34+
md += `Changes since ${latestTag}:\n\n`
35+
36+
// 获取从最新tag到现在的提交记录
37+
const LOG_FORMAT = '%Cgreen*%Creset %s'
38+
const latestLogs = await exec(
39+
`"git" log --no-merges ${latestTag}..HEAD --format="${LOG_FORMAT}" --date=short`
40+
)
41+
42+
// 处理最新的提交记录
43+
for (let log of latestLogs.stdout.split('\n')) {
44+
if (/^\s*\*\s+\[(.*?)\]:/.test(log)) {
45+
log = log.replace(/(https:\/\/\S+)/g, '[$1]($1)')
46+
for (let i = 1; i < log.length; i++) {
47+
if (log[i] === '[' && i != 0 && log[i+1]!='h') {
48+
md += '\n* '
49+
}
50+
md += log[i]
51+
}
52+
}
53+
}
54+
md += '\n---\n\n'
55+
}
56+
57+
// 处理历史tag之间的变更
2658
for (let i = 0; i < tagList.length - 1; i++) {
2759
const currentTag = tagList[i + 1]
2860
const nextTag = tagList[i]
@@ -39,19 +71,13 @@ async function make_release_note_all() {
3971

4072
for (let log of logs.stdout.split('\n')) {
4173
if (/^\s*\*\s+\[(.*?)\]:/.test(log)) {
42-
//if log contains https://, we need to replace it with [link](https://), use regex
43-
log=log.replace(/(https:\/\/\S+)/g, '[$1]($1)')
44-
// log may contains mulit [xx], so we need to put each [xx] at new line
45-
74+
log = log.replace(/(https:\/\/\S+)/g, '[$1]($1)')
4675
for (let i = 1; i < log.length; i++) {
47-
if (log[i] === '[' && i != 0&&log[i+1]!='h') {
76+
if (log[i] === '[' && i != 0 && log[i+1]!='h') {
4877
md += '\n* '
4978
}
50-
5179
md += log[i]
5280
}
53-
54-
// md += log + '\n';
5581
}
5682
}
5783

0 commit comments

Comments
 (0)