diff --git a/README.md b/README.md index dcf723765f95dfdfa4ccce0ac5eecb1790e51b03..ec966137f5bcce9cd1d98c56f6fe1a82e360068c 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,56 @@ -# AppFrame.AutoPlatform - -#### 介绍 -一个基于领域驱动设计的通用上位机框架平台 - -#### 软件架构 -软件架构说明 - - -#### 安装教程 -1. xxxx -2. xxxx -3. xxxx -#### 使用说明 +README.md文件内容如下: -1. xxxx -2. xxxx -3. xxxx - -#### 参与贡献 - -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request - - -#### 特技 +```markdown +# AppFrame.AutoPlatform -1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +## 项目介绍 +AppFrame.AutoPlatform 是一个自动化平台框架,主要为工业自动化控制应用提供基础架构。该框架支持多种通信协议(Modbus TCP/RTU、Net通信等),并提供对轴控制、气阀控制、数据存储、用户权限管理等工业自动化场景常见功能的抽象封装。 + +## 主要功能模块 +- **AppFrameControls**: 提供自定义WPF控件,如按钮、文本框、切换按钮等。 +- **Application**: 应用逻辑层,包含命令注册、配置管理、元素管理等。 +- **Core**: 核心逻辑层,包括事件总线、异常处理、通信接口抽象等。 +- **Entity**: 数据实体层,定义了权限、用户、角色、配置参数等数据模型。 +- **Infrastructrue**: �::: 通信及硬件控制的具体实现,如Modbus TCP/RTU通信、Net通信、轴控制、气阀控制等。 +- **Common**: 通用工具类,包括反射、文件操作、数据结果封装、正则验证等。 + +## 技术栈 +- WPF +- .NET Framework +- AutoMapper +- DryIoc +- SqlSugar +- Prism +- log4net +- TouchSocket + +## 目录结构 +- **AppFrameControls**: 自定义WPF控件。 +- **Application**: 应用服务,包含命令、配置、元素等业务逻辑。 +- **Core**: 核心模块,包含事件、异常、通信模型等。 +- **Entity**: 数据模型,包含权限、用户、角色、配置参数等。 +- **Infrastructrue**: 工业控制硬件接口、通信接口的具体实现。 +- **Common**: 通用帮助类,如文件操作、验证属性、数据结果封装等。 + +## 项目构建 +本项目使用 Visual Studio 构建,可通过加载 `AppFrame.AutoPlatform.sln` 文件进行构建。 + +## 使用说明 +1. 项目中引用了多个第三方库,如 `HslCommunication`, `SqlSugar`, `AutoMapper`, `Prism` �依赖项需确保正确安装。 +2. 使用 `AppFrameControls` 中的控件,可参考其样式文件进行WPF界面开发。 +3. 通过 `AppFrame.Application` 提供的服务,进行配置管理、命令注册、数据存储等应用层操作。 +4. 硬件通信及控制可通过 `AppFrame.Infrastructrue` 中的通信类实现。 + +## 注意事项 +- 本项目包含多个自定义异常类,用于处理配置错误、通信异常、硬件控制异常等,使用时需注意捕获并处理这些异常。 +- 项目中的通信模块需要正确配置IP地址、端口等参数。 +- 使用 `AppAxisElement` 和 `AppSolenoidElement` 时,需确保硬件参数如轴卡ID、轴ID、气阀IO等配置正确。 + +## 贡献者 +请参考项目的贡献指南,确保遵循代码规范及提交规范。 + +## 版权与许可 +本项目遵循所使用第三方库的许可协议,相关许可文件请参考各库的 `LICENSE` 文件。 +``` \ No newline at end of file