跳到主要内容

项目管理

项目管理是 Studio 的核心功能,支持工程的创建、编辑和发布。

项目概述

项目概念

项目是一个完整的网关工程,包含:

内容说明
配置数据通道、设备、变量的完整配置
脚本代码数据处理的 C# 脚本
自定义节点规则引擎的自定义处理节点

项目生命周期

创建 → 编辑 → 部署 → 运行 → 维护
阶段说明
创建新建项目,配置基本信息,初始化项目结构
编辑配置通道、设备、变量,编写脚本和节点
部署上传项目到看门狗,按需编译并安装
运行启动网关运行时,数据采集和处理
维护监控状态,更新配置,备份恢复

项目页面

Studio开发运行时

图1:Studio 项目管理页面

页面头部

页面顶部显示系统标题和用户信息:

元素说明
Logo和标题ThingsGateway Studio
用户头像和名称当前登录用户
修改密码点击后弹出修改密码对话框(原密码+新密码+确认密码)
退出登录退出当前登录账号

工具栏

功能说明
停止运行时停止当前正在运行的运行时进程(仅运行中时显示,红色按钮)
新建工程创建新的工程项目
导入工程从ZIP文件导入已有工程
从网关下载从已连接的网关下载工程到本地
网关管理服务打开看门狗配置管理对话框

工程卡片

每个工程以卡片形式展示,包含以下信息:

信息说明
工程图标文件夹图标
运行中标签当前运行中的工程显示绿色"运行中"标签
工程名称工程标识名称,后跟版本号标签(如 v1)
工程ID工程唯一标识
工程描述工程描述信息
更新时间最后修改时间

工程卡片操作

每个工程卡片右侧提供以下操作按钮:

操作说明
编辑修改工程名称和描述
导出导出工程为ZIP文件
上传上传工程到看门狗(部署到网关)
删除删除工程

点击工程卡片本身可进入工程开发页面。

提示

页面左上角还有一个"新建工程"的快捷卡片,点击即可创建新工程。

创建项目

新建项目

Studio新建项目

图2:Studio 新建项目对话框

新建项目对话框包含以下字段:

字段说明校验规则
工程名称工程标识名称必填,最大50字符
工程描述工程描述信息可选,最大200字符

进入工程开发页面

点击项目卡片可进入工程开发页面,进行脚本、节点、通道、设备、变量的配置。

Studio脚本管理

图3:工程开发页面

页面功能

功能说明
通道配置配置通讯通道,如串口、TCP、MQTT 等
设备配置配置设备参数、采集周期、数据类型等
变量配置配置变量地址、数据类型、报警规则等
脚本编辑编写数据处理脚本
节点开发开发自定义规则引擎节点

项目结构

目录结构

MyProject/
├── DB/ # 项目数据库
│ └── ThingsGateway.db # SQLite 数据库文件
├── Script/ # 脚本源码文件
│ └─ *.cs # C# 脚本文件
├── CustomNodes/ # 自定义节点源码
│ └─ *.cs # C# 节点文件
├── ScriptDlls/ # 编译后的脚本DLL
│ └─ *.dll # 脚本程序集
├── CustomNodeDlls/ # 编译后的节点DLL
│ └─ *.dll # 节点程序集
└── project.json # 项目配置文件
注意
  • 数据库文件不要手动修改
  • 脚本文件名即为脚本类名
  • DLL 文件由编译过程自动生成

导入导出项目

导出 ZIP 文件

Studio导出zip文件

图4:导出 ZIP 文件

导出项目为 ZIP 压缩包,便于备份和迁移。

功能说明
导出范围包含数据库、脚本、节点等所有项目文件
用途项目备份、跨机器迁移、版本存档

导入 ZIP 文件

Studio导入zip文件

图5:导入 ZIP 文件

导入已有的项目 ZIP 包,快速恢复项目环境。

功能说明
导入方式选择 ZIP 文件,支持拖拽上传
文件格式仅支持 .zip 格式
适用场景恢复备份、导入他人项目

网关交互

从网关下载

从已连接的网关下载项目配置到本地,便于查看和编辑。

说明

详细操作请参考 看门狗管理

网关管理

管理已连接的网关服务,包括状态监控、项目历史等。

说明

详细操作请参考 看门狗管理

部署项目

上传项目时会按需编译,支持两种发布模式:

正常发布

Studio正常发布上传项目

图6:正常发布上传项目

正常发布需要目标机器安装 .NET Runtime。

AOT 发布

StudioAOT发布上传项目

图7:AOT 发布上传项目

AOT 发布编译为独立可执行文件,无需安装 .NET Runtime。

发布模式对比

模式说明适用场景
正常发布需要 .NET Runtime目标机器已安装 .NET
AOT 发布独立可执行文件目标机器无 .NET 环境,但是部分插件不支持AOT发布
提示

详细操作请参考 看门狗管理

修改密码

点击页面右上角用户下拉菜单中的"修改密码"打开修改密码对话框:

字段说明
原密码当前登录密码
新密码新的登录密码
确认密码再次输入新密码
安全提示

建议定期修改密码以确保系统安全。

相关链接