New MV Hydro Machine (#412)

Tanmaya Meher

2018-08-25 2e7859c35e55b842752c6533edae2dd19290fabc

 technic/machines/switching_station.lua

@@ -1,115 +1,147 @@
-- 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.
-- 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 = {
      {"",                        "technic:lv_transformer", ""},
      {"default:copper_ingot",    "technic:machine_casing", "default:copper_ingot"},
      {"technic:lv_cable0",       "technic:lv_cable0",      "technic:lv_cable0"}
      {"",                     "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 = 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"},
   groups = {snappy=2, choppy=2, oddly_breakable_by_hand=2},
   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", 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)
   -- 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 load_position = function(pos)
   if minetest.get_node_or_nil(pos) then return end
   local vm = VoxelManip()
   local MinEdge, MaxEdge = vm:read_from_map(pos, pos)
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)
   load_position(pos)
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)
      add_cable_node(all_nodes, pos,network_id, queue)
   elseif machines[name] then
      --dprint(name.." is a "..machines[name])
      meta:set_string(tier.."_network",minetest.pos_to_string(sw_pos))
      if     machines[name] == technic.producer then
         add_new_cable_node(PR_nodes, pos)
         add_network_node(PR_nodes, pos, network_id)
      elseif machines[name] == technic.receiver then
         add_new_cable_node(RE_nodes, pos)
         add_network_node(RE_nodes, pos, network_id)
      elseif machines[name] == technic.producer_receiver then
         add_new_cable_node(PR_nodes, pos)
         add_new_cable_node(RE_nodes, pos)
         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) then
            (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)
         add_network_node(SP_nodes, pos, network_id)
         meta:set_int("active", 0)
         meta:set_string("active_pos", minetest.serialize(sw_pos))
      elseif machines[name] == technic.battery then
         add_new_cable_node(BA_nodes, pos)
         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)
   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)
      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,30 +183,57 @@
      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)
      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}
   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
})

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 pos1             = {}
@@ -190,52 +248,86 @@
      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}

      --Disable if necessary
      if meta:get_int("active") ~= 1 then
         meta:set_int("active", 1)
         local active_pos = minetest.deserialize(meta:get_string("active_pos"))
         if active_pos then
            local meta1 = minetest.get_meta(active_pos)
            meta:set_string("infotext", S("%s (Slave)"):format(meta1:get_string("infotext")))
         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
		
      -- Which kind of network are we on:
      pos1 = {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
         -- Forceload switching station
         minetest.forceload_block(pos)
         minetest.forceload_block(pos1)
         PR_nodes, BA_nodes, RE_nodes = get_network(pos, pos1, 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(pos1)
         return
      end
		

      -- Run all the nodes
      local function run_nodes(list)
      local function run_nodes(list, run_stage)
         for _, pos2 in ipairs(list) do
            load_position(pos2)
            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)
               nodedef.technic_run(pos2, node2, run_stage)
            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"
      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
@@ -269,9 +361,26 @@
      end
      --dprint("Total BA demand:"..BA_eu_demand)

      meta:set_string("infotext",
            S("%s. Supply: %d Demand: %d"):format(
            machine_name, PR_eu_supply, 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
@@ -334,6 +443,7 @@
         meta1 = minetest.get_meta(pos1)
         meta1:set_int(eu_input_str, 0)
      end

   end,
})

@@ -344,7 +454,7 @@
   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
      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)
@@ -352,10 +462,12 @@
   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]
@@ -374,6 +486,24 @@
   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 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
      if switching_station_timeout_count(pos, tier) then
         local meta = minetest.get_meta(pos)
         meta:set_int("active",1)
      end
   end,
})

for tier, machines in pairs(technic.machines) do
   -- SPECIAL will not be traversed
   technic.register_machine(tier, "technic:switching_station", "SPECIAL")