mcpField
C
can

can

github.com/zhinkgitDevelopment772724 installsUpdated 1w ago
Repository

About can

CAN is an embedded CAN and CAN-FD debugging skill for inspecting interfaces and working with bus traffic. Its scripts support monitoring, sending, logging, database-based decoding, and statistics, with project-level configuration.

Key features

  1. 01Scan CAN interfaces
  2. 02Monitor bus messages
  3. 03Send standard and CAN-FD frames
  4. 04Log ASC, BLF, and CSV files
  5. 05Decode with DBC databases
  6. 06Analyze load, IDs, and frame rates

Use cases

  1. 01Finding connected CAN interfaces
  2. 02Monitoring and recording bus traffic
  3. 03Decoding logged frames with DBC
  4. 04Inspecting bus load and message rates

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/zhinkgit/embeddedskills --skill can

After installing, type/canin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

config.example.json
README.md
references/
common_interfaces.json
scripts/
can_decode.py
can_log.py
can_monitor.py
can_runtime.py
can_scan.py
can_send.py
can_stats.py
tests/
test_can_discovery.py

Details

From the project README

CAN — 嵌入式 CAN / CAN-FD 调试工具

统一封装接口发现、实时监控、报文发送、日志记录、数据库文件解码和统计分析能力。

配置

环境级配置 (skill/config.json)

仅保留 slcan 相关的环境级配置:

{
  "slcan_serial_port": "",
  "slcan_serial_baudrate": 115200
}
字段说明默认值
slcan_serial_portslcan 场景的串口""
slcan_serial_baudrateslcan 场景的串口速率115200
工程级配置 (.embeddedskills/config.json)

工作区下的 .embeddedskills/config.json 存放工程级 CAN 配置:

{
  "can": {
    "interface": "",
    "channel": "",
    "bitrate": 500000,
    "data_bitrate": 2000000,
    "log_dir": ".embeddedskills/logs/can"
  }
}
字段说明默认值
interfaceCAN 后端,如 pcan / vector / slcan""
channel通道名,如 PCAN_USBBUS1""
bitrate仲裁域比特率500000
data_bitrateCAN-FD 数据域比特率2000000
log_dir日志输出目录.embeddedskills/logs/can
参数解析优先级
  1. CLI 参数 (--interface, --channel, --bitrate 等) - 最高优先级
  2. 工程级配置 (.embeddedskills/config.json 中的 can 部分)
  3. 状态文件 (.embeddedskills/state.json 中的历史记录)
  4. 默认值 - 最低优先级
自动扫描行为

scan 的 details.interfaces 及摘要数量只包含检测到的 USB-CAN 设备和 SocketCAN 接口。details.registered_backends 单独列出已注册的软件后端,不代表驱动可用或硬件已连接,也不参与自动选择。

当未指定 interface 和 channel 时,脚本会自动扫描系统 CAN 接口,按以下步骤处理:

  1. 扫描系统中所有可用 CAN 接口
  2. 若只找到一个接口 → 自动使用并写入工程配置
  3. 若找到多个接口 → 返回候选列表,等待用户选择
  4. 若未找到接口 → 提示错误,停止执行

子命令

子命令用途风险
scan扫描可用 CAN 接口与 USB-CAN 设备低
monitor实时监控总线报文低
send发送标准帧 / 扩展帧 / 远程帧 / CAN-FD 帧高
log记录总线报文到 ASC / BLF / CSV 文件低
decode用 DBC 等数据库文件解码报文或日志低
stats统计总线负载、ID 分布和帧率低

执行流程

  1. 检查 python-can 是否可用,未安装时提示 pip install python-can
  2. 按优先级解析参数:CLI > 工程级配置 > 状态文件 > 默认值
  3. 无子命令时默认执行 scan
  4. monitor / send / log / stats 使用解析后的连接参数
  5. decode 先确认数据库文件和输入源存在
  6. 若未指定 interface/channel,自动扫描系统 CAN 接口:
    • 唯一候选:自动使用并写入工程配置
    • 多候选:返回列表让用户选择
  7. 成功执行后,将确认的参数写回工程配置
  8. send 只要配置可连接就直接执行,不二次确认
  9. 运行对应脚本并输出结构化结果
  10. 失败时优先反馈接口、驱动、比特率和过滤条件问题

脚本调用

所有脚本位于 skill 目录的 scripts/ 下,通过 python 直接调用。 脚本会按优先级从 CLI 参数、工程级配置、状态文件中读取参数。

# 扫描接口
python scripts/can_scan.py [--json]

# 实时监控
python scripts/can_monitor.py [--interface <接口>] [--channel <通道>] [--bitrate <速率>] [--fd] [--filter-id <ID列表>] [--exclude-id <ID列表>] [--dbc <DBC文件>] [--timeout <秒>] [--json]

# 发送报文
python scripts/can_send.py [--interface <接口>] [--channel <通道>] [--bitrate <速率>] <id> <data> [--extended] [--remote] [--fd] [--repeat <次>] [--interval <秒>] [--periodic <毫秒>] [--listen] [--json]

# 日志记录
python scripts/can_log.py [--interface <接口>] [--channel <通道>] [--bitrate <速率>] [--output <文件>] [--duration <秒>] [--max-count <数量>] [--filter-id <ID列表>] [--console] [--json]

# 数据库解码
python scripts/can_decode.py <db_file> [--db-format <auto|dbc|arxml|kcd|sym|cdd>] [--id <CAN_ID>] [--data <HEX数据>] [--log <日志文件>] [--signal <信号名>] [--list] [--json]

# 总线统计
python scripts/can_stats.py [--interface <接口>] [--channel <通道>] [--bitrate <速率>] [--duration <秒>] [--top <数量>] [--watch <ID列表>] [--json]

输出格式

单次命令返回标准 JSON:

{
  "status": "ok",
  "action": "scan",
  "summary": "发现 2 个 CAN 接口",
  "details": { ... }
}

持续命令(monitor --json、send --listen --json)输出 JSON Lines,结束摘要写入 stderr。

错误输出:

{
  "status": "error",
  "action": "send",
  "error": { "code": "interface_open_failed", "message": "无法打开指定 CAN 接口" }
}

核心规则

  • 不自动猜测 interface、channel、bitrate,多接口时不自动选择
  • 参数解析优先级:CLI > 工程级配置 > 状态文件 > 默认值;自动扫描结果仅在未提供 CLI 参数时生效
  • 未指定 interface/channel 时自动扫描,唯一候选自动写入配置,多候选需用户选择
  • 成功执行后,确认的参数自动写回 .embeddedskills/config.json
  • 未明确说明用途时不主动发送任何报文
  • --json 输出的持续流使用 JSON Lines,摘要写 stderr 不污染数据流
  • DBC 解码失败不应导致监控中断
  • 找不到帧定义时返回明确错误,不静默吞掉

参考

  • references/common_interfaces.json:常见 USB-CAN 设备信息

Comments

Markdown supported