Add Flow Limiter mode to TA4 pusher

basic_machines/consumer.lua

@@ -230,6 +230,8 @@ function techage.register_consumer(base_name, inv_name, tiles, tNode, validState
 				on_metadata_inventory_put = tNode.on_metadata_inventory_put,
 				on_metadata_inventory_take = tNode.on_metadata_inventory_take,
 				ta_rotate_node = tNode.ta_rotate_node,
+				ta3_formspec = stage == 3 and tNode.ta3_formspec,
+				ta4_formspec = stage == 4 and tNode.ta4_formspec,
 
 				paramtype = tNode.paramtype,
 				paramtype2 = "facedir",
@@ -271,6 +273,8 @@ function techage.register_consumer(base_name, inv_name, tiles, tNode, validState
 				on_metadata_inventory_put = tNode.on_metadata_inventory_put,
 				on_metadata_inventory_take = tNode.on_metadata_inventory_take,
 				ta_rotate_node = tNode.ta_rotate_node,
+				ta3_formspec = stage == 3 and tNode.ta3_formspec,
+				ta4_formspec = stage == 4 and tNode.ta4_formspec,
 
 				paramtype = tNode.paramtype,
 				paramtype2 = "facedir",

basic_machines/pusher.lua

@@ -34,6 +34,16 @@ local STANDBY_TICKS = 2
 local COUNTDOWN_TICKS = 4
 local CYCLE_TIME = 2
 
+local WRENCH_MENU = {
+	{
+		type = "number",
+		name = "limit",
+		label = S("Number of items"),
+		tooltip = S("Number of items that are allowed to be pushed"),
+		default = "0",
+	},
+}
+
 local function ta4_formspec(self, pos, nvm)
 	if CRD(pos).stage == 4 then -- TA4 node?
 		return "size[8,7.2]"..
@@ -42,7 +52,8 @@ local function ta4_formspec(self, pos, nvm)
 			default.gui_slots..
 			"box[0,-0.1;7.8,0.5;#c6e8ff]"..
 			"label[3,-0.1;"..minetest.colorize("#000000", S("Pusher")).."]"..
-			techage.question_mark_help(8, S("Optionally configure\nthe pusher with one item"))..
+			techage.question_mark_help(7.5, S("Optionally configure\nthe pusher with one item"))..
+			techage.wrench_image(7.4, -0.05) .. 
 			"list[context;main;3.5,0.8;1,1;]"..
 			"image_button[3.5,2;1,1;".. self:get_state_button_image(nvm) ..";state_button;]"..
 			"tooltip[3.5,2;1,1;"..self:get_state_tooltip(nvm).."]"..
@@ -87,37 +98,50 @@ local function allow_metadata_inventory_take(pos, listname, index, stack, player
 	return 0
 end
 
-local function pushing(pos, crd, meta, nvm)
+-- Function returns the number of pushed items
-	local pull_dir = meta:get_int("pull_dir")
+local function push(pos, crd, meta, nvm, pull_dir, push_dir, num)
-	local push_dir = meta:get_int("push_dir")
-	local num = nvm.item_count or nvm.num_items or crd.num_items
 	local items = techage.pull_items(pos, pull_dir, num, nvm.item_name)
 	if items ~= nil then
 		local leftover = techage.push_items(pos, push_dir, items)
-		print("leftover", dump(leftover))
 		if not leftover then
 			-- place item back
 			techage.unpull_items(pos, pull_dir, items)
 			crd.State:blocked(pos, nvm)
-			return
+			return 0
 		elseif leftover ~= true then
 			-- place item back
 			techage.unpull_items(pos, pull_dir, leftover)
 			crd.State:blocked(pos, nvm)
-			return
+			return items:get_count() - leftover:get_count()
 		end
-		if nvm.item_count then  -- remote job?
+		return items:get_count()
-			nvm.item_count = nil
+	end
-			nvm.item_name = nil
+	crd.State:idle(pos, nvm)
+	return 0
+end
+
+local function pushing(pos, crd, meta, nvm)
+	local pull_dir = meta:get_int("pull_dir")
+	local push_dir = meta:get_int("push_dir")
+	
+	if not nvm.limit then
+		local num = nvm.item_count or nvm.num_items or crd.num_items
+		num = push(pos, crd, meta, nvm, pull_dir, push_dir, num)
+		if num > 0 then
+			crd.State:keep_running(pos, nvm, COUNTDOWN_TICKS)
+		end
+	elseif nvm.num_items < nvm.limit then
+		local num = math.min(crd.num_items, nvm.limit - nvm.num_items)
+		num = push(pos, crd, meta, nvm, pull_dir, push_dir, num)
+		if num > 0 then
+			nvm.num_items = nvm.num_items + num
+			if nvm.num_items >= nvm.limit then
 				crd.State:stop(pos, nvm)
-			local number = M(pos):get_string("node_number")
-			techage.send_single(number, nvm.rmt_num, "off")
 			else
 				crd.State:keep_running(pos, nvm, COUNTDOWN_TICKS)
 			end
-		return
 		end
-	crd.State:idle(pos, nvm)
+	end
 end
 
 local function keep_running(pos, elapsed)
@@ -187,6 +211,20 @@ local function can_start(pos, nvm, state)
 	return true
 end
 
+local function on_state_change(pos, old_state, new_state)
+	if old_state == techage.STOPPED and new_state == techage.RUNNING then
+		local nvm = techage.get_nvm(pos)
+		local val = M(pos):get_int("limit")
+		if val and val > 0 then
+			nvm.limit = val
+			nvm.num_items = 0
+		else
+			nvm.limit = nil
+			nvm.num_items = nil
+		end
+	end
+end
+
 local function config_item(pos, payload)
 	if type(payload) == "string" then
 		if payload == "" then
@@ -254,43 +292,73 @@ local tubing = {
 	is_pusher = true, -- is a pulling/pushing node
 
 	on_recv_message = function(pos, src, topic, payload)
-		if topic == "pull" then
+		if topic == "pull" then -- Deprecated command, use config/limit/start instead
 			local nvm = techage.get_nvm(pos)
 			CRD(pos).State:stop(pos, nvm)
 			nvm.item_count = math.min(config_item(pos, payload), 12)
 			nvm.rmt_num = src
 			CRD(pos).State:start(pos, nvm)
 			return true
-		elseif topic == "config" then
+		elseif topic == "config" then  -- Set item type
 			local nvm = techage.get_nvm(pos)
 			CRD(pos).State:stop(pos, nvm)
 			config_item(pos, payload)
-			CRD(pos).State:start(pos, nvm)
 			return true
+		elseif topic == "limit" then  -- Set push limit
+			local nvm = techage.get_nvm(pos)
+			CRD(pos).State:stop(pos, nvm)
+			local val = tonumber(payload) or 0
+			if val and val > 0 then
+				nvm.limit = val
+				nvm.num_items = 0
+				M(pos):set_int("limit", val)
+			else
+				nvm.limit = nil
+				nvm.num_items = nil
+				M(pos):set_string("limit", "")
+			end
+			return true
+		elseif topic == "count" then  -- Get number of push items
+			local nvm = techage.get_nvm(pos)
+			return nvm.num_items or 0
 		else
 			return CRD(pos).State:on_receive_message(pos, topic, payload)
 		end
 	end,
 	on_beduino_receive_cmnd = function(pos, src, topic, payload)
-		if topic == 64 then -- Start pusher
+		if topic == 65 then  -- Set item type
-			local nvm = techage.get_nvm(pos)
-			CRD(pos).State:stop(pos, nvm)
-			nvm.item_count = math.min(config_item(pos, payload), 12)
-			nvm.rmt_num = src
-			CRD(pos).State:start(pos, nvm)
-			return 0
-		elseif topic == 65 then -- Config Pusher
 			local nvm = techage.get_nvm(pos)
 			CRD(pos).State:stop(pos, nvm)
 			config_item(pos, payload)
-			CRD(pos).State:start(pos, nvm)
+			return 0
+		elseif topic == 68 then  -- Set push limit
+			local nvm = techage.get_nvm(pos)
+			CRD(pos).State:stop(pos, nvm)
+			if payload[1] > 0 then
+				nvm.limit = payload[1]
+				nvm.num_items = 0
+				M(pos):set_int("limit", payload[1])
+			else
+				nvm.limit = nil
+				nvm.num_items = nil
+				M(pos):set_string("limit", "")
+			end
 			return 0
 		else
+			local nvm = techage.get_nvm(pos)
+			if nvm.limit then
+				nvm.num_items = 0
+			end
 			return CRD(pos).State:on_beduino_receive_cmnd(pos, topic, payload)
 		end
 	end,
 	on_beduino_request_data = function(pos, src, topic, payload)
+		if topic == 150 then  -- Get number of pushed items
+			local nvm = techage.get_nvm(pos)
+			return 0, {nvm.num_items or 0}
+		else
 			return CRD(pos).State:on_beduino_request_data(pos, topic, payload)
+		end
 	end,
 }
 
@@ -301,6 +369,7 @@ local node_name_ta2, node_name_ta3, node_name_ta4 =
 		formspec = ta4_formspec,
 		tubing = tubing,
 		can_start = can_start,
+		on_state_change = on_state_change,
 		after_place_node = function(pos, placer)
 			local meta = M(pos)
 			local node = minetest.get_node(pos)
@@ -328,6 +397,7 @@ local node_name_ta2, node_name_ta3, node_name_ta4 =
 		node_timer = keep_running,
 		on_rotate = screwdriver.disallow,
 		tubelib2_on_update2 = tubelib2_on_update2,
+		ta4_formspec = WRENCH_MENU,
 
 		groups = {choppy=2, cracky=2, crumbly=2},
 		is_ground_content = false,

liquids/pump.lua

@@ -57,6 +57,7 @@ local State4 = techage.NodeStates:new({
 	standby_ticks = STANDBY_TICKS,
 })
 
+-- Function returns the number of pumped units
 local function pump(pos, mem, nvm, state, outdir, units)
 	local taken, name = liquid.take(pos, Pipe, Flip[outdir], nil, units, mem.dbg_cycles > 0)
 	if taken > 0 then
@@ -317,7 +318,24 @@ techage.register_node({"techage:t3_pump", "techage:t3_pump_on"}, {
 
 techage.register_node({"techage:t4_pump", "techage:t4_pump_on"}, {
 	on_recv_message = function(pos, src, topic, payload)
-		if topic == "flowrate" then
+		if topic == "limit" then  -- Set pump limit
+			local nvm = techage.get_nvm(pos)
+			State4:stop(pos, nvm)
+			local val = tonumber(payload) or 0
+			if val and val > 0 then
+				nvm.limit = val
+				nvm.num_items = 0
+				M(pos):set_int("limit", val)
+			else
+				nvm.limit = nil
+				nvm.num_items = nil
+				M(pos):set_string("limit", "")
+			end
+			return true
+		elseif topic == "count" then  -- Get number of pumped units
+			local nvm = techage.get_nvm(pos)
+			return nvm.num_items or 0
+		elseif topic == "flowrate" then  -- Get total number of pumped units
 			local nvm = techage.get_nvm(pos)
 			return nvm.flowrate or 0
 		else
@@ -325,7 +343,7 @@ techage.register_node({"techage:t4_pump", "techage:t4_pump_on"}, {
 		end
 	end,
 	on_beduino_receive_cmnd = function(pos, src, topic, payload)
-		if topic == 69 and payload then -- set limit
+		if topic == 69 and payload then  -- Set pump limit
 			local nvm = techage.get_nvm(pos)
 			State4:stop(pos, nvm)
 			if payload[1] > 0 then
@@ -347,10 +365,10 @@ techage.register_node({"techage:t4_pump", "techage:t4_pump_on"}, {
 		end
 	end,
 	on_beduino_request_data = function(pos, src, topic, payload)
-		if topic == 137 then  -- Total Flow Rate
+		if topic == 137 then  -- Get total number of pumped units
 			local nvm = techage.get_nvm(pos)
 			return 0, {nvm.flowrate or 0}
-		elseif topic == 151 then -- Request count
+		elseif topic == 151 then  -- Get number of pumped units
 			local nvm = techage.get_nvm(pos)
 			return 0, {nvm.num_items or 0}
 		else

manuals/ta4_lua_controller_EN.md

@@ -372,6 +372,8 @@ Please note, that this is not a technical distinction, only a logical.
 | "stacks"     | Array with up to 4 Stores with the inventory content (see example) | Only for Sensor Chests                                       |
 | "count"      | number                                                       | Read the item counter of the TA4 Item Detector block         |
 | "count"      | number of items                                              | Read the total amount of TA4 chest items. An optional  number as `add_data` is used to address only one inventory slot (1..8, from left to right). |
+| "count"      | number of items                                              | Read the number of pushed items for a TA4 Pusher in "flow limiter" mode |
+| "count"      | number of units                                              | Read the number of pumped liquid units for a TA4 Pump in "flow limiter" mode |
 | "itemstring" | item string of the given slot                                | Specific command for the TA4 8x2000 Chest to read the item type (technical name) of one chest slot, specified via `add_data` (1..8).<br />Example: s = $send_cmnd("223", "itemstring", 1) |
 | "output"     | recipe output string, <br />e.g.: "default:glass"            | Only for the Industrial Furnace. If no recipe is active, the command returns "unknown" |
 | "input"      | \<index>                                                     | Read a recipe from the TA4 Recipe Block. `<index>` is the number of the recipe. The block return a list of recipe items. |
@@ -395,7 +397,8 @@ Please note, that this is not a technical distinction, only a logical.
 | "config" | "\<slot> \<item list>" | Configure a Distributor filter slot, like: "red default:dirt dye:blue" |
 | "text"                           | text string  | Text to be used for the Sensor Chest menu                    |
 | "reset"                          | nil          | Reset the item counter of the TA4 Item Detector block        |
-| "pull"                           | item  string | Start the TA4 pusher to pull/push items.<br /> Example: `default:dirt 8` |
+| "limit"                       | number | Configure a TA4 Pusher with the number of items that are allowed to be pushed ("flow limiter" mode)<br />limit = 0 turns off the "flow limiter" mode |
+| "limit" | number | Configure a TA4 Pump with the number of liquid units that are allowed to be pumped ("flow limiter" mode)<br />limit = 0 turns off the "flow limiter" mode |
 | "config"                         | item  string | Configure the TA4 pusher.<br />Example: `wool:blue`          |
 | "exchange" | inventory slot number | TA3 Door Controller II (techage:ta3_doorcontroller2)<br />Exchange a block<br />*idx* is the inventory slot number (1..n) of/for the block to be exchanged |
 | "set" | inventory slot number | TA3 Door Controller II (techage:ta3_doorcontroller2)<br />Set/add a block<br />*idx* is the inventory slot number (1..n) with the block to be set |