Merge pull request #67 from cyberbit/feature/miscadapters

Add Powah, Bigger Reactors, and Advanced Peripherals adapters

src/telem/lib/input.lua

@@ -1,15 +1,35 @@
 local function requireInput(target) return require ('telem.lib.input.' .. target) end
+local function requireAP(target) return requireInput('advancedPeripherals.' .. target) end
+local function requireBR(target) return requireInput('biggerReactors.' .. target) end
 local function requireMek(target) return requireInput('mekanism.' .. target) end
+local function requirePowah(target) return requireInput('powah.' .. target) end
 
-return {
+local export = {
     helloWorld                  = requireInput('HelloWorldInputAdapter'),
     custom                      = requireInput('CustomInputAdapter'),
 
     -- storage
     itemStorage                 = requireInput('ItemStorageInputAdapter'),
     fluidStorage                = requireInput('FluidStorageInputAdapter'),
-    refinedStorage              = requireInput('RefinedStorageInputAdapter'),
-    meStorage                   = requireInput('MEStorageInputAdapter'),
+
+    -- communication
+    secureModem                 = requireInput('SecureModemInputAdapter'),
+
+    advancedPeripherals = {
+        energyDetector          = requireAP('EnergyDetectorInputAdapter'),
+        environmentDetector     = requireAP('EnvironmentDetectorInputAdapter'),
+        geoScanner              = requireAP('GeoScannerInputAdapter'),
+        inventoryManager        = requireAP('InventoryManagerInputAdapter'),
+        meBridge                = requireAP('MEBridgeInputAdapter'),
+        playerDetector          = requireAP('PlayerDetectorInputAdapter'),
+        redstoneIntegrator      = requireAP('RedstoneIntegratorInputAdapter'),
+        rsBridge                = requireAP('RSBridgeInputAdapter'),
+    },
+
+    biggerReactors = {
+        reactor                 = requireBR('ReactorInputAdapter'),
+        turbine                 = requireBR('TurbineInputAdapter'),
+    },
 
     mekanism = {
         -- machines
@@ -88,10 +108,18 @@ return {
         qioDriveArray           = requireMek('QIODriveArrayInputAdapter'),
     },
 
-    advancedPeripherals = {
-        energyDetector = require 'telem.lib.input.advancedPeripherals.EnergyDetectorInputAdapter',
+    powah = {
+        energyCell              = requirePowah('EnergyCellInputAdapter'),
+        furnator                = requirePowah('FurnatorInputAdapter'),
+        magmator                = requirePowah('MagmatorInputAdapter'),
+        reactor                 = requirePowah('ReactorInputAdapter'),
+        solarPanel              = requirePowah('SolarPanelInputAdapter'),
+        thermoGenerator         = requirePowah('ThermoGeneratorInputAdapter'),
     },
-
-    -- modem
-    secureModem                 = requireInput('SecureModemInputAdapter'),
 }
+
+-- aliases that will be deprecated in the future
+export.refinedStorage              = export.advancedPeripherals.rsBridge
+export.meStorage                   = export.advancedPeripherals.meBridge
+
+return export

src/telem/lib/input/advancedPeripherals/BaseAdvancedPeripheralsInputAdapter.lua

@@ -1,4 +1,6 @@
 local o = require 'telem.lib.ObjectModel'
+local fl = require 'telem.vendor'.fluent
+local fn = fl.fn
 
 local InputAdapter      = require 'telem.lib.InputAdapter'
 local Metric            = require 'telem.lib.Metric'
@@ -7,19 +9,47 @@ local MetricCollection  = require 'telem.lib.MetricCollection'
 local BaseAdvancedPeripheralsInputAdapter = o.class(InputAdapter)
 BaseAdvancedPeripheralsInputAdapter.type = 'BaseAdvancedPeripheralsInputAdapter'
 
-function BaseAdvancedPeripheralsInputAdapter:constructor (peripheralName)
+function BaseAdvancedPeripheralsInputAdapter:constructor (peripheralName, categories, ...)
     self:super('constructor')
 
     self.prefix = 'ap:'
 
+    self.categories = categories or { 'basic' }
+
+    ---@type table<string, table<string, cyberbit.Fluent>>
     self.queries = {}
 
+    ---@type cyberbit.Fluent[]
+    self.storageQueries = {}
+
     -- boot components
     self:setBoot(function ()
         self.components = {}
 
         self:addComponentByPeripheralID(peripheralName)
     end)()
+
+    self:beforeRegister(peripheralName, categories, ...)
+
+    self:register()
+end
+
+function BaseAdvancedPeripheralsInputAdapter:beforeRegister (peripheralName, categories, ...)
+    -- nothing by default, should be overridden by subclasses
+end
+
+function BaseAdvancedPeripheralsInputAdapter:register ()
+    local allCategories = fl(self.queries):keys():result()
+
+    if self.categories == '*' then
+        self.categories = allCategories
+    elseif type(self.categories) == 'table' then
+        self.categories = fl(self.categories):intersect(allCategories):result()
+    else
+        error('categories must be a list of categories or "*"')
+    end
+
+    return self
 end
 
 local function queueHelper (results, index, query)
@@ -30,12 +60,13 @@ end
 
 function BaseAdvancedPeripheralsInputAdapter:read ()
     self:boot()
-
+    
     local source, component = next(self.components)
 
     local tempMetrics = {}
     local queue = {}
 
+    -- execute single-metric queries from a queue
     for _, category in ipairs(self.categories) do
         for k, v in pairs(self.queries[category]) do
             table.insert(queue, queueHelper(
@@ -48,7 +79,31 @@ function BaseAdvancedPeripheralsInputAdapter:read ()
 
     parallel.waitForAll(table.unpack(queue))
 
+    -- execute storage queries, which may return multiple metrics
+    -- these have no category and are always included
+    for k, v in pairs(self.storageQueries) do
+        local tempResult = v:from(component):result()
+
+        for _, metric in ipairs(tempResult) do
+            metric.name = 'storage:' .. metric.name
+            metric.source = source
+
+            table.insert(tempMetrics, metric)
+        end
+    end
+
     return MetricCollection(table.unpack(tempMetrics))
 end
 
+function BaseAdvancedPeripheralsInputAdapter.mintAdapter (type)
+    local adapter = o.class(BaseAdvancedPeripheralsInputAdapter)
+    adapter.type = type
+
+    function adapter:constructor (peripheralName, categories, ...)
+        self:super('constructor', peripheralName, categories, ...)
+    end
+
+    return adapter
+end
+
 return BaseAdvancedPeripheralsInputAdapter

src/telem/lib/input/advancedPeripherals/EnergyDetectorInputAdapter.lua

@@ -1,31 +1,12 @@
-local o = require 'telem.lib.ObjectModel'
-local t = require 'telem.lib.util'
 local fn = require 'telem.vendor'.fluent.fn
 
-local BaseAdvancedPeripheralsInputAdapter = require 'telem.lib.input.advancedPeripherals.BaseAdvancedPeripheralsInputAdapter'
+local base = require 'telem.lib.input.advancedPeripherals.BaseAdvancedPeripheralsInputAdapter'
 
-local EnergyDetectorInputAdapter = o.class(BaseAdvancedPeripheralsInputAdapter)
-EnergyDetectorInputAdapter.type = 'EnergyDetectorInputAdapter'
+local EnergyDetectorInputAdapter = base.mintAdapter('EnergyDetectorInputAdapter')
 
-function EnergyDetectorInputAdapter:constructor (peripheralName, categories)
-    self:super('constructor', peripheralName)
-
-    -- TODO this will be a configurable feature later
+function EnergyDetectorInputAdapter:beforeRegister (peripheralName, categories)
     self.prefix = 'apenergy:'
 
-    -- TODO make these constants
-    local allCategories = {
-        'basic',
-    }
-
-    if not categories then
-        self.categories = { 'basic' }
-    elseif categories == '*' then
-        self.categories = allCategories
-    else
-        self.categories = categories
-    end
-
     self.queries = {
         basic = {
             transfer_rate       = fn():call('getTransferRate'):energyRate(),

src/telem/lib/input/advancedPeripherals/EnvironmentDetectorInputAdapter.lua

@@ -0,0 +1,38 @@
+local fn = require 'telem.vendor'.fluent.fn
+
+local base = require 'telem.lib.input.advancedPeripherals.BaseAdvancedPeripheralsInputAdapter'
+
+local EnvironmentDetectorInputAdapter = base.mintAdapter('EnvironmentDetectorInputAdapter')
+
+function EnvironmentDetectorInputAdapter:beforeRegister (peripheralName, categories)
+    self.prefix = 'apenv:'
+
+    self.queries = {
+        basic = {
+            block_light_level           = fn():call('getBlockLightLevel'),
+            day_light_level             = fn():call('getDayLightLevel'),
+            sky_light_level             = fn():call('getSkyLightLevel'),
+            moon_id                     = fn():call('getMoonId'),
+            time                        = fn():call('getTime'),
+            radiation                   = fn():call('getRadiationRaw'):with('unit', 'Sv/h'),
+            can_sleep                   = fn():call('canSleepHere'):toFlag(),
+            raining                     = fn():call('isRaining'):toFlag(),
+            sunny                       = fn():call('isSunny'):toFlag(),
+            thundering                  = fn():call('isThunder'):toFlag(),
+            slime_chunk                 = fn():call('isSlimeChunk'):toFlag(),
+        },
+    }
+
+    -- getBiome
+    -- getDimensionName
+    -- getDimensionPaN
+    -- getDimensionProvider
+    -- getMoonName
+    -- getOperationCooldown
+    -- isDimension
+    -- listDimensions
+    -- scanCost
+    -- scanEntities
+end
+
+return EnvironmentDetectorInputAdapter

src/telem/lib/input/advancedPeripherals/GeoScannerInputAdapter.lua

@@ -0,0 +1,24 @@
+local fn = require 'telem.vendor'.fluent.fn
+
+local base      = require 'telem.lib.input.advancedPeripherals.BaseAdvancedPeripheralsInputAdapter'
+local Metric    = require 'telem.lib.Metric'
+
+local GeoScannerInputAdapter = base.mintAdapter('GeoScannerInputAdapter')
+
+function GeoScannerInputAdapter:beforeRegister (peripheralName, categories)
+    self.prefix = 'apgeo:'
+
+    self.queries = {
+        basic = {},
+    }
+
+    self.storageQueries = {
+        fn():callElse('chunkAnalyze', {})
+            :map(function (k, v) return Metric{ name = k, value = v } end)
+            :values()
+    }
+
+    -- scan
+end
+
+return GeoScannerInputAdapter

src/telem/lib/input/advancedPeripherals/InventoryManagerInputAdapter.lua

@@ -0,0 +1,33 @@
+local fn = require 'telem.vendor'.fluent.fn
+
+local base      = require 'telem.lib.input.advancedPeripherals.BaseAdvancedPeripheralsInputAdapter'
+local Metric    = require 'telem.lib.Metric'
+
+local InventoryManagerInputAdapter = base.mintAdapter('InventoryManagerInputAdapter')
+
+function InventoryManagerInputAdapter:beforeRegister (peripheralName, categories)
+    self.prefix = 'apinv:'
+
+    local armor = fn():call('getArmor')
+
+    self.queries = {
+        basic = {
+            equipped                     = fn():call('isPlayerEquipped'):toFlag(),
+            equipped_helmet              = armor:firstWhere('slot', 103):toFlag(),
+            equipped_chestplate          = armor:firstWhere('slot', 102):toFlag(),
+            equipped_leggings            = armor:firstWhere('slot', 101):toFlag(),
+            equipped_boots               = armor:firstWhere('slot', 100):toFlag(),
+            inventory_available          = fn():call('isSpaceAvailable'):toFlag(),
+            inventory_slots_available    = fn():call('getEmptySpace'),
+        },
+    }
+
+    self.storageQueries = {
+        fn():call('getItems')
+            :sum('count', 'name')
+            :map(function (k, v) return Metric{ name = k, value = v, unit = 'item' } end)
+            :values()
+    }
+end
+
+return InventoryManagerInputAdapter