reactor plc reorganization and some comms updates

reactor-plc/plc.lua

@@ -1,122 +1,121 @@
---
+function scada_link(comms)
--- Reactor Programmable Logic Controller
+    local linked = false
---
+    local link_timeout = os.startTimer(5)
 
-os.loadAPI("scada-common/util.lua")
+    comms.send_link_req()
-os.loadAPI("scada-common/comms.lua")
+    print_ts("sent link request")
-os.loadAPI("reactor-plc/config.lua")
+    
-os.loadAPI("reactor-plc/safety.lua")
+    repeat
+        local event, p1, p2, p3, p4, p5 = os.pullEvent()
+    
+        -- handle event
+        if event == "timer" and param1 == link_timeout then
+            -- no response yet
+            print("...no response");
+            comms.send_link_req()
+            print_ts("sent link request")
+            link_timeout = os.startTimer(5)
+        elseif event == "modem_message" then
+            -- server response? cancel timeout
+            if link_timeout ~= nil then
+                os.cancelTimer(link_timeout)
+            end
 
-local R_PLC_VERSION = "alpha-v0.1"
+            local packet = comms.make_packet(p1, p2, p3, p4, p5)
 
-local print_ts = util.print_ts
+            -- handle response
-
+            local response = comms.handle_link(packet)
-local reactor = peripheral.find("fissionReactor")
+            if response == nil then
-local modem = peripheral.find("modem")
+                print_ts("invalid link response, bad channel?\n")
-
+                return
-print(">> Reactor PLC " .. R_PLC_VERSION .. " <<")
+            elseif response == true then
-
+                print_ts("...linked!\n")
--- we need a reactor and a modem
+                linked = true
-if reactor == nil then
+            else
-    print("Fission reactor not found, exiting...");
+                print_ts("...denied, exiting\n")
-    return
+                return
-elseif modem == nil then
+            end
-    print("No modem found, disabling reactor and exiting...")
-    reactor.scram()
-    return
-end
-
--- just booting up, no fission allowed (neutrons stay put thanks)
-reactor.scram()
-
--- init internal safety system
-local iss = safety.iss_init(reactor)
-local iss_status = "ok"
-local iss_tripped = false
-
--- read config
-
--- start comms
-if not modem.isOpen(config.LISTEN_PORT) then
-    modem.open(config.LISTEN_PORT)
-end
-
-local comms = comms.rplc_comms(config.REACTOR_ID, modem, config.LISTEN_PORT, config.SERVER_PORT, reactor)
-
--- attempt server connection
-local linked = false
-local link_timeout = os.startTimer(5)
-comms.send_link_req()
-print_ts("sent link request")
-repeat
-    local event, param1, param2, param3, param4, param5 = os.pullEvent()
-   
-    -- handle event
-    if event == "timer" and param1 == link_timeout then
-        -- no response yet
-        print("...no response");
-        comms.send_link_req()
-        print_ts("sent link request")
-        link_timeout = os.startTimer(5)
-    elseif event == "modem_message" then
-        -- server response? cancel timeout
-        if link_timeout ~= nil then
-            os.cancelTimer(link_timeout)
         end
+    until linked
+end
 
-        local packet = {
+-- Internal Safety System
-            side = param1,
+-- identifies dangerous states and SCRAMs reactor if warranted
-            sender = param2,
+-- autonomous from main control
-            reply_to = param3,
+function iss_init(reactor)
-            message = param4,
+    local self = {
-            distance = param5
+        _reactor = reactor,
-        }
+        _tripped = false,
+        _trip_cause = ""
+    }
 
-        -- handle response
+    local check = function ()
-        response = comms.handle_link(packet)
+        local status = "ok"
-        if response == "wrong_type" then
+        
-            print_ts("invalid link response, bad channel?\n")
+        -- check system states in order of severity
-            return
+        if self.damage_critical() then
-        elseif response == true then
+            status = "dmg_crit"
-            print_ts("...linked!\n")
+        elseif self.high_temp() then
-            linked = true
+            status = "high_temp"
+        elseif self.excess_heated_coolant() then
+            status = "heated_coolant_backup"
+        elseif self.excess_waste() then
+            status = "full_waste"
+        elseif self.insufficient_fuel() then
+            status = "no_fuel"
+        elseif self._tripped then
+            status = self._trip_cause
         else
-            print_ts("...denied, exiting\n")
+            self._tripped = false
-            return
         end
-    end
+    
-until linked
+        if status ~= "ok" then
-
+            self._tripped = true
--- comms watchdog, 3 second timeout
+            self._trip_cause = status
-local conn_watchdog = watchdog.new_watchdog(3)
+            self._reactor.scram()
-
--- loop clock (10Hz, 2 ticks)
--- send status updates at 4Hz (every 5 ticks)
-local loop_tick = os.startTimer(0.05)
-local ticks_to_update = 5
-
--- event loop
-while true do
-    local event, param1, param2, param3, param4, param5 = os.pullEvent()
-
-    -- check safety (SCRAM occurs if tripped)
-    iss_status, iss_tripped = iss.check()
-
-    -- handle event
-    if event == "timer" and param1 == loop_tick then
-        -- basic event tick, send updated data if it is time
-        ticks_to_update = ticks_to_update - 1
-        if ticks_to_update == 0 then
-            ticks_to_update = 5
         end
-    elseif event == "modem_message" then
+    
-        -- got a packet
+        return self._tripped, status
-        -- feed the watchdog first so it doesn't eat our packets
-        conn_watchdog.feed()
-
-    elseif event == "timer" and param1 == conn_watchdog.get_timer() then
-        -- haven't heard from server recently? shutdown
-        reactor.scram()
-        print_ts("[alert] server timeout, reactor disabled\n")
     end
+
+    local reset = function ()
+        self._tripped = false
+        self._trip_cause = ""
+    end
+    
+    local damage_critical = function ()
+        return self._reactor.getDamagePercent() >= 100
+    end
+    
+    local excess_heated_coolant = function ()
+        return self._reactor.getHeatedCoolantNeeded() == 0
+    end
+    
+    local excess_waste = function ()
+        return self._reactor.getWasteNeeded() == 0
+    end
+
+    local high_temp = function ()
+        -- mekanism: MAX_DAMAGE_TEMPERATURE = 1_200
+        return self._reactor.getTemperature() >= 1200
+    end
+    
+    local insufficient_fuel = function ()
+        return self._reactor.getFuel() == 0
+    end
+
+    local no_coolant = function()
+        return self._reactor.getCoolantFilledPercentage() < 2
+    end
+
+    return {
+        check = check,
+        reset = reset,
+        damage_critical = damage_critical,
+        excess_heated_coolant = excess_heated_coolant,
+        excess_waste = excess_waste,
+        high_temp = high_temp,
+        insufficient_fuel = insufficient_fuel,
+        no_coolant = no_coolant
+    }
 end

reactor-plc/safety.lua

@@ -1,80 +0,0 @@
--- Internal Safety System
--- identifies dangerous states and SCRAMs reactor if warranted
--- autonomous from main control
-function iss_init(reactor)
-    local self = {
-        _reactor = reactor,
-        _tripped = false,
-        _trip_cause = ""
-    }
-
-    local check = function ()
-        local status = "ok"
-        
-        -- check system states in order of severity
-        if self.damage_critical() then
-            status = "dmg_crit"
-        elseif self.high_temp() then
-            status = "high_temp"
-        elseif self.excess_heated_coolant() then
-            status = "heated_coolant_backup"
-        elseif self.excess_waste() then
-            status = "full_waste"
-        elseif self.insufficient_fuel() then
-            status = "no_fuel"
-        elseif self._tripped then
-            status = self._trip_cause
-        else
-            self._tripped = false
-        end
-    
-        if status ~= "ok" then
-            self._tripped = true
-            self._trip_cause = status
-            self._reactor.scram()
-        end
-    
-        return self._tripped, status
-    end
-
-    local reset = function ()
-        self._tripped = false
-        self._trip_cause = ""
-    end
-    
-    local damage_critical = function ()
-        return self._reactor.getDamagePercent() >= 100
-    end
-    
-    local excess_heated_coolant = function ()
-        return self._reactor.getHeatedCoolantNeeded() == 0
-    end
-    
-    local excess_waste = function ()
-        return self._reactor.getWasteNeeded() == 0
-    end
-
-    local high_temp = function ()
-        -- mekanism: MAX_DAMAGE_TEMPERATURE = 1_200
-        return self._reactor.getTemperature() >= 1200
-    end
-    
-    local insufficient_fuel = function ()
-        return self._reactor.getFuel() == 0
-    end
-
-    local no_coolant = function()
-        return self._reactor.getCoolantFilledPercentage() < 2
-    end
-
-    return {
-        check = check,
-        reset = reset,
-        damage_critical = damage_critical,
-        excess_heated_coolant = excess_heated_coolant,
-        excess_waste = excess_waste,
-        high_temp = high_temp,
-        insufficient_fuel = insufficient_fuel,
-        no_coolant = no_coolant
-    }
-end

reactor-plc/startup.lua

@@ -1,13 +1,78 @@
-print(">>RCASS LOADER START<<")
+--
-print(">>CHECKING SETTINGS...")
+-- Reactor Programmable Logic Controller
-loaded = settings.load("rcass.settings")
+--
-if loaded then
+
-    print(">>SETTINGS FOUND, VERIFIYING INTEGRITY...")
+os.loadAPI("scada-common/util.lua")
-    settings.getNames()
+os.loadAPI("scada-common/comms.lua")
-else
+os.loadAPI("reactor-plc/config.lua")
-    print(">>SETTINGS NOT FOUND")
+os.loadAPI("reactor-plc/plc.lua")
-    print(">>LAUNCHING CONFIGURATOR...")
+
-    shell.run("config")
+local R_PLC_VERSION = "alpha-v0.1"
+
+local print_ts = util.print_ts
+
+local reactor = peripheral.find("fissionReactor")
+local modem = peripheral.find("modem")
+
+print(">> Reactor PLC " .. R_PLC_VERSION .. " <<")
+
+-- we need a reactor and a modem
+if reactor == nil then
+    print("Fission reactor not found, exiting...");
+    return
+elseif modem == nil then
+    print("No modem found, disabling reactor and exiting...")
+    reactor.scram()
+    return
+end
+
+-- just booting up, no fission allowed (neutrons stay put thanks)
+reactor.scram()
+
+-- init internal safety system
+local iss = plc.iss_init(reactor)
+
+-- start comms
+if not modem.isOpen(config.LISTEN_PORT) then
+    modem.open(config.LISTEN_PORT)
+end
+
+local comms = comms.rplc_comms(config.REACTOR_ID, modem, config.LISTEN_PORT, config.SERVER_PORT, reactor)
+
+-- attempt server connection
+-- exits application if connection is denied
+plc.scada_link(comms)
+
+-- comms watchdog, 3 second timeout
+local conn_watchdog = watchdog.new_watchdog(3)
+
+-- loop clock (10Hz, 2 ticks)
+-- send status updates at 4Hz (every 5 ticks)
+local loop_tick = os.startTimer(0.05)
+local ticks_to_update = 5
+
+-- event loop
+while true do
+    local event, param1, param2, param3, param4, param5 = os.pullEvent()
+
+    -- check safety (SCRAM occurs if tripped)
+    local iss_status, iss_tripped = iss.check()
+
+    -- handle event
+    if event == "timer" and param1 == loop_tick then
+        -- basic event tick, send updated data if it is time
+        ticks_to_update = ticks_to_update - 1
+        if ticks_to_update == 0 then
+            ticks_to_update = 5
+        end
+    elseif event == "modem_message" then
+        -- got a packet
+        -- feed the watchdog first so it doesn't eat our packets
+        conn_watchdog.feed()
+
+    elseif event == "timer" and param1 == conn_watchdog.get_timer() then
+        -- haven't heard from server recently? shutdown
+        reactor.scram()
+        print_ts("[alert] server timeout, reactor disabled\n")
+    end
 end
-print(">>LAUNCHING RCASS...")
-shell.run("rcass")

scada-common/comms.lua

@@ -88,11 +88,7 @@ function rplc_comms(id, modem, local_port, server_port, reactor)
         _server = server_port,
         _local = local_port,
         _reactor = reactor,
-        _status_cache = nil,
+        _status_cache = nil
-        
-        _send = function (msg)
-            self._modem.transmit(self._server, self._local, msg)
-        end
     }
 
     local _send = function (msg)
@@ -209,7 +205,7 @@ function rplc_comms(id, modem, local_port, server_port, reactor)
         if packet.type == "link_response" then
             return packet.accepted
         else
-            return "wrong_type"
+            return nil
         end
     end