mirror of
https://gitee.com/ThingsGateway/ThingsGateway.git
synced 2025-10-20 10:50:48 +08:00
更新文档
This commit is contained in:
2248356998 qq.com
34
README.md
34
README.md
@@ -47,6 +47,35 @@
|
||||
#### 补充说明
|
||||
* OPCUAServer插件需联系OPC基金会进行授权
|
||||
|
||||
|
||||
#### 开源协议
|
||||
|
||||
Apache License 2.0为基础，以下为附加协议
|
||||
|
||||
**个人使用须知**
|
||||
|
||||
- 不得将程序集用作违法犯罪活动。
|
||||
- 不得将程序集单独包装售卖，申请专利等。
|
||||
- 不得擦除程序集所有有关作者的信息。
|
||||
|
||||
**二次开发须知**
|
||||
|
||||
- 不得将程序集用作违法犯罪活动。
|
||||
- 不得将程序集单独包装售卖，申请专利等。
|
||||
- 不得擦除程序集所有有关作者的信息。
|
||||
- 二次开发完成后的作品必须附带源作品所有作者信息，包括但不限于作者名、Gitee、Github 地址等。
|
||||
- **完成后**的作品（仅 ThingsGateway 部分）必须将发布时最新源代码提交一份给本作者，QQ 邮箱：2248356998@qq.com。
|
||||
|
||||
**盈利性（商业）用途使用须知**
|
||||
|
||||
- 不得将程序集用作违法犯罪活动。
|
||||
- 不得将程序集单独包装售卖，申请专利等。
|
||||
- **不得擦除程序集所有有关作者的信息，并必须于用户可见界面（如关于）中提名。**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### 支持作者
|
||||
如果对您有帮助，请点击右上角⭐Star关注或扫码捐赠，感谢支持开源！
|
||||
<table>
|
||||
@@ -58,4 +87,7 @@
|
||||
|
||||
#### 联系作者
|
||||
* QQ群：605534569
|
||||
* 邮箱：2248356998@qq.com
|
||||
* 邮箱：2248356998@qq.com
|
||||
|
||||
|
||||
**在使用 ThingsGateway 之前请进行缜密的测试。在使用期间，由本程序集造成或间接造成的所有损失，均自己承担，与本程序集无关。**
|
||||
|
||||
@@ -3,6 +3,11 @@ id: collectdevice
|
||||
title: 采集设备配置说明
|
||||
sidebar_label: 5.1、采集设备
|
||||
---
|
||||
:::tip `配置须知`
|
||||
|
||||
更改采集设备/变量/上传设备/插件等，需要重启线程（网关状态-运行状态-全部重启/单个采集设备重启）
|
||||
|
||||
:::
|
||||
|
||||
### （一）添加/修改采集设备
|
||||
|
||||
@@ -68,3 +73,10 @@ sidebar_label: 5.1、采集设备
|
||||
|
||||
点击上传，等待导入完成，完成后自动退出弹窗，否则提示错误
|
||||
|
||||
|
||||
#### 导出
|
||||
|
||||
|
||||
|
||||
点击导出，等待导出完成，自动下载文件
|
||||
|
||||
|
||||
@@ -3,6 +3,121 @@ id: variable
|
||||
title: 变量配置说明
|
||||
sidebar_label: 5.2、变量
|
||||
---
|
||||
:::tip `配置须知`
|
||||
|
||||
更改采集设备/变量/上传设备/插件等，需要重启线程（网关状态-运行状态-全部重启/单个采集设备重启）
|
||||
|
||||
:::
|
||||
|
||||
### （一）添加/修改变量
|
||||
|
||||
|
||||
<details>
|
||||
<summary>变量基本属性</summary>
|
||||
<div>
|
||||
|
||||
#### 名称
|
||||
当前采集设备名称，全局唯一(采集设备)
|
||||
|
||||
#### 描述
|
||||
当前采集设备描述
|
||||
|
||||
#### 设备
|
||||
当前变量选择的采集设备名称，通过选择器选择对应设备名称设置
|
||||
|
||||
#### 变量地址
|
||||
对于不同的驱动,变量地址配置不相同，查看第六节，找到对应的驱动说明
|
||||
|
||||
#### 执行间隔
|
||||
读取时间间隔
|
||||
|
||||
#### 初始值
|
||||
变量初始值
|
||||
|
||||
#### 读写权限
|
||||
读写/只写/只读
|
||||
|
||||
#### 数据类型
|
||||
对应的数据类型，注意除了特殊驱动，否则不应该选择object
|
||||
|
||||
#### 读取表达式
|
||||
支持多种运算符，原始值的代码为raw，具体可查看 [ExpressionEvaluator WiKi](https://github.com/codingseb/ExpressionEvaluator)
|
||||
下面走个示例：
|
||||
```csharp
|
||||
|
||||
raw*10+3
|
||||
|
||||
//原始值raw为8，输出实时值83
|
||||
|
||||
```
|
||||
#### 写入表达式
|
||||
|
||||
同读取表达式，在写入值时转化
|
||||
|
||||
下面走个示例：
|
||||
```csharp
|
||||
|
||||
raw*10 //读取表达式
|
||||
|
||||
raw/10 //写入表达式
|
||||
|
||||
//PLC原始值为22，读取实时值为220，写入值为230时，会下发23到PLC
|
||||
|
||||
|
||||
```
|
||||
|
||||
#### 特殊方法
|
||||
|
||||
对于不同的驱动,特殊方法配置不相同，查看第六节，找到对应的驱动说明
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>报警属性</summary>
|
||||
<div>
|
||||
|
||||
|
||||
</div>
|
||||
</details>
|
||||
|
||||
|
||||
|
||||
### （二）导入导出采集设备
|
||||
|
||||
#### 导出模板
|
||||
|
||||
|
||||
|
||||
可以看到采集设备的excel模板，填入规则参考第一小节
|
||||
|
||||
|
||||
#### 导入
|
||||
|
||||
|
||||
|
||||
弹窗选择导入的excel文件后，点击下一步进行校验
|
||||
|
||||
|
||||
|
||||
根据红色字体提示，修改对应错误列字段
|
||||
|
||||
全部正常时可进行下一步
|
||||
|
||||
|
||||
|
||||
点击上传，等待导入完成，完成后自动退出弹窗，否则提示错误
|
||||
|
||||
|
||||
#### 导出
|
||||
|
||||
|
||||
|
||||
点击导出，等待导出完成，自动下载文件
|
||||
|
||||
|
||||
|
||||
### （二）变量配置
|
||||
|
||||
|
||||
@@ -3,41 +3,7 @@ id: uploaddevice
|
||||
title: 上传设备配置说明
|
||||
sidebar_label: 5.3、上传设备
|
||||
---
|
||||
|
||||
**上传设备配置与上传设备大致相同**
|
||||
|
||||
### （一）添加/修改上传设备
|
||||
|
||||
|
||||
<details>
|
||||
<summary>设备基本属性</summary>
|
||||
<div>
|
||||
|
||||
#### 名称
|
||||
当前上传设备名称，全局唯一(上传设备)
|
||||
|
||||
#### 描述
|
||||
当前上传设备描述
|
||||
|
||||
#### 设备驱动名称
|
||||
当前上传设备选择的上传驱动插件名称，通过级联选择器选择对应驱动名称设置
|
||||
|
||||
#### 设备使能
|
||||
启动/停用上传设备
|
||||
|
||||
#### 输出日志
|
||||
启动/停用日志输出
|
||||
|
||||
|
||||
</div>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>设备附加属性</summary>
|
||||
<div>
|
||||
|
||||
**对于不同的驱动,网关会将对应的插件配置规则保存在附加属性内**
|
||||
|
||||
**对应的属性描述可以查看输入框占位文本或者浮动Tips尝试理解；或者查看第六节，找到对应的驱动说明**
|
||||
|
||||
</div>
|
||||
</details>
|
||||
|
||||
请查看5.1小节文章
|
||||
|
||||
@@ -3,4 +3,17 @@ id: plugincore
|
||||
title: 插件配置说明
|
||||
sidebar_label: 5.4、插件管理
|
||||
---
|
||||
:::tip `配置须知`
|
||||
|
||||
更改采集设备/变量/上传设备/插件等，需要重启线程（网关状态-运行状态-全部重启/单个采集设备重启）
|
||||
|
||||
:::
|
||||
|
||||
### （一）添加/修改采集设备
|
||||
|
||||
|
||||
|
||||
**选择主程序集（只能一个）
|
||||
**选择附属程序集（可多个）
|
||||
|
||||
点击保存信息
|
||||
|
||||
@@ -4,36 +4,3 @@ title: MqttServer
|
||||
sidebar_label: 7.1、MqttServer
|
||||
---
|
||||
|
||||
|
||||
### （一）变量地址说明
|
||||
|
||||
- 1、基本地址
|
||||
|
||||
| 地址 | 功能码 | 说明 |
|
||||
| ---------------| --------------|--------------------------|
|
||||
| 4xxxxx | 03 | 读取03功能码 |
|
||||
| 3xxxxx | 04 | 读取04功能码 |
|
||||
| 1xxxxx | 02 | 读取02功能码 |
|
||||
| 0xxxxx | 01 | 读取01功能码 |
|
||||
|
||||
- 2、站号(可选)
|
||||
|
||||
当需要指定站号地址时可使用，举例：
|
||||
|
||||
| 地址 | 说明 |
|
||||
| ---------------| --------------------------|
|
||||
| s=2;10001 | 读取02功能码 ,设备地址为2 |
|
||||
| s=11;40001 | 读取03功能码 ,设备地址为11 |
|
||||
|
||||
- 3、写入功能码(可选)
|
||||
|
||||
当需要指定16/15功能码时可使用，举例：
|
||||
|
||||
| 地址 | 说明 |
|
||||
| ---------------| --------------------------|
|
||||
| w=15;10001 | 读取02功能码 ,写入15功能码 |
|
||||
| w=16;40001 | 读取03功能码 ,写入16功能码 |
|
||||
|
||||
### （二）变量其他方法说明
|
||||
|
||||
- 无
|
||||
|
||||
@@ -5,35 +5,3 @@ sidebar_label: 7.2、MqttClient
|
||||
---
|
||||
|
||||
|
||||
### （一）变量地址说明
|
||||
|
||||
- 1、基本地址
|
||||
|
||||
| 地址 | 功能码 | 说明 |
|
||||
| ---------------| --------------|--------------------------|
|
||||
| 4xxxxx | 03 | 读取03功能码 |
|
||||
| 3xxxxx | 04 | 读取04功能码 |
|
||||
| 1xxxxx | 02 | 读取02功能码 |
|
||||
| 0xxxxx | 01 | 读取01功能码 |
|
||||
|
||||
- 2、站号(可选)
|
||||
|
||||
当需要指定站号地址时可使用，举例：
|
||||
|
||||
| 地址 | 说明 |
|
||||
| ---------------| --------------------------|
|
||||
| s=2;10001 | 读取02功能码 ,设备地址为2 |
|
||||
| s=11;40001 | 读取03功能码 ,设备地址为11 |
|
||||
|
||||
- 3、写入功能码(可选)
|
||||
|
||||
当需要指定16/15功能码时可使用，举例：
|
||||
|
||||
| 地址 | 说明 |
|
||||
| ---------------| --------------------------|
|
||||
| w=15;10001 | 读取02功能码 ,写入15功能码 |
|
||||
| w=16;40001 | 读取03功能码 ,写入16功能码 |
|
||||
|
||||
### （二）变量其他方法说明
|
||||
|
||||
- 无
|
||||
|
||||
@@ -5,35 +5,3 @@ sidebar_label: 7.3、ModbusServer
|
||||
---
|
||||
|
||||
|
||||
### （一）变量地址说明
|
||||
|
||||
- 1、基本地址
|
||||
|
||||
| 地址 | 功能码 | 说明 |
|
||||
| ---------------| --------------|--------------------------|
|
||||
| 4xxxxx | 03 | 读取03功能码 |
|
||||
| 3xxxxx | 04 | 读取04功能码 |
|
||||
| 1xxxxx | 02 | 读取02功能码 |
|
||||
| 0xxxxx | 01 | 读取01功能码 |
|
||||
|
||||
- 2、站号(可选)
|
||||
|
||||
当需要指定站号地址时可使用，举例：
|
||||
|
||||
| 地址 | 说明 |
|
||||
| ---------------| --------------------------|
|
||||
| s=2;10001 | 读取02功能码 ,设备地址为2 |
|
||||
| s=11;40001 | 读取03功能码 ,设备地址为11 |
|
||||
|
||||
- 3、写入功能码(可选)
|
||||
|
||||
当需要指定16/15功能码时可使用，举例：
|
||||
|
||||
| 地址 | 说明 |
|
||||
| ---------------| --------------------------|
|
||||
| w=15;10001 | 读取02功能码 ,写入15功能码 |
|
||||
| w=16;40001 | 读取03功能码 ,写入16功能码 |
|
||||
|
||||
### （二）变量其他方法说明
|
||||
|
||||
- 无
|
||||
|
||||
BIN
handbook/static/img/collectdevice7.png
Normal file
BIN
handbook/static/img/collectdevice7.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 70 KiB |
BIN
handbook/static/img/plugincore1.png
Normal file
BIN
handbook/static/img/plugincore1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 108 KiB |
BIN
handbook/static/img/variable1.png
Normal file
BIN
handbook/static/img/variable1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 141 KiB |
Reference in New Issue
Block a user