#51 WIP network interface controller

coordinator/coordinator.lua

@@ -212,13 +212,13 @@ end
 -- coordinator communications
 ---@nodiscard
 ---@param version string coordinator version
----@param modem table modem device
+---@param nic nic network interface device
 ---@param crd_channel integer port of configured supervisor
 ---@param svr_channel integer listening port for supervisor replys
 ---@param pkt_channel integer listening port for pocket API
 ---@param range integer trusted device connection range
 ---@param sv_watchdog watchdog
-function coordinator.comms(version, modem, crd_channel, svr_channel, pkt_channel, range, sv_watchdog)
+function coordinator.comms(version, nic, crd_channel, svr_channel, pkt_channel, range, sv_watchdog)
     local self = {
         sv_linked = false,
         sv_addr = comms.BROADCAST,
@@ -234,16 +234,12 @@ function coordinator.comms(version, modem, crd_channel, svr_channel, pkt_channel
 
     -- PRIVATE FUNCTIONS --
 
-    -- configure modem channels
-    local function _conf_channels()
-        modem.closeAll()
-        modem.open(crd_channel)
-    end
+    -- configure network channels
+    nic.closeAll()
+    nic.open(crd_channel)
 
-    _conf_channels()
-
-    -- link modem to apisessions
-    apisessions.init(modem)
+    -- link nic to apisessions
+    apisessions.init(nic)
 
     -- send a packet to the supervisor
     ---@param msg_type SCADA_MGMT_TYPE|SCADA_CRDN_TYPE
@@ -263,7 +259,7 @@ function coordinator.comms(version, modem, crd_channel, svr_channel, pkt_channel
         pkt.make(msg_type, msg)
         s_pkt.make(self.sv_addr, self.sv_seq_num, protocol, pkt.raw_sendable())
 
-        modem.transmit(svr_channel, crd_channel, s_pkt.raw_sendable())
+        nic.transmit(svr_channel, crd_channel, s_pkt)
         self.sv_seq_num = self.sv_seq_num + 1
     end
 
@@ -277,7 +273,7 @@ function coordinator.comms(version, modem, crd_channel, svr_channel, pkt_channel
         m_pkt.make(SCADA_MGMT_TYPE.ESTABLISH, { ack })
         s_pkt.make(packet.src_addr(), packet.seq_num() + 1, PROTOCOL.SCADA_MGMT, m_pkt.raw_sendable())
 
-        modem.transmit(pkt_channel, crd_channel, s_pkt.raw_sendable())
+        nic.transmit(pkt_channel, crd_channel, s_pkt)
         self.last_api_est_acks[packet.src_addr()] = ack
     end
 
@@ -297,14 +293,6 @@ function coordinator.comms(version, modem, crd_channel, svr_channel, pkt_channel
     ---@class coord_comms
     local public = {}
 
-    -- reconnect a newly connected modem
-    ---@param new_modem table
-    function public.reconnect_modem(new_modem)
-        modem = new_modem
-        apisessions.relink_modem(new_modem)
-        _conf_channels()
-    end
-
     -- close the connection to the server
     function public.close()
         sv_watchdog.cancel()

coordinator/session/apisessions.lua

@@ -10,7 +10,7 @@ local pocket = require("coordinator.session.pocket")
 local apisessions = {}
 
 local self = {
-    modem = nil,
+    nic = nil,
     next_id = 0,
     sessions = {}
 }
@@ -31,7 +31,7 @@ local function _api_handle_outq(session)
         if msg ~= nil then
             if msg.qtype == mqueue.TYPE.PACKET then
                 -- handle a packet to be sent
-                self.modem.transmit(config.PKT_CHANNEL, config.CRD_CHANNEL, msg.message.raw_sendable())
+                self.nic.transmit(config.PKT_CHANNEL, config.CRD_CHANNEL, msg.message)
             elseif msg.qtype == mqueue.TYPE.COMMAND then
                 -- handle instruction/notification
             elseif msg.qtype == mqueue.TYPE.DATA then
@@ -58,7 +58,7 @@ local function _shutdown(session)
     while session.out_queue.ready() do
         local msg = session.out_queue.pop()
         if msg ~= nil and msg.qtype == mqueue.TYPE.PACKET then
-            self.modem.transmit(config.PKT_CHANNEL, config.CRD_CHANNEL, msg.message.raw_sendable())
+            self.nic.transmit(config.PKT_CHANNEL, config.CRD_CHANNEL, msg.message)
         end
     end
 
@@ -68,15 +68,9 @@ end
 -- PUBLIC FUNCTIONS --
 
 -- initialize apisessions
----@param modem table
-function apisessions.init(modem)
-    self.modem = modem
-end
-
--- re-link the modem
----@param modem table
-function apisessions.relink_modem(modem)
-    self.modem = modem
+---@param nic nic
+function apisessions.init(nic)
+    self.nic = nic
 end
 
 -- find a session by remote port

coordinator/startup.lua

@@ -6,6 +6,7 @@ require("/initenv").init_env()
 
 local crash       = require("scada-common.crash")
 local log         = require("scada-common.log")
+local network     = require("scada-common.network")
 local ppm         = require("scada-common.ppm")
 local tcd         = require("scada-common.tcd")
 local util        = require("scada-common.util")
@@ -20,7 +21,7 @@ local sounder     = require("coordinator.sounder")
 
 local apisessions = require("coordinator.session.apisessions")
 
-local COORDINATOR_VERSION = "v0.16.1"
+local COORDINATOR_VERSION = "v0.17.0"
 
 local println = util.println
 local println_ts = util.println_ts
@@ -147,8 +148,9 @@ local function main()
     conn_watchdog.cancel()
     log.debug("startup> conn watchdog created")
 
-    -- start comms, open all channels
-    local coord_comms = coordinator.comms(COORDINATOR_VERSION, modem, config.CRD_CHANNEL, config.SVR_CHANNEL,
+    -- init network interface then start comms
+    local nic = network.nic(modem)
+    local coord_comms = coordinator.comms(COORDINATOR_VERSION, nic, config.CRD_CHANNEL, config.SVR_CHANNEL,
                                             config.PKT_CHANNEL, config.TRUSTED_RANGE, conn_watchdog)
     log.debug("startup> comms init")
     log_comms("comms initialized")
@@ -218,8 +220,6 @@ local function main()
 
     local date_format = util.trinary(config.TIME_24_HOUR, "%X \x04 %A, %B %d %Y", "%r \x04 %A, %B %d %Y")
 
-    local no_modem = false
-
     if ui_ok then
         -- start connection watchdog
         conn_watchdog.feed()
@@ -239,8 +239,9 @@ local function main()
             if type ~= nil and device ~= nil then
                 if type == "modem" then
                     -- we only really care if this is our wireless modem
-                    if device == modem then
-                        no_modem = true
+                    -- if it is another modem, handle other peripheral losses separately
+                    if nic.is_modem(device) then
+                        nic.disconnect()
                         log_sys("comms modem disconnected")
                         println_ts("wireless modem disconnected!")
 
@@ -254,6 +255,7 @@ local function main()
                     end
                 elseif type == "monitor" then
                     if renderer.is_monitor_used(device) then
+                        ---@todo will be handled properly in #249
                         -- "halt and catch fire" style handling
                         local msg = "lost a configured monitor, system will now exit"
                         println_ts(msg)
@@ -275,9 +277,7 @@ local function main()
                 if type == "modem" then
                     if device.isWireless() then
                         -- reconnected modem
-                        no_modem = false
-                        modem = device
-                        coord_comms.reconnect_modem(modem)
+                        nic.connect(device)
 
                         log_sys("comms modem reconnected")
                         println_ts("wireless modem reconnected.")
@@ -289,6 +289,7 @@ local function main()
                         log_sys("wired modem reconnected")
                     end
                 -- elseif type == "monitor" then
+                    ---@todo will be handled properly in #249
                     -- not supported, system will exit on loss of in-use monitors
                 elseif type == "speaker" then
                     local msg = "alarm sounder speaker reconnected"
@@ -322,7 +323,7 @@ local function main()
                 renderer.close_ui()
                 sounder.stop()
 
-                if not no_modem then
+                if nic.connected() then
                     -- try to re-connect to the supervisor
                     if not init_connect_sv() then break end
                     ui_ok = init_start_ui()
@@ -350,7 +351,7 @@ local function main()
                 renderer.close_ui()
                 sounder.stop()
 
-                if not no_modem then
+                if nic.connected() then
                     -- try to re-connect to the supervisor
                     if not init_connect_sv() then break end
                     ui_ok = init_start_ui()