EPLAN_PROD_Plugin/README.md

53 lines
4.2 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# EPLAN Harness proD 2.9 线材检查插件说明
## 1. 插件功能
- 线材检查插件用于检查线材的端子、颜色、线径等信息是否符合要求。
- 检查后会在界面中显示检查结果,并提供导出功能。
- 提供导出下单表功能,直接按模板导出下单表。
- 右键直接可跳转3D中线的位置。
## 2. 插件使用说明
- 插件使用前需要先安装EPLAN Harness proD 2.9版本。
- ![alt text](eplan_about.png)
- 插件分为单芯线扫描装配、单芯线线材检查与伺服电机选型三部分,其中单芯线线材检查与伺服电机选型为同一版本文件,单芯线扫描装配为单独版本文件。
- 插件数据源均使用共享盘192.168.1.160中excel文件除单芯线扫描装配外其余功能无法在无局域网情况下使用。
## 3. 插件安装
- 参考 \\192.168.1.160\plm系统文档\线材资料检查\线材资料检查插件安装.pptx 文件进行操作
## 4. 开发说明
- 本项目使用C# / .net framework 4.8 / Visual studio 2022 开发,理论上EPLAN ProD 2.9 支持 .net framework 4.8.1 制作插件,后续有需要可进行升级。
- 插件使用多项目结构区分入口项目、界面项目、对接PLM项目
- 入口项目Sinvo.EplanHpD.Plugin存放EPLAN ProD菜单入口类由于EPLAN ProD 插件要求,必须使用继承对应接口的方式编写菜单入口。
- 界面项目Sinvo.EplanHpD.Plugin.WPFUI存放UI与大部分逻辑代码使用WPF编写UI界面使用MVVM设计模式。
- 对接PLM项目Sinvo.EplanHpD.Plugin.DynaClient存放Web Service相关代码使用SOAP方式对接PLM系统并进行封装。目前仅要求登录功能
- Sinvo.EplanHpD.Plugin.Service :跨项目使用的服务类,存放一些公共方法。
- Sinvo.EplanHpD.Plugin.Test 测试用例。
- 项目使用HandyControl作为主要的UI控件库使界面样式更加统一、美观。
- 项目使用MiniExcel作为Excel读写库支持xlsx格式的Excel文件读写不支持xls
- 项目使用PdfiumViewer作为PDF预览支持由于网络问题所以将改第三方库的源码在公司内部Gitlab上进行了同步后续如有更新请上传到公司内部Gitlab上。
- 编译配置说明:
- Debug调试版本包含调试信息编译后可直接在EPLAN ProD中使用。
- Release发布版本包含调试信息编译后可直接在EPLAN ProD中使用。
- Release_EPLAN_20242024版本EPLAN测试用引用DLL不同。
- Release_Scanner扫码装配需求独立版本只包含扫码装配菜单入口。
- Release_WireAndCable线材相关功能独立版本只包含线材相关功能菜单入口。
## 5. 注意事项
- 当EPLAN进行大版本升级时很有可能会修改菜单入口的接口导致插件无法使用。
- 由于公开的API接口并不完善可能会导致一些功能无法实现。
- 现有逻辑均基于`FlexProject`中对象进行数据获取若后续EPLAN ProD 版本中修改了`FlexProject`对象的结构,可能会导致插件无法使用。
- 由于插件加载方式的局限性引用WPF的第三方库时会导致Application对象无法初始化故编写`AppDomainDllLoader`手动处理DLL加载方式后续如更换UI控件库或是增加了DLL引用需注意是否与该加载方式兼容。
- 插件版本使用 Versioning-Controlled-Build 插件进行管理,对多项目版本进行统一管理。
- 代码中存在部分按编译标志判断的代码所以禁止向用户发送DEBUG版本如需要调试请确保编译标志内容已调整或是删除了编译标志控制。
- 目前插件没有日志记录功能,请确保修改代码后测试完整,再进行发布。
- 如果有暂时不需要发布的新功能需要开发,建议建立新分支进行开发,以防开发过程中需要更新导致插件出现问题。
## 6. 发布更新
- 发布更新前需确保插件已在本机测试完成且无明显BUG。
- 发布更新时,推荐同时更新版本号,以便快速定位是否为更新后问题,插件窗口标题会显示版本号。
- 发布更新需要通过邮件方式通知标准化部相关人员、体系开发部门相关领导,参考:
- ![alt text](邮件示例.png)