From 0d7302dc8ea4c4e600fe16cdebf60307c684e86b Mon Sep 17 00:00:00 2001 From: Mikayla Fischler Date: Mon, 21 Apr 2025 22:18:09 -0400 Subject: [PATCH 01/14] #604 start of total rework of redstone RTUs for relay functionalitiy --- rtu/config/redstone.lua | 1 + rtu/dev/redstone_rtu.lua | 12 ++++++- rtu/modbus.lua | 46 +++++++++++++-------------- rtu/rtu.lua | 10 ++++-- rtu/startup.lua | 69 +++++++++++++++++++++++++--------------- rtu/threads.lua | 2 ++ 6 files changed, 87 insertions(+), 53 deletions(-) diff --git a/rtu/config/redstone.lua b/rtu/config/redstone.lua index 9826cb1..854d6b9 100644 --- a/rtu/config/redstone.lua +++ b/rtu/config/redstone.lua @@ -18,6 +18,7 @@ local NumberField = require("graphics.elements.form.NumberField") ---@class rtu_rs_definition ---@field unit integer|nil ---@field port IO_PORT +---@field relay string|nil ---@field side side ---@field color color|nil ---@field invert true|nil diff --git a/rtu/dev/redstone_rtu.lua b/rtu/dev/redstone_rtu.lua index 8c3e5ee..366e960 100644 --- a/rtu/dev/redstone_rtu.lua +++ b/rtu/dev/redstone_rtu.lua @@ -11,10 +11,14 @@ local digital_write = rsio.digital_write -- create new redstone device ---@nodiscard +---@param relay? table optional redstone relay to use instead of the computer's redstone interface ---@return rtu_rs_device interface, boolean faulted -function redstone_rtu.new() +function redstone_rtu.new(relay) local unit = rtu.init_unit() + -- physical interface to use + local phy = relay or rs + -- get RTU interface local interface = unit.interface() @@ -30,6 +34,12 @@ function redstone_rtu.new() write_holding_reg = interface.write_holding_reg } + -- change the phy in use (a relay or rs) + ---@param new_phy table + function public.change_phy(new_phy) phy = new_phy end + + -- NOTE: for runtime speed, inversion logic results in extra code here but less code when functions are called + -- link digital input ---@param side string ---@param color integer diff --git a/rtu/modbus.lua b/rtu/modbus.lua index d55907f..ed8ee19 100644 --- a/rtu/modbus.lua +++ b/rtu/modbus.lua @@ -399,43 +399,41 @@ function modbus.new(rtu_dev, use_parallel_read) return public end +-- create an error reply +---@nodiscard +---@param packet modbus_frame MODBUS packet frame +---@param code MODBUS_EXCODE exception code +---@return modbus_packet reply +local function excode_reply(packet, code) + -- reply back with error flag and exception code + local reply = comms.modbus_packet() + local fcode = bit.bor(packet.func_code, MODBUS_FCODE.ERROR_FLAG) + reply.make(packet.txn_id, packet.unit_id, fcode, { code }) + return reply +end + +-- return a SERVER_DEVICE_FAIL error reply +---@nodiscard +---@param packet modbus_frame MODBUS packet frame +---@return modbus_packet reply +function modbus.reply__srv_device_fail(packet) return excode_reply(packet, MODBUS_EXCODE.SERVER_DEVICE_FAIL) end + -- return a SERVER_DEVICE_BUSY error reply ---@nodiscard ---@param packet modbus_frame MODBUS packet frame ---@return modbus_packet reply -function modbus.reply__srv_device_busy(packet) - -- reply back with error flag and exception code - local reply = comms.modbus_packet() - local fcode = bit.bor(packet.func_code, MODBUS_FCODE.ERROR_FLAG) - local data = { MODBUS_EXCODE.SERVER_DEVICE_BUSY } - reply.make(packet.txn_id, packet.unit_id, fcode, data) - return reply -end +function modbus.reply__srv_device_busy(packet) return excode_reply(packet, MODBUS_EXCODE.SERVER_DEVICE_BUSY) end -- return a NEG_ACKNOWLEDGE error reply ---@nodiscard ---@param packet modbus_frame MODBUS packet frame ---@return modbus_packet reply -function modbus.reply__neg_ack(packet) - -- reply back with error flag and exception code - local reply = comms.modbus_packet() - local fcode = bit.bor(packet.func_code, MODBUS_FCODE.ERROR_FLAG) - local data = { MODBUS_EXCODE.NEG_ACKNOWLEDGE } - reply.make(packet.txn_id, packet.unit_id, fcode, data) - return reply -end +function modbus.reply__neg_ack(packet) return excode_reply(packet, MODBUS_EXCODE.NEG_ACKNOWLEDGE) end -- return a GATEWAY_PATH_UNAVAILABLE error reply ---@nodiscard ---@param packet modbus_frame MODBUS packet frame ---@return modbus_packet reply -function modbus.reply__gw_unavailable(packet) - -- reply back with error flag and exception code - local reply = comms.modbus_packet() - local fcode = bit.bor(packet.func_code, MODBUS_FCODE.ERROR_FLAG) - local data = { MODBUS_EXCODE.GATEWAY_PATH_UNAVAILABLE } - reply.make(packet.txn_id, packet.unit_id, fcode, data) - return reply -end +function modbus.reply__gw_unavailable(packet) return excode_reply(packet, MODBUS_EXCODE.GATEWAY_PATH_UNAVAILABLE) end return modbus diff --git a/rtu/rtu.lua b/rtu/rtu.lua index d7a576e..c7401fe 100644 --- a/rtu/rtu.lua +++ b/rtu/rtu.lua @@ -477,9 +477,15 @@ function rtu.comms(version, nic, conn_watchdog) local unit = units[packet.unit_id] local unit_dbg_tag = " (unit " .. packet.unit_id .. ")" - if unit.name == "redstone_io" then + if unit.type == RTU_UNIT_TYPE.REDSTONE then -- immediately execute redstone RTU requests - return_code, reply = unit.modbus_io.handle_packet(packet) + if not unit.device then + reply = modbus.reply__srv_device_fail(packet) + return_code = false + else + return_code, reply = unit.modbus_io.handle_packet(packet) + end + if not return_code then log.warning("requested MODBUS operation failed" .. unit_dbg_tag) end diff --git a/rtu/startup.lua b/rtu/startup.lua index c1413a6..d875ae6 100644 --- a/rtu/startup.lua +++ b/rtu/startup.lua @@ -143,29 +143,23 @@ local function main() -- configure RTU gateway based on settings file definitions local function sys_config() -- redstone interfaces - local rs_rtus = {} ---@type { rtu: rtu_rs_device, capabilities: IO_PORT[] }[] + local rs_rtus = {} ---@type { name: string, rtu: rtu_rs_device, phy: table|nil, banks: IO_PORT[][] }[] -- go through redstone definitions list for entry_idx = 1, #rtu_redstone do local entry = rtu_redstone[entry_idx] + local assignment local for_reactor = entry.unit - local iface_name = util.trinary(entry.color ~= nil, util.c(entry.side, "/", rsio.color_name(entry.color)), entry.side) + local phy = entry.relay or 0 + local iface_name = util.trinary(entry.color ~= nil, util.c(entry.side, "/", rsio.color_name(entry.color)), entry.side) if util.is_int(entry.unit) and entry.unit > 0 and entry.unit < 5 then ---@cast for_reactor integer assignment = "reactor unit " .. entry.unit - if rs_rtus[for_reactor] == nil then - log.debug(util.c("sys_config> allocated redstone RTU for reactor unit ", entry.unit)) - rs_rtus[for_reactor] = { rtu = redstone_rtu.new(), capabilities = {} } - end elseif entry.unit == nil then assignment = "facility" for_reactor = 0 - if rs_rtus[for_reactor] == nil then - log.debug(util.c("sys_config> allocated redstone RTU for the facility")) - rs_rtus[for_reactor] = { rtu = redstone_rtu.new(), capabilities = {} } - end else local message = util.c("sys_config> invalid unit assignment at block index #", entry_idx) println(message) @@ -173,6 +167,31 @@ local function main() return false end + -- create the appropriate RTU if it doesn't exist and check relay name validity + if entry.relay then + if type(entry.relay) ~= "string" then + local message = util.c("sys_config> invalid redstone relay '", entry.relay, '"') + println(message) + log.fatal(message) + return false + elseif not rs_rtus[entry.relay] then + log.debug(util.c("sys_config> allocated relay redstone RTU for interface ", entry.relay)) + + local relay = ppm.get_device(entry.relay) + + if not relay then + log.warning(util.c("sys_config> redstone relay ", entry.relay, " not connected")) + elseif ppm.get_type(entry.relay) ~= "redstone_relay" then + log.warning(util.c("sys_config> redstone relay ", entry.relay, " is not a redstone relay")) + end + + rs_rtus[entry.relay] = { name = entry.relay, rtu = redstone_rtu.new(relay), phy = relay, banks = {} } + end + elseif rs_rtus[0] == nil then + log.debug(util.c("sys_config> allocated local redstone RTU")) + rs_rtus[0] = { name = "redstone_local", rtu = redstone_rtu.new(), phy = rs, banks = {} } + end + -- verify configuration local valid = false if rsio.is_valid_port(entry.port) and rsio.is_valid_side(entry.side) then @@ -180,7 +199,7 @@ local function main() end local rs_rtu = rs_rtus[for_reactor].rtu - local capabilities = rs_rtus[for_reactor].capabilities + local conns = rs_rtus[phy].banks[for_reactor] if not valid then local message = util.c("sys_config> invalid redstone definition at block index #", entry_idx) @@ -192,7 +211,7 @@ local function main() local mode = rsio.get_io_mode(entry.port) if mode == rsio.IO_MODE.DIGITAL_IN then -- can't have duplicate inputs - if util.table_contains(capabilities, entry.port) then + if util.table_contains(conns, entry.port) then local message = util.c("sys_config> skipping duplicate input for port ", rsio.to_string(entry.port), " on side ", iface_name) println(message) log.warning(message) @@ -203,7 +222,7 @@ local function main() rs_rtu.link_do(entry.side, entry.color, entry.invert) elseif mode == rsio.IO_MODE.ANALOG_IN then -- can't have duplicate inputs - if util.table_contains(capabilities, entry.port) then + if util.table_contains(conns, entry.port) then local message = util.c("sys_config> skipping duplicate input for port ", rsio.to_string(entry.port), " on side ", iface_name) println(message) log.warning(message) @@ -219,25 +238,28 @@ local function main() return false end - table.insert(capabilities, entry.port) + table.insert(conns, entry.port) - log.debug(util.c("sys_config> linked redstone ", #capabilities, ": ", rsio.to_string(entry.port), " (", iface_name, ") for ", assignment)) + log.debug(util.c("sys_config> linked redstone ", #conns, ": ", rsio.to_string(entry.port), " (", iface_name, ") for ", assignment)) end end -- create unit entries for redstone RTUs - for for_reactor, def in pairs(rs_rtus) do + for _, def in pairs(rs_rtus) do + local hw_state = util.trinary(def.phy, RTU_HW_STATE.OK, RTU_HW_STATE.OFFLINE) + ---@class rtu_registry_entry local unit = { uid = 0, ---@type integer - name = "redstone_io", ---@type string + name = def.name, ---@type string type = RTU_UNIT_TYPE.REDSTONE, ---@type RTU_UNIT_TYPE index = false, ---@type integer|false - reactor = for_reactor, ---@type integer - device = def.capabilities, ---@type IO_PORT[] use device field for redstone ports + reactor = nil, ---@type nil + device = def.phy, ---@type table|nil + banks = def.banks, ---@type IO_PORT[][] is_multiblock = false, ---@type boolean formed = nil, ---@type boolean|nil - hw_state = RTU_HW_STATE.OK, ---@type RTU_HW_STATE + hw_state = hw_state, ---@type RTU_HW_STATE rtu = def.rtu, ---@type rtu_device|rtu_rs_device modbus_io = modbus.new(def.rtu, false), pkt_queue = nil, ---@type mqueue|nil @@ -246,12 +268,7 @@ local function main() table.insert(units, unit) - local for_message = "facility" - if util.is_int(for_reactor) then - for_message = util.c("reactor unit ", for_reactor) - end - - log.info(util.c("sys_config> initialized RTU unit #", #units, ": redstone_io (redstone) [1] for ", for_message)) + log.info(util.c("sys_config> initialized RTU unit #", #units, ": ", unit.name, " (redstone)")) unit.uid = #units diff --git a/rtu/threads.lua b/rtu/threads.lua index e1d8c6c..7b872bf 100644 --- a/rtu/threads.lua +++ b/rtu/threads.lua @@ -132,6 +132,8 @@ local function handle_unit_mount(smem, println_ts, iface, type, device, unit) unit.rtu, faulted = sna_rtu.new(device) elseif unit.type == RTU_UNIT_TYPE.ENV_DETECTOR then unit.rtu, faulted = envd_rtu.new(device) + elseif unit.type == RTU_UNIT_TYPE.REDSTONE then + unit.rtu.change_phy(device) else unknown = true log.error(util.c("failed to identify reconnected RTU unit type (", unit.name, ")"), true) From 1dc3d82e59336c7824558c7ac7f5b9ba15dca571 Mon Sep 17 00:00:00 2001 From: Mikayla Fischler Date: Sun, 27 Apr 2025 22:40:42 -0400 Subject: [PATCH 02/14] #604 work on redstone RTU rework --- rtu/dev/redstone_rtu.lua | 36 ++++++++++----------- rtu/startup.lua | 68 ++++++++++++++++++++++++++++++++-------- rtu/threads.lua | 2 +- 3 files changed, 74 insertions(+), 32 deletions(-) diff --git a/rtu/dev/redstone_rtu.lua b/rtu/dev/redstone_rtu.lua index 366e960..5772a10 100644 --- a/rtu/dev/redstone_rtu.lua +++ b/rtu/dev/redstone_rtu.lua @@ -36,7 +36,7 @@ function redstone_rtu.new(relay) -- change the phy in use (a relay or rs) ---@param new_phy table - function public.change_phy(new_phy) phy = new_phy end + function public.remount_phy(new_phy) phy = new_phy end -- NOTE: for runtime speed, inversion logic results in extra code here but less code when functions are called @@ -49,15 +49,15 @@ function redstone_rtu.new(relay) if color then if invert then - f_read = function () return digital_read(not rs.testBundledInput(side, color)) end + f_read = function () return digital_read(not phy.testBundledInput(side, color)) end else - f_read = function () return digital_read(rs.testBundledInput(side, color)) end + f_read = function () return digital_read(phy.testBundledInput(side, color)) end end else if invert then - f_read = function () return digital_read(not rs.getInput(side)) end + f_read = function () return digital_read(not phy.getInput(side)) end else - f_read = function () return digital_read(rs.getInput(side)) end + f_read = function () return digital_read(phy.getInput(side)) end end end @@ -74,50 +74,50 @@ function redstone_rtu.new(relay) if color then if invert then - f_read = function () return digital_read(not colors.test(rs.getBundledOutput(side), color)) end + f_read = function () return digital_read(not colors.test(phy.getBundledOutput(side), color)) end f_write = function (level) if level ~= IO_LVL.FLOATING and level ~= IO_LVL.DISCONNECT then - local output = rs.getBundledOutput(side) + local output = phy.getBundledOutput(side) -- inverted conditions if digital_write(level) then output = colors.subtract(output, color) else output = colors.combine(output, color) end - rs.setBundledOutput(side, output) + phy.setBundledOutput(side, output) end end else - f_read = function () return digital_read(colors.test(rs.getBundledOutput(side), color)) end + f_read = function () return digital_read(colors.test(phy.getBundledOutput(side), color)) end f_write = function (level) if level ~= IO_LVL.FLOATING and level ~= IO_LVL.DISCONNECT then - local output = rs.getBundledOutput(side) + local output = phy.getBundledOutput(side) if digital_write(level) then output = colors.combine(output, color) else output = colors.subtract(output, color) end - rs.setBundledOutput(side, output) + phy.setBundledOutput(side, output) end end end else if invert then - f_read = function () return digital_read(not rs.getOutput(side)) end + f_read = function () return digital_read(not phy.getOutput(side)) end f_write = function (level) if level ~= IO_LVL.FLOATING and level ~= IO_LVL.DISCONNECT then - rs.setOutput(side, not digital_write(level)) + phy.setOutput(side, not digital_write(level)) end end else - f_read = function () return digital_read(rs.getOutput(side)) end + f_read = function () return digital_read(phy.getOutput(side)) end f_write = function (level) if level ~= IO_LVL.FLOATING and level ~= IO_LVL.DISCONNECT then - rs.setOutput(side, digital_write(level)) + phy.setOutput(side, digital_write(level)) end end end @@ -129,15 +129,15 @@ function redstone_rtu.new(relay) -- link analog input ---@param side string function public.link_ai(side) - unit.connect_input_reg(function () return rs.getAnalogInput(side) end) + unit.connect_input_reg(function () return phy.getAnalogInput(side) end) end -- link analog output ---@param side string function public.link_ao(side) unit.connect_holding_reg( - function () return rs.getAnalogOutput(side) end, - function (value) rs.setAnalogOutput(side, value) end + function () return phy.getAnalogOutput(side) end, + function (value) phy.setAnalogOutput(side, value) end ) end diff --git a/rtu/startup.lua b/rtu/startup.lua index d875ae6..577a13e 100644 --- a/rtu/startup.lua +++ b/rtu/startup.lua @@ -140,10 +140,19 @@ local function main() local rtu_redstone = config.Redstone local rtu_devices = config.Peripherals + -- get a string representation of a port interface + ---@param entry rtu_rs_definition + ---@return string + local function entry_iface_name(entry) + return util.trinary(entry.color ~= nil, util.c(entry.side, "/", rsio.color_name(entry.color)), entry.side) + end + -- configure RTU gateway based on settings file definitions local function sys_config() -- redstone interfaces - local rs_rtus = {} ---@type { name: string, rtu: rtu_rs_device, phy: table|nil, banks: IO_PORT[][] }[] + local rs_rtus = {} ---@type { name: string, rtu: rtu_rs_device, phy: table|nil, banks: rtu_rs_definition[][] }[] + + local all_conns = {} -- go through redstone definitions list for entry_idx = 1, #rtu_redstone do @@ -152,7 +161,7 @@ local function main() local assignment local for_reactor = entry.unit local phy = entry.relay or 0 - local iface_name = util.trinary(entry.color ~= nil, util.c(entry.side, "/", rsio.color_name(entry.color)), entry.side) + local iface_name = entry_iface_name(entry) if util.is_int(entry.unit) and entry.unit > 0 and entry.unit < 5 then ---@cast for_reactor integer @@ -175,12 +184,12 @@ local function main() log.fatal(message) return false elseif not rs_rtus[entry.relay] then - log.debug(util.c("sys_config> allocated relay redstone RTU for interface ", entry.relay)) + log.debug(util.c("sys_config> allocated relay redstone RTU on interface ", entry.relay)) local relay = ppm.get_device(entry.relay) if not relay then - log.warning(util.c("sys_config> redstone relay ", entry.relay, " not connected")) + log.warning(util.c("sys_config> redstone relay ", entry.relay, " is not connected")) elseif ppm.get_type(entry.relay) ~= "redstone_relay" then log.warning(util.c("sys_config> redstone relay ", entry.relay, " is not a redstone relay")) end @@ -198,8 +207,9 @@ local function main() valid = util.trinary(entry.color == nil, true, rsio.is_color(entry.color)) end - local rs_rtu = rs_rtus[for_reactor].rtu - local conns = rs_rtus[phy].banks[for_reactor] + -- local rs_rtu = rs_rtus[phy].rtu + local bank = rs_rtus[phy].banks[for_reactor] + local conns = all_conns[for_reactor] if not valid then local message = util.c("sys_config> invalid redstone definition at block index #", entry_idx) @@ -216,10 +226,12 @@ local function main() println(message) log.warning(message) else - rs_rtu.link_di(entry.side, entry.color, entry.invert) + table.insert(bank, entry) + -- rs_rtu.link_di(entry.side, entry.color, entry.invert) end elseif mode == rsio.IO_MODE.DIGITAL_OUT then - rs_rtu.link_do(entry.side, entry.color, entry.invert) + table.insert(bank, entry) + -- rs_rtu.link_do(entry.side, entry.color, entry.invert) elseif mode == rsio.IO_MODE.ANALOG_IN then -- can't have duplicate inputs if util.table_contains(conns, entry.port) then @@ -227,25 +239,55 @@ local function main() println(message) log.warning(message) else - rs_rtu.link_ai(entry.side) + table.insert(bank, entry) + -- rs_rtu.link_ai(entry.side) end elseif mode == rsio.IO_MODE.ANALOG_OUT then - rs_rtu.link_ao(entry.side) + table.insert(bank, entry) + -- rs_rtu.link_ao(entry.side) else -- should be unreachable code, we already validated ports - log.error("sys_config> fell through if chain attempting to identify IO mode at block index #" .. entry_idx, true) + log.error("sys_config> failed to identify IO mode at block index #" .. entry_idx, true) println("sys_config> encountered a software error, check logs") return false end table.insert(conns, entry.port) - log.debug(util.c("sys_config> linked redstone ", #conns, ": ", rsio.to_string(entry.port), " (", iface_name, ") for ", assignment)) + log.debug(util.c("sys_config> banked redstone ", #conns, ": ", rsio.to_string(entry.port), " (", iface_name, ") for ", assignment)) end end -- create unit entries for redstone RTUs for _, def in pairs(rs_rtus) do + local rtu_conns = { [0] = {}, {}, {}, {}, {}} + + -- connect the IO banks + for for_reactor = 0, #def.banks do + local bank = def.banks[for_reactor] + local conns = rtu_conns[for_reactor] + + -- link redstone to the RTU + for i = 1, #bank do + local conn = bank[i] + + local mode = rsio.get_io_mode(conn.port) + if mode == rsio.IO_MODE.DIGITAL_IN then + def.rtu.link_di(conn.side, conn.color, conn.invert) + elseif mode == rsio.IO_MODE.DIGITAL_OUT then + def.rtu.link_do(conn.side, conn.color, conn.invert) + elseif mode == rsio.IO_MODE.ANALOG_IN then + def.rtu.link_ai(conn.side) + elseif mode == rsio.IO_MODE.ANALOG_OUT then + def.rtu.link_ao(conn.side) + end + + table.insert(conns, conn.port) + + log.debug(util.c("sys_config> linked redstone ", for_reactor, ".", #conns, ": ", rsio.to_string(conn.port), " (", entry_iface_name(conn), ")")) + end + end + local hw_state = util.trinary(def.phy, RTU_HW_STATE.OK, RTU_HW_STATE.OFFLINE) ---@class rtu_registry_entry @@ -256,7 +298,7 @@ local function main() index = false, ---@type integer|false reactor = nil, ---@type nil device = def.phy, ---@type table|nil - banks = def.banks, ---@type IO_PORT[][] + rs_conns = rtu_conns, ---@type IO_PORT[][]|nil is_multiblock = false, ---@type boolean formed = nil, ---@type boolean|nil hw_state = hw_state, ---@type RTU_HW_STATE diff --git a/rtu/threads.lua b/rtu/threads.lua index 7b872bf..e036a4e 100644 --- a/rtu/threads.lua +++ b/rtu/threads.lua @@ -133,7 +133,7 @@ local function handle_unit_mount(smem, println_ts, iface, type, device, unit) elseif unit.type == RTU_UNIT_TYPE.ENV_DETECTOR then unit.rtu, faulted = envd_rtu.new(device) elseif unit.type == RTU_UNIT_TYPE.REDSTONE then - unit.rtu.change_phy(device) + unit.rtu.remount_phy(device) else unknown = true log.error(util.c("failed to identify reconnected RTU unit type (", unit.name, ")"), true) From be462db50b03c49f06b5c4fd6024131c395203fc Mon Sep 17 00:00:00 2001 From: Mikayla Date: Tue, 29 Apr 2025 01:44:52 +0000 Subject: [PATCH 03/14] #604 new redstone initialization logic --- rtu/dev/redstone_rtu.lua | 18 ++++--- rtu/rtu.lua | 17 ++---- rtu/startup.lua | 112 +++++++++++++++++++++------------------ 3 files changed, 75 insertions(+), 72 deletions(-) diff --git a/rtu/dev/redstone_rtu.lua b/rtu/dev/redstone_rtu.lua index 5772a10..185795e 100644 --- a/rtu/dev/redstone_rtu.lua +++ b/rtu/dev/redstone_rtu.lua @@ -44,8 +44,9 @@ function redstone_rtu.new(relay) ---@param side string ---@param color integer ---@param invert boolean|nil + ---@return integer count count of digital inputs function public.link_di(side, color, invert) - local f_read ---@type function + local f_read ---@type function if color then if invert then @@ -61,16 +62,17 @@ function redstone_rtu.new(relay) end end - unit.connect_di(f_read) + return unit.connect_di(f_read) end -- link digital output ---@param side string ---@param color integer ---@param invert boolean|nil + ---@return integer count count of digital outputs function public.link_do(side, color, invert) - local f_read ---@type function - local f_write ---@type function + local f_read ---@type function + local f_write ---@type function if color then if invert then @@ -123,19 +125,21 @@ function redstone_rtu.new(relay) end end - unit.connect_coil(f_read, f_write) + return unit.connect_coil(f_read, f_write) end -- link analog input ---@param side string + ---@return integer count count of analog inputs function public.link_ai(side) - unit.connect_input_reg(function () return phy.getAnalogInput(side) end) + return unit.connect_input_reg(function () return phy.getAnalogInput(side) end) end -- link analog output ---@param side string + ---@return integer count count of analog outputs function public.link_ao(side) - unit.connect_holding_reg( + return unit.connect_holding_reg( function () return phy.getAnalogOutput(side) end, function (value) phy.setAnalogOutput(side, value) end ) diff --git a/rtu/rtu.lua b/rtu/rtu.lua index c7401fe..473b234 100644 --- a/rtu/rtu.lua +++ b/rtu/rtu.lua @@ -338,13 +338,7 @@ function rtu.comms(version, nic, conn_watchdog) local unit = units[i] if unit.type ~= nil then - local advert = { unit.type, unit.index, unit.reactor } - - if unit.type == RTU_UNIT_TYPE.REDSTONE then - insert(advert, unit.device) - end - - insert(advertisement, advert) + insert(advertisement, { unit.type, unit.index, unit.reactor or -1, unit.rs_conns }) end end @@ -479,12 +473,7 @@ function rtu.comms(version, nic, conn_watchdog) if unit.type == RTU_UNIT_TYPE.REDSTONE then -- immediately execute redstone RTU requests - if not unit.device then - reply = modbus.reply__srv_device_fail(packet) - return_code = false - else - return_code, reply = unit.modbus_io.handle_packet(packet) - end + return_code, reply = unit.modbus_io.handle_packet(packet) if not return_code then log.warning("requested MODBUS operation failed" .. unit_dbg_tag) @@ -502,7 +491,7 @@ function rtu.comms(version, nic, conn_watchdog) unit.pkt_queue.push_packet(packet) end else - log.warning("cannot perform requested MODBUS operation" .. unit_dbg_tag) + log.warning("requested MODBUS operation failed" .. unit_dbg_tag) end end else diff --git a/rtu/startup.lua b/rtu/startup.lua index 577a13e..1b3d4ad 100644 --- a/rtu/startup.lua +++ b/rtu/startup.lua @@ -149,9 +149,9 @@ local function main() -- configure RTU gateway based on settings file definitions local function sys_config() - -- redstone interfaces - local rs_rtus = {} ---@type { name: string, rtu: rtu_rs_device, phy: table|nil, banks: rtu_rs_definition[][] }[] + --#region Redstone Interfaces + local rs_rtus = {} ---@type { name: string, rtu: rtu_rs_device, phy: table, banks: rtu_rs_definition[][] }[] local all_conns = {} -- go through redstone definitions list @@ -161,6 +161,7 @@ local function main() local assignment local for_reactor = entry.unit local phy = entry.relay or 0 + local phy_name = entry.relay or "local" local iface_name = entry_iface_name(entry) if util.is_int(entry.unit) and entry.unit > 0 and entry.unit < 5 then @@ -186,10 +187,12 @@ local function main() elseif not rs_rtus[entry.relay] then log.debug(util.c("sys_config> allocated relay redstone RTU on interface ", entry.relay)) - local relay = ppm.get_device(entry.relay) + local relay = ppm.get_device(entry.relay) if not relay then log.warning(util.c("sys_config> redstone relay ", entry.relay, " is not connected")) + local _, v_device = ppm.mount_virtual() + relay = v_device elseif ppm.get_type(entry.relay) ~= "redstone_relay" then log.warning(util.c("sys_config> redstone relay ", entry.relay, " is not a redstone relay")) end @@ -208,8 +211,8 @@ local function main() end -- local rs_rtu = rs_rtus[phy].rtu - local bank = rs_rtus[phy].banks[for_reactor] - local conns = all_conns[for_reactor] + local bank = rs_rtus[phy].banks[for_reactor] + local conns = all_conns[for_reactor] if not valid then local message = util.c("sys_config> invalid redstone definition at block index #", entry_idx) @@ -222,54 +225,50 @@ local function main() if mode == rsio.IO_MODE.DIGITAL_IN then -- can't have duplicate inputs if util.table_contains(conns, entry.port) then - local message = util.c("sys_config> skipping duplicate input for port ", rsio.to_string(entry.port), " on side ", iface_name) + local message = util.c("sys_config> skipping duplicate input for port ", rsio.to_string(entry.port), " on side ", iface_name, " @ ", phy_name) println(message) log.warning(message) else table.insert(bank, entry) - -- rs_rtu.link_di(entry.side, entry.color, entry.invert) end - elseif mode == rsio.IO_MODE.DIGITAL_OUT then - table.insert(bank, entry) - -- rs_rtu.link_do(entry.side, entry.color, entry.invert) elseif mode == rsio.IO_MODE.ANALOG_IN then -- can't have duplicate inputs if util.table_contains(conns, entry.port) then - local message = util.c("sys_config> skipping duplicate input for port ", rsio.to_string(entry.port), " on side ", iface_name) + local message = util.c("sys_config> skipping duplicate input for port ", rsio.to_string(entry.port), " on side ", iface_name, " @ ", phy_name) println(message) log.warning(message) else table.insert(bank, entry) - -- rs_rtu.link_ai(entry.side) end - elseif mode == rsio.IO_MODE.ANALOG_OUT then + elseif (mode == rsio.IO_MODE.DIGITAL_OUT) or (mode == rsio.IO_MODE.ANALOG_OUT) then table.insert(bank, entry) - -- rs_rtu.link_ao(entry.side) else -- should be unreachable code, we already validated ports - log.error("sys_config> failed to identify IO mode at block index #" .. entry_idx, true) + log.fatal("sys_config> failed to identify IO mode at block index #" .. entry_idx) println("sys_config> encountered a software error, check logs") return false end table.insert(conns, entry.port) - log.debug(util.c("sys_config> banked redstone ", #conns, ": ", rsio.to_string(entry.port), " (", iface_name, ") for ", assignment)) + log.debug(util.c("sys_config> banked redstone ", #conns, ": ", rsio.to_string(entry.port), " (", iface_name, " @ ", phy_name, ") for ", assignment)) end end -- create unit entries for redstone RTUs for _, def in pairs(rs_rtus) do - local rtu_conns = { [0] = {}, {}, {}, {}, {}} + local rtu_conns = { [0] = {}, {}, {}, {}, {} } -- connect the IO banks for for_reactor = 0, #def.banks do - local bank = def.banks[for_reactor] - local conns = rtu_conns[for_reactor] + local bank = def.banks[for_reactor] + local conns = rtu_conns[for_reactor] + local assign = util.trinary(for_reactor > 0, "reactor unit " .. for_reactor, "the facility") -- link redstone to the RTU for i = 1, #bank do - local conn = bank[i] + local conn = bank[i] + local phy_name = conn.relay or "local" local mode = rsio.get_io_mode(conn.port) if mode == rsio.IO_MODE.DIGITAL_IN then @@ -280,44 +279,52 @@ local function main() def.rtu.link_ai(conn.side) elseif mode == rsio.IO_MODE.ANALOG_OUT then def.rtu.link_ao(conn.side) + else + log.fatal(util.c("sys_config> failed to identify IO mode of ", rsio.to_string(conn.port), " (", entry_iface_name(conn), " @ ", phy_name, ") for ", assign)) + println("sys_config> encountered a software error, check logs") + return false end table.insert(conns, conn.port) - log.debug(util.c("sys_config> linked redstone ", for_reactor, ".", #conns, ": ", rsio.to_string(conn.port), " (", entry_iface_name(conn), ")")) + log.debug(util.c("sys_config> linked redstone ", for_reactor, ".", #conns, ": ", rsio.to_string(conn.port), " (", entry_iface_name(conn), ")", " @ ", phy_name, ") for ", assign)) end end local hw_state = util.trinary(def.phy, RTU_HW_STATE.OK, RTU_HW_STATE.OFFLINE) - ---@class rtu_registry_entry + ---@type rtu_registry_entry local unit = { - uid = 0, ---@type integer - name = def.name, ---@type string - type = RTU_UNIT_TYPE.REDSTONE, ---@type RTU_UNIT_TYPE - index = false, ---@type integer|false - reactor = nil, ---@type nil - device = def.phy, ---@type table|nil - rs_conns = rtu_conns, ---@type IO_PORT[][]|nil - is_multiblock = false, ---@type boolean - formed = nil, ---@type boolean|nil - hw_state = hw_state, ---@type RTU_HW_STATE - rtu = def.rtu, ---@type rtu_device|rtu_rs_device + uid = 0, + name = def.name, + type = RTU_UNIT_TYPE.REDSTONE, + index = false, + reactor = nil, + device = def.phy, + rs_conns = rtu_conns, + is_multiblock = false, + formed = nil, + hw_state = hw_state, + rtu = def.rtu, modbus_io = modbus.new(def.rtu, false), - pkt_queue = nil, ---@type mqueue|nil - thread = nil ---@type parallel_thread|nil + pkt_queue = nil, + thread = nil } table.insert(units, unit) - log.info(util.c("sys_config> initialized RTU unit #", #units, ": ", unit.name, " (redstone)")) + local type = util.trinary(def.phy == rs, "redstone", "redstone_relay") + + log.info(util.c("sys_config> initialized RTU unit #", #units, ": ", unit.name, " (", type, ")")) unit.uid = #units databus.tx_unit_hw_status(unit.uid, unit.hw_state) end - -- mounted peripherals + --#endregion + --#region Mounted Peripherals + for i = 1, #rtu_devices do local entry = rtu_devices[i] ---@type rtu_peri_definition local name = entry.name @@ -498,19 +505,20 @@ local function main() ---@class rtu_registry_entry local rtu_unit = { - uid = 0, ---@type integer - name = name, ---@type string - type = rtu_type, ---@type RTU_UNIT_TYPE - index = index or false, ---@type integer|false - reactor = for_reactor, ---@type integer - device = device, ---@type table peripheral reference - is_multiblock = is_multiblock, ---@type boolean - formed = formed, ---@type boolean|nil - hw_state = RTU_HW_STATE.OFFLINE, ---@type RTU_HW_STATE - rtu = rtu_iface, ---@type rtu_device|rtu_rs_device - modbus_io = modbus.new(rtu_iface, true), - pkt_queue = mqueue.new(), ---@type mqueue|nil - thread = nil ---@type parallel_thread|nil + uid = 0, ---@type integer RTU unit ID + name = name, ---@type string unit name + type = rtu_type, ---@type RTU_UNIT_TYPE unit type + index = index or false, ---@type integer|false device index + reactor = for_reactor, ---@type integer|nil unit/facility assignment + device = device, ---@type table peripheral reference + rs_conns = nil, ---@type IO_PORT[][]|nil available redstone connections + is_multiblock = is_multiblock, ---@type boolean if this is for a multiblock peripheral + formed = formed, ---@type boolean|nil if this peripheral is currently formed + hw_state = RTU_HW_STATE.OFFLINE, ---@type RTU_HW_STATE hardware device status + rtu = rtu_iface, ---@type rtu_device|rtu_rs_device RTU hardware interface + modbus_io = modbus.new(rtu_iface, true), ---@type modbus MODBUS interface + pkt_queue = mqueue.new(), ---@type mqueue|nil packet queue + thread = nil ---@type parallel_thread|nil associated RTU thread } rtu_unit.thread = threads.thread__unit_comms(__shared_memory, rtu_unit) @@ -544,6 +552,8 @@ local function main() databus.tx_unit_hw_status(rtu_unit.uid, rtu_unit.hw_state) end + --#endregion + return true end @@ -612,7 +622,7 @@ local function main() -- run threads parallel.waitForAll(table.unpack(_threads)) else - println("configuration failed, exiting...") + println("system initialization failed, exiting...") end renderer.close_ui() From e6f5ab8ef439a5ee61ec79353fcbd9a0e500591c Mon Sep 17 00:00:00 2001 From: Mikayla Date: Tue, 29 Apr 2025 02:38:42 +0000 Subject: [PATCH 04/14] #604 reworked supervisor redstone RTU interface --- scada-common/types.lua | 2 +- supervisor/facility.lua | 2 +- supervisor/session/rsctl.lua | 11 +- supervisor/session/rtu.lua | 43 +++-- supervisor/session/rtu/redstone.lua | 248 +++++++++++++++------------- supervisor/startup.lua | 2 +- supervisor/unit.lua | 2 +- 7 files changed, 176 insertions(+), 134 deletions(-) diff --git a/scada-common/types.lua b/scada-common/types.lua index 0d562a6..bc11516 100644 --- a/scada-common/types.lua +++ b/scada-common/types.lua @@ -125,7 +125,7 @@ function types.new_zero_coordinate() return { x = 0, y = 0, z = 0 } end ---@field type RTU_UNIT_TYPE ---@field index integer|false ---@field reactor integer ----@field rsio IO_PORT[]|nil +---@field rs_conns IO_PORT[][]|nil -- create a new reactor database ---@nodiscard diff --git a/supervisor/facility.lua b/supervisor/facility.lua index f3cf18b..8d22f4b 100644 --- a/supervisor/facility.lua +++ b/supervisor/facility.lua @@ -157,7 +157,7 @@ function facility.new(config) self.rtu_list = { self.redstone, self.induction, self.sps, self.tanks, self.envd } -- init redstone RTU I/O controller - self.io_ctl = rsctl.new(self.redstone) + self.io_ctl = rsctl.new(self.redstone, 0) -- fill blank alarm/tone states for _ = 1, 12 do table.insert(self.test_alarm_states, false) end diff --git a/supervisor/session/rsctl.lua b/supervisor/session/rsctl.lua index b270267..eb84cee 100644 --- a/supervisor/session/rsctl.lua +++ b/supervisor/session/rsctl.lua @@ -9,7 +9,8 @@ local rsctl = {} -- create a new redstone RTU I/O controller ---@nodiscard ---@param redstone_rtus redstone_session[] redstone RTU sessions -function rsctl.new(redstone_rtus) +---@param bank integer I/O bank (unit/facility assignment) to interface with +function rsctl.new(redstone_rtus, bank) ---@class rs_controller local public = {} @@ -18,7 +19,7 @@ function rsctl.new(redstone_rtus) ---@return boolean function public.is_connected(port) for i = 1, #redstone_rtus do - if redstone_rtus[i].get_db().io[port] ~= nil then return true end + if redstone_rtus[i].get_db().io[bank][port] ~= nil then return true end end return false @@ -29,7 +30,7 @@ function rsctl.new(redstone_rtus) ---@param value boolean function public.digital_write(port, value) for i = 1, #redstone_rtus do - local io = redstone_rtus[i].get_db().io[port] + local io = redstone_rtus[i].get_db().io[bank][port] if io ~= nil then io.write(value) end end end @@ -40,7 +41,7 @@ function rsctl.new(redstone_rtus) ---@return boolean|nil function public.digital_read(port) for i = 1, #redstone_rtus do - local io = redstone_rtus[i].get_db().io[port] + local io = redstone_rtus[i].get_db().io[bank][port] if io ~= nil then return io.read() --[[@as boolean|nil]] end end end @@ -52,7 +53,7 @@ function rsctl.new(redstone_rtus) ---@param max number maximum value for scaling 0 to 15 function public.analog_write(port, value, min, max) for i = 1, #redstone_rtus do - local io = redstone_rtus[i].get_db().io[port] + local io = redstone_rtus[i].get_db().io[bank][port] if io ~= nil then io.write(rsio.analog_write(value, min, max)) end end end diff --git a/supervisor/session/rtu.lua b/supervisor/session/rtu.lua index a38559c..4f04a1e 100644 --- a/supervisor/session/rtu.lua +++ b/supervisor/session/rtu.lua @@ -93,7 +93,7 @@ function rtu.new_session(id, s_addr, i_seq_num, in_queue, out_queue, timeout, ad type = self.advert[i][1], index = self.advert[i][2], reactor = self.advert[i][3], - rsio = self.advert[i][4] + rs_conns = self.advert[i][4] } local u_type = unit_advert.type ---@type RTU_UNIT_TYPE|boolean @@ -105,13 +105,19 @@ function rtu.new_session(id, s_addr, i_seq_num, in_queue, out_queue, timeout, ad advert_validator.assert_type_int(unit_advert.reactor) if u_type == RTU_UNIT_TYPE.REDSTONE then - advert_validator.assert_type_table(unit_advert.rsio) + advert_validator.assert_type_table(unit_advert.rs_conns) end if advert_validator.valid() then if util.is_int(unit_advert.index) then advert_validator.assert_min(unit_advert.index, 1) end - advert_validator.assert_min(unit_advert.reactor, 0) - advert_validator.assert_max(unit_advert.reactor, #self.fac_units) + + if unit_advert.reactor == -1 then + advert_validator.assert_type_table(unit_advert.rs_conns) + else + advert_validator.assert_min(unit_advert.reactor, 0) + advert_validator.assert_max(unit_advert.reactor, #self.fac_units) + end + if not advert_validator.valid() then u_type = false end else u_type = false @@ -126,15 +132,32 @@ function rtu.new_session(id, s_addr, i_seq_num, in_queue, out_queue, timeout, ad -- validation fail log.debug(log_tag .. "_handle_advertisement(): advertisement unit validation failure") else - if unit_advert.reactor > 0 then - local target_unit = self.fac_units[unit_advert.reactor] - - -- unit RTUs + if unit_advert.reactor == -1 then + -- redstone RTUs can be used in multiple different assignments if u_type == RTU_UNIT_TYPE.REDSTONE then -- redstone unit = svrs_redstone.new(id, i, unit_advert, self.modbus_q) - if type(unit) ~= "nil" then target_unit.add_redstone(unit) end - elseif u_type == RTU_UNIT_TYPE.BOILER_VALVE then + + -- link this to any subsystems this RTU provides connections for + if type(unit) ~= "nil" then + for assignment, _ in pairs(unit_advert.rs_conns) do + if assignment == 0 then + facility.add_redstone(unit) + elseif assignment > 0 and assignment < #self.fac_units then + self.fac_units[assignment].add_redstone(unit) + else + log.warning(util.c(log_tag, "_handle_advertisement(): unrecognized redstone RTU assignment ", assignment, " ", type_string)) + end + end + end + else + log.warning(util.c(log_tag, "_handle_advertisement(): encountered unsupported multi-assignment RTU type ", type_string)) + end + elseif unit_advert.reactor > 0 then + local target_unit = self.fac_units[unit_advert.reactor] + + -- unit RTUs + if u_type == RTU_UNIT_TYPE.BOILER_VALVE then -- boiler unit = svrs_boilerv.new(id, i, unit_advert, self.modbus_q) if type(unit) ~= "nil" then target_unit.add_boiler(unit) end diff --git a/supervisor/session/rtu/redstone.lua b/supervisor/session/rtu/redstone.lua index ce9d6c4..610432d 100644 --- a/supervisor/session/rtu/redstone.lua +++ b/supervisor/session/rtu/redstone.lua @@ -39,6 +39,9 @@ local PERIODICS = { OUTPUT_SYNC = 200 } +-- create a new block of IO banks (facility, then each unit) +local function new_io_block() return { [0] = {}, {}, {}, {}, {} } end + ---@class dig_phy_entry ---@field phy IO_LVL actual value ---@field req IO_LVL commanded value @@ -74,27 +77,27 @@ function redstone.new(session_id, unit_id, advert, out_queue) next_ir_req = 0, next_hr_sync = 0 }, - ---@class rs_io_list - io_list = { - digital_in = {}, ---@type IO_PORT[] discrete inputs - digital_out = {}, ---@type IO_PORT[] coils - analog_in = {}, ---@type IO_PORT[] input registers - analog_out = {} ---@type IO_PORT[] holding registers + ---@class rs_io_map + io_map = { + digital_in = {}, ---@type { bank: integer, port: IO_PORT }[] discrete inputs + digital_out = {}, ---@type { bank: integer, port: IO_PORT }[] coils + analog_in = {}, ---@type { bank: integer, port: IO_PORT }[] input registers + analog_out = {} ---@type { bank: integer, port: IO_PORT }[] holding registers }, phy_trans = { coils = -1, hold_regs = -1 }, -- last set/read ports (reflecting the current state of the RTU) ---@class rs_io_states phy_io = { - digital_in = {}, ---@type dig_phy_entry[] discrete inputs - digital_out = {}, ---@type dig_phy_entry[] coils - analog_in = {}, ---@type ana_phy_entry[] input registers - analog_out = {} ---@type ana_phy_entry[] holding registers + digital_in = new_io_block(), ---@type dig_phy_entry[][] discrete inputs + digital_out = new_io_block(), ---@type dig_phy_entry[][] coils + analog_in = new_io_block(), ---@type ana_phy_entry[][] input registers + analog_out = new_io_block() ---@type ana_phy_entry[][] holding registers }, ---@class redstone_session_db db = { -- read/write functions for connected I/O - ---@type (rs_db_dig_io|rs_db_ana_io)[] - io = {} + ---@type (rs_db_dig_io|rs_db_ana_io)[][] + io = new_io_block() } } @@ -103,93 +106,91 @@ function redstone.new(session_id, unit_id, advert, out_queue) -- INITIALIZE -- - -- create all ports as disconnected - for _ = 1, #IO_PORT do - table.insert(self.db, IO_LVL.DISCONNECT) - end - -- setup I/O - for i = 1, #advert.rsio do - local port = advert.rsio[i] + for bank = 0, 4 do + for i = 1, #advert.rs_conns[bank] do + local port = advert.rs_conns[bank][i] - if rsio.is_valid_port(port) then - local mode = rsio.get_io_mode(port) + if rsio.is_valid_port(port) then + local mode = rsio.get_io_mode(port) + local io_entry = { bank = bank, port = port } - if mode == IO_MODE.DIGITAL_IN then - self.has_di = true - table.insert(self.io_list.digital_in, port) + if mode == IO_MODE.DIGITAL_IN then + self.has_di = true + table.insert(self.io_map.digital_in, io_entry) - self.phy_io.digital_in[port] = { phy = IO_LVL.FLOATING, req = IO_LVL.FLOATING } + self.phy_io.digital_in[bank][port] = { phy = IO_LVL.FLOATING, req = IO_LVL.FLOATING } - ---@class rs_db_dig_io - local io_f = { - ---@nodiscard - read = function () return rsio.digital_is_active(port, self.phy_io.digital_in[port].phy) end, - write = function () end - } + ---@class rs_db_dig_io + local io_f = { + ---@nodiscard + read = function () return rsio.digital_is_active(port, self.phy_io.digital_in[bank][port].phy) end, + write = function () end + } - self.db.io[port] = io_f - elseif mode == IO_MODE.DIGITAL_OUT then - self.has_do = true - table.insert(self.io_list.digital_out, port) + self.db.io[port] = io_f + elseif mode == IO_MODE.DIGITAL_OUT then + self.has_do = true + table.insert(self.io_map.digital_out, io_entry) - self.phy_io.digital_out[port] = { phy = IO_LVL.FLOATING, req = IO_LVL.FLOATING } + self.phy_io.digital_out[bank][port] = { phy = IO_LVL.FLOATING, req = IO_LVL.FLOATING } - ---@class rs_db_dig_io - local io_f = { - ---@nodiscard - read = function () return rsio.digital_is_active(port, self.phy_io.digital_out[port].phy) end, - ---@param active boolean - write = function (active) - local level = rsio.digital_write_active(port, active) - if level ~= nil then self.phy_io.digital_out[port].req = level end - end - } - - self.db.io[port] = io_f - elseif mode == IO_MODE.ANALOG_IN then - self.has_ai = true - table.insert(self.io_list.analog_in, port) - - self.phy_io.analog_in[port] = { phy = 0, req = 0 } - - ---@class rs_db_ana_io - local io_f = { - ---@nodiscard - ---@return integer - read = function () return self.phy_io.analog_in[port].phy end, - write = function () end - } - - self.db.io[port] = io_f - elseif mode == IO_MODE.ANALOG_OUT then - self.has_ao = true - table.insert(self.io_list.analog_out, port) - - self.phy_io.analog_out[port] = { phy = 0, req = 0 } - - ---@class rs_db_ana_io - local io_f = { - ---@nodiscard - ---@return integer - read = function () return self.phy_io.analog_out[port].phy end, - ---@param value integer - write = function (value) - if value >= 0 and value <= 15 then - self.phy_io.analog_out[port].req = value + ---@class rs_db_dig_io + local io_f = { + ---@nodiscard + read = function () return rsio.digital_is_active(port, self.phy_io.digital_out[bank][port].phy) end, + ---@param active boolean + write = function (active) + local level = rsio.digital_write_active(port, active) + if level ~= nil then self.phy_io.digital_out[bank][port].req = level end end - end - } + } - self.db.io[port] = io_f + self.db.io[port] = io_f + elseif mode == IO_MODE.ANALOG_IN then + self.has_ai = true + table.insert(self.io_map.analog_in, io_entry) + + self.phy_io.analog_in[bank][port] = { phy = 0, req = 0 } + + ---@class rs_db_ana_io + local io_f = { + ---@nodiscard + ---@return integer + read = function () return self.phy_io.analog_in[bank][port].phy end, + write = function () end + } + + self.db.io[port] = io_f + elseif mode == IO_MODE.ANALOG_OUT then + self.has_ao = true + table.insert(self.io_map.analog_out, io_entry) + + self.phy_io.analog_out[bank][port] = { phy = 0, req = 0 } + + ---@class rs_db_ana_io + local io_f = { + ---@nodiscard + ---@return integer + read = function () return self.phy_io.analog_out[bank][port].phy end, + ---@param value integer + write = function (value) + if value >= 0 and value <= 15 then + self.phy_io.analog_out[bank][port].req = value + end + end + } + + self.db.io[port] = io_f + else + -- should be unreachable code, we already validated ports + log.error(util.c(log_tag, "failed to identify advertisement port IO mode (", bank, ":", port, ")"), true) + return nil + end else - -- should be unreachable code, we already validated ports - log.error(util.c(log_tag, "failed to identify advertisement port IO mode (", port, ")"), true) + log.error(util.c(log_tag, "invalid advertisement port (", bank, ":", port, ")"), true) return nil end - else - log.error(util.c(log_tag, "invalid advertisement port (", port, ")"), true) - return nil end end @@ -197,12 +198,12 @@ function redstone.new(session_id, unit_id, advert, out_queue) -- query discrete inputs local function _request_discrete_inputs() - self.session.send_request(TXN_TYPES.DI_READ, MODBUS_FCODE.READ_DISCRETE_INPUTS, { 1, #self.io_list.digital_in }) + self.session.send_request(TXN_TYPES.DI_READ, MODBUS_FCODE.READ_DISCRETE_INPUTS, { 1, #self.io_map.digital_in }) end -- query input registers local function _request_input_registers() - self.session.send_request(TXN_TYPES.INPUT_REG_READ, MODBUS_FCODE.READ_INPUT_REGS, { 1, #self.io_list.analog_in }) + self.session.send_request(TXN_TYPES.INPUT_REG_READ, MODBUS_FCODE.READ_INPUT_REGS, { 1, #self.io_map.analog_in }) end -- write all coil outputs @@ -210,9 +211,9 @@ function redstone.new(session_id, unit_id, advert, out_queue) local params = { 1 } local outputs = self.phy_io.digital_out - for i = 1, #self.io_list.digital_out do - local port = self.io_list.digital_out[i] - table.insert(params, outputs[port].req) + for i = 1, #self.io_map.digital_out do + local entry = self.io_map.digital_out[i] + table.insert(params, outputs[entry.bank][entry.port].req) end self.phy_trans.coils = self.session.send_request(TXN_TYPES.COIL_WRITE, MODBUS_FCODE.WRITE_MUL_COILS, params) @@ -220,7 +221,7 @@ function redstone.new(session_id, unit_id, advert, out_queue) -- read all coil outputs local function _read_coils() - self.session.send_request(TXN_TYPES.COIL_READ, MODBUS_FCODE.READ_COILS, { 1, #self.io_list.digital_out }) + self.session.send_request(TXN_TYPES.COIL_READ, MODBUS_FCODE.READ_COILS, { 1, #self.io_map.digital_out }) end -- write all holding register outputs @@ -228,9 +229,9 @@ function redstone.new(session_id, unit_id, advert, out_queue) local params = { 1 } local outputs = self.phy_io.analog_out - for i = 1, #self.io_list.analog_out do - local port = self.io_list.analog_out[i] - table.insert(params, outputs[port].req) + for i = 1, #self.io_map.analog_out do + local entry = self.io_map.analog_out[i] + table.insert(params, outputs[entry.bank][entry.port].req) end self.phy_trans.hold_regs = self.session.send_request(TXN_TYPES.HOLD_REG_WRITE, MODBUS_FCODE.WRITE_MUL_HOLD_REGS, params) @@ -238,7 +239,7 @@ function redstone.new(session_id, unit_id, advert, out_queue) -- read all holding register outputs local function _read_holding_registers() - self.session.send_request(TXN_TYPES.HOLD_REG_READ, MODBUS_FCODE.READ_MUL_HOLD_REGS, { 1, #self.io_list.analog_out }) + self.session.send_request(TXN_TYPES.HOLD_REG_READ, MODBUS_FCODE.READ_MUL_HOLD_REGS, { 1, #self.io_map.analog_out }) end -- PUBLIC FUNCTIONS -- @@ -259,24 +260,24 @@ function redstone.new(session_id, unit_id, advert, out_queue) end elseif txn_type == TXN_TYPES.DI_READ then -- discrete input read response - if m_pkt.length == #self.io_list.digital_in then + if m_pkt.length == #self.io_map.digital_in then for i = 1, m_pkt.length do - local port = self.io_list.digital_in[i] + local entry = self.io_map.digital_in[i] local value = m_pkt.data[i] - self.phy_io.digital_in[port].phy = value + self.phy_io.digital_in[entry.bank][entry.port].phy = value end else log.debug(log_tag .. "MODBUS transaction reply length mismatch (" .. TXN_TAGS[txn_type] .. ")") end elseif txn_type == TXN_TYPES.INPUT_REG_READ then -- input register read response - if m_pkt.length == #self.io_list.analog_in then + if m_pkt.length == #self.io_map.analog_in then for i = 1, m_pkt.length do - local port = self.io_list.analog_in[i] + local entry = self.io_map.analog_in[i] local value = m_pkt.data[i] - self.phy_io.analog_in[port].phy = value + self.phy_io.analog_in[entry.bank][entry.port].phy = value end else log.debug(log_tag .. "MODBUS transaction reply length mismatch (" .. TXN_TAGS[txn_type] .. ")") @@ -288,15 +289,14 @@ function redstone.new(session_id, unit_id, advert, out_queue) -- update phy I/O table -- if there are multiple outputs for the same port, they will overwrite eachother (but *should* be identical) -- given these are redstone outputs, if one worked they all should have, so no additional verification will be done - if m_pkt.length == #self.io_list.digital_out then + if m_pkt.length == #self.io_map.digital_out then for i = 1, m_pkt.length do - local port = self.io_list.digital_out[i] + local entry = self.io_map.digital_out[i] + local state = self.phy_io.digital_out[entry.bank][entry.port] local value = m_pkt.data[i] - self.phy_io.digital_out[port].phy = value - if self.phy_io.digital_out[port].req == IO_LVL.FLOATING then - self.phy_io.digital_out[port].req = value - end + state.phy = value + if state.req == IO_LVL.FLOATING then state.req = value end end self.phy_trans.coils = TXN_READY @@ -310,12 +310,12 @@ function redstone.new(session_id, unit_id, advert, out_queue) -- update phy I/O table -- if there are multiple outputs for the same port, they will overwrite eachother (but *should* be identical) -- given these are redstone outputs, if one worked they all should have, so no additional verification will be done - if m_pkt.length == #self.io_list.analog_out then + if m_pkt.length == #self.io_map.analog_out then for i = 1, m_pkt.length do - local port = self.io_list.analog_out[i] + local entry = self.io_map.analog_out[i] local value = m_pkt.data[i] - self.phy_io.analog_out[port].phy = value + self.phy_io.analog_out[entry.bank][entry.port].phy = value end else log.debug(log_tag .. "MODBUS transaction reply length mismatch (" .. TXN_TAGS[txn_type] .. ")") @@ -343,8 +343,17 @@ function redstone.new(session_id, unit_id, advert, out_queue) -- sync digital outputs if self.has_do then if (self.periodics.next_cl_sync <= time_now) and (self.phy_trans.coils == TXN_READY) then - for _, entry in pairs(self.phy_io.digital_out) do - if entry.phy ~= entry.req then + for bank = 0, 4 do + local changed = false + + for _, entry in pairs(self.phy_io.digital_out[bank]) do + if entry.phy ~= entry.req then + changed = true + break + end + end + + if changed then _write_coils() break end @@ -365,8 +374,17 @@ function redstone.new(session_id, unit_id, advert, out_queue) -- sync analog outputs if self.has_ao then if (self.periodics.next_hr_sync <= time_now) and (self.phy_trans.hold_regs == TXN_READY) then - for _, entry in pairs(self.phy_io.analog_out) do - if entry.phy ~= entry.req then + for bank = 0, 4 do + local changed = false + + for _, entry in pairs(self.phy_io.analog_out[bank]) do + if entry.phy ~= entry.req then + changed = true + break + end + end + + if changed then _write_holding_registers() break end diff --git a/supervisor/startup.lua b/supervisor/startup.lua index d1ee16d..4a88018 100644 --- a/supervisor/startup.lua +++ b/supervisor/startup.lua @@ -23,7 +23,7 @@ local supervisor = require("supervisor.supervisor") local svsessions = require("supervisor.session.svsessions") -local SUPERVISOR_VERSION = "v1.6.8" +local SUPERVISOR_VERSION = "v1.7.0" local println = util.println local println_ts = util.println_ts diff --git a/supervisor/unit.lua b/supervisor/unit.lua index b448a95..9e22824 100644 --- a/supervisor/unit.lua +++ b/supervisor/unit.lua @@ -258,7 +258,7 @@ function unit.new(reactor_id, num_boilers, num_turbines, ext_idle, aux_coolant) self.rtu_list = { self.redstone, self.boilers, self.turbines, self.tanks, self.snas, self.envd } -- init redstone RTU I/O controller - self.io_ctl = rsctl.new(self.redstone) + self.io_ctl = rsctl.new(self.redstone, reactor_id) -- init boiler table fields for _ = 1, num_boilers do From 41b6a558d512d359b6e0cd8b5e1f7513b1fec487 Mon Sep 17 00:00:00 2001 From: Mikayla Date: Mon, 5 May 2025 16:35:44 +0000 Subject: [PATCH 05/14] init RTU gateway UI after checking for modem to prevent that failure making a UI mess --- rtu/startup.lua | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/rtu/startup.lua b/rtu/startup.lua index 1b3d4ad..8ac188c 100644 --- a/rtu/startup.lua +++ b/rtu/startup.lua @@ -564,17 +564,6 @@ local function main() log.debug("boot> running sys_config()") if sys_config() then - -- start UI - local message - rtu_state.fp_ok, message = renderer.try_start_ui(units, config.FrontPanelTheme, config.ColorMode) - - if not rtu_state.fp_ok then - println_ts(util.c("UI error: ", message)) - println("startup> running without front panel") - log.error(util.c("front panel GUI render failed with error ", message)) - log.info("startup> running in headless mode without front panel") - end - -- check modem if smem_dev.modem == nil then println("startup> wireless modem not found") @@ -596,6 +585,17 @@ local function main() databus.tx_hw_spkr_count(#smem_dev.sounders) + -- start UI + local message + rtu_state.fp_ok, message = renderer.try_start_ui(units, config.FrontPanelTheme, config.ColorMode) + + if not rtu_state.fp_ok then + println_ts(util.c("UI error: ", message)) + println("startup> running without front panel") + log.error(util.c("front panel GUI render failed with error ", message)) + log.info("startup> running in headless mode without front panel") + end + -- start connection watchdog smem_sys.conn_watchdog = util.new_watchdog(config.ConnTimeout) log.debug("startup> conn watchdog started") From e3dbda3c54372df485668cc9cea789baf11efdb5 Mon Sep 17 00:00:00 2001 From: Mikayla Fischler Date: Wed, 7 May 2025 10:42:52 -0400 Subject: [PATCH 06/14] fixed logic for duplicate input detection --- rtu/config/redstone.lua | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/rtu/config/redstone.lua b/rtu/config/redstone.lua index 854d6b9..d8fd56f 100644 --- a/rtu/config/redstone.lua +++ b/rtu/config/redstone.lua @@ -185,15 +185,6 @@ function redstone.create(tool_ctl, main_pane, cfg_sys, rs_cfg, style) local rs_ports = ListBox{parent=rs_c_2,x=1,y=3,height=10,width=49,scroll_height=200,fg_bg=bw_fg_bg,nav_fg_bg=g_lg_fg_bg,nav_active=cpair(colors.black,colors.gray)} local function new_rs(port) - if (rsio.get_io_dir(port) == rsio.IO_DIR.IN) then - for i = 1, #tmp_cfg.Redstone do - if tmp_cfg.Redstone[i].port == port then - rs_pane.set_value(6) - return - end - end - end - self.rs_cfg_editing = false local text @@ -316,8 +307,16 @@ function redstone.create(tool_ctl, main_pane, cfg_sys, rs_cfg, style) port = port, side = side_options_map[side.get_value()], color = tri(self.rs_cfg_bundled.get_value() and rsio.is_digital(port), color_options_map[self.rs_cfg_color.get_value()], nil), - invert = self.rs_cfg_inverted.get_value() or nil - } + + -- check for duplicate inputs for this unit/facility + if (rsio.get_io_dir(port) == rsio.IO_DIR.IN) then + for i = 1, #tmp_cfg.Redstone do + if tmp_cfg.Redstone[i].port == port and tmp_cfg.Redstone[i].unit == def.unit then + rs_pane.set_value(7) + return + end + end + end if self.rs_cfg_editing == false then table.insert(tmp_cfg.Redstone, def) From 12ead136a30646f031103f20ee8462f30dfc2f8a Mon Sep 17 00:00:00 2001 From: Mikayla Fischler Date: Wed, 7 May 2025 11:27:53 -0400 Subject: [PATCH 07/14] #604 configuration of redstone RTUs --- rtu/config/redstone.lua | 285 ++++++++++++++++++++-------- rtu/configure.lua | 6 +- supervisor/session/rtu/redstone.lua | 1 - 3 files changed, 208 insertions(+), 84 deletions(-) diff --git a/rtu/config/redstone.lua b/rtu/config/redstone.lua index d8fd56f..53fd9fd 100644 --- a/rtu/config/redstone.lua +++ b/rtu/config/redstone.lua @@ -1,4 +1,5 @@ local constants = require("scada-common.constants") +local ppm = require("scada-common.ppm") local rsio = require("scada-common.rsio") local util = require("scada-common.util") @@ -34,6 +35,7 @@ local IO_MODE = rsio.IO_MODE local LEFT = core.ALIGN.LEFT local self = { + rs_cfg_phy = false, ---@type string|nil|false rs_cfg_port = 1, ---@type IO_PORT rs_cfg_editing = false, ---@type integer|false @@ -109,6 +111,23 @@ local function color_to_idx(color) end end +-- select the subset of redstone entries assigned to the given phy +---@param cfg rtu_rs_definition[] the full redstone entry list +---@param phy string|nil which phy to get redstone entries for +---@param invert boolean? true to get all except this phy +---@return rtu_rs_definition[] +local function redstone_subset(cfg, phy, invert) + local subset = {} + + for i = 1, #cfg do + if ((not invert) and cfg[i].relay == phy) or (invert and cfg[i].relay ~= phy) then + table.insert(subset, cfg[i]) + end + end + + return subset +end + local redstone = {} -- validate a redstone entry @@ -138,21 +157,89 @@ function redstone.create(tool_ctl, main_pane, cfg_sys, rs_cfg, style) --#region Redstone - local rs_c_1 = Div{parent=rs_cfg,x=2,y=4,width=49} - local rs_c_2 = Div{parent=rs_cfg,x=2,y=4,width=49} - local rs_c_3 = Div{parent=rs_cfg,x=2,y=4,width=49} - local rs_c_4 = Div{parent=rs_cfg,x=2,y=4,width=49} - local rs_c_5 = Div{parent=rs_cfg,x=2,y=4,width=49} - local rs_c_6 = Div{parent=rs_cfg,x=2,y=4,width=49} - local rs_c_7 = Div{parent=rs_cfg,x=2,y=4,width=49} - local rs_c_8 = Div{parent=rs_cfg,x=2,y=4,width=49} + local rs_c_1 = Div{parent=rs_cfg,x=2,y=4,width=49} + local rs_c_2 = Div{parent=rs_cfg,x=2,y=4,width=49} + local rs_c_3 = Div{parent=rs_cfg,x=2,y=4,width=49} + local rs_c_4 = Div{parent=rs_cfg,x=2,y=4,width=49} + local rs_c_5 = Div{parent=rs_cfg,x=2,y=4,width=49} + local rs_c_6 = Div{parent=rs_cfg,x=2,y=4,width=49} + local rs_c_7 = Div{parent=rs_cfg,x=2,y=4,width=49} + local rs_c_8 = Div{parent=rs_cfg,x=2,y=4,width=49} + local rs_c_9 = Div{parent=rs_cfg,x=2,y=4,width=49} + local rs_c_10 = Div{parent=rs_cfg,x=2,y=4,width=49} - local rs_pane = MultiPane{parent=rs_cfg,x=1,y=4,panes={rs_c_1,rs_c_2,rs_c_3,rs_c_4,rs_c_5,rs_c_6,rs_c_7,rs_c_8}} + local rs_pane = MultiPane{parent=rs_cfg,x=1,y=4,panes={rs_c_1,rs_c_2,rs_c_3,rs_c_4,rs_c_5,rs_c_6,rs_c_7,rs_c_8,rs_c_9,rs_c_10}} - TextBox{parent=rs_cfg,x=1,y=2,text=" Redstone Connections",fg_bg=cpair(colors.black,colors.red)} + local header = TextBox{parent=rs_cfg,x=1,y=2,text=" Redstone Connections",fg_bg=cpair(colors.black,colors.red)} - TextBox{parent=rs_c_1,x=1,y=1,text=" port side/color unit/facility",fg_bg=g_lg_fg_bg} - local rs_list = ListBox{parent=rs_c_1,x=1,y=2,height=11,width=49,scroll_height=200,fg_bg=bw_fg_bg,nav_fg_bg=g_lg_fg_bg,nav_active=cpair(colors.black,colors.gray)} + --#region Interface Selection + + TextBox{parent=rs_c_1,x=1,y=1,text="Configure this computer or a redstone relay."} + local iface_list = ListBox{parent=rs_c_1,x=1,y=3,height=10,width=49,scroll_height=1000,fg_bg=bw_fg_bg,nav_fg_bg=g_lg_fg_bg,nav_active=cpair(colors.black,colors.gray)} + + -- update relay interface list + function tool_ctl.update_relay_list() + local mounts = ppm.list_mounts() + + iface_list.remove_all() + + -- assemble list of configured relays + local relays = {} + for i = 1, #tmp_cfg.Redstone do + local def = tmp_cfg.Redstone[i] + if def.relay and not util.table_contains(relays, def.relay) then + table.insert(relays, def.relay) + end + end + + -- add unconfigured connected relays + for name, entry in pairs(mounts) do + if entry.type == "redstone_relay" and not util.table_contains(relays, name) then + table.insert(relays, name) + end + end + + local function config_rs(name) + header.set_value(" Redstone Connections (" .. name .. ")") + + self.rs_cfg_phy = tri(name == "local", nil, name) + + tool_ctl.gen_rs_summary() + rs_pane.set_value(2) + end + + local line = Div{parent=iface_list,height=2,fg_bg=cpair(colors.black,colors.white)} + TextBox{parent=line,x=1,y=1,text="@ local",fg_bg=cpair(colors.black,colors.white)} + TextBox{parent=line,x=3,y=2,text="This Computer",fg_bg=cpair(colors.gray,colors.white)} + local count = #redstone_subset(ini_cfg.Redstone, nil) + TextBox{parent=line,x=33,y=2,width=16,alignment=core.ALIGN.RIGHT,text=count.." connections",fg_bg=cpair(colors.gray,colors.white)} + + PushButton{parent=line,x=41,y=1,min_width=8,height=1,text="CONFIG",callback=function()config_rs("local")end,fg_bg=cpair(colors.black,colors.blue),active_fg_bg=btn_act_fg_bg,dis_fg_bg=btn_dis_fg_bg} + + for i = 1, #relays do + local name = relays[i] + + line = Div{parent=iface_list,height=2,fg_bg=cpair(colors.black,colors.white)} + TextBox{parent=line,x=1,y=1,text="@ "..name,fg_bg=cpair(colors.black,colors.white)} + TextBox{parent=line,x=3,y=2,text="Redstone Relay",fg_bg=cpair(colors.gray,colors.white)} + TextBox{parent=line,x=18,y=2,text=tri(mounts[name],"ONLINE","OFFLINE"),fg_bg=cpair(tri(mounts[name],colors.green,colors.red),colors.white)} + count = #redstone_subset(ini_cfg.Redstone, name) + TextBox{parent=line,x=33,y=2,width=16,alignment=core.ALIGN.RIGHT,text=count.." connections",fg_bg=cpair(colors.gray,colors.white)} + + PushButton{parent=line,x=41,y=1,min_width=8,height=1,text="CONFIG",callback=function()config_rs(name)end,fg_bg=cpair(colors.black,colors.yellow),active_fg_bg=btn_act_fg_bg,dis_fg_bg=btn_dis_fg_bg} + end + end + + tool_ctl.update_relay_list() + + PushButton{parent=rs_c_1,x=1,y=14,text="\x1b Back",callback=function()main_pane.set_value(1)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg} + PushButton{parent=rs_c_1,x=27,y=14,min_width=23,text="I don't see my relay!",callback=function()rs_pane.set_value(10)end,fg_bg=cpair(colors.black,colors.yellow),active_fg_bg=btn_act_fg_bg} + + --#endregion + --#region Configuration List + + TextBox{parent=rs_c_2,x=1,y=1,text=" port side/color unit/facility",fg_bg=g_lg_fg_bg} + local rs_list = ListBox{parent=rs_c_2,x=1,y=2,height=11,width=49,scroll_height=200,fg_bg=bw_fg_bg,nav_fg_bg=g_lg_fg_bg,nav_active=cpair(colors.black,colors.gray)} local function rs_revert() tmp_cfg.Redstone = tool_ctl.deep_copy_rs(ini_cfg.Redstone) @@ -160,29 +247,44 @@ function redstone.create(tool_ctl, main_pane, cfg_sys, rs_cfg, style) end local function rs_apply() - settings.set("Redstone", tmp_cfg.Redstone) + -- add the changed data to the existing saved data + local new_data = redstone_subset(tmp_cfg.Redstone, self.rs_cfg_phy) + local new_save = redstone_subset(ini_cfg.Redstone, self.rs_cfg_phy, true) + for i = 1, #new_data do table.insert(new_save, new_data[i]) end + + settings.set("Redstone", new_save) if settings.save("/rtu.settings") then load_settings(settings_cfg, true) load_settings(ini_cfg) - rs_pane.set_value(4) + rs_pane.set_value(5) -- for return to list from saved screen + -- this will delete unsaved changes for other phy's, which is acceptable tmp_cfg.Redstone = tool_ctl.deep_copy_rs(ini_cfg.Redstone) tool_ctl.gen_rs_summary() else - rs_pane.set_value(5) + rs_pane.set_value(6) end end - PushButton{parent=rs_c_1,x=1,y=14,text="\x1b Back",callback=function()main_pane.set_value(1)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg} - local rs_revert_btn = PushButton{parent=rs_c_1,x=8,y=14,min_width=16,text="Revert Changes",callback=rs_revert,fg_bg=cpair(colors.black,colors.yellow),active_fg_bg=btn_act_fg_bg,dis_fg_bg=btn_dis_fg_bg} - PushButton{parent=rs_c_1,x=35,y=14,min_width=7,text="New +",callback=function()rs_pane.set_value(2)end,fg_bg=cpair(colors.black,colors.blue),active_fg_bg=btn_act_fg_bg} - local rs_apply_btn = PushButton{parent=rs_c_1,x=43,y=14,min_width=7,text="Apply",callback=rs_apply,fg_bg=cpair(colors.black,colors.green),active_fg_bg=btn_act_fg_bg,dis_fg_bg=btn_dis_fg_bg} + local function rs_back() + self.rs_cfg_phy = false + rs_pane.set_value(1) + header.set_value(" Redstone Connections") + end - TextBox{parent=rs_c_2,x=1,y=1,text="Select one of the below ports to use."} + PushButton{parent=rs_c_2,x=1,y=14,text="\x1b Back",callback=rs_back,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg} + local rs_revert_btn = PushButton{parent=rs_c_2,x=8,y=14,min_width=16,text="Revert Changes",callback=rs_revert,fg_bg=cpair(colors.black,colors.yellow),active_fg_bg=btn_act_fg_bg,dis_fg_bg=btn_dis_fg_bg} + PushButton{parent=rs_c_2,x=35,y=14,min_width=7,text="New +",callback=function()rs_pane.set_value(3)end,fg_bg=cpair(colors.black,colors.blue),active_fg_bg=btn_act_fg_bg} + local rs_apply_btn = PushButton{parent=rs_c_2,x=43,y=14,min_width=7,text="Apply",callback=rs_apply,fg_bg=cpair(colors.black,colors.green),active_fg_bg=btn_act_fg_bg,dis_fg_bg=btn_dis_fg_bg} - local rs_ports = ListBox{parent=rs_c_2,x=1,y=3,height=10,width=49,scroll_height=200,fg_bg=bw_fg_bg,nav_fg_bg=g_lg_fg_bg,nav_active=cpair(colors.black,colors.gray)} + --#endregion + --#region Port Selection + + TextBox{parent=rs_c_3,x=1,y=1,text="Select one of the below ports to use."} + + local rs_ports = ListBox{parent=rs_c_3,x=1,y=3,height=10,width=49,scroll_height=200,fg_bg=bw_fg_bg,nav_fg_bg=g_lg_fg_bg,nav_active=cpair(colors.black,colors.gray)} local function new_rs(port) self.rs_cfg_editing = false @@ -241,7 +343,7 @@ function redstone.create(tool_ctl, main_pane, cfg_sys, rs_cfg, style) self.rs_cfg_selection.set_value(text) self.rs_cfg_port = port - rs_pane.set_value(3) + rs_pane.set_value(4) end -- add entries to redstone option list @@ -262,38 +364,43 @@ function redstone.create(tool_ctl, main_pane, cfg_sys, rs_cfg, style) TextBox{parent=entry,x=22,y=1,text=PORT_DESC_MAP[i][2],fg_bg=cpair(colors.gray,colors.white)} end - PushButton{parent=rs_c_2,x=1,y=14,text="\x1b Back",callback=function()rs_pane.set_value(1)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg} + PushButton{parent=rs_c_3,x=1,y=14,text="\x1b Back",callback=function()rs_pane.set_value(2)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg} - self.rs_cfg_selection = TextBox{parent=rs_c_3,x=1,y=1,height=2,text=""} + --#endregion + --#region Port Configuration - PushButton{parent=rs_c_3,x=36,y=3,text="What's that?",min_width=14,callback=function()rs_pane.set_value(7)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg} + self.rs_cfg_selection = TextBox{parent=rs_c_4,x=1,y=1,height=2,text=""} - self.rs_cfg_side_l = TextBox{parent=rs_c_3,x=1,y=4,width=11,text="Output Side"} - local side = Radio2D{parent=rs_c_3,x=1,y=5,rows=1,columns=6,default=1,options=side_options,radio_colors=cpair(colors.lightGray,colors.black),select_color=colors.red} + PushButton{parent=rs_c_4,x=36,y=3,text="What's that?",min_width=14,callback=function()rs_pane.set_value(8)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg} - self.rs_cfg_unit_l = TextBox{parent=rs_c_3,x=25,y=7,width=7,text="Unit ID"} - self.rs_cfg_unit = NumberField{parent=rs_c_3,x=33,y=7,width=10,max_chars=2,min=1,max=4,fg_bg=bw_fg_bg} + self.rs_cfg_side_l = TextBox{parent=rs_c_4,x=1,y=4,width=11,text="Output Side"} + local side = Radio2D{parent=rs_c_4,x=1,y=5,rows=1,columns=6,default=1,options=side_options,radio_colors=cpair(colors.lightGray,colors.black),select_color=colors.red} + + self.rs_cfg_unit_l = TextBox{parent=rs_c_4,x=25,y=7,width=7,text="Unit ID"} + self.rs_cfg_unit = NumberField{parent=rs_c_4,x=33,y=7,width=10,max_chars=2,min=1,max=4,fg_bg=bw_fg_bg} local function set_bundled(bundled) if bundled then self.rs_cfg_color.enable() else self.rs_cfg_color.disable() end end - self.rs_cfg_shortcut = TextBox{parent=rs_c_3,x=1,y=9,height=4,text="This shortcut will add entries for each of the 4 waste outputs. If you select bundled, 4 colors will be assigned to the selected side. Otherwise, 4 default sides will be used."} + self.rs_cfg_shortcut = TextBox{parent=rs_c_4,x=1,y=9,height=4,text="This shortcut will add entries for each of the 4 waste outputs. If you select bundled, 4 colors will be assigned to the selected side. Otherwise, 4 default sides will be used."} self.rs_cfg_shortcut.hide(true) - self.rs_cfg_bundled = Checkbox{parent=rs_c_3,x=1,y=7,label="Is Bundled?",default=false,box_fg_bg=cpair(colors.red,colors.black),callback=set_bundled,disable_fg_bg=g_lg_fg_bg} - self.rs_cfg_color = Radio2D{parent=rs_c_3,x=1,y=9,rows=4,columns=4,default=1,options=color_options,radio_colors=cpair(colors.lightGray,colors.black),color_map=color_options_map,disable_color=colors.gray,disable_fg_bg=g_lg_fg_bg} + self.rs_cfg_bundled = Checkbox{parent=rs_c_4,x=1,y=7,label="Is Bundled?",default=false,box_fg_bg=cpair(colors.red,colors.black),callback=set_bundled,disable_fg_bg=g_lg_fg_bg} + self.rs_cfg_color = Radio2D{parent=rs_c_4,x=1,y=9,rows=4,columns=4,default=1,options=color_options,radio_colors=cpair(colors.lightGray,colors.black),color_map=color_options_map,disable_color=colors.gray,disable_fg_bg=g_lg_fg_bg} self.rs_cfg_color.disable() - local rs_err = TextBox{parent=rs_c_3,x=8,y=14,width=30,text="Unit ID must be within 1 to 4.",fg_bg=cpair(colors.red,colors.lightGray),hidden=true} + local rs_err = TextBox{parent=rs_c_4,x=8,y=14,width=30,text="Unit ID invalid.",fg_bg=cpair(colors.red,colors.lightGray),hidden=true} rs_err.hide(true) local function back_from_rs_opts() rs_err.hide(true) - if self.rs_cfg_editing ~= false then rs_pane.set_value(1) else rs_pane.set_value(2) end + if self.rs_cfg_editing ~= false then rs_pane.set_value(2) else rs_pane.set_value(3) end end local function save_rs_entry() + assert(self.rs_cfg_phy ~= false, "tried to save a redstone entry without a phy") + local port = self.rs_cfg_port local u = tonumber(self.rs_cfg_unit.get_value()) @@ -307,18 +414,21 @@ function redstone.create(tool_ctl, main_pane, cfg_sys, rs_cfg, style) port = port, side = side_options_map[side.get_value()], color = tri(self.rs_cfg_bundled.get_value() and rsio.is_digital(port), color_options_map[self.rs_cfg_color.get_value()], nil), - - -- check for duplicate inputs for this unit/facility - if (rsio.get_io_dir(port) == rsio.IO_DIR.IN) then - for i = 1, #tmp_cfg.Redstone do - if tmp_cfg.Redstone[i].port == port and tmp_cfg.Redstone[i].unit == def.unit then - rs_pane.set_value(7) - return - end - end - end + invert = self.rs_cfg_inverted.get_value() or nil, + relay = self.rs_cfg_phy + } if self.rs_cfg_editing == false then + -- check for duplicate inputs for this unit/facility + if (rsio.get_io_dir(port) == rsio.IO_DIR.IN) then + for i = 1, #tmp_cfg.Redstone do + if tmp_cfg.Redstone[i].port == port and tmp_cfg.Redstone[i].unit == def.unit then + rs_pane.set_value(7) + return + end + end + end + table.insert(tmp_cfg.Redstone, def) else def.port = tmp_cfg.Redstone[self.rs_cfg_editing].port @@ -332,12 +442,13 @@ function redstone.create(tool_ctl, main_pane, cfg_sys, rs_cfg, style) unit = tri(PORT_DSGN[IO.WASTE_PU + i] == 1, u, nil), port = IO.WASTE_PU + i, side = tri(self.rs_cfg_bundled.get_value(), side_options_map[side.get_value()], default_sides[i + 1]), - color = tri(self.rs_cfg_bundled.get_value(), default_colors[i + 1], nil) + color = tri(self.rs_cfg_bundled.get_value(), default_colors[i + 1], nil), + relay = self.rs_cfg_phy }) end end - rs_pane.set_value(1) + rs_pane.set_value(2) tool_ctl.gen_rs_summary() side.set_value(1) @@ -349,30 +460,35 @@ function redstone.create(tool_ctl, main_pane, cfg_sys, rs_cfg, style) else rs_err.show() end end - PushButton{parent=rs_c_3,x=1,y=14,text="\x1b Back",callback=back_from_rs_opts,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg} - self.rs_cfg_advanced = PushButton{parent=rs_c_3,x=30,y=14,min_width=10,text="Advanced",callback=function()rs_pane.set_value(8)end,fg_bg=cpair(colors.black,colors.yellow),active_fg_bg=btn_act_fg_bg,dis_fg_bg=btn_dis_fg_bg} - PushButton{parent=rs_c_3,x=41,y=14,min_width=9,text="Confirm",callback=save_rs_entry,fg_bg=cpair(colors.black,colors.blue),active_fg_bg=btn_act_fg_bg} + PushButton{parent=rs_c_4,x=1,y=14,text="\x1b Back",callback=back_from_rs_opts,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg} + self.rs_cfg_advanced = PushButton{parent=rs_c_4,x=30,y=14,min_width=10,text="Advanced",callback=function()rs_pane.set_value(9)end,fg_bg=cpair(colors.black,colors.yellow),active_fg_bg=btn_act_fg_bg,dis_fg_bg=btn_dis_fg_bg} + PushButton{parent=rs_c_4,x=41,y=14,min_width=9,text="Confirm",callback=save_rs_entry,fg_bg=cpair(colors.black,colors.blue),active_fg_bg=btn_act_fg_bg} - TextBox{parent=rs_c_4,x=1,y=1,text="Settings saved!"} - PushButton{parent=rs_c_4,x=1,y=14,text="\x1b Back",callback=function()rs_pane.set_value(1)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg} - PushButton{parent=rs_c_4,x=44,y=14,min_width=6,text="Home",callback=function()tool_ctl.go_home()end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg} + --#endregion - TextBox{parent=rs_c_5,x=1,y=1,height=5,text="Failed to save the settings file.\n\nThere may not be enough space for the modification or server file permissions may be denying writes."} - PushButton{parent=rs_c_5,x=1,y=14,text="\x1b Back",callback=function()rs_pane.set_value(1)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg} + TextBox{parent=rs_c_5,x=1,y=1,text="Settings saved!"} + PushButton{parent=rs_c_5,x=1,y=14,text="\x1b Back",callback=function()rs_pane.set_value(2)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg} PushButton{parent=rs_c_5,x=44,y=14,min_width=6,text="Home",callback=function()tool_ctl.go_home()end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg} - TextBox{parent=rs_c_6,x=1,y=1,height=5,text="You already configured this input. There can only be one entry for each input.\n\nPlease select a different port."} + TextBox{parent=rs_c_6,x=1,y=1,height=5,text="Failed to save the settings file.\n\nThere may not be enough space for the modification or server file permissions may be denying writes."} PushButton{parent=rs_c_6,x=1,y=14,text="\x1b Back",callback=function()rs_pane.set_value(2)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg} + PushButton{parent=rs_c_6,x=44,y=14,min_width=6,text="Home",callback=function()tool_ctl.go_home()end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg} - TextBox{parent=rs_c_7,x=1,y=1,height=4,text="(Normal) Digital Input: On if there is a redstone signal, off otherwise\nInverted Digital Input: On without a redstone signal, off otherwise"} - TextBox{parent=rs_c_7,x=1,y=6,height=4,text="(Normal) Digital Output: Redstone signal to 'turn it on', none to 'turn it off'\nInverted Digital Output: No redstone signal to 'turn it on', redstone signal to 'turn it off'"} - TextBox{parent=rs_c_7,x=1,y=11,height=2,text="Analog Input: 0-15 redstone power level input\nAnalog Output: 0-15 scaled redstone power level output"} + TextBox{parent=rs_c_7,x=1,y=1,height=6,text="You already configured this input for this facility/unit assignment. There can only be one entry for each input per each unit or the facility (for facility inputs).\n\nPlease select a different port."} PushButton{parent=rs_c_7,x=1,y=14,text="\x1b Back",callback=function()rs_pane.set_value(3)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg} - TextBox{parent=rs_c_8,x=1,y=1,height=5,text="Advanced Options"} - self.rs_cfg_inverted = Checkbox{parent=rs_c_8,x=1,y=3,label="Invert",default=false,box_fg_bg=cpair(colors.red,colors.black),callback=function()end,disable_fg_bg=g_lg_fg_bg} - TextBox{parent=rs_c_8,x=3,y=4,height=4,text="Digital I/O is already inverted (or not) based on intended use. If you have a non-standard setup, you can use this option to avoid needing a redstone inverter.",fg_bg=cpair(colors.gray,colors.lightGray)} - PushButton{parent=rs_c_8,x=1,y=14,text="\x1b Back",callback=function()rs_pane.set_value(3)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg} + TextBox{parent=rs_c_8,x=1,y=1,height=4,text="(Normal) Digital Input: On if there is a redstone signal, off otherwise\nInverted Digital Input: On without a redstone signal, off otherwise"} + TextBox{parent=rs_c_8,x=1,y=6,height=4,text="(Normal) Digital Output: Redstone signal to 'turn it on', none to 'turn it off'\nInverted Digital Output: No redstone signal to 'turn it on', redstone signal to 'turn it off'"} + TextBox{parent=rs_c_8,x=1,y=11,height=2,text="Analog Input: 0-15 redstone power level input\nAnalog Output: 0-15 scaled redstone power level output"} + PushButton{parent=rs_c_8,x=1,y=14,text="\x1b Back",callback=function()rs_pane.set_value(4)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg} + + TextBox{parent=rs_c_9,x=1,y=1,height=5,text="Advanced Options"} + self.rs_cfg_inverted = Checkbox{parent=rs_c_9,x=1,y=3,label="Invert",default=false,box_fg_bg=cpair(colors.red,colors.black),callback=function()end,disable_fg_bg=g_lg_fg_bg} + TextBox{parent=rs_c_9,x=3,y=4,height=4,text="Digital I/O is already inverted (or not) based on intended use. If you have a non-standard setup, you can use this option to avoid needing a redstone inverter.",fg_bg=cpair(colors.gray,colors.lightGray)} + PushButton{parent=rs_c_9,x=1,y=14,text="\x1b Back",callback=function()rs_pane.set_value(4)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg} + + TextBox{parent=rs_c_10,x=1,y=1,height=10,text="Make sure your relay is either touching the RTU gateway or connected via wired modems. There should be a wired modem on a side of the RTU gateway then one on the device, connected by a cable. The modem on the device needs to be right clicked to connect it (which will turn its border red), at which point the peripheral name will be shown in the chat."} + PushButton{parent=rs_c_10,x=1,y=14,text="\x1b Back",callback=function()rs_pane.set_value(1)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg} --#endregion @@ -422,7 +538,7 @@ function redstone.create(tool_ctl, main_pane, cfg_sys, rs_cfg, style) side.set_value(side_to_idx(def.side)) self.rs_cfg_color.set_value(value) self.rs_cfg_inverted.set_value(def.invert or false) - rs_pane.set_value(3) + rs_pane.set_value(4) end local function delete_rs_entry(idx) @@ -432,34 +548,41 @@ function redstone.create(tool_ctl, main_pane, cfg_sys, rs_cfg, style) -- generate the redstone summary list function tool_ctl.gen_rs_summary() + assert(self.rs_cfg_phy ~= false, "tried to generate a summary without a phy set") + rs_list.remove_all() - local modified = #ini_cfg.Redstone ~= #tmp_cfg.Redstone + local ini = redstone_subset(ini_cfg.Redstone, self.rs_cfg_phy) + local tmp = redstone_subset(tmp_cfg.Redstone, self.rs_cfg_phy) + + local modified = #ini ~= #tmp for i = 1, #tmp_cfg.Redstone do local def = tmp_cfg.Redstone[i] - local name = rsio.to_string(def.port) - local io_dir = tri(rsio.get_io_dir(def.port) == rsio.IO_DIR.IN, "\x1a", "\x1b") - local io_c = tri(rsio.is_digital(def.port), colors.blue, colors.purple) - local conn = def.side - local unit = util.strval(def.unit or "F") + if def.relay == self.rs_cfg_phy then + local name = rsio.to_string(def.port) + local io_dir = tri(rsio.get_io_dir(def.port) == rsio.IO_DIR.IN, "\x1a", "\x1b") + local io_c = tri(rsio.is_digital(def.port), colors.blue, colors.purple) + local conn = def.side + local unit = util.strval(def.unit or "F") - if def.color ~= nil then conn = def.side .. "/" .. rsio.color_name(def.color) end + if def.color ~= nil then conn = def.side .. "/" .. rsio.color_name(def.color) end - local entry = Div{parent=rs_list,height=1} - TextBox{parent=entry,x=1,y=1,width=1,text=io_dir,fg_bg=cpair(tri(def.invert,colors.orange,io_c),colors.white)} - TextBox{parent=entry,x=2,y=1,width=14,text=name} - TextBox{parent=entry,x=16,y=1,width=string.len(conn),text=conn,fg_bg=cpair(colors.gray,colors.white)} - TextBox{parent=entry,x=33,y=1,width=1,text=unit,fg_bg=cpair(colors.gray,colors.white)} - PushButton{parent=entry,x=35,y=1,min_width=6,height=1,text="EDIT",callback=function()edit_rs_entry(i)end,fg_bg=cpair(colors.black,colors.blue),active_fg_bg=btn_act_fg_bg} - PushButton{parent=entry,x=41,y=1,min_width=8,height=1,text="DELETE",callback=function()delete_rs_entry(i)end,fg_bg=cpair(colors.black,colors.red),active_fg_bg=btn_act_fg_bg} + local entry = Div{parent=rs_list,height=1} + TextBox{parent=entry,x=1,y=1,width=1,text=io_dir,fg_bg=cpair(tri(def.invert,colors.orange,io_c),colors.white)} + TextBox{parent=entry,x=2,y=1,width=14,text=name} + TextBox{parent=entry,x=16,y=1,width=string.len(conn),text=conn,fg_bg=cpair(colors.gray,colors.white)} + TextBox{parent=entry,x=33,y=1,width=1,text=unit,fg_bg=cpair(colors.gray,colors.white)} + PushButton{parent=entry,x=35,y=1,min_width=6,height=1,text="EDIT",callback=function()edit_rs_entry(i)end,fg_bg=cpair(colors.black,colors.blue),active_fg_bg=btn_act_fg_bg} + PushButton{parent=entry,x=41,y=1,min_width=8,height=1,text="DELETE",callback=function()delete_rs_entry(i)end,fg_bg=cpair(colors.black,colors.red),active_fg_bg=btn_act_fg_bg} - if not modified then - local a = ini_cfg.Redstone[i] - local b = tmp_cfg.Redstone[i] + if not modified then + local a = ini_cfg.Redstone[i] + local b = tmp_cfg.Redstone[i] - modified = (a.unit ~= b.unit) or (a.port ~= b.port) or (a.side ~= b.side) or (a.color ~= b.color) or (a.invert ~= b.invert) + modified = (a.unit ~= b.unit) or (a.port ~= b.port) or (a.side ~= b.side) or (a.color ~= b.color) or (a.invert ~= b.invert) + end end end diff --git a/rtu/configure.lua b/rtu/configure.lua index 03fb1b9..380f4ca 100644 --- a/rtu/configure.lua +++ b/rtu/configure.lua @@ -76,6 +76,7 @@ local tool_ctl = { gen_summary = nil, ---@type function load_legacy = nil, ---@type function update_peri_list = nil, ---@type function + update_relay_list = nil, ---@type function gen_peri_summary = nil, ---@type function gen_rs_summary = nil, ---@type function } @@ -128,7 +129,7 @@ end ---@param data rtu_rs_definition[] function tool_ctl.deep_copy_rs(data) local array = {} - for _, d in ipairs(data) do table.insert(array, { unit = d.unit, port = d.port, side = d.side, color = d.color, invert = d.invert }) end + for _, d in ipairs(data) do table.insert(array, { unit = d.unit, port = d.port, side = d.side, color = d.color, invert = d.invert, relay = d.relay }) end return array end @@ -208,7 +209,6 @@ local function config_view(display) end local function show_rs_conns() - tool_ctl.gen_rs_summary() main_pane.set_value(9) end @@ -348,10 +348,12 @@ function configurator.configure(ask_config) ---@diagnostic disable-next-line: discard-returns ppm.handle_unmount(param1) tool_ctl.update_peri_list() + tool_ctl.update_relay_list() elseif event == "peripheral" then ---@diagnostic disable-next-line: discard-returns ppm.mount(param1) tool_ctl.update_peri_list() + tool_ctl.update_relay_list() end if event == "terminate" then return end diff --git a/supervisor/session/rtu/redstone.lua b/supervisor/session/rtu/redstone.lua index 610432d..7b91dc3 100644 --- a/supervisor/session/rtu/redstone.lua +++ b/supervisor/session/rtu/redstone.lua @@ -10,7 +10,6 @@ local redstone = {} local RTU_UNIT_TYPE = types.RTU_UNIT_TYPE local MODBUS_FCODE = types.MODBUS_FCODE -local IO_PORT = rsio.IO local IO_LVL = rsio.IO_LVL local IO_MODE = rsio.IO_MODE From 7404e6da311f2169e3e0f63b16aa729d9e9bae8a Mon Sep 17 00:00:00 2001 From: Mikayla Fischler Date: Wed, 7 May 2025 11:48:32 -0400 Subject: [PATCH 08/14] #604 updated self check for relays and added duplicate input detection --- rtu/config/check.lua | 47 +++++++++++++++++++++++++++++++++----------- rtu/configure.lua | 3 ++- rtu/startup.lua | 8 ++++---- 3 files changed, 41 insertions(+), 17 deletions(-) diff --git a/rtu/config/check.lua b/rtu/config/check.lua index 6818ba6..bc3f6d5 100644 --- a/rtu/config/check.lua +++ b/rtu/config/check.lua @@ -136,22 +136,45 @@ local function self_check() self.self_check_msg("> check gateway configuration...", valid_cfg, "go through Configure Gateway and apply settings to set any missing settings and repair any corrupted ones") -- check redstone configurations - local ifaces = {} - local bundled_sides = {} + + local phys = {} ---@type rtu_rs_definition[][] + local inputs = { [0] = {}, {}, {}, {}, {} } + for i = 1, #cfg.Redstone do local entry = cfg.Redstone[i] - local ident = entry.side .. tri(entry.color, ":" .. rsio.color_name(entry.color), "") - local dupe = util.table_contains(ifaces, ident) - local mixed = (bundled_sides[entry.side] and (entry.color == nil)) or (bundled_sides[entry.side] == false and (entry.color ~= nil)) + local name = entry.relay or "local" - local mixed_msg = util.trinary(bundled_sides[entry.side], "bundled entry(s) but this entry is not", "non-bundled entry(s) but this entry is") + if phys[name] == nil then phys[name] = {} end + table.insert(phys[entry.relay or "local"], entry) + end - self.self_check_msg("> check redstone " .. ident .. " unique...", not dupe, "only one port should be set to a side/color combination") - self.self_check_msg("> check redstone " .. ident .. " bundle...", not mixed, "this side has " .. mixed_msg .. " bundled, which will not work") - self.self_check_msg("> check redstone " .. ident .. " valid...", redstone.validate(entry), "configuration invalid, please re-configure redstone entry") + for name, entries in pairs(phys) do + TextBox{parent=self.sc_log,text="> checking redstone @ "..name.."...",fg_bg=cpair(colors.blue,colors.white)} - bundled_sides[entry.side] = bundled_sides[entry.side] or entry.color ~= nil - table.insert(ifaces, ident) + local ifaces = {} + local bundled_sides = {} + + for i = 1, #entries do + local entry = entries[i] + local ident = entry.side .. tri(entry.color, ":" .. rsio.color_name(entry.color), "") + + local sc_dupe = util.table_contains(ifaces, ident) + local mixed = (bundled_sides[entry.side] and (entry.color == nil)) or (bundled_sides[entry.side] == false and (entry.color ~= nil)) + + local mixed_msg = util.trinary(bundled_sides[entry.side], "bundled entry(s) but this entry is not", "non-bundled entry(s) but this entry is") + + self.self_check_msg("> check redstone " .. ident .. " unique...", not sc_dupe, "only one port should be set to a side/color combination") + self.self_check_msg("> check redstone " .. ident .. " bundle...", not mixed, "this side has " .. mixed_msg .. " bundled, which will not work") + self.self_check_msg("> check redstone " .. ident .. " valid...", redstone.validate(entry), "configuration invalid, please re-configure redstone entry") + + if rsio.get_io_dir(entry.port) == rsio.IO_DIR.IN then + local in_dupe = util.table_contains(inputs[entry.unit or 0], entry.port) + self.self_check_msg("> check redstone " .. ident .. " input...", not in_dupe, "you cannot have multiple of the same input for a given unit or the facility ("..rsio.to_string(entry.port)..")") + end + + bundled_sides[entry.side] = bundled_sides[entry.side] or entry.color ~= nil + table.insert(ifaces, ident) + end end -- check peripheral configurations @@ -245,7 +268,7 @@ function check.create(main_pane, settings_cfg, check_sys, style) TextBox{parent=check_sys,x=1,y=2,text=" RTU Gateway Self-Check",fg_bg=bw_fg_bg} - self.sc_log = ListBox{parent=sc,x=1,y=1,height=12,width=49,scroll_height=500,fg_bg=bw_fg_bg,nav_fg_bg=g_lg_fg_bg,nav_active=cpair(colors.black,colors.gray)} + self.sc_log = ListBox{parent=sc,x=1,y=1,height=12,width=49,scroll_height=1000,fg_bg=bw_fg_bg,nav_fg_bg=g_lg_fg_bg,nav_active=cpair(colors.black,colors.gray)} local last_check = { nil, nil } diff --git a/rtu/configure.lua b/rtu/configure.lua index 380f4ca..eea6072 100644 --- a/rtu/configure.lua +++ b/rtu/configure.lua @@ -36,7 +36,8 @@ local changes = { { "v1.7.15", { "Added front panel UI theme", "Added color accessibility modes" } }, { "v1.9.2", { "Added standard with black off state color mode", "Added blue indicator color modes" } }, { "v1.10.2", { "Re-organized peripheral configuration UI, resulting in some input fields being re-ordered" } }, - { "v1.11.8", { "Added advanced option to invert digital redstone signals" } } + { "v1.11.8", { "Added advanced option to invert digital redstone signals" } }, + { "v1.12.0", { "Added support for redstone relays" } } } ---@class rtu_configurator diff --git a/rtu/startup.lua b/rtu/startup.lua index 8ac188c..314c2c7 100644 --- a/rtu/startup.lua +++ b/rtu/startup.lua @@ -31,7 +31,7 @@ local sna_rtu = require("rtu.dev.sna_rtu") local sps_rtu = require("rtu.dev.sps_rtu") local turbinev_rtu = require("rtu.dev.turbinev_rtu") -local RTU_VERSION = "v1.11.8" +local RTU_VERSION = "v1.12.0" local RTU_UNIT_TYPE = types.RTU_UNIT_TYPE local RTU_HW_STATE = databus.RTU_HW_STATE @@ -152,7 +152,7 @@ local function main() --#region Redstone Interfaces local rs_rtus = {} ---@type { name: string, rtu: rtu_rs_device, phy: table, banks: rtu_rs_definition[][] }[] - local all_conns = {} + local all_conns = { [0] = {}, {}, {}, {}, {} } -- go through redstone definitions list for entry_idx = 1, #rtu_redstone do @@ -197,11 +197,11 @@ local function main() log.warning(util.c("sys_config> redstone relay ", entry.relay, " is not a redstone relay")) end - rs_rtus[entry.relay] = { name = entry.relay, rtu = redstone_rtu.new(relay), phy = relay, banks = {} } + rs_rtus[entry.relay] = { name = entry.relay, rtu = redstone_rtu.new(relay), phy = relay, banks = { [0] = {}, {}, {}, {}, {} } } end elseif rs_rtus[0] == nil then log.debug(util.c("sys_config> allocated local redstone RTU")) - rs_rtus[0] = { name = "redstone_local", rtu = redstone_rtu.new(), phy = rs, banks = {} } + rs_rtus[0] = { name = "redstone_local", rtu = redstone_rtu.new(), phy = rs, banks = { [0] = {}, {}, {}, {}, {} } } end -- verify configuration From 8eff1c0d761e0f002065b89b7f5ce7cb5a7f20a7 Mon Sep 17 00:00:00 2001 From: Mikayla Fischler Date: Wed, 7 May 2025 20:03:20 -0400 Subject: [PATCH 09/14] #604 refresh connections count on saving an interface --- rtu/config/redstone.lua | 1 + 1 file changed, 1 insertion(+) diff --git a/rtu/config/redstone.lua b/rtu/config/redstone.lua index 53fd9fd..7592bf9 100644 --- a/rtu/config/redstone.lua +++ b/rtu/config/redstone.lua @@ -263,6 +263,7 @@ function redstone.create(tool_ctl, main_pane, cfg_sys, rs_cfg, style) -- this will delete unsaved changes for other phy's, which is acceptable tmp_cfg.Redstone = tool_ctl.deep_copy_rs(ini_cfg.Redstone) tool_ctl.gen_rs_summary() + tool_ctl.update_relay_list() else rs_pane.set_value(6) end From 069a7ce0ad0da1f74e86606396c1b5ea136e1deb Mon Sep 17 00:00:00 2001 From: Mikayla Fischler Date: Wed, 7 May 2025 20:03:48 -0400 Subject: [PATCH 10/14] #604 front panel updates and hw state tracking fixes --- rtu/panel/front_panel.lua | 30 +++++++++++++++++++++++------- rtu/startup.lua | 15 ++++++++------- 2 files changed, 31 insertions(+), 14 deletions(-) diff --git a/rtu/panel/front_panel.lua b/rtu/panel/front_panel.lua index 51adf30..02f5979 100644 --- a/rtu/panel/front_panel.lua +++ b/rtu/panel/front_panel.lua @@ -19,7 +19,8 @@ local LED = require("graphics.elements.indicators.LED") local LEDPair = require("graphics.elements.indicators.LEDPair") local RGBLED = require("graphics.elements.indicators.RGBLED") -local LINK_STATE = types.PANEL_LINK_STATE +local LINK_STATE = types.PANEL_LINK_STATE +local RTU_UNIT_TYPE = types.RTU_UNIT_TYPE local ALIGN = core.ALIGN @@ -129,30 +130,45 @@ local function init(panel, units) -- show routine statuses for i = 1, list_length do TextBox{parent=threads,x=1,y=i,text=util.sprintf("%02d",i)} - local rt_unit = LED{parent=threads,x=4,y=i,label="RT",colors=ind_grn} + local rt_unit = LED{parent=threads,x=4,y=i,label="RT",colors=util.trinary(units[i].type~=RTU_UNIT_TYPE.REDSTONE,ind_grn,cpair(style.ind_bkg,style.ind_bkg))} rt_unit.register(databus.ps, "routine__unit_" .. i, rt_unit.update) end local unit_hw_statuses = Div{parent=panel,height=term_h-3,x=25,y=3} + local relay_counter = 0 + -- show hardware statuses for i = 1, list_length do local unit = units[i] + local is_rs = unit.type == RTU_UNIT_TYPE.REDSTONE + -- hardware status local unit_hw = RGBLED{parent=unit_hw_statuses,y=i,label="",colors={colors.red,colors.orange,colors.yellow,colors.green}} unit_hw.register(databus.ps, "unit_hw_" .. i, unit_hw.update) -- unit name identifier (type + index) - local function get_name(t) return util.c(UNIT_TYPE_LABELS[t + 1], " ", util.trinary(util.is_int(unit.index), unit.index, "")) end - local name_box = TextBox{parent=unit_hw_statuses,y=i,x=3,text=get_name(unit.type),width=15} + local function get_name() + if is_rs then + local is_local = unit.name == "redstone_local" + relay_counter = relay_counter + util.trinary(is_local, 0, 1) + return util.c("REDSTONE", util.trinary(is_local, "", " RELAY "..relay_counter)) + else + return util.c(UNIT_TYPE_LABELS[unit.type + 1], " ", util.trinary(util.is_int(unit.index), unit.index, "")) + end + end - name_box.register(databus.ps, "unit_type_" .. i, function (t) name_box.set_value(get_name(t)) end) + local name_box = TextBox{parent=unit_hw_statuses,y=i,x=3,text=get_name(),width=util.trinary(is_rs,24,15)} + + name_box.register(databus.ps, "unit_type_" .. i, function () name_box.set_value(get_name()) end) -- assignment (unit # or facility) - local for_unit = util.trinary(unit.reactor == 0, "\x1a FACIL ", "\x1a UNIT " .. unit.reactor) - TextBox{parent=unit_hw_statuses,y=i,x=term_w-32,text=for_unit,fg_bg=disabled_fg} + if unit.reactor then + local for_unit = util.trinary(unit.reactor == 0, "\x1a FACIL ", "\x1a UNIT " .. unit.reactor) + TextBox{parent=unit_hw_statuses,y=i,x=term_w-32,text=for_unit,fg_bg=disabled_fg} + end end end diff --git a/rtu/startup.lua b/rtu/startup.lua index 314c2c7..69e3a56 100644 --- a/rtu/startup.lua +++ b/rtu/startup.lua @@ -151,7 +151,7 @@ local function main() local function sys_config() --#region Redstone Interfaces - local rs_rtus = {} ---@type { name: string, rtu: rtu_rs_device, phy: table, banks: rtu_rs_definition[][] }[] + local rs_rtus = {} ---@type { name: string, hw_state: RTU_HW_STATE, rtu: rtu_rs_device, phy: table, banks: rtu_rs_definition[][] }[] local all_conns = { [0] = {}, {}, {}, {}, {} } -- go through redstone definitions list @@ -187,21 +187,24 @@ local function main() elseif not rs_rtus[entry.relay] then log.debug(util.c("sys_config> allocated relay redstone RTU on interface ", entry.relay)) - local relay = ppm.get_device(entry.relay) + local hw_state = RTU_HW_STATE.OK + local relay = ppm.get_periph(entry.relay) if not relay then + hw_state = RTU_HW_STATE.OFFLINE log.warning(util.c("sys_config> redstone relay ", entry.relay, " is not connected")) local _, v_device = ppm.mount_virtual() relay = v_device elseif ppm.get_type(entry.relay) ~= "redstone_relay" then + hw_state = RTU_HW_STATE.FAULTED log.warning(util.c("sys_config> redstone relay ", entry.relay, " is not a redstone relay")) end - rs_rtus[entry.relay] = { name = entry.relay, rtu = redstone_rtu.new(relay), phy = relay, banks = { [0] = {}, {}, {}, {}, {} } } + rs_rtus[entry.relay] = { name = entry.relay, hw_state = hw_state, rtu = redstone_rtu.new(relay), phy = relay, banks = { [0] = {}, {}, {}, {}, {} } } end elseif rs_rtus[0] == nil then log.debug(util.c("sys_config> allocated local redstone RTU")) - rs_rtus[0] = { name = "redstone_local", rtu = redstone_rtu.new(), phy = rs, banks = { [0] = {}, {}, {}, {}, {} } } + rs_rtus[0] = { name = "redstone_local", hw_state = RTU_HW_STATE.OK, rtu = redstone_rtu.new(), phy = rs, banks = { [0] = {}, {}, {}, {}, {} } } end -- verify configuration @@ -291,8 +294,6 @@ local function main() end end - local hw_state = util.trinary(def.phy, RTU_HW_STATE.OK, RTU_HW_STATE.OFFLINE) - ---@type rtu_registry_entry local unit = { uid = 0, @@ -304,7 +305,7 @@ local function main() rs_conns = rtu_conns, is_multiblock = false, formed = nil, - hw_state = hw_state, + hw_state = def.hw_state, rtu = def.rtu, modbus_io = modbus.new(def.rtu, false), pkt_queue = nil, From 8f6425b81439185dec90b9a0cab73a660cd087f4 Mon Sep 17 00:00:00 2001 From: Mikayla Fischler Date: Wed, 7 May 2025 20:04:39 -0400 Subject: [PATCH 11/14] #604 fixed supervisor bugs with new redstone --- supervisor/session/rtu.lua | 16 +++++++++------- supervisor/session/rtu/redstone.lua | 13 +++++++------ 2 files changed, 16 insertions(+), 13 deletions(-) diff --git a/supervisor/session/rtu.lua b/supervisor/session/rtu.lua index 4f04a1e..dea4eb2 100644 --- a/supervisor/session/rtu.lua +++ b/supervisor/session/rtu.lua @@ -140,13 +140,15 @@ function rtu.new_session(id, s_addr, i_seq_num, in_queue, out_queue, timeout, ad -- link this to any subsystems this RTU provides connections for if type(unit) ~= "nil" then - for assignment, _ in pairs(unit_advert.rs_conns) do - if assignment == 0 then - facility.add_redstone(unit) - elseif assignment > 0 and assignment < #self.fac_units then - self.fac_units[assignment].add_redstone(unit) - else - log.warning(util.c(log_tag, "_handle_advertisement(): unrecognized redstone RTU assignment ", assignment, " ", type_string)) + for assignment, conns in pairs(unit_advert.rs_conns) do + if #conns > 0 then + if assignment == 0 then + facility.add_redstone(unit) + elseif assignment > 0 and assignment <= #self.fac_units then + self.fac_units[assignment].add_redstone(unit) + else + log.warning(util.c(log_tag, "_handle_advertisement(): unrecognized redstone RTU assignment ", assignment, " ", type_string)) + end end end end diff --git a/supervisor/session/rtu/redstone.lua b/supervisor/session/rtu/redstone.lua index 7b91dc3..2cd2856 100644 --- a/supervisor/session/rtu/redstone.lua +++ b/supervisor/session/rtu/redstone.lua @@ -127,7 +127,7 @@ function redstone.new(session_id, unit_id, advert, out_queue) write = function () end } - self.db.io[port] = io_f + self.db.io[bank][port] = io_f elseif mode == IO_MODE.DIGITAL_OUT then self.has_do = true table.insert(self.io_map.digital_out, io_entry) @@ -145,7 +145,7 @@ function redstone.new(session_id, unit_id, advert, out_queue) end } - self.db.io[port] = io_f + self.db.io[bank][port] = io_f elseif mode == IO_MODE.ANALOG_IN then self.has_ai = true table.insert(self.io_map.analog_in, io_entry) @@ -160,7 +160,7 @@ function redstone.new(session_id, unit_id, advert, out_queue) write = function () end } - self.db.io[port] = io_f + self.db.io[bank][port] = io_f elseif mode == IO_MODE.ANALOG_OUT then self.has_ao = true table.insert(self.io_map.analog_out, io_entry) @@ -180,7 +180,7 @@ function redstone.new(session_id, unit_id, advert, out_queue) end } - self.db.io[port] = io_f + self.db.io[bank][port] = io_f else -- should be unreachable code, we already validated ports log.error(util.c(log_tag, "failed to identify advertisement port IO mode (", bank, ":", port, ")"), true) @@ -396,9 +396,10 @@ function redstone.new(session_id, unit_id, advert, out_queue) self.session.post_update() end - -- invalidate build cache + -- force a re-read of cached outputs function public.invalidate_cache() - -- no build cache for this device + _read_coils() + _read_holding_registers() end -- get the unit session database From f01fb6286322d631734624682eff2f29c878db73 Mon Sep 17 00:00:00 2001 From: Mikayla Fischler Date: Wed, 7 May 2025 20:05:03 -0400 Subject: [PATCH 12/14] #604 updated emergency coolant annunciator logic --- supervisor/unit_logic.lua | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/supervisor/unit_logic.lua b/supervisor/unit_logic.lua index db8af3a..631449f 100644 --- a/supervisor/unit_logic.lua +++ b/supervisor/unit_logic.lua @@ -173,12 +173,8 @@ function logic.update_annunciator(self) annunc.EmergencyCoolant = 1 - for i = 1, #self.redstone do - local io = self.redstone[i].get_db().io[IO.U_EMER_COOL] - if io ~= nil then - annunc.EmergencyCoolant = util.trinary(io.read(), 3, 2) - break - end + if self.io_ctl.is_connected(IO.U_EMER_COOL) then + annunc.EmergencyCoolant = util.trinary(self.io_ctl.digital_read(IO.U_EMER_COOL), 3, 2) end --#endregion From 41e6d89a4bf1768c5e54487b126cb83e18cb7fd9 Mon Sep 17 00:00:00 2001 From: Mikayla Fischler Date: Wed, 7 May 2025 20:06:04 -0400 Subject: [PATCH 13/14] incremented comms version for RTU advertisement changes --- scada-common/comms.lua | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scada-common/comms.lua b/scada-common/comms.lua index 48cf416..f827ab8 100644 --- a/scada-common/comms.lua +++ b/scada-common/comms.lua @@ -17,7 +17,7 @@ local max_distance = nil local comms = {} -- protocol/data versions (protocol/data independent changes tracked by util.lua version) -comms.version = "3.0.5" +comms.version = "3.0.6" comms.api_version = "0.0.9" ---@enum PROTOCOL From 5f8c947105feb91111fa56ae8e87a8063c649fa9 Mon Sep 17 00:00:00 2001 From: Mikayla Date: Fri, 9 May 2025 15:41:14 +0000 Subject: [PATCH 14/14] cleanup and fixes --- rtu/config/redstone.lua | 10 +++++----- rtu/configure.lua | 2 +- rtu/panel/front_panel.lua | 2 +- rtu/startup.lua | 1 - supervisor/session/rtu.lua | 9 +++------ 5 files changed, 10 insertions(+), 14 deletions(-) diff --git a/rtu/config/redstone.lua b/rtu/config/redstone.lua index 7592bf9..3227f3f 100644 --- a/rtu/config/redstone.lua +++ b/rtu/config/redstone.lua @@ -413,10 +413,10 @@ function redstone.create(tool_ctl, main_pane, cfg_sys, rs_cfg, style) local def = { unit = tri(PORT_DSGN[port] == 1, u, nil), port = port, + relay = self.rs_cfg_phy, side = side_options_map[side.get_value()], color = tri(self.rs_cfg_bundled.get_value() and rsio.is_digital(port), color_options_map[self.rs_cfg_color.get_value()], nil), - invert = self.rs_cfg_inverted.get_value() or nil, - relay = self.rs_cfg_phy + invert = self.rs_cfg_inverted.get_value() or nil } if self.rs_cfg_editing == false then @@ -442,9 +442,9 @@ function redstone.create(tool_ctl, main_pane, cfg_sys, rs_cfg, style) table.insert(tmp_cfg.Redstone, { unit = tri(PORT_DSGN[IO.WASTE_PU + i] == 1, u, nil), port = IO.WASTE_PU + i, + relay = self.rs_cfg_phy, side = tri(self.rs_cfg_bundled.get_value(), side_options_map[side.get_value()], default_sides[i + 1]), - color = tri(self.rs_cfg_bundled.get_value(), default_colors[i + 1], nil), - relay = self.rs_cfg_phy + color = tri(self.rs_cfg_bundled.get_value(), default_colors[i + 1], nil) }) end end @@ -582,7 +582,7 @@ function redstone.create(tool_ctl, main_pane, cfg_sys, rs_cfg, style) local a = ini_cfg.Redstone[i] local b = tmp_cfg.Redstone[i] - modified = (a.unit ~= b.unit) or (a.port ~= b.port) or (a.side ~= b.side) or (a.color ~= b.color) or (a.invert ~= b.invert) + modified = (a.unit ~= b.unit) or (a.port ~= b.port) or (a.relay ~= b.relay) or (a.side ~= b.side) or (a.color ~= b.color) or (a.invert ~= b.invert) end end end diff --git a/rtu/configure.lua b/rtu/configure.lua index eea6072..022dfbb 100644 --- a/rtu/configure.lua +++ b/rtu/configure.lua @@ -130,7 +130,7 @@ end ---@param data rtu_rs_definition[] function tool_ctl.deep_copy_rs(data) local array = {} - for _, d in ipairs(data) do table.insert(array, { unit = d.unit, port = d.port, side = d.side, color = d.color, invert = d.invert, relay = d.relay }) end + for _, d in ipairs(data) do table.insert(array, { unit = d.unit, port = d.port, relay = d.relay, side = d.side, color = d.color, invert = d.invert }) end return array end diff --git a/rtu/panel/front_panel.lua b/rtu/panel/front_panel.lua index 02f5979..0b9c2ed 100644 --- a/rtu/panel/front_panel.lua +++ b/rtu/panel/front_panel.lua @@ -154,7 +154,7 @@ local function init(panel, units) if is_rs then local is_local = unit.name == "redstone_local" relay_counter = relay_counter + util.trinary(is_local, 0, 1) - return util.c("REDSTONE", util.trinary(is_local, "", " RELAY "..relay_counter)) + return util.c("REDSTONE", util.trinary(is_local, "", " RELAY " .. relay_counter)) else return util.c(UNIT_TYPE_LABELS[unit.type + 1], " ", util.trinary(util.is_int(unit.index), unit.index, "")) end diff --git a/rtu/startup.lua b/rtu/startup.lua index 69e3a56..f4e9eed 100644 --- a/rtu/startup.lua +++ b/rtu/startup.lua @@ -213,7 +213,6 @@ local function main() valid = util.trinary(entry.color == nil, true, rsio.is_color(entry.color)) end - -- local rs_rtu = rs_rtus[phy].rtu local bank = rs_rtus[phy].banks[for_reactor] local conns = all_conns[for_reactor] diff --git a/supervisor/session/rtu.lua b/supervisor/session/rtu.lua index dea4eb2..094c13d 100644 --- a/supervisor/session/rtu.lua +++ b/supervisor/session/rtu.lua @@ -104,14 +104,11 @@ function rtu.new_session(id, s_addr, i_seq_num, in_queue, out_queue, timeout, ad advert_validator.assert(util.is_int(unit_advert.index) or (unit_advert.index == false)) advert_validator.assert_type_int(unit_advert.reactor) - if u_type == RTU_UNIT_TYPE.REDSTONE then - advert_validator.assert_type_table(unit_advert.rs_conns) - end - if advert_validator.valid() then if util.is_int(unit_advert.index) then advert_validator.assert_min(unit_advert.index, 1) end - if unit_advert.reactor == -1 then + if (unit_advert.reactor == -1) or (u_type == RTU_UNIT_TYPE.REDSTONE) then + advert_validator.assert((unit_advert.reactor == -1) and (u_type == RTU_UNIT_TYPE.REDSTONE)) advert_validator.assert_type_table(unit_advert.rs_conns) else advert_validator.assert_min(unit_advert.reactor, 0) @@ -147,7 +144,7 @@ function rtu.new_session(id, s_addr, i_seq_num, in_queue, out_queue, timeout, ad elseif assignment > 0 and assignment <= #self.fac_units then self.fac_units[assignment].add_redstone(unit) else - log.warning(util.c(log_tag, "_handle_advertisement(): unrecognized redstone RTU assignment ", assignment, " ", type_string)) + log.warning(util.c(log_tag, "_handle_advertisement(): invalid redstone RTU assignment ", assignment)) end end end