cc-mek-scada/supervisor/session/rsctl.lua

--
-- Redstone RTU Session I/O Controller
--

local rsio = require("scada-common.rsio")

local rsctl = {}

-- create a new redstone RTU I/O controller
---@nodiscard
---@param redstone_rtus redstone_session[] redstone RTU sessions
---@param bank integer I/O bank (unit/facility assignment) to interface with
function rsctl.new(redstone_rtus, bank)
    ---@class rs_controller
    local public = {}

    -- check if a redstone port has available connections
    ---@param port IO_PORT
    ---@return boolean
    function public.is_connected(port)
        for i = 1, #redstone_rtus do
            if redstone_rtus[i].get_db().io[bank][port] ~= nil then return true end
        end

        return false
    end

    -- write to a digital redstone port (applies to all RTUs)
    ---@param port IO_PORT
    ---@param value boolean
    function public.digital_write(port, value)
        for i = 1, #redstone_rtus do
            local io = redstone_rtus[i].get_db().io[bank][port]
            if io ~= nil then io.write(value) end
        end
    end

    -- read a digital redstone port<br>
    -- this will read from the first one encountered if there are multiple, because there should not be multiple
    ---@param port IO_PORT
    ---@return boolean|nil
    function public.digital_read(port)
        for i = 1, #redstone_rtus do
            local io = redstone_rtus[i].get_db().io[bank][port]
            if io ~= nil then return io.read() --[[@as boolean|nil]] end
        end
    end

    -- write to an analog redstone port (applies to all RTUs)
    ---@param port IO_PORT
    ---@param value number value
    ---@param min number minimum value for scaling 0 to 15
    ---@param max number maximum value for scaling 0 to 15
    function public.analog_write(port, value, min, max)
        for i = 1, #redstone_rtus do
            local io = redstone_rtus[i].get_db().io[bank][port]
            if io ~= nil then io.write(rsio.analog_write(value, min, max)) end
        end
    end

    return public
end

return rsctl