302 lines
11 KiB
Lua
302 lines
11 KiB
Lua
local comms = require("scada-common.comms")
|
|
local network = require("scada-common.network")
|
|
local ppm = require("scada-common.ppm")
|
|
local tcd = require("scada-common.tcd")
|
|
local util = require("scada-common.util")
|
|
|
|
local plc = require("reactor-plc.plc")
|
|
|
|
local core = require("graphics.core")
|
|
|
|
local Div = require("graphics.elements.Div")
|
|
local ListBox = require("graphics.elements.ListBox")
|
|
local TextBox = require("graphics.elements.TextBox")
|
|
|
|
local PushButton = require("graphics.elements.controls.PushButton")
|
|
|
|
local tri = util.trinary
|
|
|
|
local cpair = core.cpair
|
|
|
|
local PROTOCOL = comms.PROTOCOL
|
|
local DEVICE_TYPE = comms.DEVICE_TYPE
|
|
local ESTABLISH_ACK = comms.ESTABLISH_ACK
|
|
local MGMT_TYPE = comms.MGMT_TYPE
|
|
|
|
local self = {
|
|
checking_wl = true,
|
|
wd_modem = nil, ---@type Modem|nil
|
|
wl_modem = nil, ---@type Modem|nil
|
|
|
|
nic = nil, ---@type nic
|
|
net_listen = false,
|
|
|
|
self_check_pass = true,
|
|
|
|
settings = nil, ---@type plc_config
|
|
|
|
run_test_btn = nil, ---@type PushButton
|
|
sc_log = nil, ---@type ListBox
|
|
self_check_msg = nil ---@type function
|
|
}
|
|
|
|
-- report successful completion of the check
|
|
local function check_complete()
|
|
TextBox{parent=self.sc_log,text="> all tests passed!",fg_bg=cpair(colors.blue,colors._INHERIT)}
|
|
TextBox{parent=self.sc_log,text=""}
|
|
local more = Div{parent=self.sc_log,height=3,fg_bg=cpair(colors.gray,colors._INHERIT)}
|
|
TextBox{parent=more,text="if you still have a problem:"}
|
|
TextBox{parent=more,text="- check the wiki on GitHub"}
|
|
TextBox{parent=more,text="- ask for help on GitHub discussions or Discord"}
|
|
end
|
|
|
|
-- send a management packet to the supervisor (one-time broadcast)
|
|
---@param msg_type MGMT_TYPE
|
|
---@param msg table
|
|
local function send_sv(msg_type, msg)
|
|
local s_pkt = comms.scada_packet()
|
|
local pkt = comms.mgmt_packet()
|
|
|
|
pkt.make(msg_type, msg)
|
|
s_pkt.make(comms.BROADCAST, util.time_ms() * 10, PROTOCOL.SCADA_MGMT, pkt.raw_sendable())
|
|
|
|
self.nic.transmit(self.settings.SVR_Channel, self.settings.PLC_Channel, s_pkt)
|
|
end
|
|
|
|
-- handle an establish message from the supervisor
|
|
---@param packet mgmt_frame
|
|
local function handle_packet(packet)
|
|
local error_msg = nil
|
|
|
|
if packet.scada_frame.local_channel() ~= self.settings.PLC_Channel then
|
|
error_msg = "error: unknown receive channel"
|
|
elseif packet.scada_frame.remote_channel() == self.settings.SVR_Channel and packet.scada_frame.protocol() == PROTOCOL.SCADA_MGMT then
|
|
if packet.type == MGMT_TYPE.ESTABLISH then
|
|
if packet.length == 1 then
|
|
local est_ack = packet.data[1]
|
|
|
|
if est_ack== ESTABLISH_ACK.ALLOW then
|
|
-- success
|
|
elseif est_ack == ESTABLISH_ACK.DENY then
|
|
error_msg = "error: supervisor connection denied"
|
|
elseif est_ack == ESTABLISH_ACK.COLLISION then
|
|
error_msg = "another reactor PLC is connected with this reactor unit ID"
|
|
elseif est_ack == ESTABLISH_ACK.BAD_VERSION then
|
|
error_msg = "reactor PLC comms version does not match supervisor comms version, make sure both devices are up-to-date (ccmsi update)"
|
|
else
|
|
error_msg = "error: invalid reply from supervisor"
|
|
end
|
|
else
|
|
error_msg = "error: invalid reply length from supervisor"
|
|
end
|
|
else
|
|
error_msg = "error: didn't get an establish reply from supervisor"
|
|
end
|
|
end
|
|
|
|
self.net_listen = false
|
|
|
|
if error_msg then
|
|
self.self_check_msg(nil, false, error_msg)
|
|
else
|
|
self.self_check_msg(nil, true, "")
|
|
end
|
|
|
|
util.push_event("conn_test_complete", error_msg == nil)
|
|
end
|
|
|
|
-- handle supervisor connection failure
|
|
local function handle_timeout()
|
|
self.net_listen = false
|
|
util.push_event("conn_test_complete", false)
|
|
end
|
|
|
|
-- execute the self-check
|
|
local function self_check()
|
|
self.run_test_btn.disable()
|
|
|
|
self.sc_log.remove_all()
|
|
ppm.mount_all()
|
|
|
|
self.self_check_pass = true
|
|
|
|
local cfg = self.settings
|
|
self.wd_modem = ppm.get_modem(cfg.WiredModem)
|
|
self.wl_modem = ppm.get_wireless_modem()
|
|
local reactor = ppm.get_fission_reactor()
|
|
local valid_cfg = plc.validate_config(cfg)
|
|
|
|
-- check for comms modems
|
|
if cfg.Networked then
|
|
if cfg.WiredModem then
|
|
self.self_check_msg("> check wired comms modem connected...", self.wd_modem, "please connect the wired comms modem " .. cfg.WiredModem)
|
|
end
|
|
|
|
if cfg.WirelessModem then
|
|
self.self_check_msg("> check wireless/ender modem connected...", self.wl_modem, "please connect an ender or wireless modem for wireless comms")
|
|
end
|
|
end
|
|
|
|
self.self_check_msg("> check fission reactor connected...", reactor ~= nil, "please connect the reactor PLC to the reactor's fission reactor logic adapter")
|
|
self.self_check_msg("> check fission reactor formed...")
|
|
-- this consumes events, but that is fine here
|
|
self.self_check_msg(nil, reactor and reactor.isFormed(), "ensure the fission reactor multiblock is formed")
|
|
|
|
self.self_check_msg("> check configuration...", valid_cfg, "go through Configure System and apply settings to set any missing settings and repair any corrupted ones")
|
|
|
|
if cfg.Networked and valid_cfg then
|
|
self.checking_wl = true
|
|
|
|
if cfg.WirelessModem and self.wl_modem then
|
|
self.self_check_msg("> check wireless supervisor connection...")
|
|
|
|
-- init mac as needed
|
|
if cfg.AuthKey and string.len(cfg.AuthKey) >= 8 then
|
|
network.init_mac(cfg.AuthKey)
|
|
else
|
|
network.deinit_mac()
|
|
end
|
|
|
|
comms.set_trusted_range(cfg.TrustedRange)
|
|
|
|
self.nic = network.nic(self.wl_modem)
|
|
|
|
self.nic.closeAll()
|
|
self.nic.open(cfg.PLC_Channel)
|
|
|
|
self.net_listen = true
|
|
|
|
send_sv(MGMT_TYPE.ESTABLISH, { comms.version, comms.CONN_TEST_FWV, DEVICE_TYPE.PLC, cfg.UnitID })
|
|
|
|
tcd.dispatch_unique(8, handle_timeout)
|
|
elseif cfg.WiredModem and self.wd_modem then
|
|
-- skip to wired
|
|
util.push_event("conn_test_complete", true)
|
|
else
|
|
self.self_check_msg("> no modem, can't test supervisor connection", false)
|
|
end
|
|
else
|
|
if self.self_check_pass then check_complete() end
|
|
self.run_test_btn.enable()
|
|
end
|
|
end
|
|
|
|
-- exit self check back home
|
|
---@param main_pane MultiPane
|
|
local function exit_self_check(main_pane)
|
|
tcd.abort(handle_timeout)
|
|
self.net_listen = false
|
|
self.run_test_btn.enable()
|
|
self.sc_log.remove_all()
|
|
main_pane.set_value(1)
|
|
end
|
|
|
|
local check = {}
|
|
|
|
-- create the self-check view
|
|
---@param main_pane MultiPane
|
|
---@param settings_cfg plc_config
|
|
---@param check_sys Div
|
|
---@param style { [string]: cpair }
|
|
function check.create(main_pane, settings_cfg, check_sys, style)
|
|
local bw_fg_bg = style.bw_fg_bg
|
|
local g_lg_fg_bg = style.g_lg_fg_bg
|
|
local nav_fg_bg = style.nav_fg_bg
|
|
local btn_act_fg_bg = style.btn_act_fg_bg
|
|
local btn_dis_fg_bg = style.btn_dis_fg_bg
|
|
|
|
self.settings = settings_cfg
|
|
|
|
local sc = Div{parent=check_sys,x=2,y=4,width=49}
|
|
|
|
TextBox{parent=check_sys,x=1,y=2,text=" Reactor PLC Self-Check",fg_bg=bw_fg_bg}
|
|
|
|
self.sc_log = ListBox{parent=sc,x=1,y=1,height=12,width=49,scroll_height=100,fg_bg=bw_fg_bg,nav_fg_bg=g_lg_fg_bg,nav_active=cpair(colors.black,colors.gray)}
|
|
|
|
local last_check = { nil, nil }
|
|
|
|
function self.self_check_msg(msg, success, fail_msg)
|
|
if type(msg) == "string" then
|
|
last_check[1] = Div{parent=self.sc_log,height=1}
|
|
local e = TextBox{parent=last_check[1],text=msg,fg_bg=bw_fg_bg}
|
|
last_check[2] = e.get_x()+string.len(msg)
|
|
end
|
|
|
|
if type(fail_msg) == "string" then
|
|
TextBox{parent=last_check[1],x=last_check[2],y=1,text=tri(success,"PASS","FAIL"),fg_bg=tri(success,cpair(colors.green,colors._INHERIT),cpair(colors.red,colors._INHERIT))}
|
|
|
|
if not success then
|
|
local fail = Div{parent=self.sc_log,height=#util.strwrap(fail_msg, 46)}
|
|
TextBox{parent=fail,x=3,text=fail_msg,fg_bg=cpair(colors.gray,colors.white)}
|
|
end
|
|
|
|
self.self_check_pass = self.self_check_pass and success
|
|
end
|
|
end
|
|
|
|
PushButton{parent=sc,x=1,y=14,text="\x1b Back",callback=function()exit_self_check(main_pane)end,fg_bg=nav_fg_bg,active_fg_bg=btn_act_fg_bg}
|
|
self.run_test_btn = PushButton{parent=sc,x=40,y=14,min_width=10,text="Run Test",callback=function()self_check()end,fg_bg=cpair(colors.black,colors.blue),active_fg_bg=btn_act_fg_bg,dis_fg_bg=btn_dis_fg_bg}
|
|
end
|
|
|
|
-- handle incoming modem messages
|
|
---@param side string
|
|
---@param sender integer
|
|
---@param reply_to integer
|
|
---@param message any
|
|
---@param distance integer
|
|
function check.receive_sv(side, sender, reply_to, message, distance)
|
|
if self.nic ~= nil and self.net_listen then
|
|
local s_pkt = self.nic.receive(side, sender, reply_to, message, distance)
|
|
|
|
if s_pkt and s_pkt.protocol() == PROTOCOL.SCADA_MGMT then
|
|
local pkt = comms.mgmt_packet().decode(s_pkt)
|
|
if pkt then
|
|
tcd.abort(handle_timeout)
|
|
handle_packet(pkt)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
-- handle completed connection tests
|
|
---@param pass boolean
|
|
function check.conn_test_callback(pass)
|
|
local cfg = self.settings
|
|
|
|
if self.checking_wl then
|
|
if not pass then
|
|
self.self_check_msg(nil, false, "make sure your supervisor is running, listening on the wireless interface, your channels are correct, trusted ranges are set properly (if enabled), facility keys match (if set), and if you are using wireless modems rather than ender modems, that your devices are close together in the same dimension")
|
|
end
|
|
|
|
if cfg.WiredModem and self.wd_modem then
|
|
self.checking_wl = false
|
|
self.self_check_msg("> check wired supervisor connection...")
|
|
|
|
comms.set_trusted_range(0)
|
|
|
|
self.nic = network.nic(self.wd_modem)
|
|
|
|
self.nic.closeAll()
|
|
self.nic.open(cfg.PLC_Channel)
|
|
|
|
self.net_listen = true
|
|
|
|
send_sv(MGMT_TYPE.ESTABLISH, { comms.version, comms.CONN_TEST_FWV, DEVICE_TYPE.PLC, cfg.UnitID })
|
|
|
|
tcd.dispatch_unique(8, handle_timeout)
|
|
else
|
|
if self.self_check_pass then check_complete() end
|
|
self.run_test_btn.enable()
|
|
end
|
|
else
|
|
if not pass then
|
|
self.self_check_msg(nil, false, "make sure your supervisor is running, listening on the wired interface, the wire is intact, and your channels are correct")
|
|
end
|
|
|
|
if self.self_check_pass then check_complete() end
|
|
self.run_test_btn.enable()
|
|
end
|
|
end
|
|
|
|
return check
|