Add more mekanism input adapters #19

bananasov · 2023-10-07T12:56:17Z

THIS IS A DRAFT, THERE IS NO WAY IN HELL I'D BE ABLE TO ADD SUPPORT FOR EVERYTHING
This PR adds support for even more mekanism inputs!!!! I'd hope to add support for EVERYTHING but currently it is very basic. There are over 700 rows in the CSV im looking up stuff in, its a really bad CSV too, send help.

List of blocks that have support

look i have no idea if this works, but from eyeballing `methods.csv` and reading lines in ComputerCraft itself I am fairly certain that this might work although i could be wrong because mekanism sucks sometimes.

not something special really, just the bare minimum to monitor a chemical tank

how the fuck did i miss that..

poggersss

All complaints go to: https://github.com/SkyTheCodeMaster

cyberbit · 2023-10-07T15:04:44Z

This is great! Whenever you get to a stopping point I will review in more detail but looks pretty good so far!

The only note I would make is concerning units. For consistency with other adapters I would use B and B/t for gas/chemicals/fluids (see below for example from FissionReactorInputAdapter):

Thanks for contributing ❤️

cyberbit · 2023-10-07T18:56:05Z

FYI, I found this improved computer API documentation: https://mekanism.github.io/computer_data/10.4.0.html

This is for the very newly released 1.20.x Mekanism version, so it may be slightly off but is probably better than the spreadsheet.

bananasov · 2023-10-07T22:48:53Z

FYI, I found this improved computer API documentation: https://mekanism.github.io/computer_data/10.4.0.html

This is for the very newly released 1.20.x Mekanism version, so it may be slightly off but is probably better than the spreadsheet.

holy shit that is so much better

This supports all of the types afaik

its a direct copy paste of the previous addition

these were so easy wtf

pog

oh my god i hate this so much thank god it is over

cyberbit · 2023-10-21T23:25:00Z

Hey @Autist69420, are you at a stopping point with this? If so I can merge and continue with the rest of them. :)

bananasov · 2023-10-22T22:55:40Z

Hey @Autist69420, are you at a stopping point with this? If so I can merge and continue with the rest of them. :)

Been a bit lazy lately, you can merge everything I have now if ya want I can always open more PRs :p

although I haven't added everything to the input.lua file yet so 🤷

cyberbit · 2023-10-23T15:47:28Z

It happens to the best of us. :)

I will merge everything to feature/more-mekanism and open another draft PR so progress can still be tracked. I want to take a deeper look at the code and try to define better categories so the standard is the same across Mekanism adapters.

cyberbit · 2023-10-24T00:30:12Z

src/telem/lib/input.lua

I may move Mekanism stuff to input/mekanism.lua to keep this file a little more tidy, haven't decided yet. 🤔

Seems like the smartest approach since this is a little messy 😛

cyberbit

Sorry ahead of time for the pings!!

Adapters reviewed:

Current input categories for Mekanism (I will expand this as I review)

basic: This should included the fundamental indicators for a machine. For example, most "filled percentage" values and energy production/consumption rates are appropriate here. Avoid including specific max/min/current capacity metrics; those usually belong in their respective category.
advanced: Machine-specific configuration, flags, or statuses
fuel: Any non-basic metric relating to a resource consumed for energy production, like fissile fuel, biofuel, ethylene, etc.
coolant: Any non-basic metric relating to coolant
waste: Any non-basic metric relating to waste
formation: Any non-basic metrics related to facts about the machine itself, such as physical dimensions, component parts, and mod-level configurations.
energy: Any non-basic metrics related to energy. Most often this will be energy capacity.
steam: This category is only used by the turbine and will probably go away because it is dumb.
input: Any non-basic metric relating to input resources, except energy (items, fluids, chemicals, etc.)
output: Any non-basic metric relating to output resources, except energy (items, fluids, chemicals, etc.)

src/telem/lib/input/mekanism/BioGeneratorInputAdapter.lua

cyberbit · 2023-10-24T00:43:07Z

src/telem/lib/input/mekanism/BioGeneratorInputAdapter.lua

+            metrics:insert(Metric{ name = self.prefix .. 'fuel_amount', value = (generator.getBioFuel().amount / 1000), unit = "B", source = source }) -- might error might not, no clue!
+            metrics:insert(Metric{ name = self.prefix .. 'fuel_filled_percentage', value = generator.getBioFuelFilledPercentage(), unit = nil, source = source })
+            metrics:insert(Metric{ name = self.prefix .. 'fuel_needed', value = (generator.getBioFuelNeeded() / 1000), unit = 'B/t', source = source })
+            metrics:insert(Metric{ name = self.prefix .. 'production_rate', value = mekanismEnergyHelper.joulesToFE(generator.getProductionRate()), unit = nil, source = source })


Unit should be 'FE/t'

Fixed in 6814f0d, hopefully

cyberbit · 2023-10-24T00:45:26Z

src/telem/lib/input/mekanism/BioGeneratorInputAdapter.lua

+            metrics:insert(Metric{ name = self.prefix .. 'fuel_capacity', value = (generator.getBioFuelCapacity() / 1000), unit = "B", source = source })
+            metrics:insert(Metric{ name = self.prefix .. 'fuel_amount', value = (generator.getBioFuel().amount / 1000), unit = "B", source = source }) -- might error might not, no clue!
+            metrics:insert(Metric{ name = self.prefix .. 'fuel_filled_percentage', value = generator.getBioFuelFilledPercentage(), unit = nil, source = source })
+            metrics:insert(Metric{ name = self.prefix .. 'fuel_needed', value = (generator.getBioFuelNeeded() / 1000), unit = 'B/t', source = source })


I think the unit here should be B? From what I can tell, needed is max_capacity - current

Done in 6814f0d

cyberbit · 2023-10-24T00:52:25Z

src/telem/lib/input/mekanism/BioGeneratorInputAdapter.lua

+            -- do nothing
+
+        -- Literally all we have lmao
+        elseif v == 'basic' then


I think to preserve API parity, fuel_* should be changed to bio_fuel_*.

Categories should be expanded:

Basic:

energy_filled_percentage

bio_fuel_filled_percentage

production_rate

Fuel:

bio_fuel_capacity

bio_fuel

bio_fuel_needed

Energy:

energy

blehhh my responses are gonna get sillier the more send it: 6814f0d

cyberbit · 2023-10-24T01:07:20Z

src/telem/lib/input/mekanism/DigitalMinerInputAdapter.lua

+    self.prefix = 'mekdigitalminer:'
+
+    -- TODO make these constants
+    local allCategories = {


Recommend basic and energy; may add advanced and formation in later updates.

cyberbit · 2023-10-24T01:45:06Z

src/telem/lib/input/mekanism/DigitalMinerInputAdapter.lua

+            -- do nothing
+
+        -- Literally all we have lmao
+        elseif v == 'basic' then


Categories should be expanded:

Basic:

energy_filled_percentage

energy_usage

get_to_mine

is_running

Energy:

energy

cyberbit · 2023-10-24T01:46:05Z

src/telem/lib/input/mekanism/DigitalMinerInputAdapter.lua

+            metrics:insert(Metric{ name = self.prefix .. 'energy', value = mekanismEnergyHelper.joulesToFE(miner.getEnergy()), unit = "FE", source = source })
+            metrics:insert(Metric{ name = self.prefix .. 'energy_filled_percentage', value = (miner.getEnergyFilledPercentage()), unit = nil, source = source })
+            metrics:insert(Metric{ name = self.prefix .. 'energy_usage', value = mekanismEnergyHelper.joulesToFE(miner.getEnergyUsage()), unit = "FE/t", source = source })
+            metrics:insert(Metric{ name = self.prefix .. 'get_to_mine', value = miner.getToMine(), unit = "items", source = source })


Metric name should not include the function verb, recommend to_mine.

Use singular units whenever possible, recommend "item" here.

cyberbit · 2023-10-24T01:52:24Z

src/telem/lib/input/mekanism/DigitalMinerInputAdapter.lua

+            metrics:insert(Metric{ name = self.prefix .. 'energy_filled_percentage', value = (miner.getEnergyFilledPercentage()), unit = nil, source = source })
+            metrics:insert(Metric{ name = self.prefix .. 'energy_usage', value = mekanismEnergyHelper.joulesToFE(miner.getEnergyUsage()), unit = "FE/t", source = source })
+            metrics:insert(Metric{ name = self.prefix .. 'get_to_mine', value = miner.getToMine(), unit = "items", source = source })
+            metrics:insert(Metric{ name = self.prefix .. 'is_running', value = (miner.isRunning() and 1 or 0), unit = nil, source = source })


Remove function verb from name, recommend running.

Thought about this one for a bit, as I do like labelling true/false flags differently. But, Induction Matrix adapter does this for isFormed() => formed, so probably better to follow the precedent.

bananasov · 2023-10-24T08:12:34Z

Christ that is a lot of reviews, I'll get to nibbling on them slowly over the week

cyberbit · 2023-10-25T00:47:04Z

src/telem/lib/input/mekanism/DynamicTankInputAdapter.lua

+    self:super('constructor')
+
+    -- TODO this will be a configurable feature later
+    self.prefix = 'mekchemtank:'


Recommend mekdynamictank: for prefix

cyberbit · 2023-10-25T00:47:35Z

src/telem/lib/input/mekanism/DynamicTankInputAdapter.lua

+    self.prefix = 'mekchemtank:'
+
+    -- TODO make these constants
+    local allCategories = {


Recommend basic category only, see comments in read()

cyberbit · 2023-10-25T00:53:46Z

src/telem/lib/input/mekanism/DynamicTankInputAdapter.lua

+            -- do nothing
+
+        -- Literally all we have lmao
+        elseif v == 'basic' then


Recommend putting everything in basic category to match Chemical Tank adapter layout.

I think tank_capacity and chemical_tank_capacity would be the most correct here. Dynamic Tanks can store more mB of chemical vs fluid for the same structure dimensions, so there are technically two maximum capacities depending on the contents. 🤷

cyberbit · 2023-10-25T00:58:21Z

src/telem/lib/input/mekanism/GasGeneratorInputAdapter.lua

+    self.prefix = 'mekgasgen:'
+
+    -- TODO make these constants
+    local allCategories = {


Recommend basic, fuel, energy

cyberbit · 2023-10-25T01:01:43Z

src/telem/lib/input/mekanism/GasGeneratorInputAdapter.lua

+            -- do nothing
+
+        -- Literally all we have lmao
+        elseif v == 'basic' then


Categories should be expanded:

Basic:

energy_filled_percentage

fuel_filled_percentage

production_rate

Fuel:

fuel_amount

fuel_capacity

fuel_needed

Energy:

energy

cyberbit · 2023-10-25T01:02:50Z

src/telem/lib/input/mekanism/IsotopicCentrifugeInputAdapter.lua

+    self:super('constructor')
+
+    -- TODO this will be a configurable feature later
+    self.prefix = 'mekunicable:'


Prefix should be mekcentrifuge:

cyberbit · 2023-10-25T01:09:49Z

src/telem/lib/input/mekanism/IsotopicCentrifugeInputAdapter.lua

+    self.prefix = 'mekunicable:'
+
+    -- TODO make these constants
+    local allCategories = {


Recommend adding energy category

cyberbit · 2023-10-25T01:22:10Z

src/telem/lib/input/mekanism/IsotopicCentrifugeInputAdapter.lua

+            -- do nothing
+
+        -- Literally all we have lmao
+        elseif v == 'basic' then


Recommend this category layout:

Basic:

energy_usage

energy_filled_percentage

input_filled_percentage

output_filled_percentage

Energy:

energy

energy_needed

Input:

input

input_capacity

Output:

output

output_capacity

cyberbit · 2023-10-25T01:26:41Z

src/telem/lib/input/mekanism/LaserAmplifierInputAdapter.lua

+    self.prefix = 'meklaseramp:'
+
+    -- TODO make these constants
+    local allCategories = {


Recommend basic, energy

cyberbit · 2023-10-25T01:42:56Z

src/telem/lib/input/mekanism/LaserAmplifierInputAdapter.lua

+            -- do nothing
+
+        -- Literally all we have lmao
+        elseif v == 'basic' then


Rename energy_max to max_energy to align with induction matrix and turbine adapters. I would also add an energy category:

Basic:

energy_filled_percentage

Energy:

energy

max_energy

energy_needed

The energy category across most machines is nearly identical... I may try to look into ways of applying metric "templates" for common categories in the future to improve code reuse.

cyberbit · 2023-10-25T01:48:19Z

src/telem/lib/input/mekanism/LaserInputAdapter.lua

Same notes on this as Laser Amplifier:

category list update

energy_max => max_energy

move everything to energy category except energy_filled_percentage

cyberbit · 2024-06-15T14:45:38Z

Merging this for now, as the Mekanism integration is being rewritten with fluent queries.

bananasov added 7 commits October 7, 2023 14:36

feat: Mekanism Bio Generator input adapter

1d70df0

look i have no idea if this works, but from eyeballing `methods.csv` and reading lines in ComputerCraft itself I am fairly certain that this might work although i could be wrong because mekanism sucks sometimes.

feat: Mekanism Chemical Tank input adapter

f650a57

not something special really, just the bare minimum to monitor a chemical tank

fix: Incorrect return table

fab7e55

how the fuck did i miss that..

feat: Add production rate to bio generator

5d0d36a

feat: Mekanism Gas Generator input adapter

2c8ea86

feat: Mekanism Digital Miner input adapter

daa85e1

poggersss

feat: Mekanism dynamic tank input adapter

cd6f5e5

All complaints go to: https://github.com/SkyTheCodeMaster

cyberbit added enhancement New feature or request mod: Mekanism Related to Mekanism and affiliates sw: Adapter Inputs and outputs labels Oct 7, 2023

bananasov added 2 commits October 7, 2023 17:50

fix: Use B and B/t for gas/chemicals/fluids

6d5f1c2

chore: Add new input adapters to input.lua

e816ede

bananasov added 6 commits October 8, 2023 13:21

feat: Add laser and laser amp input adapters

7e2a1c0

feat: Add universal cable input adapter

d8cb736

This supports all of the types afaik

feat: Add PressurizedTube input adapter

483bb0b

its a direct copy paste of the previous addition

feat: Add Mechanical Pipe input adapter

85d7005

these were so easy wtf

feat: Add Isotopic Centrifuge input adapter

a2266b3

pog

feat: Add Quantum Entangloporter input adapter

04378fa

oh my god i hate this so much thank god it is over

cyberbit self-assigned this Oct 23, 2023

cyberbit changed the base branch from main to feature/more-mekanism October 23, 2023 15:48

cyberbit marked this pull request as ready for review October 23, 2023 15:54

cyberbit reviewed Oct 24, 2023

View reviewed changes

src/telem/lib/input/mekanism/BioGeneratorInputAdapter.lua Show resolved Hide resolved

cyberbit reviewed Oct 24, 2023

View reviewed changes

bananasov added 3 commits October 24, 2023 09:59

fix: Patch up bio generator to comply with bits requests.

6814f0d

fix: Patch up digital miner input adapter per bits requests

b243c62

fix: Fix up mistake in DigitalMinerInputAdapter

d4e44df

cyberbit reviewed Oct 25, 2023

View reviewed changes

cyberbit merged commit a8b2dc8 into cyberbit:feature/more-mekanism Jun 15, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add more mekanism input adapters #19

Add more mekanism input adapters #19

bananasov commented Oct 7, 2023 •

edited

Loading

cyberbit commented Oct 7, 2023 •

edited

Loading

cyberbit commented Oct 7, 2023

bananasov commented Oct 7, 2023

cyberbit commented Oct 21, 2023

bananasov commented Oct 22, 2023 •

edited

Loading

cyberbit commented Oct 23, 2023

cyberbit Oct 24, 2023

bananasov Oct 24, 2023

cyberbit left a comment •

edited

Loading

cyberbit Oct 24, 2023

bananasov Oct 24, 2023

cyberbit Oct 24, 2023

bananasov Oct 24, 2023

cyberbit Oct 24, 2023

bananasov Oct 24, 2023

cyberbit Oct 24, 2023

cyberbit Oct 24, 2023

cyberbit Oct 24, 2023 •

edited

Loading

cyberbit Oct 24, 2023

bananasov commented Oct 24, 2023

cyberbit Oct 25, 2023

cyberbit Oct 25, 2023

cyberbit Oct 25, 2023

cyberbit Oct 25, 2023

cyberbit Oct 25, 2023

cyberbit Oct 25, 2023

cyberbit Oct 25, 2023

cyberbit Oct 25, 2023

cyberbit Oct 25, 2023

cyberbit Oct 25, 2023

cyberbit Oct 25, 2023 •

edited

Loading

cyberbit commented Jun 15, 2024

Add more mekanism input adapters #19

Add more mekanism input adapters #19

Conversation

bananasov commented Oct 7, 2023 • edited Loading

List of blocks that have support

cyberbit commented Oct 7, 2023 • edited Loading

cyberbit commented Oct 7, 2023

bananasov commented Oct 7, 2023

cyberbit commented Oct 21, 2023

bananasov commented Oct 22, 2023 • edited Loading

cyberbit commented Oct 23, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cyberbit left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cyberbit Oct 24, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bananasov commented Oct 24, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cyberbit Oct 25, 2023 • edited Loading

Choose a reason for hiding this comment

cyberbit commented Jun 15, 2024

bananasov commented Oct 7, 2023 •

edited

Loading

cyberbit commented Oct 7, 2023 •

edited

Loading

bananasov commented Oct 22, 2023 •

edited

Loading

cyberbit left a comment •

edited

Loading

cyberbit Oct 24, 2023 •

edited

Loading

cyberbit Oct 25, 2023 •

edited

Loading