From 7d39136764c894cb4adc3f0726f1df5eb6a4926b Mon Sep 17 00:00:00 2001 From: SmallJoker <SmallJoker@users.noreply.github.com> Date: Tue, 25 Oct 2022 18:03:51 +0200 Subject: [PATCH] Chainsaw: Partial rewrite, various improvements (#607) --- technic/machines/switching_station.lua | 491 +++++++++++++++++++++++++++++++++++++++--------------- 1 files changed, 356 insertions(+), 135 deletions(-) diff --git a/technic/machines/switching_station.lua b/technic/machines/switching_station.lua index de9b4aa..84d9a43 100644 --- a/technic/machines/switching_station.lua +++ b/technic/machines/switching_station.lua @@ -1,120 +1,161 @@ --- SWITCHING STATION --- The switching station is the center of all power distribution on an electric network. --- The station will collect all produced power from producers (PR) and batteries (BA) --- and distribute it to receivers (RE) and depleted batteries (BA). --- --- It works like this: --- All PR,BA,RE nodes are indexed and tagged with the switching station. --- The tagging is to allow more stations to be built without allowing a cheat --- with duplicating power. --- All the RE nodes are queried for their current EU demand. Those which are off --- would require no or a small standby EU demand, while those which are on would --- require more. --- If the total demand is less than the available power they are all updated with the --- demand number. --- If any surplus exists from the PR nodes the batteries will be charged evenly with this. --- If the total demand requires draw on the batteries they will be discharged evenly. --- --- If the total demand is more than the available power all RE nodes will be shut down. --- We have a brown-out situation. --- --- Hence all the power distribution logic resides in this single node. --- --- Nodes connected to the network will have one or more of these parameters as meta data: --- <LV|MV|HV>_EU_supply : Exists for PR and BA node types. This is the EU value supplied by the node. Output --- <LV|MV|HV>_EU_demand : Exists for RE and BA node types. This is the EU value the node requires to run. Output --- <LV|MV|HV>_EU_input : Exists for RE and BA node types. This is the actual EU value the network can give the node. Input --- --- The reason the LV|MV|HV type is prepended toe meta data is because some machine could require several supplies to work. --- This way the supplies are separated per network. -technic.DBG = 1 -local dprint = technic.dprint +-- See also technic/doc/api.md + +technic.networks = {} +technic.cables = {} +technic.redundant_warn = {} + +local mesecons_path = minetest.get_modpath("mesecons") +local digilines_path = minetest.get_modpath("digilines") + +local S = technic.getter + +local cable_entry = "^technic_cable_connection_overlay.png" minetest.register_craft({ output = "technic:switching_station", recipe = { - {"default:steel_ingot", "technic:lv_transformer", "default:steel_ingot"}, - {"default:copper_ingot", "technic:lv_cable0", "default:copper_ingot"}, - {"default:steel_ingot", "technic:lv_cable0", "default:steel_ingot"} + {"", "technic:lv_transformer", ""}, + {"default:copper_ingot", "technic:machine_casing", "default:copper_ingot"}, + {"technic:lv_cable", "technic:lv_cable", "technic:lv_cable"} } }) +local mesecon_def +if mesecons_path then + mesecon_def = {effector = { + rules = mesecon.rules.default, + }} +end + minetest.register_node("technic:switching_station",{ - description = "Switching Station", - tiles = {"technic_water_mill_top_active.png", "technic_water_mill_top_active.png", - "technic_water_mill_top_active.png", "technic_water_mill_top_active.png", - "technic_water_mill_top_active.png", "technic_water_mill_top_active.png"}, - groups = {snappy=2, choppy=2, oddly_breakable_by_hand=2}, + description = S("Switching Station"), + tiles = { + "technic_water_mill_top_active.png", + "technic_water_mill_top_active.png"..cable_entry, + "technic_water_mill_top_active.png", + "technic_water_mill_top_active.png", + "technic_water_mill_top_active.png", + "technic_water_mill_top_active.png"}, + groups = {snappy=2, choppy=2, oddly_breakable_by_hand=2, technic_all_tiers=1}, + connect_sides = {"bottom"}, sounds = default.node_sound_wood_defaults(), - drawtype = "nodebox", - paramtype = "light", - node_box = { - type = "fixed", - fixed = {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5}, - }, on_construct = function(pos) local meta = minetest.get_meta(pos) - meta:set_string("infotext", "Switching Station") + meta:set_string("infotext", S("Switching Station")) + meta:set_string("active", 1) + meta:set_string("channel", "switching_station"..minetest.pos_to_string(pos)) + meta:set_string("formspec", "field[channel;Channel;${channel}]") + technic.redundant_warn.poshash = nil end, + after_dig_node = function(pos) + minetest.forceload_free_block(pos) + pos.y = pos.y - 1 + minetest.forceload_free_block(pos) + technic.redundant_warn.poshash = nil + end, + on_receive_fields = function(pos, formname, fields, sender) + if not fields.channel then + return + end + local plname = sender:get_player_name() + if minetest.is_protected(pos, plname) then + minetest.record_protection_violation(pos, plname) + return + end + local meta = minetest.get_meta(pos) + meta:set_string("channel", fields.channel) + end, + mesecons = mesecon_def, + digiline = { + receptor = {action = function() end}, + effector = { + action = function(pos, node, channel, msg) + if msg ~= "GET" and msg ~= "get" then + return + end + local meta = minetest.get_meta(pos) + if channel ~= meta:get_string("channel") then + return + end + digilines.receptor_send(pos, digilines.rules.default, channel, { + supply = meta:get_int("supply"), + demand = meta:get_int("demand") + }) + end + }, + }, }) - --------------------------------------------------- --- Functions to help the machines on the electrical network --------------------------------------------------- --- This one provides a timeout for a node in case it was disconnected from the network --- A node must be touched by the station continuously in order to function -function technic.switching_station_timeout_count(pos, tier) - local meta = minetest.get_meta(pos) - timeout = meta:get_int(tier.."_EU_timeout") - if timeout == 0 then - meta:set_int(tier.."_EU_input", 0) - else - meta:set_int(tier.."_EU_timeout", timeout - 1) - end -end -------------------------------------------------- -- Functions to traverse the electrical network -------------------------------------------------- +local function flatten(map) + local list = {} + for key, value in pairs(map) do + list[#list + 1] = value + end + return list +end -- Add a wire node to the LV/MV/HV network -local add_new_cable_node = function(nodes, pos) - -- Ignore if the node has already been added - for i = 1, #nodes do - if pos.x == nodes[i].x and - pos.y == nodes[i].y and - pos.z == nodes[i].z then - return false - end +-- Returns: indicator whether the cable is new in the network +local hash_node_position = minetest.hash_node_position +local function add_network_node(nodes, pos, network_id) + local node_id = hash_node_position(pos) + technic.cables[node_id] = network_id + if nodes[node_id] then + return false end - table.insert(nodes, {x=pos.x, y=pos.y, z=pos.z, visited=1}) + nodes[node_id] = pos return true end --- Generic function to add found connected nodes to the right classification array -local check_node_subp = function(PR_nodes, RE_nodes, BA_nodes, all_nodes, pos, machines, tier) - local meta = minetest.get_meta(pos) - local name = minetest.get_node(pos).name - - if technic.is_tier_cable(name, tier) then - add_new_cable_node(all_nodes, pos) - elseif machines[name] then - --dprint(name.." is a "..machines[name]) - if machines[name] == technic.producer then - add_new_cable_node(PR_nodes, pos) - elseif machines[name] == technic.receiver then - add_new_cable_node(RE_nodes, pos) - elseif machines[name] == technic.battery then - add_new_cable_node(BA_nodes, pos) - end - - meta:set_int(tier.."_EU_timeout", 2) -- Touch node +local function add_cable_node(nodes, pos, network_id, queue) + if add_network_node(nodes, pos, network_id) then + queue[#queue + 1] = pos end end +-- Generic function to add found connected nodes to the right classification array +local check_node_subp = function(network, pos, machines, sw_pos, from_below, network_id, queue) + technic.get_or_load_node(pos) + local name = minetest.get_node(pos).name + + if technic.is_tier_cable(name, network.tier) then + add_cable_node(network.all_nodes, pos, network_id, queue) + return + end + + local eu_type = machines[name] + if not eu_type then + return + end + + --dprint(name.." is a "..machines[name]) + local meta = minetest.get_meta(pos) + meta:set_string(network.tier.."_network", minetest.pos_to_string(sw_pos)) + + if eu_type == technic.producer then + add_network_node(network.PR_nodes, pos, network_id) + elseif eu_type == technic.receiver then + add_network_node(network.RE_nodes, pos, network_id) + elseif eu_type == technic.producer_receiver then + add_network_node(network.PR_nodes, pos, network_id) + add_network_node(network.RE_nodes, pos, network_id) + elseif eu_type == technic.battery then + add_network_node(network.BA_nodes, pos, network_id) + elseif eu_type == "SPECIAL" and from_below and + not vector.equals(pos, sw_pos) then + -- Another switching station -> disable it + add_network_node(network.SP_nodes, pos, network_id) + meta:set_int("active", 0) + end + + meta:set_int(network.tier.."_EU_timeout", 2) -- Touch node +end + -- Traverse a network given a list of machines and a cable type name -local traverse_network = function(PR_nodes, RE_nodes, BA_nodes, all_nodes, i, machines, tier) - local pos = all_nodes[i] +local traverse_network = function(network, pos, machines, sw_pos, network_id, queue) local positions = { {x=pos.x+1, y=pos.y, z=pos.z}, {x=pos.x-1, y=pos.y, z=pos.z}, @@ -122,61 +163,173 @@ {x=pos.x, y=pos.y-1, z=pos.z}, {x=pos.x, y=pos.y, z=pos.z+1}, {x=pos.x, y=pos.y, z=pos.z-1}} - --print("ON") for i, cur_pos in pairs(positions) do - check_node_subp(PR_nodes, RE_nodes, BA_nodes, all_nodes, cur_pos, machines, tier) + check_node_subp(network, cur_pos, machines, sw_pos, i == 3, network_id, queue) end +end + +local touch_nodes = function(list, tier) + for _, pos in ipairs(list) do + local meta = minetest.get_meta(pos) + meta:set_int(tier.."_EU_timeout", 2) -- Touch node + end +end + +local get_network = function(sw_pos, cable_pos, tier) + local network_id = minetest.hash_node_position(cable_pos) + local cached = technic.networks[network_id] + if cached and cached.tier == tier then + -- Re-use cached system data + touch_nodes(cached.PR_nodes, tier) + touch_nodes(cached.BA_nodes, tier) + touch_nodes(cached.RE_nodes, tier) + for _, pos in ipairs(cached.SP_nodes) do + -- Disable all other switching stations (again) + local meta = minetest.get_meta(pos) + meta:set_int("active", 0) + end + return cached.PR_nodes, cached.BA_nodes, cached.RE_nodes + end + + local machines = technic.machines[tier] + local network = { + tier = tier, + PR_nodes = {}, + BA_nodes = {}, + RE_nodes = {}, + SP_nodes = {}, + all_nodes = {} + } + -- Traverse the network step by step starting from the node underneath the switching station + local queue = {} + add_cable_node(network.all_nodes, cable_pos, network_id, queue) + while next(queue) do + local to_visit = {} + for _, pos in ipairs(queue) do + traverse_network(network, pos, machines, sw_pos, network_id, to_visit) + end + queue = to_visit + end + + -- Convert { [hash] = pos, ... } to { pos, ... } + network.PR_nodes = flatten(network.PR_nodes) + network.BA_nodes = flatten(network.BA_nodes) + network.RE_nodes = flatten(network.RE_nodes) + network.SP_nodes = flatten(network.SP_nodes) + network.all_nodes = flatten(network.all_nodes) + technic.networks[network_id] = network + + return network.PR_nodes, network.BA_nodes, network.RE_nodes end ----------------------------------------------- -- The action code for the switching station -- ----------------------------------------------- + +technic.powerctrl_state = true + +minetest.register_chatcommand("powerctrl", { + params = "[on/off]", + description = "Enables or disables technic's switching station ABM", + privs = { basic_privs = true }, + func = function(name, state) + technic.powerctrl_state = (state:trim():lower() == "on") + minetest.chat_send_player(name, "Technic switching station: " .. + (technic.powerctrl_state and "on" or "off")) + end +}) + +-- Run `technic_run` on all nodes in the power grid +local function run_nodes(list, run_stage) + for _, pos in ipairs(list) do + technic.get_or_load_node(pos) + local node = minetest.get_node_or_nil(pos) + if node and node.name then + local nodedef = minetest.registered_nodes[node.name] + if nodedef and nodedef.technic_run then + nodedef.technic_run(pos, node, run_stage) + end + end + end +end + minetest.register_abm({ nodenames = {"technic:switching_station"}, + label = "Switching Station", -- name for the Minetest mod profiler interval = 1, chance = 1, action = function(pos, node, active_object_count, active_object_count_wider) - local meta = minetest.get_meta(pos) - local meta1 = nil - local pos1 = {} - local PR_EU = 0 -- EUs from PR nodes - local BA_PR_EU = 0 -- EUs from BA nodes (discharching) - local BA_RE_EU = 0 -- EUs to BA nodes (charging) - local RE_EU = 0 -- EUs to RE nodes - - local tier = "" - local all_nodes = {} - local PR_nodes = {} - local BA_nodes = {} - local RE_nodes = {} + if not technic.powerctrl_state then return end + local meta = minetest.get_meta(pos) + local meta1 + local PR_nodes, BA_nodes, RE_nodes + local machine_name = S("Switching Station") -- Which kind of network are we on: - pos1 = {x=pos.x, y=pos.y-1, z=pos.z} - all_nodes[1] = pos1 + local cable_pos = {x=pos.x, y=pos.y-1, z=pos.z} - local name = minetest.get_node(pos1).name - local tier = technic.get_cable_tier(name) - if tier then - local i = 1 - repeat - traverse_network(PR_nodes, RE_nodes, BA_nodes, all_nodes, - i, technic.machines[tier], tier) - i = i + 1 - until all_nodes[i] == nil - else - --dprint("Not connected to a network") - meta:set_string("infotext", "Switching Station - no network") + --Disable if necessary + if meta:get_int("active") ~= 1 then + minetest.forceload_free_block(pos) + minetest.forceload_free_block(cable_pos) + meta:set_string("infotext",S("%s Already Present"):format(machine_name)) + + local poshash = minetest.hash_node_position(pos) + + if not technic.redundant_warn[poshash] then + technic.redundant_warn[poshash] = true + print("[TECHNIC] Warning: redundant switching station found near "..minetest.pos_to_string(pos)) + end return end - --dprint("nodes="..table.getn(all_nodes) - -- .." PR="..table.getn(PR_nodes) - -- .." BA="..table.getn(BA_nodes) - -- .." RE="..table.getn(RE_nodes)) + + local name = minetest.get_node(cable_pos).name + local tier = technic.get_cable_tier(name) + if tier then + -- Forceload switching station + minetest.forceload_block(pos) + minetest.forceload_block(cable_pos) + PR_nodes, BA_nodes, RE_nodes = get_network(pos, cable_pos, tier) + else + --dprint("Not connected to a network") + meta:set_string("infotext", S("%s Has No Network"):format(machine_name)) + minetest.forceload_free_block(pos) + minetest.forceload_free_block(cable_pos) + return + end + + run_nodes(PR_nodes, technic.producer) + run_nodes(RE_nodes, technic.receiver) + run_nodes(BA_nodes, technic.battery) -- Strings for the meta data local eu_demand_str = tier.."_EU_demand" local eu_input_str = tier.."_EU_input" local eu_supply_str = tier.."_EU_supply" + + -- Distribute charge equally across multiple batteries. + local charge_total = 0 + local battery_count = 0 + + for n, pos1 in pairs(BA_nodes) do + meta1 = minetest.get_meta(pos1) + local charge = meta1:get_int("internal_EU_charge") + + if (meta1:get_int(eu_demand_str) ~= 0) then + charge_total = charge_total + charge + battery_count = battery_count + 1 + end + end + + local charge_distributed = math.floor(charge_total / battery_count) + + for n, pos1 in pairs(BA_nodes) do + meta1 = minetest.get_meta(pos1) + + if (meta1:get_int(eu_demand_str) ~= 0) then + meta1:set_int("internal_EU_charge", charge_distributed) + end + end -- Get all the power from the PR nodes local PR_eu_supply = 0 -- Total power @@ -194,25 +347,36 @@ end --dprint("Total RE demand:"..RE_eu_demand) - -- Get all the power from the BA nodes - local BA_eu_supply = 0 + -- Batteries + local BA_eu_supply, BA_eu_demand = 0, 0 for _, pos1 in pairs(BA_nodes) do meta1 = minetest.get_meta(pos1) BA_eu_supply = BA_eu_supply + meta1:get_int(eu_supply_str) - end - --dprint("Total BA supply:"..BA_eu_supply) - - -- Get all the demand from the BA nodes - local BA_eu_demand = 0 - for _, pos1 in pairs(BA_nodes) do - meta1 = minetest.get_meta(pos1) BA_eu_demand = BA_eu_demand + meta1:get_int(eu_demand_str) end + --dprint("Total BA supply:"..BA_eu_supply) --dprint("Total BA demand:"..BA_eu_demand) - meta:set_string("infotext", - "Switching Station. Supply: "..PR_eu_supply - .." Demand: "..RE_eu_demand) + meta:set_string("infotext", S("@1. Supply: @2 Demand: @3", + machine_name, technic.EU_string(PR_eu_supply), + technic.EU_string(RE_eu_demand))) + + -- If mesecon signal and power supply or demand changed then + -- send them via digilines. + if mesecons_path and digilines_path and mesecon.is_powered(pos) then + if PR_eu_supply ~= meta:get_int("supply") or + RE_eu_demand ~= meta:get_int("demand") then + local channel = meta:get_string("channel") + digilines.receptor_send(pos, digilines.rules.default, channel, { + supply = PR_eu_supply, + demand = RE_eu_demand + }) + end + end + + -- Data that will be used by the power monitor + meta:set_int("supply", PR_eu_supply) + meta:set_int("demand", RE_eu_demand) -- If the PR supply is enough for the RE demand supply them all if PR_eu_supply >= RE_eu_demand then @@ -275,6 +439,63 @@ meta1 = minetest.get_meta(pos1) meta1:set_int(eu_input_str, 0) end + + end, +}) + +-- Timeout ABM +-- Timeout for a node in case it was disconnected from the network +-- A node must be touched by the station continuously in order to function +local function switching_station_timeout_count(pos, tier) + local meta = minetest.get_meta(pos) + local timeout = meta:get_int(tier.."_EU_timeout") + if timeout <= 0 then + meta:set_int(tier.."_EU_input", 0) -- Not needed anymore <-- actually, it is for supply converter + return true + else + meta:set_int(tier.."_EU_timeout", timeout - 1) + return false + end +end +minetest.register_abm({ + label = "Machines: timeout check", + nodenames = {"group:technic_machine"}, + interval = 1, + chance = 1, + action = function(pos, node, active_object_count, active_object_count_wider) + for tier, machines in pairs(technic.machines) do + if machines[node.name] and switching_station_timeout_count(pos, tier) then + local nodedef = minetest.registered_nodes[node.name] + if nodedef then + local meta = minetest.get_meta(pos) + meta:set_string("infotext", S("%s Has No Network"):format(nodedef.description)) + end + if nodedef and nodedef.technic_disabled_machine_name then + node.name = nodedef.technic_disabled_machine_name + minetest.swap_node(pos, node) + end + if nodedef and nodedef.technic_on_disable then + nodedef.technic_on_disable(pos, node) + end + end + end + end, +}) + +--Re-enable disabled switching station if necessary, similar to the timeout above +minetest.register_abm({ + label = "Machines: re-enable check", + nodenames = {"technic:switching_station"}, + interval = 1, + chance = 1, + action = function(pos, node, active_object_count, active_object_count_wider) + local pos1 = {x=pos.x,y=pos.y-1,z=pos.z} + local tier = technic.get_cable_tier(minetest.get_node(pos1).name) + if not tier then return end + if switching_station_timeout_count(pos, tier) then + local meta = minetest.get_meta(pos) + meta:set_int("active",1) + end end, }) -- Gitblit v1.8.0