TIA Portal 自动化文档与
合规性报告
只需一条命令即可生成完整的项目报告、FAT/SAT 验收测试文档和项目交付包 -- 无需手动收集数据，无需排版工作。
四种报告类型，一条命令
从快速技术概览到正式签署的合规包
项目报告
TIA Portal 项目的全套技术文档。涵盖硬件配置、网络拓扑、I/O 列表、程序块、变量、UDT、HMI 画面、交叉引用和编译状态。任何项目移交的基准文档。
FAT 报告
工厂验收测试 (Factory Acceptance Test) 报告，将完整的项目报告与自动化测试结果、测试时的项目状态 VCS 快照以及签署页相结合。在发货前的工厂测试结束时生成。
SAT 报告
现场验收测试 (Site Acceptance Test) 报告，结构与 FAT 报告相同，专为现场调试定制。记录系统最终安装和调试后的状态。
项目交付物
一个完整的 ZIP 压缩包，结合了 PDF 报告、XLSX 数据导出、TIA Portal .zap20 归档文件和 VCS 快照。客户或归档系统所需的一切都包含在一个文件中。
项目报告包含哪些内容
自动从运行中的 TIA Portal 项目中提取 -- 无需手动输入数据
- 硬件配置：机架、模块、固件版本、插槽分配
- 网络拓扑：PROFINET 环网、子网、IP 地址、设备连接
- 完整的 I/O 列表：物理地址、符号名称、数据类型、描述
- 程序块清单：包含大小和修改日期的 OB、FB、FC、DB
- 变量表：包含地址、类型和注释的所有 PLC 变量
- 用户自定义类型 (UDTs)：结构定义和成员详细信息
- HMI 画面：画面列表、元素数量和变量绑定概览
- 交叉引用分析：每个变量和块在整个项目中的使用位置
- 编译状态：最后一次构建结果、错误、每个设备的警告
输出格式
每种格式服务于不同的受众和工作流
PDF 报告
供客户、审计员和项目存档使用的人类可读文档。包含结构化章节、表格和封面。可直接打印或进行数字签名。
XLSX 数据导出
供进一步分析、导入 ERP/MES 系统或自定义报告流水线使用的机器可读电子表格。每个章节位于专用工作表中。
ZIP 交付物
完整的项目包：PDF 报告 + XLSX 数据 + .zap20 TIA Portal 归档 + VCS 快照。一个文件即可移交给客户或存储在文档管理系统中。
报告选项
精细调整每份报告包含的内容
设备过滤器
使用 deviceName 选项将报告范围限定在特定的 PLC 或 HMI 设备。适用于每个设备都有独立验收测试的多设备项目。
包含源代码
includeSourceCode 选项会附加所有程序块的完整 SCL 源码。适用于审计、代码审查或合同规定的源码交付要求。
测试结果
includeTestResults 会附加报告生成前运行的 T-IA Connect 自动化 PLC 测试的输出。证明系统在签署时刻通过了其测试套件。
VCS 快照
includeVcsSnapshot 会记录报告生成时的 Git 提交哈希和分支。在报告与测试的确切代码版本之间提供防篡改链接。
报告作为 DevOps 流水线的一部分
在 CI/CD 阶段结束时自动触发报告生成
T-IA Connect 为报告生成提供同步和异步的 REST 接口。CI 流水线可以在 PLCSim 测试运行成功结束后触发 FAT 报告，将 PDF 作为构建产物附加，并通知负责工程师 -- 全程无需人工干预。
建议大型项目使用异步接口：任务进入队列，流水线轮询完成状态，准备就绪后下载生成的报告。对于较小的项目，同步接口直接返回文件。
结合 Git 版本控制和自动化 PLC 测试，自动化报告完成了 DevOps 闭环：每次合并到 main 分支都会产生一个带版本的报告、一个经过测试的系统状态和一个完整的项目交付物。
MCP 工具参考
涵盖所有报告类型和输出格式的六个工具
generate_project_report
生成完整的技术项目报告。选项：deviceName, includeSourceCode, outputPath。返回 PDF 报告文件。
generate_project_deliverable
生成完整的 ZIP 交付包：PDF + XLSX + .zap20 归档 + VCS 快照。项目完成的标准移交包。
fat_generate_report
生成工厂验收测试报告。将项目报告与测试结果、VCS 快照和签署页相结合。
sat_generate_report
生成现场验收测试报告。结构与 FAT 相同，适用于现场调试文档。
异步 REST 接口
POST /api/reports/generate -- 将报告生成任务加入队列并返回任务 ID。轮询 GET /api/reports/job/{id} 获取状态，完成后下载。
同步 REST 接口
POST /api/reports/generate/sync -- 同步生成报告并直接返回文件。适用于小型项目或交互式使用。