[MOD 1.1] Inventory Sensor

[steinio]

Thanks for the flowers.

The reason why I changed the license is simple. Someone re-branded LTN and re-hosted it on the mods page as his own creation. (without asking ofc, as (L)GPL allows forgoing any form of manners apparently)
I always liked open source, but I also like to get credit for my work, so I pulled the plug and will only release projects where I sink countless hours into under licenses preventing re-hosting or re-branding.

WTF?
Sorry for that.

Stupids are everywhere around.

Please keep on your good work.

[folk]

[*]I never looked at your code - I looked at your github to see if there were any blueprints there in the readme.md or GH wiki
[*]I have never written any mods for Factorio

Well, that was then and this is now
Since you removed the ability to read Roboport contents in the previous version (1.2.0), I unzipped the mod so that I could add it back in, and I just remade the mod.

https://hastebin.com/pasojitike.lua

All the code is in here and the URL above

Code: Select all

require "config"

local itemSignalCache
do
	local items = setmetatable({}, {
		__index = function(self, key)
			local entry = { type = "item", name = key }
			rawset(self, key, entry)
			return entry
		end
	})
	local cache = {}
	itemSignalCache = setmetatable({}, {
		__index = cache,
		__newindex = function(self, key, value)
			if cache[key] then
				cache[key].count = value
			else
				cache[key] = { index = 0, count = value, signal = items[key] }
			end
		end
	})
end
local fluidSignalCache
do
	local fluids = setmetatable({}, {
		__index = function(self, key)
			local entry = { type = "fluid", name = key }
			rawset(self, key, entry)
			return entry
		end
	})
	local cache = {}
	fluidSignalCache = setmetatable({}, {
		__index = cache,
		__newindex = function(self, key, value)
			if cache[key] then
				cache[key].count = value
			else
				cache[key] = { index = 0, count = value, signal = fluids[key] }
			end
		end
	})
end
local function pwipe(tbl) for k in pairs(tbl) do tbl[k] = nil end; return tbl end

local ROBOPORT = "roboport"
local WAGON = "cargo-wagon"
local LOCO = "locomotive"
local TANK = "tank" -- XXX not implemented
local ASS = "assembling-machine"
local CAR = "car" -- XXX not implemented
local FURNACE = "furnace"

-- We always index this table by entity.name before entity.type. Same as for
-- updateByName/Type
local staticParameters = {
	[ROBOPORT] = {
		parameters = {
			{index=1,signal={type="virtual",name="all-lrobots"},count = 0},
			{index=2,signal={type="virtual",name="home-lrobots"},count = 0},
			{index=3,signal={type="virtual",name="all-crobots"},count = 0},
			{index=4,signal={type="virtual",name="home-crobots"},count = 0},
		}
	}
}

-- If there is an entry for the entity.name in updateByName, we only invoke
-- that one. So for "tank", we only invoke updateByName["tank"], but for other car types
-- we do updateByType["car"]
local updateByType = {}
local updateByName = {}

do
	updateByType[ROBOPORT] = function(sensor, cc, read)
		local p = sensor.parameters
		local net = read.force.find_logistic_network_by_position(read.position, read.surface)
		if net and net.valid then --logisticNetwork is nil when roboport is out of power
			p.parameters[1].count = net.all_logistic_robots
			p.parameters[2].count = net.available_logistic_robots
			p.parameters[3].count = net.all_construction_robots
			p.parameters[4].count = net.available_construction_robots
		else
			p.parameters[1].count = 0
			p.parameters[2].count = 0
			p.parameters[3].count = 0
			p.parameters[4].count = 0
		end
		cc.get_control_behavior().parameters = p
	end
end
do
	local parameters = {parameters = {}}
	updateByType[FURNACE] = function(sensor, cc, read)
		local p = pwipe(parameters.parameters)
		local counter = 1

		for i = 1, 4 do
			local inv = read.get_inventory(i)
			if inv and inv.valid then
				local contents = inv.get_contents()
				for item, count in pairs(contents) do
					itemSignalCache[item] = count
					itemSignalCache[item].index = counter
					p[counter] = itemSignalCache[item]
					counter = counter + 1
				end
			end
		end
		cc.get_control_behavior().parameters = parameters
	end
end
do
	local parameters = {parameters = {}}
	updateByType[ASS] = function(sensor, cc, read)
		local p = pwipe(parameters.parameters)
		local counter = 1

		for i = 1, #read.fluidbox do
			local fluid = read.fluidbox[i]
			if fluid then
				fluidSignalCache[fluid.type] = math.floor(fluid.amount + 0.5)
				fluidSignalCache[fluid.type].index = counter
				p[counter] = fluidSignalCache[fluid.type]
				counter = counter + 1
			end
		end

		for i = 1, 4 do
			local inv = read.get_inventory(i)
			if inv and inv.valid then
				local contents = inv.get_contents()
				for item, count in pairs(contents) do
					itemSignalCache[item] = count
					itemSignalCache[item].index = counter
					p[counter] = itemSignalCache[item]
					counter = counter + 1
				end
			end
		end
		cc.get_control_behavior().parameters = parameters
	end
end
-- do
--       for i=1, 4, 1 do
--         local tempInv = entity.get_inventory(i)
--         if tempInv then
--           inventory[#inventory+1] = tempInv
--         end
--       end
-- 	updateByName[TANK] = function(sensor, cc, read)
-- 		if tostring(connectedEntity.speed) == "0" then --car isn't moving
-- 				signals[1] = {index=1,signal={type="virtual",name="detected-tank"},count=1}
--       signalIndex = 2
-- 			for i=1, #itemSensor.Inventory, 1 do
--         local contentsTable = itemSensor.Inventory[i].get_contents()
--         for k,v in pairs(contentsTable) do
--           signals[signalIndex] = {index = signalIndex, signal = {type = "item",name = k},count = v }
--           signalIndex = signalIndex+1
--         end
-- 			end
-- 	end
-- end
-- do
--       for i=1, 4, 1 do
--         local tempInv = entity.get_inventory(i)
--         if tempInv then
--           inventory[#inventory+1] = tempInv
--         end
--       end
-- 	updateByType[CAR] = function(sensor, cc, read)
-- 		if tostring(connectedEntity.speed) == "0" then --car isn't moving
-- 				signals[1] = {index=1,signal={type="virtual",name="detected-car"},count=1}
--       signalIndex = 2
-- 			for i=1, #itemSensor.Inventory, 1 do
--         local contentsTable = itemSensor.Inventory[i].get_contents()
--         for k,v in pairs(contentsTable) do
--           signals[signalIndex] = {index = signalIndex, signal = {type = "item",name = k},count = v }
--           signalIndex = signalIndex+1
--         end
-- 			end
-- 	end
-- end
do
	local locomotiveSignal = {
		parameters = {
			{index=1,signal={type="virtual",name="detected-locomotive"},count=0}
		}
	}

	local station = defines.train_state.wait_station
	local signal = defines.train_state.wait_signal
	local inventory = defines.inventory.fuel
	updateByType[LOCO] = function(sensor, cc, read)
		if read.train.state == station or read.train.state == signal then
			local inv = read.get_inventory(inventory)
			local param = locomotiveSignal
			if inv and inv.valid then
				local contents = inv.get_contents()
				-- Index 1 is the detected-locomotive signal
				local counter = 2
				for item, count in pairs(contents) do
					itemSignalCache[item] = count
					itemSignalCache[item].index = counter
					param.parameters[counter] = itemSignalCache[item]
					counter = counter + 1
				end
			end
			param.parameters[1].count = #read.train.locomotives.front_movers + #read.train.locomotives.back_movers
			cc.get_control_behavior().parameters = param
		else
			sensor.read = nil
			cc.get_control_behavior().parameters = nil
		end
	end
end
do
	local wagonSignal = {
		parameters = {
			{index=1,signal={type="virtual",name="detected-wagon"},count=0}
		}
	}
	local station = defines.train_state.wait_station
	local signal = defines.train_state.wait_signal
	local inventory = defines.inventory.cargo_wagon

	updateByType[WAGON] = function(sensor, cc, read)
		if read.train.state == station or read.train.state == signal then
			local inv = read.get_inventory(inventory)
			local param = wagonSignal
			if inv and inv.valid then
				local contents = inv.get_contents()
				-- Index 1 is the detected-wagon signal
				local counter = 2
				for item, count in pairs(contents) do
					itemSignalCache[item] = count
					itemSignalCache[item].index = counter
					param.parameters[counter] = itemSignalCache[item]
					counter = counter + 1
				end
			end
			param.parameters[1].count = #read.train.cargo_wagons
			cc.get_control_behavior().parameters = param
		else
			sensor.read = nil
			cc.get_control_behavior().parameters = nil
		end
	end
end

local findConnectedEntity
do
	findConnectedEntity = function(sensor)
		local found = sensor.cc.surface.find_entities(sensor.area)
		if not found then return end

		for i, entity in next, found do
			if entity.valid and updateByType[entity.type] or updateByName[entity.name] then
				sensor.read = entity
				break
			end
		end
		if not sensor.read or not sensor.read.type then return end

		if staticParameters[sensor.read.name] then
			sensor.parameters = staticParameters[sensor.read.name]
		elseif staticParameters[sensor.read.type] then
			sensor.parameters = staticParameters[sensor.read.type]
		else
			sensor.parameters = nil
		end
	end
end

local ticker
do
	local function update(sensor)
		local cc = sensor.cc -- constantCombinator
		local read = sensor.read

		if not read or not read.valid then
			sensor.read = nil
			cc.get_control_behavior().parameters = nil
			return
		end

		if updateByName[read.name] then
			updateByName[read.name](sensor, cc, read)
		elseif updateByType[read.type] then
			updateByType[read.type](sensor, cc, read)
		end
	end

	ticker = function(event)
		if event.tick % 20 == 0 then
			if #global.sensors == 0 then
				script.on_event(defines.events.on_tick, nil)
				return
			end
			for i, sensor in next, global.sensors do
				if not sensor.read or not sensor.read.valid then
					findConnectedEntity(sensor)
				end
				if sensor.read then update(sensor) end
			end
		end
	end

	-- Attempt to instantly get contents of wagons regardless of tick% delay
	script.on_event(defines.events.on_train_changed_state, function(event)
		if not event.train.cargo_wagons then return end
		for i, sensor in next, global.sensors do
			if not sensor.read or not sensor.read.valid then
				findConnectedEntity(sensor)
				if sensor.read then update(sensor) end
			end
		end
	end)
end

do
	local function onLoad()
		global.sensors = global.sensors or {}
		if #global.sensors > 0 then
			script.on_event(defines.events.on_tick, ticker)
		end
	end

	script.on_init(onLoad)
	script.on_load(onLoad)
end

do
	-- Created on game load/sensor creation and cached until the entity disappears
	local function getSearchArea(e)
		if e.direction == 0 then --south
			return {{e.position.x - BBox_offset, e.position.y}, {e.position.x + BBox_offset, e.position.y + BBox_range}}
		elseif e.direction == 2 then --west
			return {{e.position.x - BBox_range, e.position.y - BBox_offset}, {e.position.x, e.position.y + BBox_offset}}
		elseif e.direction == 4 then --north
			return {{e.position.x - BBox_offset, e.position.y - BBox_range}, {e.position.x + BBox_offset, e.position.y}}
		elseif e.direction == 6 then --east
			return {{e.position.x, e.position.y - BBox_offset}, {e.position.x + BBox_range, e.position.y + BBox_offset}}
		end
	end

	local function createSensor(entity)
		if global.sensors == nil then
			global.sensors = {}
		end
		if #global.sensors == 0 then
			script.on_event(defines.events.on_tick, ticker)
		end

		entity.operable = false
		entity.rotatable = false

		local s = {
			unitId = entity.unit_number,
			cc = entity,
		}
		s.area = getSearchArea(entity)
		findConnectedEntity(s)

		global.sensors[#global.sensors+1] = s
	end

	script.on_configuration_changed(function(data)
		global.sensors = global.sensors or {}
		if not global.migrated then
			for k, surface in pairs(game.surfaces) do
				local ents = surface.find_entities_filtered({name="item-sensor"})
				if ents and type(ents) == "table" and #ents > 0 then
					for i, s in next, ents do
						createSensor(s)
					end
				end
			end
			global.migrated = true
		end

		for i, sensor in next, global.sensors do
			sensor.unitId = sensor.cc.unit_number
			if not sensor.area then
				sensor.area = getSearchArea(sensor.cc)
			end
			findConnectedEntity(sensor)
		end
	end)

	local function onCreateCheck(event)
		if event.created_entity.name == "item-sensor" then
			createSensor(event.created_entity)
		end
	end

	script.on_event(defines.events.on_built_entity, onCreateCheck)
	script.on_event(defines.events.on_robot_built_entity, onCreateCheck)

	local function onRemoveCheck(event)
		if global.sensors ~= nil then
			if event.entity.name == "item-sensor" then
				for i = #global.sensors, 1, -1 do
					if event.entity.unit_number == global.sensors[i].unitId then
						table.remove(global.sensors, i)
						return
					end
				end
			end
		end
	end

	script.on_event(defines.events.on_preplayer_mined_item, onRemoveCheck)
	script.on_event(defines.events.on_robot_pre_mined, onRemoveCheck)
	script.on_event(defines.events.on_entity_died, onRemoveCheck)
end

There are 6 things worth noting;
1. It should be substantially faster. Note that I am not claiming I noticed anything before, because I did not. Regardless, theoretically, it should be much faster, which might be worth something on larger maps - I don't know.
2. The roboport only reads the 4 robot statistics, not the other contents because I don't care
3. I didn't implement the car/tank, because I don't use it
4. I am not going to upload this anywhere, and with this post I sign over all rights to the above to the author of the original addon
5. Line 370-380 are because I renamed the mod locally and toggled "Inventory Sensor" off, and so it migrates all the entities in my save games from your mod to this .global table
6. The tick function updates every 20 ticks, I ignore whatever is in the config file

The reason I want the roboport readout is because my perimeter outposts with 1 roboport use it to read both logistic network content and robot statistics. Anyway, it was a quick fix.

Hopefully you like it

[Optera]

There's quite some interesting changes you made in that complete rewrite. I sent you a pm with more details.

Reading Logistic Network statistic is a lot slower in lua than directly from a roboport and sometimes really buggy. For example when roboports run out of power and split a network. That's why I decided to remove this redundant/obsolete feature instead of properly implementing it with all checks.

[Sedar]

Thank you for this mod. He is sometimes extremely useful.

Recently, in my game, I learned the technology of electric trains and see that your sensor does not see electric locomotives from Electric Vehicles mod. Could you add compatibility with this mod, please.

[Optera]

Thank you for this mod. He is sometimes extremely useful.

Recently, in my game, I learned the technology of electric trains and see that your sensor does not see electric locomotives from Electric Vehicles mod. Could you add compatibility with this mod, please.

It can see electric locomotives just fine in my games. Only electric tanks are detected as car, though that's a drawback with any modded vehicle as I don't include a lookup table with names of all tanks in popular mods.

[Sedar]

It can see electric locomotives just fine in my games. Only electric tanks are detected as car, though that's a drawback with any modded vehicle as I don't include a lookup table with names of all tanks in popular mods.

You're right, everything works fine. Maybe when I did the tests I placed the sensor by the wrong side. Excuse for troubling. Thanks again for your mod.

[gridstop]

Would it be possible to read the contents of a requester chest? I have some setups where I have to use a circuit network to set requests, and read the contents of the requester chests, since they aren't normally part of the network.

[Optera]

Would it be possible to read the contents of a requester chest? I have some setups where I have to use a circuit network to set requests, and read the contents of the requester chests, since they aren't normally part of the network.

Good idea.

Edit: 1.3.0 connects to requester chests, including any modded requester, and ignores all other chest types.

[Mobius1]

hey Optera, how's it going?

first of all thanks for creating this mod, its so amazingly helpful I love it!

I'd like to give you an idea, why don't you make the hability to read wagon contents in your LTN mod?

Like the train arrives at the "provider station" with the signal, for example, 100 iron-ore, but my "provider station" is a mining outpost that has around 90k in stock and mines both iron and copper and its fed into the trains by logistic robots.

Sometimes the train requests "14 stacks" or something like that, that makes it requests 2 or more types of items at once on the station, so now lets say its outputting 100 iron and 100 copper, the logistic bots will start to grab iron to fill the train but the inserters are faster than the bots, so they empty out the requester chest before it tells the robots to stop bringing more iron, so they end up in a loop of grabbing iron over and over and over filling the wagon with only 1 type of ore. The solution I found for this particular issue was to use this Inventory Sensor mod attached with a combinator that turns the contents of the wagon into a negative signal and feeds the output of the LTN station, so once the wagon has, say, 100 iron ore, the requester chests clears out their filters since they're attached to the circuit network because its sending an iron signal of 0, the robots stops feeding it with iron and starts feeding it with copper and everything works automagically brilliant!

So that made me think that since the train sends the request signal to the LTN stop, why it doesn't also send its wagon contents to the Stop with an inverse signal of the work order? For example, if the train is providing items, outputting a negative signal, the contents of its wagon would output a positive signal, if the train is requesting items, outputting a positive signal, the wagon would output a negative signal.

Its just a suggestion btw, I'll still love both mods either way

[Optera]

hey Optera, how's it going?

first of all thanks for creating this mod, its so amazingly helpful I love it!

I'd like to give you an idea, why don't you make the hability to read wagon contents in your LTN mod?

Like the train arrives at the "provider station" with the signal, for example, 100 iron-ore, but my "provider station" is a mining outpost that has around 90k in stock and mines both iron and copper and its fed into the trains by logistic robots.

Sometimes the train requests "14 stacks" or something like that, that makes it requests 2 or more types of items at once on the station, so now lets say its outputting 100 iron and 100 copper, the logistic bots will start to grab iron to fill the train but the inserters are faster than the bots, so they empty out the requester chest before it tells the robots to stop bringing more iron, so they end up in a loop of grabbing iron over and over and over filling the wagon with only 1 type of ore. The solution I found for this particular issue was to use this Inventory Sensor mod attached with a combinator that turns the contents of the wagon into a negative signal and feeds the output of the LTN station, so once the wagon has, say, 100 iron ore, the requester chests clears out their filters since they're attached to the circuit network because its sending an iron signal of 0, the robots stops feeding it with iron and starts feeding it with copper and everything works automagically brilliant!

So that made me think that since the train sends the request signal to the LTN stop, why it doesn't also send its wagon contents to the Stop with an inverse signal of the work order? For example, if the train is providing items, outputting a negative signal, the contents of its wagon would output a positive signal, if the train is requesting items, outputting a positive signal, the wagon would output a negative signal.

Its just a suggestion btw, I'll still love both mods either way

LTN doesn't show train inventories because it would be waste of script updates wasted on a (soon) tripple redundant functionality.

• Inventory Sensor came long before LTN and has a much finer, per wagon, granularity than ltn could.
• For less granularity a simple memory cell storing inserter pulse reads and subtracting that from the static loading amount provides the best ups performance as it doesn't need any script update.
  On my maps I exclusively use this method for (u-)loading LTN controlled trains.
• 0.15 will add reading train inventories to all stops.

[Optera]

Update to 0.15 is done.
I've added reading inventories of fluid wagons, no idea why the devs didn't add that to train stops.


Now I need a break before moving LTN to 0.15.

[loganb]

Hello,

Your mods are great, BTW. Thanks for enriching the game for us all.

Quick question/feature request: can you/would you consider making it possible for the inventory sensor to report available space rather than contents? With the stack inserter override in 0.15 (and bug fix on 0.15.8), I think it's possible to load a train with multiple resources without locking inserters, but only if it's possible to sense the remaining space in the cargo wagon. Specifically, sensing space in locked slots would be amazing.

I made a feature request awhile ago and described how it might work: viewtopic.php?f=6&t=38897. I'd be interested in your thoughts on the subject. Thanks!

[Optera]

I'm not keen on doing anything related to filters with the horrible inefficient way the api exposes them.
Even just counting the number of filtered slots requires iterating over every single slot. The only exposed function is is_filtered which is mostly useless as it only returns if there is any filter set.

Should LuaInventory ever get a functions returning a list of indizes of filtered slots or a dictionary with direct references to filtered slots I'd consider working with them.

[ZlovreD]

Adding is_crafting() to assemblers, furnaces and reactors:

[signal.lua] @end

Code: Select all

  {
    type = "virtual-signal",
    name = "detect-in-use",
    icon = "__base__/graphics/icons/signal/signal_C.png",
    subgroup = "sensor-signals",
    order = "x[sensor-signals]-du"
  }

Maybee new icon?

[control.lua] @212 line before "if connectedEntity.type == ASSEMBLER then"

Code: Select all

  if connectedEntity.type == ASSEMBLER or connectedEntity.type == FURNACE or connectedEntity.type == REACTOR then
	if connectedEntity.is_crafting() then
		signals[signalIndex] = {index = signalIndex, signal = {type = "virtual",name = "detect-in-use"}, count = 1 }
		signalIndex = signalIndex+1
	end
  end

Reason, explanation and usage

I tried to make the flow of resources more smooth, without overloading Centrifuge with additional resources.
So it was needed a setup when inserters and/or belts stop working/moving if Centrifuge already is crafting. And result above.

From bottom and up:
First Centrifuge is unloading [C=0], inserter is loading resources and belt is blocked.
Second and third is crafting [C=1], inserter is stopped, belt passing items further.
Forth is not yet loaded, so [C=0] - behaviour same as first.

[Optera]

Why settle for just is_crafting when I could instead check crafting_progress.
To be useful it will have to display the percentage it's currently working on instead of how much it has completed. 0%-1% = 1, 99%-100% = 100

PS:
I currently use a a slight variation of this linear Kovarex design.

[ZlovreD]

Why settle for just is_crafting when I could instead check crafting_progress.
To be useful it will have to display the percentage it's currently working on instead of how much it has completed. 0%-1% = 1, 99%-100% = 100

Not yet tested, but i'm assuming 100% keeps until assembler unfinished unloading? But yeah, it's may be usefull.

PS:
I currently use a a slight variation of this linear Kovarex design.

Cuz donut shape allow me to check amount of 238 and split off 235 from circulation only if i have at least double amount of it to run kovarex process.

[Optera]

Done adding crafting progress.
A better icon would be appreciated.

I also rewrote a good chunk of inventory detection so it will work with modded creations like nuclear fuel powered furnaces with burnt results.

Edit: The mod portal is messed up again, you can download it on Github.

[ZlovreD]

Done adding crafting progress.

Sweet..

A better icon would be appreciated.

Pick any (clickable):




PS: And Dont forget to set [.icon_size = 64] like you did for LTN tech icon

[Optera]

Done adding crafting progress.

Sweet..

A better icon would be appreciated.

Pick any (clickable):




PS: And Dont forget to set [.icon_size = 64] like you did for LTN tech icon

Those gears would be fine for the crafting signal. However I'm looking for an icon for progress signal. preferably matching the temperature icon.

[ZlovreD]

Those gears would be fine for the crafting signal. However I'm looking for an icon for progress signal. preferably matching the temperature icon.

Last chance:


Btw you can go further and improve it by adding check for "entity.get_output_inventory().is_empty()" like in Bottleneck to maintain sending 100% signal.
Also can be added signal for bonus progress "entity.bonus_progress".