From 5597ea2097aee7bee8e87f5bedd4d33da8f75c89 Mon Sep 17 00:00:00 2001 From: Mikayla Date: Fri, 16 Aug 2024 19:53:43 +0000 Subject: [PATCH] comment updates for clarity around RTU gateway vs RTU --- supervisor/session/rtu/boilerv.lua | 6 +++--- supervisor/session/rtu/dynamicv.lua | 6 +++--- supervisor/session/rtu/envd.lua | 8 ++++---- supervisor/session/rtu/imatrix.lua | 6 +++--- supervisor/session/rtu/redstone.lua | 8 ++++---- supervisor/session/rtu/sna.lua | 6 +++--- supervisor/session/rtu/sps.lua | 6 +++--- supervisor/session/rtu/turbinev.lua | 6 +++--- supervisor/session/rtu/unit_session.lua | 4 ++-- 9 files changed, 28 insertions(+), 28 deletions(-) diff --git a/supervisor/session/rtu/boilerv.lua b/supervisor/session/rtu/boilerv.lua index 33759f2..26a8f2d 100644 --- a/supervisor/session/rtu/boilerv.lua +++ b/supervisor/session/rtu/boilerv.lua @@ -32,10 +32,10 @@ local PERIODICS = { -- create a new boilerv rtu session runner ---@nodiscard ----@param session_id integer RTU session ID ----@param unit_id integer RTU unit ID +---@param session_id integer RTU gateway session ID +---@param unit_id integer RTU ID ---@param advert rtu_advertisement RTU advertisement table ----@param out_queue mqueue RTU unit message out queue +---@param out_queue mqueue RTU message out queue function boilerv.new(session_id, unit_id, advert, out_queue) -- checks if advert.type ~= RTU_UNIT_TYPE.BOILER_VALVE then diff --git a/supervisor/session/rtu/dynamicv.lua b/supervisor/session/rtu/dynamicv.lua index b1e5b4a..13239a7 100644 --- a/supervisor/session/rtu/dynamicv.lua +++ b/supervisor/session/rtu/dynamicv.lua @@ -44,10 +44,10 @@ local PERIODICS = { -- create a new dynamicv rtu session runner ---@nodiscard ----@param session_id integer RTU session ID ----@param unit_id integer RTU unit ID +---@param session_id integer RTU gateway session ID +---@param unit_id integer RTU ID ---@param advert rtu_advertisement RTU advertisement table ----@param out_queue mqueue RTU unit message out queue +---@param out_queue mqueue RTU message out queue function dynamicv.new(session_id, unit_id, advert, out_queue) -- checks if advert.type ~= RTU_UNIT_TYPE.DYNAMIC_VALVE then diff --git a/supervisor/session/rtu/envd.lua b/supervisor/session/rtu/envd.lua index 8eacf1d..046ef0a 100644 --- a/supervisor/session/rtu/envd.lua +++ b/supervisor/session/rtu/envd.lua @@ -23,10 +23,10 @@ local PERIODICS = { -- create a new environment detector rtu session runner ---@nodiscard ----@param session_id integer ----@param unit_id integer ----@param advert rtu_advertisement ----@param out_queue mqueue +---@param session_id integer RTU gateway session ID +---@param unit_id integer RTU ID +---@param advert rtu_advertisement RTU advertisement table +---@param out_queue mqueue RTU message out queue function envd.new(session_id, unit_id, advert, out_queue) -- checks if advert.type ~= RTU_UNIT_TYPE.ENV_DETECTOR then diff --git a/supervisor/session/rtu/imatrix.lua b/supervisor/session/rtu/imatrix.lua index 5a6880e..84bfc1e 100644 --- a/supervisor/session/rtu/imatrix.lua +++ b/supervisor/session/rtu/imatrix.lua @@ -32,10 +32,10 @@ local PERIODICS = { -- create a new imatrix rtu session runner ---@nodiscard ----@param session_id integer RTU session ID ----@param unit_id integer RTU unit ID +---@param session_id integer RTU gateway session ID +---@param unit_id integer RTU ID ---@param advert rtu_advertisement RTU advertisement table ----@param out_queue mqueue RTU unit message out queue +---@param out_queue mqueue RTU message out queue function imatrix.new(session_id, unit_id, advert, out_queue) -- checks if advert.type ~= RTU_UNIT_TYPE.IMATRIX then diff --git a/supervisor/session/rtu/redstone.lua b/supervisor/session/rtu/redstone.lua index b248902..b99c0d9 100644 --- a/supervisor/session/rtu/redstone.lua +++ b/supervisor/session/rtu/redstone.lua @@ -45,10 +45,10 @@ local PERIODICS = { -- create a new redstone rtu session runner ---@nodiscard ----@param session_id integer ----@param unit_id integer ----@param advert rtu_advertisement ----@param out_queue mqueue +---@param session_id integer RTU gateway session ID +---@param unit_id integer RTU ID +---@param advert rtu_advertisement RTU advertisement table +---@param out_queue mqueue RTU message out queue function redstone.new(session_id, unit_id, advert, out_queue) -- type check if advert.type ~= RTU_UNIT_TYPE.REDSTONE then diff --git a/supervisor/session/rtu/sna.lua b/supervisor/session/rtu/sna.lua index 39ab1d0..a75e185 100644 --- a/supervisor/session/rtu/sna.lua +++ b/supervisor/session/rtu/sna.lua @@ -29,10 +29,10 @@ local PERIODICS = { -- create a new sna rtu session runner ---@nodiscard ----@param session_id integer RTU session ID ----@param unit_id integer RTU unit ID +---@param session_id integer RTU gateway session ID +---@param unit_id integer RTU ID ---@param advert rtu_advertisement RTU advertisement table ----@param out_queue mqueue RTU unit message out queue +---@param out_queue mqueue RTU message out queue function sna.new(session_id, unit_id, advert, out_queue) -- type check if advert.type ~= RTU_UNIT_TYPE.SNA then diff --git a/supervisor/session/rtu/sps.lua b/supervisor/session/rtu/sps.lua index 3143658..a631e58 100644 --- a/supervisor/session/rtu/sps.lua +++ b/supervisor/session/rtu/sps.lua @@ -32,10 +32,10 @@ local PERIODICS = { -- create a new sps rtu session runner ---@nodiscard ----@param session_id integer RTU session ID ----@param unit_id integer RTU unit ID +---@param session_id integer RTU gateway session ID +---@param unit_id integer RTU ID ---@param advert rtu_advertisement RTU advertisement table ----@param out_queue mqueue RTU unit message out queue +---@param out_queue mqueue RTU message out queue function sps.new(session_id, unit_id, advert, out_queue) -- type check if advert.type ~= RTU_UNIT_TYPE.SPS then diff --git a/supervisor/session/rtu/turbinev.lua b/supervisor/session/rtu/turbinev.lua index e6c08f5..4541e56 100644 --- a/supervisor/session/rtu/turbinev.lua +++ b/supervisor/session/rtu/turbinev.lua @@ -44,10 +44,10 @@ local PERIODICS = { -- create a new turbinev rtu session runner ---@nodiscard ----@param session_id integer RTU session ID ----@param unit_id integer RTU unit ID +---@param session_id integer RTU gateway session ID +---@param unit_id integer RTU ID ---@param advert rtu_advertisement RTU advertisement table ----@param out_queue mqueue RTU unit message out queue +---@param out_queue mqueue RTU message out queue function turbinev.new(session_id, unit_id, advert, out_queue) -- checks if advert.type ~= RTU_UNIT_TYPE.TURBINE_VALVE then diff --git a/supervisor/session/rtu/unit_session.lua b/supervisor/session/rtu/unit_session.lua index 0a2964a..18ac1c9 100644 --- a/supervisor/session/rtu/unit_session.lua +++ b/supervisor/session/rtu/unit_session.lua @@ -24,7 +24,7 @@ unit_session.RTU_US_DATA = RTU_US_DATA -- create a new unit session runner ---@nodiscard ----@param session_id integer RTU session ID +---@param session_id integer RTU gateway session ID ---@param unit_id integer MODBUS unit ID ---@param advert rtu_advertisement RTU advertisement for this unit ---@param out_queue mqueue send queue @@ -144,7 +144,7 @@ function unit_session.new(session_id, unit_id, advert, out_queue, log_tag, txn_t -- PUBLIC FUNCTIONS -- - -- get the unit ID + -- get the RTU gateway session ID ---@nodiscard function public.get_session_id() return session_id end -- get the unit ID