local comms = require("scada-common.comms") local log = require("scada-common.log") local types = require("scada-common.types") local unit_session = require("supervisor.session.rtu.unit_session") local sna = {} local RTU_UNIT_TYPES = comms.RTU_UNIT_TYPES local MODBUS_FCODE = types.MODBUS_FCODE local TXN_TYPES = { BUILD = 1, STATE = 2, TANKS = 3 } local TXN_TAGS = { "sna.build", "sna.state", "sna.tanks", } local PERIODICS = { BUILD = 1000, STATE = 500, TANKS = 1000 } -- create a new sna rtu session runner ---@param session_id integer ---@param unit_id integer ---@param advert rtu_advertisement ---@param out_queue mqueue function sna.new(session_id, unit_id, advert, out_queue) -- type check if advert.type ~= RTU_UNIT_TYPES.SNA then log.error("attempt to instantiate sna RTU for type '" .. advert.type .. "'. this is a bug.") return nil end local log_tag = "session.rtu(" .. session_id .. ").sna(" .. advert.index .. "): " local self = { session = unit_session.new(unit_id, advert, out_queue, log_tag, TXN_TAGS), has_build = false, periodics = { next_build_req = 0, next_state_req = 0, next_tanks_req = 0, }, ---@class sna_session_db db = { build = { input_cap = 0, output_cap = 0 }, state = { production_rate = 0.0, peak_production = 0.0 }, tanks = { input = {}, ---@type tank_fluid input_need = 0, input_fill = 0.0, output = {}, ---@type tank_fluid output_need = 0, output_fill = 0.0 } } } local public = self.session.get() -- PRIVATE FUNCTIONS -- -- query the build of the device local function _request_build() -- read input registers 1 through 2 (start = 1, count = 2) self.session.send_request(TXN_TYPES.BUILD, MODBUS_FCODE.READ_INPUT_REGS, { 1, 2 }) end -- query the state of the device local function _request_state() -- read input registers 3 through 4 (start = 3, count = 2) self.session.send_request(TXN_TYPES.STATE, MODBUS_FCODE.READ_INPUT_REGS, { 3, 2 }) end -- query the tanks of the device local function _request_tanks() -- read input registers 5 through 10 (start = 5, count = 6) self.session.send_request(TXN_TYPES.TANKS, MODBUS_FCODE.READ_INPUT_REGS, { 5, 6 }) end -- PUBLIC FUNCTIONS -- -- handle a packet ---@param m_pkt modbus_frame function public.handle_packet(m_pkt) local txn_type = self.session.try_resolve(m_pkt.txn_id) if txn_type == false then -- nothing to do elseif txn_type == TXN_TYPES.BUILD then -- build response -- load in data if correct length if m_pkt.length == 2 then self.db.build.input_cap = m_pkt.data[1] self.db.build.output_cap = m_pkt.data[2] self.has_build = true else log.debug(log_tag .. "MODBUS transaction reply length mismatch (" .. TXN_TAGS[txn_type] .. ")") end elseif txn_type == TXN_TYPES.STATE then -- state response -- load in data if correct length if m_pkt.length == 2 then self.db.state.production_rate = m_pkt.data[1] self.db.state.peak_production = m_pkt.data[2] else log.debug(log_tag .. "MODBUS transaction reply length mismatch (" .. TXN_TAGS[txn_type] .. ")") end elseif txn_type == TXN_TYPES.TANKS then -- tanks response -- load in data if correct length if m_pkt.length == 6 then self.db.tanks.input = m_pkt.data[1] self.db.tanks.input_need = m_pkt.data[2] self.db.tanks.input_fill = m_pkt.data[3] self.db.tanks.output = m_pkt.data[4] self.db.tanks.output_need = m_pkt.data[5] self.db.tanks.output_fill = m_pkt.data[6] else log.debug(log_tag .. "MODBUS transaction reply length mismatch (" .. TXN_TAGS[txn_type] .. ")") end elseif txn_type == nil then log.error(log_tag .. "unknown transaction reply") else log.error(log_tag .. "unknown transaction type " .. txn_type) end end -- update this runner ---@param time_now integer milliseconds function public.update(time_now) if not self.has_build and self.periodics.next_build_req <= time_now then _request_build() self.periodics.next_build_req = time_now + PERIODICS.BUILD end if self.periodics.next_state_req <= time_now then _request_state() self.periodics.next_state_req = time_now + PERIODICS.STATE end if self.periodics.next_tanks_req <= time_now then _request_tanks() self.periodics.next_tanks_req = time_now + PERIODICS.TANKS end self.session.post_update() end -- get the unit session database function public.get_db() return self.db end return public end return sna