docs: 加入三份协议文档 + 更新README架构图
This commit is contained in:
wangfq
359
docs/PGLC网络接口协议.md
Normal file
359
docs/PGLC网络接口协议.md
Normal file
@@ -0,0 +1,359 @@
|
||||
# 自动化工装PGLC网络接口协议
|
||||
|
||||
# 1 文档说明
|
||||
|
||||
**PGLC** : Parking Guide Local Center
|
||||
|
||||
# 2 端口说明
|
||||
|
||||
默认端口如下
|
||||
|
||||
```plaintext
|
||||
服务器 设备
|
||||
UDP监听端口 5500 监听4900
|
||||
UDP信息监听端口5505
|
||||
|
||||
TCP监听端口 5550
|
||||
|
||||
```
|
||||
|
||||
# 3 接口指令详情
|
||||
|
||||
## 3.1 发现设备
|
||||
|
||||
用于发现设备，用于主机对当前网络主动发起**广播指令**，设备收到指令后返回相关信息。 主机发送内容
|
||||
|
||||
```plaintext
|
||||
{
|
||||
"Method": "Count_Off", //广播报数
|
||||
|
||||
"Params": {
|
||||
"Ip": "192.168.1.122", //主机、服务中心IP地址
|
||||
"Port": 5500, //主机、服务中心端口号
|
||||
"Device_code": "ABcd" //设备代码 指明设备类别，设备信息里面还有设备代码
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
eg.: `{"Method":"Count_Off","Params":{"Ip":"192.168.1.122","Port":5500,"Device_code":"ABcd"}}`
|
||||
|
||||
终端返回内容
|
||||
|
||||
```plaintext
|
||||
{
|
||||
"Method": "Count_Off"，
|
||||
"Code": 0, //0 表示正常返回
|
||||
"Message": "success", //提示信息
|
||||
"Data"：{
|
||||
"Ip": "192.168.1.188",
|
||||
"Port": 5500,
|
||||
"PortMsg": 5505,
|
||||
"Mac": "",
|
||||
"SubnetMask": "255.255.255.0",
|
||||
"DNS": "www.",
|
||||
"Gateway": "192.168.1.1",
|
||||
"Server_Ip": "192.168.1.222", //本地主机
|
||||
"Iot_Host": "192.168.1.221", //MQTT主机
|
||||
"Iot_Port": 1883,
|
||||
"UserName": "admin", //MQTT用户名
|
||||
"Device_id": "1234",
|
||||
"Device_num": "1234", //只允许字母和数字编码
|
||||
"Device_Type": "1", //1 采集端 区位模式；2 采集端 车位模式；3 发布显示端；
|
||||
//4 采集端、发布端混合 区位模式 ；5 采集端 、发布端混合 车位模式
|
||||
"Type_Code": 1, // 设备类型代码
|
||||
"Area_amount": 16,
|
||||
"Dev_amount": 32,
|
||||
"Dev_mode": 0, //0区位模式， 1 车位模式
|
||||
"Version": "0.1.0"
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
---
|
||||
|
||||
## 3.2 获取通信终端信息
|
||||
|
||||
主机发送内容
|
||||
|
||||
```plaintext
|
||||
{
|
||||
"Method": "Device_Info",
|
||||
"Device": "1234" //hex字符串格式
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
终端返回内容
|
||||
|
||||
```plaintext
|
||||
{
|
||||
"Method": "Device_Info"，
|
||||
"Code": 0, //0 表示正常返回
|
||||
"Message": "success", //提示信息
|
||||
"Data"：{
|
||||
"ip": "192.168.1.188",
|
||||
"Device_id": "1234" ,
|
||||
"NT_Addr": 0,
|
||||
"Hw_Ver": "1.01", //硬件版本号
|
||||
"Sw_Ver": "1.01" //软件版本号
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
---
|
||||
|
||||
## 3.3 配置通信终端的设备信息
|
||||
|
||||
主机发送包括通信终端的iP地址、网关等信息。
|
||||
|
||||
```plaintext
|
||||
{
|
||||
"Method": "Device_Net_Set",
|
||||
|
||||
"Params": {
|
||||
"Device_id": "1234",
|
||||
"Dev_Ip": "192.168.1.188", //终端新IP地址
|
||||
"Gateway_Ip": "192.168.1.1", //网关IP地址
|
||||
"Server_Ip": "192.168.1.222", //主机、中心IP地址
|
||||
"Dev_Port": 4900 //终端新端口号
|
||||
"Gateway_Port": 5500 //主机、服务中心端口号
|
||||
"SubnetMask": "255.255.255.0",
|
||||
"Mac": "",
|
||||
"DNS": ""
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
终端返回内容
|
||||
|
||||
```plaintext
|
||||
{
|
||||
"Method": "Device_Net_Set"，
|
||||
"Code": 0, //0 表示正常返回
|
||||
"Message": "success", //提示信息
|
||||
"Data"：{
|
||||
"Device_id": "1234"
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
---
|
||||
|
||||
## 3.4 心跳包
|
||||
|
||||
终端发送内容
|
||||
|
||||
```plaintext
|
||||
{
|
||||
"Method": "Heartbeat",
|
||||
"Params": {
|
||||
"Device_id": "2345",
|
||||
"Dev_Time": 1591663980 //设备时间
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
主机返回内容
|
||||
|
||||
```plaintext
|
||||
{
|
||||
"Method": "Heartbeat",
|
||||
"Code": 0,
|
||||
"Message": "code不等于0时的出错信息",
|
||||
"Data": {
|
||||
"Device_id": "2345",
|
||||
"SSC_Time": 1591663980 //主机、服务中心时间
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
## 3.5 同步时间
|
||||
|
||||
设备请求内容
|
||||
|
||||
```plaintext
|
||||
{
|
||||
"Method": "TimeStamp",
|
||||
"Params": {
|
||||
"Device_id": "2345",
|
||||
"TimeZone": "Asia/Shanghai"
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
主机返回内容：
|
||||
|
||||
```plaintext
|
||||
{
|
||||
"Method": "TimeStamp",
|
||||
"Code": 0,
|
||||
"Message": "code不等于0有出错信息",
|
||||
"Data": {
|
||||
"Device_id": "2345",
|
||||
"Time_Counter": 123313213 //unix时间戳，精确到秒
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
---
|
||||
|
||||
## 3.6 串口透传指令
|
||||
|
||||
主机发送
|
||||
|
||||
```plaintext
|
||||
{
|
||||
"Method": "SerialNet",
|
||||
"Params": {
|
||||
"Device_id": "1234",
|
||||
"Extra_id": 0,
|
||||
"Bus_Num":0 //总线号，0表示所有，非0表示指定总线上的设备
|
||||
"SerialDat": "7F0102" //发送给串口设备的数据
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
终端返回
|
||||
|
||||
```plaintext
|
||||
{
|
||||
"Method": "SerialNet",
|
||||
"Code": 0,
|
||||
"Message": "code不等于0时的出错信息",
|
||||
"Data": {
|
||||
"Device_id": "1234",
|
||||
"Extra_id":0,
|
||||
"SerialDat": "7F303132" //串口返回数据
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
## 3.7 网络复位指令
|
||||
|
||||
```plaintext
|
||||
{
|
||||
"Method": "Dev_Reset",
|
||||
"Params": {
|
||||
"Device_id": "1234",
|
||||
"Extra_id": 0,
|
||||
"Message":"Null"
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
eg.: `{"Method":"Dev_Reset","Params":{"Device_id":"1234","Extra_id":0,"Message":"Null"}}`
|
||||
|
||||
终端返回
|
||||
|
||||
```plaintext
|
||||
{
|
||||
"Method": "Dev_Reset",
|
||||
"Code": 0,
|
||||
"Message": "code不等于0时的出错信息",
|
||||
"Data": {
|
||||
"Device_id": "1234",
|
||||
"Extra_id":0,
|
||||
"Message": "OK" //
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
---
|
||||
|
||||
## 3.8 联网终端主动上报事件信息
|
||||
|
||||
终端主动上报内容
|
||||
|
||||
```plaintext
|
||||
{
|
||||
"Method": "ACS_NT_Event",
|
||||
"Device_id": "2345",
|
||||
"Params": {
|
||||
"Extra_id": 0, //非0表示有扩展设备
|
||||
"Sub_Addr": 0, //非0表示有子设备
|
||||
"E_Src": 0, //事件来源，0 ，1 NT，2 Extra，3 DPG, 4 Sub dev
|
||||
"Event_ID": 0, //事件ID
|
||||
"Event_Type": 0, //事件类型， 0 info， 1 warning，2 异常
|
||||
"Level": 0, //事件等级，数字越高，等级越高，或越严重
|
||||
"Event_Data": "0101", //事件内容
|
||||
"Event_Time": 0 //事件时间戳
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
主机返回
|
||||
|
||||
```plaintext
|
||||
{
|
||||
"Method": "ACS_NT_Event",
|
||||
"Code": 0,
|
||||
"Message": "code不等于0时的出错信息",
|
||||
"Data": {
|
||||
"Device_id": "2345"
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
---
|
||||
|
||||
## 3.9 设备通用上报子设备传感数据指令
|
||||
|
||||
终端主动上报传感数据指令：
|
||||
|
||||
```plaintext
|
||||
{
|
||||
"Method": "TSReport",
|
||||
"Device_id": "CA12345",
|
||||
|
||||
"Sensor_Dat": {
|
||||
"Bus_Num": 1, // 节点总线号
|
||||
"Sub_Addr": 1, // 子设备如传感器地址
|
||||
"Sub_Type": 7, // 6 超声波探头，7 微波雷达，30 测试工装
|
||||
"Dat_Format": 1, // 格式， 1 十六进制字符串
|
||||
"Sub_Dat": "XXXX" // 十六进制字符串
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
```
|
||||
|
||||
eg: `{"Method":"TSReport","Device_id":"CA12345","Sensor_Dat":{"Bus_Num":1,"Sub_Addr":1,"Sub_Type":7,"Dat_Format":1,"Sub_Dat":"7F8118B20100000F03390D41143D143D1496009A000200030000004AD0"}}`
|
||||
|
||||
主机返回：
|
||||
|
||||
```plaintext
|
||||
{
|
||||
"Method": "TSReport",
|
||||
"Code": 0,
|
||||
"Message": "code不等于0时的出错信息",
|
||||
"Data": {
|
||||
"Device_id": "2345"
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
---
|
||||
|
||||
# 修订说明
|
||||
|
||||
| 版本 | 修订日期 | 说明 | 修订人 |
|
||||
| --- | --- | --- | --- |
|
||||
| | | | |
|
||||
| V1.0 | 2026-05-26 | 初始版本 | wangfq |
|
||||
| | | | |
|
||||
| | | | |
|
||||
| | | | |
|
||||
| | | | |
|
||||
| | | | |
|
||||
| | | | |
|
||||
Reference in New Issue
Block a user