Skip to content

Commit

Permalink
update doc, 0.8.15
Browse files Browse the repository at this point in the history
  • Loading branch information
frankie-zeng committed Jan 25, 2025
1 parent 9ec22c1 commit 9c76e50
Show file tree
Hide file tree
Showing 16 changed files with 143 additions and 14 deletions.
6 changes: 6 additions & 0 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ export default defineConfig({
{
text: 'Database', link: '/docs/um/database', items: [
{ text: 'LIN LDF', link: '/docs/um/ldf' },
{ text: 'CAN DBC', link: '/docs/um/dbc' },
]
},
]
Expand All @@ -87,6 +88,11 @@ export default defineConfig({

items: [
{ text: 'Secure Access dll', link: '/examples/secure_access_dll/readme' },
{
text: 'CAN', items: [
{ text: 'CAN Basic', link: '/examples/can/readme', },
], collapsed: true
},
{
text: 'LIN', items: [

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ See our [User Manual](./docs/um/concept.md) for detailed documentation.
|---------|-------------|
| Platform Support | Windows (exe,portable) Linux (deb) |
| UDS | CAN/CAN-FD DoIP LIN |
| Scripting | see [script](./docs/um/script.md) |
| Database | LIN LDF (edit and export) |
| Scripting | see [Scripting](./docs/um/script.md) |
| Database | LIN LDF (edit and export), CAN DBC (view only), see [Database](./docs/um/database.md) |
| Graph | Signal Graph |

### Visual Overview
Expand Down
10 changes: 10 additions & 0 deletions docs/dev/releases_note.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# EcuBus-Pro Release Notes

## v0.8.15
Changes from v0.8.14 to v0.8.15:


* [feat]:add can setSingal
* [feat]:opt can dbc parse
* [feat]:add signal update
* [feat]:add prase dbc file
---

## v0.8.14
Changes from v0.8.13 to v0.8.14:

Expand Down
2 changes: 1 addition & 1 deletion docs/um/database.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ Data transform depending on the database information. Added database system to h
## Supported Databases

* [LIN LDF](./ldf)
* CAN DBC, TODO
* [CAN DBC](./dbc)
29 changes: 29 additions & 0 deletions docs/um/dbc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# CAN DBC

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.

The application provides an efficient search interface for messages and signals.

> [!NOTE]
> Currently, EcuBus-Pro only supports viewing DBC files and does not support editing. Please ensure your DBC file is correctly formatted before use.
## Select a DBC File
![alt text](image-18.png)

## Overview
The DBC viewer provides comprehensive information about:
* Network Nodes
* Messages
* Signals

![alt text](image-19.png)

## Value Tables
Value tables define the mapping between raw values and their corresponding meanings.

![alt text](image-20.png)

## Attributes
View and inspect all DBC attributes.

![alt text](image-21.png)
Binary file added docs/um/image-18.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/um/image-19.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/um/image-20.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/um/image-21.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/um/image-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ecubuspro",
"version": "0.8.14",
"version": "0.8.15",
"description": "EcuBus-Pro",
"main": "./out/main/index.js",
"author": "[email protected]",
Expand Down
3 changes: 3 additions & 0 deletions resources/examples/can/Can.ecb
Original file line number Diff line number Diff line change
Expand Up @@ -68629,6 +68629,9 @@
"id": "graph",
"options": {}
}
},,
"example":{
"catalog":"CAN"
}
}
}
Binary file added resources/examples/can/image-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/examples/can/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
55 changes: 55 additions & 0 deletions resources/examples/can/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# CAN Example

This example demonstrates basic CAN communication setup and usage in EcuBus-Pro.

## Network Structure

The example consists of three nodes:
- Node 1 (Brown) - Signal generator node
- Can IA (SkyBlue) - Interactive analysis interface
- SIMULATE_0 (Blue) - CAN bus simulator

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.

## Features Demonstrated

1. **Message Transmission**
- Node 1 runs a script that periodically updates signal value
- Signal: VCLEFT_liftgateLatchRequest (cycles through values 0-4)
- Update interval: 1000ms
```typescript
// Node 1 script
import {setSignal} from 'ECB'
let val = 0;
setInterval(() => {
setSignal("Model3CAN.VCLEFT_liftgateLatchRequest", (val++) % 5);
}, 1000);
```

2. **Data Visualization**
- Real-time signal graphing in Can IA
- Message trace logging
- Network topology view

3. **Interactive Controls**
- Start/Stop frame sending
- Signal value inspection
![alt text](image.png)

4. **Graph**
- graph signal `VCLEFT_liftgateLatchRequest`

![alt text](image-1.png)

## Usage

1. Load the example configuration file (`Can.ecb`)
2. The network topology will be displayed in the Network view
3. Start the simulation to see Node 1 generating signal values
4. Use Can IA interface to:
- Monitor signal changes
- View message trace
- Watch real-time signal graph
- Inspect message details

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.
46 changes: 36 additions & 10 deletions tools/release_note.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ async function make_release_note_all() {
const ret = await exec('"git" tag -l --sort=-v:refname')
let tagList = ret.stdout.match(/v\d+\.\d+\.\d+/g) // 匹配形如 'v1.0.0' 的版本号

if (!tagList || tagList.length < 2) {
console.error('Insufficient tags found for release note generation.')
if (!tagList) {
console.error('No tags found for release note generation.')
return
}

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

// 检查当前commit是否有tag
const { stdout: currentTag } = await exec('"git" tag --points-at HEAD')
const hasCurrentTag = currentTag.trim() !== ''

if (!hasCurrentTag) {
// 如果当前commit没有tag,添加Unreleased部分
const latestTag = tagList[0]
md += `## Unreleased\n`
md += `Changes since ${latestTag}:\n\n`

// 获取从最新tag到现在的提交记录
const LOG_FORMAT = '%Cgreen*%Creset %s'
const latestLogs = await exec(
`"git" log --no-merges ${latestTag}..HEAD --format="${LOG_FORMAT}" --date=short`
)

// 处理最新的提交记录
for (let log of latestLogs.stdout.split('\n')) {
if (/^\s*\*\s+\[(.*?)\]:/.test(log)) {
log = log.replace(/(https:\/\/\S+)/g, '[$1]($1)')
for (let i = 1; i < log.length; i++) {
if (log[i] === '[' && i != 0 && log[i+1]!='h') {
md += '\n* '
}
md += log[i]
}
}
}
md += '\n---\n\n'
}

// 处理历史tag之间的变更
for (let i = 0; i < tagList.length - 1; i++) {
const currentTag = tagList[i + 1]
const nextTag = tagList[i]
Expand All @@ -39,19 +71,13 @@ async function make_release_note_all() {

for (let log of logs.stdout.split('\n')) {
if (/^\s*\*\s+\[(.*?)\]:/.test(log)) {
//if log contains https://, we need to replace it with [link](https://), use regex
log=log.replace(/(https:\/\/\S+)/g, '[$1]($1)')
// log may contains mulit [xx], so we need to put each [xx] at new line

log = log.replace(/(https:\/\/\S+)/g, '[$1]($1)')
for (let i = 1; i < log.length; i++) {
if (log[i] === '[' && i != 0&&log[i+1]!='h') {
if (log[i] === '[' && i != 0 && log[i+1]!='h') {
md += '\n* '
}

md += log[i]
}

// md += log + '\n';
}
}

Expand Down

0 comments on commit 9c76e50

Please sign in to comment.