From a8daa417c485ee20716ec050d4c676b5c91af773 Mon Sep 17 00:00:00 2001 From: David Leal <halfpacho@gmail.com> Date: Fri, 12 Jun 2020 20:39:00 +0200 Subject: [PATCH] Add GitHub workflow and luacheck (#545) --- technic/machines/switching_station.lua | 270 ++++++++++++++++++++++++++++++++++------------------- 1 files changed, 171 insertions(+), 99 deletions(-) diff --git a/technic/machines/switching_station.lua b/technic/machines/switching_station.lua index f925817..56a0db0 100644 --- a/technic/machines/switching_station.lua +++ b/technic/machines/switching_station.lua @@ -1,40 +1,15 @@ --- SWITCHING STATION --- The switching station is the center of all power distribution on an electric network. --- --- The station collects power from sources (PR), distributes it to sinks (RE), --- and uses the excess/shortfall to charge and discharge batteries (BA). --- --- For now, all supply and demand values are expressed in kW. --- --- 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. +-- 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", @@ -45,11 +20,22 @@ } }) +local mesecon_def +if mesecons_path then + mesecon_def = {effector = { + rules = mesecon.rules.default, + }} +end + minetest.register_node("technic:switching_station",{ description = S("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"}, + 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(), @@ -57,59 +43,105 @@ local meta = minetest.get_meta(pos) 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}]") + local poshash = minetest.hash_node_position(pos) + 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) + local poshash = minetest.hash_node_position(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 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, network_id) - technic.cables[minetest.hash_node_position(pos)] = network_id - -- 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 +local function add_network_node(nodes, pos, network_id) + local node_id = minetest.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 +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(PR_nodes, RE_nodes, BA_nodes, SP_nodes, all_nodes, pos, machines, tier, sw_pos, from_below, network_id) +local check_node_subp = function(PR_nodes, RE_nodes, BA_nodes, SP_nodes, all_nodes, pos, machines, tier, sw_pos, from_below, network_id, queue) technic.get_or_load_node(pos) - 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,network_id) + add_cable_node(all_nodes, pos,network_id, queue) elseif machines[name] then --dprint(name.." is a "..machines[name]) + local meta = minetest.get_meta(pos) meta:set_string(tier.."_network",minetest.pos_to_string(sw_pos)) if machines[name] == technic.producer then - add_new_cable_node(PR_nodes, pos, network_id) + add_network_node(PR_nodes, pos, network_id) elseif machines[name] == technic.receiver then - add_new_cable_node(RE_nodes, pos, network_id) + add_network_node(RE_nodes, pos, network_id) elseif machines[name] == technic.producer_receiver then - add_new_cable_node(PR_nodes, pos, network_id) - add_new_cable_node(RE_nodes, pos, network_id) + add_network_node(PR_nodes, pos, network_id) + add_network_node(RE_nodes, pos, network_id) elseif machines[name] == "SPECIAL" and (pos.x ~= sw_pos.x or pos.y ~= sw_pos.y or pos.z ~= sw_pos.z) and from_below then -- Another switching station -> disable it - add_new_cable_node(SP_nodes, pos, network_id) + add_network_node(SP_nodes, pos, network_id) meta:set_int("active", 0) elseif machines[name] == technic.battery then - add_new_cable_node(BA_nodes, pos, network_id) + add_network_node(BA_nodes, pos, network_id) end meta:set_int(tier.."_EU_timeout", 2) -- Touch node @@ -117,8 +149,7 @@ end -- Traverse a network given a list of machines and a cable type name -local traverse_network = function(PR_nodes, RE_nodes, BA_nodes, SP_nodes, all_nodes, i, machines, tier, sw_pos, network_id) - local pos = all_nodes[i] +local traverse_network = function(PR_nodes, RE_nodes, BA_nodes, SP_nodes, all_nodes, pos, machines, tier, 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}, @@ -126,9 +157,8 @@ {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, SP_nodes, all_nodes, cur_pos, machines, tier, sw_pos, i == 3, network_id) + check_node_subp(PR_nodes, RE_nodes, BA_nodes, SP_nodes, all_nodes, cur_pos, machines, tier, sw_pos, i == 3, network_id, queue) end end @@ -140,7 +170,8 @@ end local get_network = function(sw_pos, pos1, tier) - local cached = technic.networks[minetest.hash_node_position(pos1)] + local network_id = minetest.hash_node_position(pos1) + local cached = technic.networks[network_id] if cached and cached.tier == tier then touch_nodes(cached.PR_nodes, tier) touch_nodes(cached.BA_nodes, tier) @@ -152,45 +183,81 @@ end return cached.PR_nodes, cached.BA_nodes, cached.RE_nodes end - local i = 1 local PR_nodes = {} local BA_nodes = {} local RE_nodes = {} local SP_nodes = {} - local all_nodes = {pos1} - repeat - traverse_network(PR_nodes, RE_nodes, BA_nodes, SP_nodes, all_nodes, - i, technic.machines[tier], tier, sw_pos, minetest.hash_node_position(pos1)) - i = i + 1 - until all_nodes[i] == nil - technic.networks[minetest.hash_node_position(pos1)] = {tier = tier, PR_nodes = PR_nodes, - RE_nodes = RE_nodes, BA_nodes = BA_nodes, SP_nodes = SP_nodes, all_nodes = all_nodes} + local all_nodes = {} + local queue = {} + add_cable_node(all_nodes, pos1, network_id, queue) + while next(queue) do + local to_visit = {} + for _, pos in ipairs(queue) do + traverse_network(PR_nodes, RE_nodes, BA_nodes, SP_nodes, all_nodes, + pos, technic.machines[tier], tier, sw_pos, network_id, to_visit) + end + queue = to_visit + end + PR_nodes = flatten(PR_nodes) + BA_nodes = flatten(BA_nodes) + RE_nodes = flatten(RE_nodes) + SP_nodes = flatten(SP_nodes) + all_nodes = flatten(all_nodes) + technic.networks[network_id] = {tier = tier, all_nodes = all_nodes, SP_nodes = SP_nodes, + PR_nodes = PR_nodes, RE_nodes = RE_nodes, BA_nodes = BA_nodes} return PR_nodes, BA_nodes, RE_nodes end ----------------------------------------------- -- The action code for the switching station -- ----------------------------------------------- + +technic.powerctrl_state = true + +minetest.register_chatcommand("powerctrl", { + params = "state", + description = "Enables or disables technic's switching station ABM", + privs = { basic_privs = true }, + func = function(name, state) + if state == "on" then + technic.powerctrl_state = true + else + technic.powerctrl_state = false + end + end +}) + +-- Run all the nodes +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", -- allows the mtt profiler to profile this abm individually interval = 1, chance = 1, action = function(pos, node, active_object_count, active_object_count_wider) + if not technic.powerctrl_state then return end local meta = minetest.get_meta(pos) - local meta1 = nil + local meta1 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 PR_nodes local BA_nodes local 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} @@ -199,6 +266,13 @@ minetest.forceload_free_block(pos) minetest.forceload_free_block(pos1) 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 @@ -216,25 +290,10 @@ minetest.forceload_free_block(pos1) return end - - -- Run all the nodes - local function run_nodes(list) - for _, pos2 in ipairs(list) do - technic.get_or_load_node(pos2) - local node2 = minetest.get_node(pos2) - local nodedef - if node2 and node2.name then - nodedef = minetest.registered_nodes[node2.name] - end - if nodedef and nodedef.technic_run then - nodedef.technic_run(pos2, node2) - end - end - end - - run_nodes(PR_nodes) - run_nodes(RE_nodes) - run_nodes(BA_nodes) + + 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" @@ -297,9 +356,22 @@ end --dprint("Total BA demand:"..BA_eu_demand) - meta:set_string("infotext", - S("@1. Supply: @2 Demand: @3", - machine_name, technic.pretty_num(PR_eu_supply), technic.pretty_num(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) @@ -366,7 +438,7 @@ meta1 = minetest.get_meta(pos1) meta1:set_int(eu_input_str, 0) end - + end, }) @@ -385,11 +457,11 @@ 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) - local meta = minetest.get_meta(pos) 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] @@ -410,11 +482,11 @@ --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 meta = minetest.get_meta(pos) 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 -- Gitblit v1.8.0