first commit
This commit is contained in:
@@ -0,0 +1,229 @@
|
||||
# CpyGateway 打包和部署指南
|
||||
|
||||
## 环境要求
|
||||
|
||||
### 开发环境(打包机器)
|
||||
- Python 3.8 或更高版本
|
||||
- Windows 操作系统
|
||||
- 管理员权限(可选,但建议)
|
||||
|
||||
### 目标环境(运行机器)
|
||||
- Windows 7 或更高版本
|
||||
- 无需安装Python
|
||||
- 无需安装依赖库
|
||||
|
||||
## 打包步骤
|
||||
|
||||
### 方法1:使用批处理脚本(推荐)
|
||||
|
||||
1. 打开命令提示符,进入项目目录:
|
||||
```cmd
|
||||
cd d:\Qt\CpyAlgorithmServerQt\PythonGateway
|
||||
```
|
||||
|
||||
2. 运行打包脚本:
|
||||
```cmd
|
||||
build.bat
|
||||
```
|
||||
|
||||
3. 等待打包完成,生成的exe文件位于 `dist\CpyGateway_v1.0.0.exe`(版本号会根据version.py自动更新)
|
||||
|
||||
### 方法2:手动打包
|
||||
|
||||
1. 安装PyInstaller:
|
||||
```cmd
|
||||
pip install pyinstaller
|
||||
```
|
||||
|
||||
2. 安装项目依赖:
|
||||
```cmd
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
3. 执行打包命令:
|
||||
```cmd
|
||||
pyinstaller CpyGateway.spec
|
||||
```
|
||||
|
||||
4. 打包完成后,exe文件位于 `dist\CpyGateway_v1.0.0.exe`(版本号会根据version.py自动更新)
|
||||
|
||||
## 部署步骤
|
||||
|
||||
### 1. 准备部署包
|
||||
|
||||
将以下文件/文件夹复制到目标电脑:
|
||||
|
||||
```
|
||||
CpyGateway/
|
||||
├── dist/
|
||||
│ └── CpyGateway.exe # 主程序
|
||||
├── config.json # 配置文件(可选,程序会自动生成默认配置)
|
||||
└── README_DEPLOY.md # 部署说明
|
||||
```
|
||||
|
||||
### 2. 修改配置文件(可选)
|
||||
|
||||
根据目标环境修改 `config.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"device_id": "1",
|
||||
"file_root": "D:\\CPY_DTAT",
|
||||
"template_path": "D:\\Python\\CPY_Server\\InStructTemplate.mat",
|
||||
"http": {
|
||||
"host": "0.0.0.0",
|
||||
"port": 5000
|
||||
},
|
||||
"mqtt": {
|
||||
"enable": true,
|
||||
"broker": "123.57.81.127",
|
||||
"port": 1883,
|
||||
"username": "test",
|
||||
"password": "test",
|
||||
"keepalive": 60,
|
||||
"topic_prefix": "v1/cpycal/"
|
||||
},
|
||||
"udp": {
|
||||
"udp_map": {}
|
||||
},
|
||||
"logging": {
|
||||
"level": "INFO",
|
||||
"file": "cpy_server.log"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**重要配置项说明**:
|
||||
- `file_root`: 数据文件存储根目录,确保该目录存在且有写入权限
|
||||
- `template_path`: MATLAB模板文件路径,确保文件存在
|
||||
- `mqtt.broker`: MQTT服务器地址,根据实际环境修改
|
||||
- `http.port`: HTTP服务端口,确保端口未被占用
|
||||
|
||||
### 3. 创建必要的目录
|
||||
|
||||
在目标电脑上创建数据存储目录:
|
||||
|
||||
```cmd
|
||||
mkdir D:\CPY_DTAT
|
||||
```
|
||||
|
||||
如果使用MATLAB计算,还需要:
|
||||
```cmd
|
||||
mkdir D:\Python\CPY_Server
|
||||
```
|
||||
|
||||
并将 `InStructTemplate.mat` 文件复制到该目录。
|
||||
|
||||
### 4. 运行程序
|
||||
|
||||
双击 `CpyGateway.exe` 运行程序,或在命令行中运行:
|
||||
|
||||
```cmd
|
||||
cd dist
|
||||
CpyGateway.exe
|
||||
```
|
||||
|
||||
### 5. 验证运行
|
||||
|
||||
打开浏览器访问:`http://localhost:5000/api/status`
|
||||
|
||||
应该看到类似以下响应:
|
||||
|
||||
```json
|
||||
{
|
||||
"running": "true",
|
||||
"mqtt_connected": true
|
||||
}
|
||||
```
|
||||
|
||||
## 常见问题
|
||||
|
||||
### 1. 防火墙提示
|
||||
|
||||
首次运行时,Windows防火墙可能会提示是否允许程序访问网络,请选择"允许"。
|
||||
|
||||
### 2. 端口被占用
|
||||
|
||||
如果提示端口5000被占用,可以修改 `config.json` 中的端口号:
|
||||
|
||||
```json
|
||||
"http": {
|
||||
"host": "0.0.0.0",
|
||||
"port": 5001 // 修改为其他端口
|
||||
}
|
||||
```
|
||||
|
||||
### 3. 文件权限错误
|
||||
|
||||
确保程序有权限读写 `file_root` 指定的目录。可以右键目录 -> 属性 -> 安全,添加用户权限。
|
||||
|
||||
### 4. MATLAB相关错误
|
||||
|
||||
如果程序需要与MATLAB网关通信:
|
||||
- 确保MATLAB网关程序正在运行
|
||||
- 确保UDP端口配置正确
|
||||
- 检查防火墙是否阻止了UDP通信
|
||||
|
||||
### 5. MQTT连接失败
|
||||
|
||||
检查 `config.json` 中的MQTT配置:
|
||||
- 确认broker地址正确
|
||||
- 确认端口正确(默认1883)
|
||||
- 确认用户名和密码正确
|
||||
- 确认网络可以访问MQTT服务器
|
||||
|
||||
## 日志查看
|
||||
|
||||
程序运行日志保存在 `cpy_server.log` 文件中,位于exe文件同级目录。
|
||||
|
||||
如果遇到问题,请查看日志文件获取详细错误信息。
|
||||
|
||||
## 卸载
|
||||
|
||||
要卸载程序:
|
||||
|
||||
1. 停止程序(如果正在运行)
|
||||
2. 删除程序文件夹
|
||||
3. 删除数据目录(如果需要)
|
||||
|
||||
## 更新
|
||||
|
||||
要更新程序:
|
||||
|
||||
1. 停止旧版本程序
|
||||
2. 备份 `config.json` 文件
|
||||
3. 用新版本的 `CpyGateway.exe` 替换旧版本
|
||||
4. 恢复 `config.json` 文件
|
||||
5. 启动新版本程序
|
||||
|
||||
## 性能优化建议
|
||||
|
||||
1. **关闭控制台窗口**:如果不需要看到控制台输出,可以修改 `CpyGateway.spec` 文件:
|
||||
```python
|
||||
console=False, # 改为False
|
||||
```
|
||||
然后重新打包。
|
||||
|
||||
2. **启用UPX压缩**:spec文件中已启用UPX压缩,可以减小exe文件大小。
|
||||
|
||||
3. **日志级别调整**:在生产环境中,可以将日志级别改为 `WARNING` 或 `ERROR`:
|
||||
```json
|
||||
"logging": {
|
||||
"level": "WARNING",
|
||||
"file": "cpy_server.log"
|
||||
}
|
||||
```
|
||||
|
||||
## 技术支持
|
||||
|
||||
如遇到问题,请:
|
||||
1. 查看日志文件 `cpy_server.log`
|
||||
2. 检查配置文件 `config.json`
|
||||
3. 参考API文档 `API_DOCUMENTATION.md`
|
||||
4. 联系技术支持
|
||||
|
||||
## 版本信息
|
||||
|
||||
- 版本:1.0.0
|
||||
- 打包日期:2026-01-05
|
||||
- Python版本:3.11
|
||||
Reference in New Issue
Block a user