Skip to content

Commit

Permalink
📦 add docs for QIO drive array, entangloporter, waste barrel
Browse files Browse the repository at this point in the history
  • Loading branch information
cyberbit committed Jan 3, 2025
1 parent df1eab9 commit 49ae236
Show file tree
Hide file tree
Showing 6 changed files with 233 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,9 @@ export default defineConfig({
{ text: 'Pressurized Tube', link: '/reference/input/mekanism/PressurizedTube' },
{ text: 'Purification Chamber', link: '/reference/input/mekanism/PurificationChamber' },
// { text: 'Purifying Factory', link: '/reference/input/mekanism/PurifyingFactory' },
// { text: 'QIO Drive Array', link: '/reference/input/mekanism/QIODriveArray' },
// { text: 'Quantum Entangloporter', link: '/reference/input/mekanism/QuantumEntangloporter' },
// { text: 'Radioactive Waste Barrel', link: '/reference/input/mekanism/RadioactiveWasteBarrel' },
{ text: 'QIO Drive Array', link: '/reference/input/mekanism/QIODriveArray' },
{ text: 'Quantum Entangloporter', link: '/reference/input/mekanism/QuantumEntangloporter' },
{ text: 'Radioactive Waste Barrel', link: '/reference/input/mekanism/RadioactiveWasteBarrel' },
// { text: 'Resistive Heater', link: '/reference/input/mekanism/ResistiveHeater' },
// { text: 'Rotary Condensentrator', link: '/reference/input/mekanism/RotaryCondensentrator' },
// { text: 'Sawing Factory', link: '/reference/input/mekanism/SawingFactory' },
Expand Down
Binary file added docs/assets/mekanism-qio-inventory.webp
Binary file not shown.
Binary file added docs/assets/mekanism-waste-barrel-contents.webp
Binary file not shown.
70 changes: 70 additions & 0 deletions docs/reference/input/mekanism/QIODriveArray.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
telem:
adapter:
id: 'qioDriveArray'
name: 'QIO Drive Array'
categories: '{ "basic", "advanced", "storage" }'
---

# Mekanism QIO Drive Array Input <RepoLink path="lib/input/mekanism/QIODriveArrayInputAdapter.lua" />

<!--@include: ./common/preamble.md -->

### Basic

<MetricTable
prefix="mekqioarray:"
:metrics="[
{ name: 'frequency_selected', value: '0 or 1' },
{ name: 'item_filled_percentage', value: '0.0 - 1.0' },
{ name: 'type_filled_percentage', value: '0.0 - 1.0' }
]"
/>

### Advanced

```lua
DRIVE_STATUSES = { READY = 1, NONE = 2, OFFLINE = 3, NEAR_FULL = 4, FULL = 5 }
```

<MetricTable
prefix="mekqioarray:"
:metrics="[
{
name: 'drive_status_N', value: 'DRIVE_STATUSES value',
badge: { type: 'tip', text: 'Indexed per drive' }
}
]"
/>

### Storage

<MetricTable
prefix="mekqioarray:"
:metrics="[
{ name: 'item_count', value: '0 - inf', unit: 'item' },
{ name: 'item_capacity', value: '0 - inf', unit: 'item' },
{ name: 'type_count', value: '0 - inf' },
{ name: 'type_capacity', value: '0 - inf' }
]"
/>

## Storage

::: tip Frequency Scope
Due to Mekanism limitations, only the items in the specified drive array peripheral are exposed as metrics. To see the full contents of a frequency, use a separate peripheral/adapter per drive array.
:::

If the drive array contains items in its drives, a storage metric is added for each item. Given a drive array with the following contents (as shown in a QIO Dashboard):

![Mekanism QIO Dashboard with contents](/assets/mekanism-qio-inventory.webp)

The following metrics would be added:

<MetricTable
prefix="storage:"
:metrics="[
{ name: 'minecraft:glowstone_dust', value: '48', unit: 'item' },
{ name: 'minecraft:redstone', value: '459', unit: 'item' }
]"
/>
111 changes: 111 additions & 0 deletions docs/reference/input/mekanism/QuantumEntangloporter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
---
telem:
adapter:
id: 'quantumEntangloporter'
name: 'Quantum Entangloporter'
categories: '{ "basic", "advanced", "fluid", "gas", "infuse", "item", "pigment", "slurry", "energy" }'
---

# Mekanism Quantum Entangloporter Input <RepoLink path="lib/input/mekanism/QuantumEntangloporterInputAdapter.lua" />

<!--@include: ./common/preamble.md -->

### Basic

<MetricTable
prefix="mekentanglo:"
:metrics="[
{ name: 'fluid_filled_percentage', value: '0.0 - 1.0' },
{ name: 'gas_filled_percentage', value: '0.0 - 1.0' },
{ name: 'infuse_filled_percentage', value: '0.0 - 1.0' },
{ name: 'pigment_filled_percentage', value: '0.0 - 1.0' },
{ name: 'slurry_filled_percentage', value: '0.0 - 1.0' },
{ name: 'energy_filled_percentage', value: '0.0 - 1.0' },
{ name: 'temperature', value: '0.0 - inf', unit: 'K' }
]"
/>

### Advanced

<MetricTable
prefix="mekentanglo:"
:metrics="[
{ name: 'transfer_loss', value: '0.0 - inf' },
{ name: 'environmental_loss', value: '0.0 - inf' }
]"
/>

### Fluid

<MetricTable
prefix="mekentanglo:"
:metrics="[
{ name: 'fluid', value: '0.0 - inf', unit: 'B' },
{ name: 'fluid_capacity', value: '0.0 - inf', unit: 'B' },
{ name: 'fluid_needed', value: '0.0 - inf', unit: 'B' }
]"
/>

### Gas

<MetricTable
prefix="mekentanglo:"
:metrics="[
{ name: 'gas', value: '0.0 - inf', unit: 'B' },
{ name: 'gas_capacity', value: '0.0 - inf', unit: 'B' },
{ name: 'gas_needed', value: '0.0 - inf', unit: 'B' }
]"
/>

### Infuse

<MetricTable
prefix="mekentanglo:"
:metrics="[
{ name: 'infuse', value: '0.0 - inf', unit: 'B' },
{ name: 'infuse_capacity', value: '0.0 - inf', unit: 'B' },
{ name: 'infuse_needed', value: '0.0 - inf', unit: 'B' }
]"
/>

### Item

<MetricTable
prefix="mekentanglo:"
:metrics="[
{ name: 'item_count', value: '0 - inf' }
]"
/>

### Pigment

<MetricTable
prefix="mekentanglo:"
:metrics="[
{ name: 'pigment', value: '0.0 - inf', unit: 'B' },
{ name: 'pigment_capacity', value: '0.0 - inf', unit: 'B' },
{ name: 'pigment_needed', value: '0.0 - inf', unit: 'B' }
]"
/>

### Slurry

<MetricTable
prefix="mekentanglo:"
:metrics="[
{ name: 'slurry', value: '0.0 - inf', unit: 'B' },
{ name: 'slurry_capacity', value: '0.0 - inf', unit: 'B' },
{ name: 'slurry_needed', value: '0.0 - inf', unit: 'B' }
]"
/>

### Energy

<MetricTable
prefix="mekentanglo:"
:metrics="[
{ name: 'energy', value: '0.0 - inf', unit: 'FE' },
{ name: 'max_energy', value: '0.0 - inf', unit: 'FE' },
{ name: 'energy_needed', value: '0.0 - inf', unit: 'FE' }
]"
/>
49 changes: 49 additions & 0 deletions docs/reference/input/mekanism/RadioactiveWasteBarrel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
telem:
adapter:
id: 'wasteBarrel'
name: 'Radioactive Waste Barrel'
categories: '{ "basic", "storage" }'
---

<script setup>
import { data as metrics } from './common/metrics.data.ts'
</script>

# Mekanism Radioactive Waste Barrel Input <RepoLink path="lib/input/mekanism/RadioactiveWasteBarrelInputAdapter.lua" />

<!--@include: ./common/preamble.md -->

### Basic

<MetricTable
prefix="mekwastebarrel:"
:metrics="[
{ name: 'filled_percentage', value: '0.0 - 1.0' }
]"
/>

### Storage

<MetricTable
prefix="mekwastebarrel:"
:metrics="[
{ name: 'stored', value: '0.0 - inf', unit: 'B' },
{ name: 'capacity', value: '0.0 - inf', unit: 'B' },
{ name: 'needed', value: '0.0 - inf', unit: 'B' }
]"
/>

## Storage
If the barrel contains a chemical, a storage metric is added for the chemical. Given a waste barrel with the following contents:

![Mekanism Radioactive Waste Barrel with contents](/assets/mekanism-waste-barrel-contents.webp)

The following metric would be added:

<MetricTable
prefix="storage:"
:metrics="[
{ name: 'mekanism:spent_nuclear_waste', value: '491.92', unit: 'B' }
]"
/>

0 comments on commit 49ae236

Please # to comment.