English · 中文
WaveBench 是一个用 Python 编写的实验室自动测量台,提供 CLI、实验性 TUI、显式 run plan、采集包和离线报告。当前开发线为 0.8.22,最新稳定 tag 为 v0.8.0。版本变化见 更新日志;旧版本原始文档可切换到对应 Git tag 查看。
Warning
部分命令会连接并控制真实仪器。示例会区分离线检查、连接读取和硬件写入;执行写入前,应确认接线和限制值。
先阅读根目录的 README,完成安装和离线检查:
wavebench run template --list
wavebench run template source-scope-sine --output /tmp/wavebench-demo.toml --force
wavebench run check --plan /tmp/wavebench-demo.toml安装 .[tui] 后可运行 wavebench tui --fake 检查 TUI 界面;该模式使用模拟设备。
- run plan 使用指南:模板、
run check、run verify、执行、恢复和报告。 - 数据输出格式:采集包、run、频响和校准产物。
- 示例计划目录:每个计划的硬件副作用和适用范围。
- CLI 形态:命令入口和交互/非交互边界。
- 配置文件格式
- 错误处理和日志策略
- HTTP MCP 只读接口
- 插件接口以当前源码中的 Protocol、models 和对应插件文档为准。
- 可安装仪器插件用户指南:本地目录/wheel 的检查、安装、升级、卸载和恢复。
- 插件开发指南:V2 插件的接入流程和发布检查。
- 可执行仪器插件 API 约定:descriptor、factory、context、capability 和兼容边界。
- 新增仪器驱动指南:从 driver 到 CLI、run plan 和文档的接入路径。
- 声明式 SCPI 插件 · 插件注册表 · 插件市场索引
目录分类见 project/README。本页只负责入口,不把阶段记录当作当前使用说明。
| 类别 | 例子 | 是否连接仪器 |
|---|---|---|
| 离线 | run schema、run template、run check、run report、capture inspect、tui --fake |
不连接仪器;TUI 可能写本地日志 |
| 连接读取 | doctor、idn、status、run verify |
是,仅读取或做预检 |
| 修改状态 | scope fetch/capture/autoscale、source/power setter、output、run plan |
是,可能写入、触发或改变输出 |
run check 不代表 plan 可以安全执行。它只检查 TOML 和字段;真正执行前,还要核对接线、scope coupling、输出状态、保护限值和 restore 条款。
版本历史统一放在根目录的 CHANGELOG.md。厂商手册和 SCPI 摘录由 仪器插件仓库 维护;本仓库只保留 WaveBench 自身的接入边界、接口、配置和安全语义。
中文页面覆盖最完整,英文入口提供对应的安装、离线体验和安全摘要。版本以 pyproject.toml 和 Git tag 为准;CLI 语法以 wavebench --help,run plan 语法以 wavebench run schema 和 run template --list 为准。公开文档中的示例资源必须使用保留地址或占位符,不得写入实验室真实 IP、序列号或串口路径。