跳转到内容

5.5. 数据读写接口

通过数据读写接口可以通过网关读取、写入机台数据,或读取机组数据。数据读写接口分为两类,直接读写与缓存读取。

使用直接读写类接口,网关会立刻与目标机台通讯,获取或写入数据。

GET /api/cnc/readAlarm?machineID=MACHINEID
请求参数 类型 说明
machineID String (必需)目标机台标识,详见 4.1.1. machineID 机台标识

返回示例

{
"alarmMsg": [
"警报 1",
"警报 2"],
"alarmLevel": [
"WRN",
"WRN"]
}
返回参数 类型 说明
alarmMsg String[] (必需)机台当前警报内容。如无警报,返回空 Array。
alarmLevel String[] (必需)警报级别,与警报内容按顺序对应。如无警报,返回空 Array。详见警报级别。
GET /api/cnc/readCNCStatus?machineID=MACHINEID&channel=CHANNEL
请求参数 类型 说明
machineID String (必需)目标机台标识,详见 4.1.1. machineID 机台标识
channel Int32 机台通道号,如不补充则默认为 0,即主通道

返回示例

{
"cncStatus": "MANUAL_EDIT",
"alarmStatus": "ALARM",
"alarmLevel": "WRN",
"channel": 2
}
返回参数 类型 说明
cncStatus String (必需)运行状态,详见运行状态
alarmStatus String (必需)警报状态,详见警报状态
alarmLevel String 警报级别,如有多个警报,取这些警报中的最高级别。如无警报,则不返回。详见警报级别
channel Int32 机台通道号,仅当请求中补充 channel 且不为 0 时出现

由网关后处理得到的修正运行状态 adjustedStatus,累计关机时间 offTime,累计待机时间 waitTime,累计急停时间 emergencyTime,累计自动运行时间 autoRunTime,累计调机时间 manualTime 等,暂不支持 HTTP 协议。需要在开启自动采集任务后,通过接口 5.5.2.1. readTaskData 读取机台任务数据或 5.5.2.2. batchReadTaskData 批量读取机台任务数据,或通过 MODBUS,MQTT,数据库等方式获取。

5.5.1.3. readCNCStatusDetails 读取机台状态详情

Section titled “5.5.1.3. readCNCStatusDetails 读取机台状态详情”

此接口除了读取到与 2.5.1.2. readCNCStatus 读取机台状态相同的通用机台状态数据,还能获取到不通用的原始数据。

GET /api/cnc/readCNCStatusDetails?machineID=MACHINEID&channel=CHANNEL
请求参数 类型 说明
machineID String (必需)目标机台标识,详见 4.1.1. machineID 机台标识
channel Int32 机台通道号,如不补充则默认为 0,即主通道

返回示例

{
"mode": "AUTO_RUN",
"programStatus": "RUNNING",
"emergencyStatus": "NOT_EMG",
"dryRunStatus": "DRY_RUN",
"cncStatus": "AUTO_RUN",
"alarmStatus": "ALARM",
"alarmLevel": "WRN",
"channel": 2
}
返回参数 类型 说明
mode String 运行模式
programStatus String 程序状态
emergencyStatus String 急停状态,见急停状态
dryRunStatus String 试运行状态,见试运行状态
cncStatus String (必需)运行状态,详见运行状态
alarmStatus String (必需)警报状态,详见警报状态
alarmLevel String 警报级别,如有多个警报,取这些警报中的最高级别。如无警报,则不返回。详见警报级别
channel Int32 机台通道号,仅当请求中补充 channel 且不为 0 时出现

由网关后处理得到的修正运行状态 adjustedStatus,累计关机时间 offTime,累计待机时间 waitTime,累计急停时间 emergencyTime,累计自动运行时间 autoRunTime,累计调机时间 manualTime 等,暂不支持 HTTP 协议。需要在开启自动采集任务后,通过接口 5.5.2.1. readTaskData 读取机台任务数据或 5.5.2.2. batchReadTaskData 批量读取机台任务数据,或通过 MODBUS,MQTT,数据库等方式获取。

GET /api/cnc/readCount?machineID=MACHINEID
请求参数 类型 说明
machineID String (必需)目标机台标识,详见 4.1.1. machineID 机台标识

返回示例

{
"count": 1052
}
返回参数 类型 说明
count Int32 (必需)从机台系统获取的加工计数

由网关统计生成的机台累计加工计数 cumulativeCount,与当前监控时间内的加工计数 currentCount 暂不支持 HTTP 协议。需要在开启自动采集任务后,通过接口 5.5.2.1. readTaskData 读取机台任务数据或 5.5.2.2. batchReadTaskData 批量读取机台任务数据,或通过 MODBUS,MQTT,数据库等方式获取。

5.5.1.5. readCurrentToolNumber 读取当前刀号

Section titled “5.5.1.5. readCurrentToolNumber 读取当前刀号”
GET /api/cnc/readCurrentToolNumber?machineID=MACHINEID&channel=CHANNEL
请求参数 类型 说明
machineID String (必需)目标机台标识,详见 4.1.1. machineID 机台标识
channel Int32 机台通道号,如不补充则默认为 0,即主通道

返回示例

{
"toolNumber": "6",
"toolOffsetNum": "6",
"channel": 2
}
返回参数 类型 说明
toolNumber String (必需)当前刀号
toolOffsetNum String 当前刀补号
channel Int32 机台通道号,仅当请求中补充 channel 且不为 0 时出现

5.5.1.6. readEnergyConsum 读取能耗数据

Section titled “5.5.1.6. readEnergyConsum 读取能耗数据”

目前支持部分新款 Brother 兄弟机型和模拟机台。

GET /api/cnc/readEnergyConsum?machineID=MACHINEID
请求参数 类型 说明
machineID String (必需)目标机台标识,详见 4.1.1. machineID 机台标识

返回示例

{
"allServoAxes": 127144.0,
"coolantPump": 41577.0,
"ctsPump": 6507.0,
"chipFlusherPump": 0.0,
"cyclonePump": 0.0,
"system24V": 46270.0,
"ncControl": 10099.0,
"lcdBacklight": 2884.0,
"chipConveyor": 0.0,
"screwConveyor": 0.0,
"autoLubrication": 239.0,
"spindleCoolingFan": 7212.0,
"servoControl": 23806.0
}
返回参数 类型 说明
allServoAxes Double 所有伺服轴能耗[Wh]
coolantPump Double 冷却液泵能耗[Wh]
ctsPump Double CTS 泵能耗[Wh]
chipFlusherPump Double 切屑冲洗器泵能耗[Wh]
cyclonePump Double 离心式过滤器用泵能耗[Wh]
system24V Double 24V 系统能耗[Wh]
ncControl Double NC 控制能耗[Wh]
lcdBacklight Double LCD 背光能耗[Wh]
chipConveyor Double 排屑器能耗[Wh]
screwConveyor Double 螺旋排屑器能耗[Wh]
autoLubrication Double 自动注油设备(或自动注脂设备)能耗[Wh]
spindleCoolingFan Double 主轴冷却风扇能耗[Wh]
servoControl Double 伺服控制能耗[Wh]

仅限激光切割机/焊接机。

GET /api/cnc/readFeed?machineID=MACHINEID&channel=CHANNEL
请求参数 类型 说明
machineID String (必需)目标机台标识,详见 4.1.1. machineID 机台标识
channel Int32 机台通道号,如不补充则默认为 0,即主通道

返回示例

{
"overFeed": 100.0,
"actFeed": 80.0,
"cmdFeed": 80.0,
"overRapid": 100.0,
"channel": 2
}
返回参数 类型 说明
overFeed Float 进给倍率[%]
actFeed Float 实际进给速率
cmdFeed Float 指令进给速率
overRapid Float 快速倍率[%]
channel Int32 机台通道号,仅当请求中补充 channel 且不为 0 时出现

5.5.1.8. readFeedAndSpindle 读取进给转速数据

Section titled “5.5.1.8. readFeedAndSpindle 读取进给转速数据”

仅限 CNC。

GET /api/cnc/readFeedAndSpindle?machineID=MACHINEID&channel=CHANNEL
请求参数 类型 说明
machineID String (必需)目标机台标识,详见 4.1.1. machineID 机台标识
channel Int32 机台通道号,如不补充则默认为 0,即主通道

返回示例

{
"overSpindle": 150.0,
"actSpindle": 3000.0,
"cmdSpindle": 3000.0,
"overFeed": 100.0,
"actFeed": 80.0,
"cmdFeed": 80.0,
"overRapid": 100.0,
"channel": 2
}
返回参数 类型 说明
overSpindle Float 主轴转速倍率[%]
actSpindle Float 实际主轴转速
cmdSpindle Float 指令主轴转速
overFeed Float 进给倍率[%]
actFeed Float 实际进给速率
cmdFeed Float 指令进给速率
overRapid Float 快速倍率[%]
channel Int32 机台通道号,仅当请求中补充 channel 且不为 0 时出现

当有多个主轴时,仅返回第一主轴转速数据。

5.5.1.9. readLaserPower 读取激光功率

Section titled “5.5.1.9. readLaserPower 读取激光功率”

仅限激光切割机/焊接机。

GET /api/cnc/readLaserPower?machineID=MACHINEID
请求参数 类型 说明
machineID String (必需)目标机台标识,详见 4.1.1. machineID 机台标识

返回示例

{
"preset": 100.0,
"actual": 100.0
}
返回参数 类型 说明
preset Float 预设功率[%]
actual Float 实际功率[%]

仅限 CNC。

GET /api/cnc/readLoad?machineID=MACHINEID&channel=CHANNEL
请求参数 类型 说明
machineID String (必需)目标机台标识,详见 4.1.1. machineID 机台标识
channel Int32 机台通道号,如不补充则默认为 0,即主通道

返回示例

{
"spindleLoad": [
100.0,
0.0],
"axialLoad": [
50.1,
12.4,
0.0],
"channel": 2
}
返回参数 类型 说明
spindleLoad Float[] 主轴负载[%]
axialLoad Float[] 伺服轴负载[%]
channel Int32 机台通道号,仅当请求中补充 channel 且不为 0 时出现

当有多个主轴时,主轴负载中数据对应依次为第一主轴,第二主轴。伺服轴负载与 5.5.1.17. readPosition 读取坐标数据返回的 axisName 按顺序一一对应。

目前支持 Fanuc 机器人,ABB 机器人,模拟机台。

GET /api/cnc/readLog?machineID=MACHINEID
请求参数 类型 说明
machineID String (必需)目标机台标识,详见 4.1.1. machineID 机台标识
type String 类型,范围:Alarm(警报日志),Operation(操作日志),Default(默认),默认为 Default。ABB 机器人支持 Operation;Fanuc 机器人支持 Alarm;模拟机台支持所有类型,Default 等同 Operation。可用分号 ; 分隔多个类型(如 type=Alarm;Operation),返回的 msgs 为各类型日志按顺序合并的结果;取值非法时返回错误码 CNCWRAPPER_INVALID_COMMAND。
count Int32 日志数量,获取最新的指定数量的日志内容,默认为 0,即获取所有日志。
path String 日志文件路径。仅 ABB 机器人支持;如指定,则直接返回该文件的全部内容作为 msgs 的唯一元素,并忽略 type 参数。

返回示例(ABB 机器人 Operation)

{
"msgs": [
"{\"SeqNo\":\"79\",\"Type\":\"I \",\"Code\":\"10011\",\"Title\":\" 电机上电(ON) 状态\",\"Date\":\"2025-04-02 T 10:54:40\",\"Description\":\"系统处于电机上电 (ON) 状态。\",\"Args\":[]}",
"{\"SeqNo\":\"78\",\"Type\":\"I \",\"Code\":\"10010\",\"Title\":\" 电机下电 (OFF) 状态\",\"Date\":\"2025-04-02 T 10:54:39\",\"Description\":\"系统处于电机下电 (OFF) 状态。从手动模式切换至自动模式,或者程序执行过程中电机上电 (ON) 电路被打开后,系统就会进入此状态。\",\"Args\":[]}"]
}

返回示例(Fanuc 机器人 Alarm)

{
"msgs": [
"{\"AlarmID\":24,\"AlarmNumber\":212,\"CauseAlarmID\":0,\"CauseAlarmNumber\":0,\"Severity\":38,\"Time\":\"2025-06-26T04:04:46\",\"AlarmMessage\":\"SYST-212 需要应用 DCS 参数\",\"CauseAlarmMessage\":\"\",\"SeverityMessage\":\"STOP.G\"}",
"{\"AlarmID\":0,\"AlarmNumber\":0,\"CauseAlarmID\":0,\"CauseAlarmNumber\":0,\"Severity\":0,\"Time\":\"2025-06-26T04:04:46\",\"AlarmMessage\":\"重置\",\"CauseAlarmMessage\":\"\",\"SeverityMessage\":\"\"}"]
}

返回示例(模拟机台 Operation)

{
"msgs": [
"2025-07-07 13:24:45 Status: WAIT",
"2025-07-07 13:24:45 Machine power on"]
}

返回示例(模拟机台 Alarm)

{
"msgs": [
"2025-07-07 13:25:05 Alarm: 102 ALARM 2, 13:25",
"2025-07-07 13:25:05 Alarm: 101 ALARM 1, 13:25"
]
}
返回参数 类型 说明
msgs String[] (必需)日志内容。注:不同机台的日志内容格式不同。

5.5.1.12. readCNCCommonStatus 读取机台通用状态

Section titled “5.5.1.12. readCNCCommonStatus 读取机台通用状态”

此接口除了读取到与 2.5.1.3. readCNCStatusDetails 读取机台状态详情相同的机台状态数据,还能获取到部分系统特有的状态数据。

GET /api/cnc/readCNCCommonStatus?machineID=MACHINEID&channel=CHANNEL
请求参数 类型 说明
machineID String (必需)目标机台标识,详见 4.1.1. machineID 机台标识
channel Int32 机台通道号,如不补充则默认为 0,即主通道

返回示例

{
"mode": "AUTO_RUN",
"programStatus": "RUNNING",
"emergencyStatus": "NOT_EMG",
"dryRunStatus": "DRY_RUN",
"cncStatus": "AUTO_RUN",
"alarmStatus": "ALARM",
"alarmLevel": "WRN",
"channel": 2
}
返回参数 类型 说明
mode String 运行模式
programStatus String 程序状态
emergencyStatus String 急停状态,见急停状态
dryRunStatus String 试运行状态,见试运行状态
cncStatus String (必需)运行状态,详见运行状态
alarmStatus String (必需)警报状态,详见警报状态
alarmLevel String 警报级别,如有多个警报,取这些警报中的最高级别。如无警报,则不返回。详见警报级别
channel Int32 机台通道号,仅当请求中补充 channel 且不为 0 时出现
mode2 String 手动模式选择(Rexroth 力士乐[OPC UA]为副模式)
readyStatus String 准备就绪状态
alarmOnlyStatus String 警报状态(不含警告)
emergencySetStatus String 急停设定状态
lightColor1 String 第 1 组信号灯颜色
lightStatus1 String 第 1 组信号灯状态
lightColor2 String 第 2 组信号灯颜色
lightStatus2 String 第 2 组信号灯状态
lightColor3 String 第 3 组信号灯颜色
lightStatus3 String 第 3 组信号灯状态
lightColor4 String 第 4 组信号灯颜色
lightStatus4 String 第 4 组信号灯状态

此接口对目标机台执行一次连接初始化(预处理),用于在正式读写数据前建立或校验与机台的通讯。接口不返回数据,仅返回执行结果。

GET /api/cnc/init?machineID=MACHINEID
请求参数 类型 说明
machineID String (必需)目标机台标识,详见 4.1.1. machineID 机台标识

返回示例

{
"errorCode": 0,
"errorMsg": "Success"
}
返回参数 类型 说明
errorCode Int32 (必需)错误代码,0 代表成功。
errorMsg String (必需)错误内容