Stationeers Community Wiki - User contributions [en]

Kit (Grow Light)

2026-01-15T01:44:30Z

Thoth: restore the wall-mount lighting diagram

[[Category:Items]][[Category:Lights]][[Category:Electronic]]
{{Itembox
| name = Kit (GrowLight)
| image = [[File:ItemKitGrowLight.png|Kit(GrowLight)]]
| stacks = 10
| paintable = Yes
| constructs = [[Grow Light]]
| recipe_machine1 = Electronics Printer
| recipe_cost1 = 5g [[Copper]], 5g [[Steel]], 10g [[Electrum]]
| prefabhash = 341030083
| prefabname = ItemKitGrowLight
}}

{{Structurebox
| name = Grow Light
| image = [[File:ItemGrowLight.png]]
| placed_with_item = [[Kit (Grow Light)]]
| power_usage = 70W
| placed_on_grid = Small Grid
| decon_with_tool1 = [[Hand Drill]]
| item_rec1 = [[Kit (Grow Light)]]
| prefab_hash = -1758710260
| prefab_name = StructureGrowLight
}}

==Description==
Provides artificial sunlight to grow crops.

Crops need [[Water]] and sunlight to grow. Without water the plant will wither and die. Without sunlight/UV light it will stop growing, but won't wither.

[[Guide_(Farming)|Guide (Farming)]] provides additional info on how to setup farming with hydroponic tray.

==Illumination pattern==

The Illumination pattern of the Grow Light has changed as of the [[Update v0.2.6085.26682|Respawn Update: Round Robin Community Starts (Update v0.2.6085.26682)]].

Lighting area is not a focused cone but a 8x7 small grid rectangle with the light being projected out 3 small grids from each side of the grow light.

Previous to this update, the lighting area was a 7x6 rectangle centred on the small [[grid]] of the grow light containing the power connection.

Although ceiling mounting is more logical with regard to real plants growing, it is worth noting that floor mounting will provide the same illumination pattern with no downside.

Ceiling mounting grow lights two large grids above planters will not provide adequate light to the planters.

[[File:Stationeers-grow-light-footprint-jan2026.png|frameless]]

Wall-mounted illumination coverage looks like this:

[[File:GrowLight topDown 2024.svg|frameless|wall-mount grow light coverage]]

==Wall Mounting vs Ceiling Mounting==
Illumination Radius is at its maximum 2-4 '''<big>small grids</big>''' away which coincides with '''<big>one large grid size</big>''', so ceiling mounting has '''the best coverage of 41''', against 37 of wall mounting.
However this creates difficulty for [[LArRE]] or [[Harvie]] as those can only be mounted on ceiling. When either is expected to be used, wall mounting is more flexible then ceiling mounting. Note that Harvie requires space to either side of for chutes, so it can only harvest from trays with some separation between them; a Hydroponics LArRE does not have this limitation.


{{Data Network Header}}


{{Data Parameters}}
{| class="wikitable"
|-
! Parameter Name !! Data Type !! Description
|-
| On || Boolean ||
|}


{{Data Outputs}}
{| class="wikitable"
|-
! Output Name !! Data Type !! Description
|-
| On || Boolean ||
|-
| Power || Boolean ||
|-
| PrefabHash || Integer ||
|-
| RequiredPower || Integer ||
|-
|}

LArRE Dock (Hydroponics)

2026-01-06T16:28:21Z

Thoth: fraction of a page for the LArRE hydroponics to hold my recent observations

== Slot Variables ==

This LArRE has a special slot 255 which can sample slot variables from a structure (hydroponics tray/device or import/export chute) under the current station. While some slot variables are documented on LArRE's in-game stationpedia page, the slot variables for the adjacent device are only documented on the device's page. Not that while the [[Hydroponics Tray]] does not have a data connection, the LArRE slot 255 can sample the same Slot Variables from the tray as are documented for the [[Hydroponics Device]]. It is unclear how or if the slot variables for the Fertilizer slot can be accessed via LArRE's slot 255.

== Plant growth states ==

This LArRE has a special slot 255 which can sample slot variables from a structure (hydroponics tray/device or import/export chute) under the current station. When designing a MIPS script to operate LArRE, you must understand how those slot variables change as the crops grow.

{| class="wikitable"
|-
! Slot Variable !! empty !! early !! crops grown !! seed grown !! seed harvested & crops available !! dead
|-
| Occupied|| 0 || 1|| 1|| 1|| 1|| 1
|-
| Damage|| 0|| 0|| 0|| 0|| 0|| 1
|-
| Health|| 0|| 1|| 1|| 1|| 1|| 0
|-
| Growth || 0 || 3 || 4 || 6 || 6 || 6
|-
| Mature || 0 || 0 || 1 || 1 || 1 || 0
|-
| Seeding || 0 || -1 || -1 || 1 || 0 || -1
|}

Most crops are consumed by harvesting and must be replanted after the last crop is picked by the LArRE. They transition from growth 6 to 0 when the last crop is harvested.

There are some crops that are "perennial", where when the last crop is harvested, a plant remains to grow a new set of fruit and seed. These crops transition from growth 6 to 3 and seeding from 1 to 0 to -1.

Crops that are under stress (temperature, light, or water) for long enough start gaining damage. If the environment is not fixed before the damage reaches 1.0 the crop is dead and must be cleared from the tray, and a replacement plant installed.

LArRE Dock (Collector)

2025-12-31T16:53:35Z

Thoth: extremely incomplete start of an article about the LArRE collecor

== Description ==

<blockquote><q>The collector LArRE can suck up nearby loose items when its mode is set to inward and eject stored items when its mode is set to outward. When set to suck up items, the collector LArRE will automatically stop and retract when full.
Pressing the activate button while the LArRE arm is at its home dock will move the arm off the main rail. This allows arms on the same rail to pass by.</q><br>
'''- Stationpedia'''</blockquote>

== Hints ==

While the stationpedia uses the word "eject", the stored items will actually just be dropped. This can be exploited to feed the items into a [[Chute Inlet]], but the LArRE will drop the items faster than the chute will load them. If you want to be able to absorb all 10 items unloaded by the LArRE an [[SDB Hopper]] is the most reliable choice.

[[File:LArRE collector drop geometry.png|frameless|illustration of how to catch items dropped by LArRE into a chute]]

File:LArRE collector drop geometry.png

2025-12-31T16:47:54Z

Thoth: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=An illustration of the geometry necessary to catch items dropped by a LArRE collector.}}
|date=2025-12-31
|source={{own}}
|author=[[User:Thoth|Thoth]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{licensing|generic}}

[[Category:Structures]]

LArRE

2025-12-31T16:35:34Z

Thoth: mention the specialized variants

{{Itembox
| name = Kit (LArRE)
| image = [[File:ItemKitRoboticArm.png]]
| prefabhash = -1228287398
| prefabname = ItemKitRoboticArm
| stacks = 1
| slot_class = SlotClass.None
| sorting_class = SortingClass.Kits
| recipe_machine1 = Electronics Printer
| recipe_cost1 = 10g [[Inconel]], 5g [[Hastelloy]], 15g [[Astroloy]]
| constructs = [[LArRE |LArRE Dock]]
}}
{{Structurebox
| name = LArRE Dock
| image = [[File:StructureRoboticArmDock.png]]
| prefab_hash = -1818718810
| prefab_name = StructureRoboticArmDock
| power_usage = 10W
| placed_on_grid = Small Grid
| decon_with_tool1 = [[Hand Drill]]
| placed_with_item = [[LArRE|Kit (LArRE)]]
| item_rec1 = [[LArRE|Kit (LArRE)]]
}}

== Superseded ==

While the original LArRE can still be printed from the [[Electronics Printer]] it has been superseded by a number of specialized variations:
* [[LArRE Dock (Atmos)]]
* [[LArRE Dock (Bypass)]]
* [[LArRE Dock (Cargo)]]
* [[LArRE Dock (Collector)]]
* [[LArRE Dock (Hydroponics)]]
Each variant is constructed from its own dedicated kit. While some variants provide brand new capability, others overlap with the original, but bring enhanced capability. For instance the original LArRE could interact with hydroponics and import/export chutes, but the hydroponics variant is able to measure the content of a [[Hydroponics Tray]] beneath the arm without having to sample a separate [[Hydroponics Device]], allowing for denser planting.

== Description ==
<blockquote><q>The (L)inear (Ar)ticulated (R)ail (E)ntity or LArRE can be used to plant, harvest and fertilize plants in plant trays. It can also grab items from a [[Powered_Chutes#Chute_Import.2FExport_Bin|Chute Export Bin]] and drop them in a [[Powered_Chutes#Chute_Import.2FExport_Bin|Chute Import Bin]]. LArRE can interact with plant trays or chute bins built under a linear rail station or built under its dock.</q><br>
'''- Stationpedia'''</blockquote>

LArRE is a robotic arm that can interact with [[Powered_Chutes#Chute_Import.2FExport_Bin|powered chute bins]] and [[Hydroponics_Tray|hydroponic trays]] or [[Hydroponics_Device|devices]].<br/>
Compared to [[Kit_(Harvie)|Harvie]], LArRE can be configured to care for multiple plants and distribute fertilizer. It can also be used to transport items in general.<br/>

== Usage ==
The dock can be connected on both sides to a network of [[Linear_Rail|linear rails]] to enable LArRE to move horizontally and vertically. [[Linear_Rail#Station|Linear rail stations]] must be positioned so that LArRE can stop and interact with the device below. The network can only be linear (i.e. without intersections). <br/>
Each station (including the dock) is assigned a number. <br/>
Stations can be assigned a negative number unless the rail connections make a loop back to the dock. <br/>
If the network is modified (by removing or adding a rail), LARrE will be teleported to its dock. LARrE is also susceptible to collisions with players and structures. If it is blocked while moving towards its target station, LArRE will stop and flash an error until the path is cleared or the target is changed.

{{Data Network Header}}
{{Data Parameters|
{{Data Parameters/row|Power|Boolean|w=0|Can be read to return if the LArRE Dock is correctly powered or not, set via the power system, return 1 if powered and 0 if not|multiple=2|0|Unpowered|1|Powered}}
{{Data Parameters/row|Error|Boolean|w=0|1 if device is in error state, otherwise 0|multiple=2|0|<p></p>|1|Error}}
{{Data Parameters/row|Activate|Integer|Set this to 1 to make LArRE use its claw (either to place or fetch an item)}}
{{Data Parameters/row|Setting|Integer|Set this to make LArRE move to a station}}
{{Data Parameters/row|On|Boolean|The current state of the LArRE Dock.|multiple=2|0|Off|1|On}}
{{Data Parameters/row|RequiredPower|Integer|w=0|Idle operating power quantity, does not necessarily include extra demand power}}
{{Data Parameters/row|Idle|Integer|w=0|Returns 1 if the LArRE Dock is currently idle (stationary), otherwise 0 (moving). Use this to detect if it has completed its movement/action.}}
{{Data Parameters/row|PrefabHash|Integer|w=0|The hash of the structure}}
{{Data Parameters/row|ReferenceId|Integer|w=0|Unique Reference Identifier for this object}}
{{Data Parameters/row|Index|Integer|w=0|The current index for the LArRE Dock on the rails. Can be non-integer. This usually does not correlate with Setting since it counts non-station rail sections.}}
{{Data Parameters/row|NameHash|Integer|w=0|Provides the hash value for the name of the object as a 32 bit integer.}}
}}

==== Data Slots ====
These are all parameters, that can be read with a [[Kit_(Logic_I/O)#Slots_Reader|Slots Reader]]. The outputs are listed in the order a Slots Reader's "VAR" setting cycles through them.
{| class="wikitable"
|-
! Number || Name !! Description
|-
| 0 || Occupied||
|-
| 0 || OccupantHash ||
|-
| 0 || Quantity ||
|-
| 0 || Damage ||
|-
| 0 || Class ||
|-
| 0 || MaxQuantity ||
|-
| 0 || PrefabHash ||
|-
| 0 || SortingCLass ||
|-
| 0 || ReferenceId ||
|}

== Notes ==

* Renamed to LArRE to better align with its non-acronym name in 2024-July-22

== External Links ==
[https://steamcommunity.com/sharedfiles/filedetails/?id=3447555043 reference Hydro LArRE implementation by lisnaz]

Solar Logic Circuits Guide

2025-12-15T20:44:11Z

Thoth: add illustration of duality of solar panel coordinates

[[Category:Tutorials]][[Category:Solar power]]
<languages />
== Disclaimer ==

Due to the frequency of game updates, all solutions are subject to change and may or may not be functional.

The designs on this page are valid as of v0.2.5906.26015 (2025-09-16)

While this specific Guide calls out the sensor being place in a specific direction (north - 0 degrees), it's not necessary to orient your sensors to a specific direction.
If you find your panels don't point at the sun, you can add either 0, 90, 180 or 270 to the horizontal until they point at the sun. This guide is an attempt
to simplify the setup by removing an extra math, and memory chip (6 chips instead of 8).

== Geometry Of [[Solar Panel|Solar Panels]] and [[Sensors#Daylight Sensor|Daylight Sensors]] ==

<gallery>
daylight sensor horizontal.png|Geometry of values measured by daylight sensor in horizontal (yaw) mode
daylight sensor vertical.png|Geometry of values measured by daylight sensor in vertical (pitch) mode
solar panel yaw-Horizontal setting.png|Effect of setting horizontal rotation of a solar panel
</gallery>

==Solar tracking using Logic Chips ==

=== Six-chip dual-axis tracking ===
To get a "100%" accurate solar tracker on planets with an offset solar arc, you need to include the Horizontal component to the solar angle.

'''What do you need:'''
* [[Kit (Logic I/O)]] x4
* [[Kit (Logic Processor)]]
* [[Kit (Logic Memory)]]
* [[Sensors|Kit (Sensor)]] > [[Sensors#Daylight Sensor|Daylight Sensor]]

Place the Daylight Sensor facing up, '''with the Data Port facing north (0 degrees).'''

{| class="wikitable"
|-
! '''Horizontal'''
|-
! '''Chip''' !! '''Chip label''' !! '''IN''' !! '''VAR''' !! '''OUT'''
|-
| Logic Reader || Horizontal Reader || Daylight Sensor || Horizontal ||
|-
| Batch Writer || Horizontal Writer || Horizontal Reader || Horizontal || Solar Panel
|-
! '''Vertical'''
|-
! '''Chip''' !! '''Chip label''' !! '''IN''' !! '''VAR''' !! '''OUT'''
|-
| Logic Reader || Vertical Reader || Daylight Sensor || Vertical ||
|-
| Batch Writer || Vertical Writer || Vertical Correction Math || Vertical || Solar Panel
|-
! '''Chip''' !! '''Chip label''' !! '''Value'''
|-
| Logic Memory || Vertical Correction Memory || 90
|-
! '''Chip''' !! '''Chip label''' !! '''IN 1''' !! '''IN 2''' !! '''OUT'''
|-
| Logic Math || Vertical Correction Math || Vertical Reader || Vertical Correction Memory || Add
|}

[[File:2022-10-02 Two-axis solar tracking.png|Accurate two-axis solar tracking]]

The panels should align themselves to the sun, you make sure to '''put the Power Port on the panels facing east (east - 90 degrees).''' If you've already built the panels and logic with the Power Port facing west, swapping the direction of the sensor so that its Data Port faces south will allow the setup to work with no additional changes.

== Solar tracking using Integrated Circuits ==
This is the most powerful way to track the sun, but the implementation might be a bit daunting at first.

'''What you need:'''
* [[Integrated Circuit (IC10)]]
* [[Kit (IC Housing)]]
* [[Sensors|Kit (Sensor)]] > [[Sensors#Daylight Sensor|Daylight Sensor]]

And if you don't already have one set up:
* [[Kit (Computer)]]
* [[Motherboard (IC Editor)|IC Editor Motherboard]]

Place the '''Daylight Sensor''' facing up, note which direction the Data Port is facing, and which direction the solar panel Power Port is facing. These two directions are needed in the code. The '''Daylight Sensor''' is connected to the '''d0''' screw, that's all you need.

A simple code example can be found here: https://stationeering.com/tools/ic/_2FpmwojGnBq<br>
This code is considered "inefficient" since it's hard-coded to spam all types of solar panels, even if you don't have them.

A better code example can be found here: https://stationeering.com/tools/ic/_2FpoBEcd3QK<br>
It targets the solar-panel types on '''d2''' and (optionally) '''d3''', so it's less spammy. It also has an option for a display ('''Kit (Console)''') on '''d1''' that shows the sum of power output from both types of panels

== duality of orientation ==

Due to the coordinate system used by solar panels, it is actually possible to capture peak sunlight using two different (but related) H,V coordinates.

[[File:stationeers-solar-duality.svg|frameless|panels using different control logic to accomplish the same goal]]

This screenshot shows two sets of solar panels, each with its own daylight sensor. Each sensor is oriented differently to properly match its panel and formulas. The panel on the right uses panel.horizontal = daysensor.horizontal; panel.vertical = 90-daysensor.vertical; while the panel on the left uses panel.horizontal = daysensor.horizontal; panel.vertical = daysensor.vertical + 90. They both achieve the same orientation.

File:Stationeers-solar-duality.svg

2025-12-15T20:42:17Z

Thoth: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=Illustrates two sets of solar panels using different formulas to mach different daylight sensor orientations.}}
|date=2025-12-15
|source={{own}}
|author=[[User:Thoth|Thoth]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{licensing|generic}}

[[Category:Structures]]

Solar Logic Circuits Guide

2025-12-15T20:35:35Z

Thoth: remove a diagram that contains obsolete info

Thermal Convection and Radiation Values

2025-12-15T17:55:04Z

Thoth: get rid of mistaken |s

This is a collection of thermal convection, radiation, and solar heating values for easy comparison to one another.

===Pipe Network===
Note that all equivalent liquid structures have the same values as their gas counterparts, except for the [[Kit (Liquid Radiator)| ''Liquid Pipe Convection Radiator'']] which is listed separately.<br>
Insulated tanks, pipes and in-line tanks have zero for all values.<br>
Solar heating does not seem to apply to pipe-mounted radiators.
{| class="wikitable sortable"
|-
! Pipe Network Structure !! Thermal Convection !! Thermal Radiation !! Solar Heating
|-
| <div class="stationeers-icon">[[image:ItemPipeStraight.png]]</div> [[Pipes|Pipe]] || 0.005|| ''0.001''* || 0.05
|-
| <div class="stationeers-icon">[[image:ItemKitPipeRadiator.png]]</div> [[Pipe Radiator|Pipe Radiator]] || 0.231 || 3.46 || 2.31
|-
| <div class="stationeers-icon">[[image:ItemPipeRadiator.png]]</div> [[Pipe Radiator|Pipe Convection Radiator]] || 1.05 || 0.79 || 0.105
|-
| <div class="stationeers-icon">[[image:ItemKitPipeRadiatorLiquid.png]]</div> [[Kit (Liquid Radiator)| ''Liquid Pipe Convection Radiator'']] || 1.02 || 0.763 || 0.102
|-
| <div class="stationeers-icon">[[image:ItemKitPassiveLargeRadiatorGas.png]]</div> [[Medium Radiator|Medium Radiator]] || 1.5 || 30 || 15
|-
| <div class="stationeers-icon">[[image:ItemKitPassiveLargeRadiatorGas.png]]</div> [[Medium Radiator|Medium Convection Radiator]] || 9.38 || 3 || 1.5
|-
| <div class="stationeers-icon">[[image:ItemKitLargeExtendableRadiator.png]]</div> [[Large Extendable Radiator]] || 0.736 || 73.6 || ''950 (at 100% efficiency)''*
|-
| <div class="stationeers-icon">[[image:ItemKitTank.png]]</div> [[Tank|Small Tank]] || 0.758 || 0.03 || 1.52
|-
| <div class="stationeers-icon">[[image:ItemKitTank.png]]</div> [[Tank|Large Tank]] || 4.24 || 0.17 || 8.49
|-
| <div class="stationeers-icon">[[image:StructureInLineTankGas.png]]</div> [[In-Line Tank Gas]] || 0.025 || 0.001 || 0.25
|-
| <div class="stationeers-icon">[[image:StructureInLineTankSmallGas.png]]</div> [[In-Line Tank Small Gas]] || 0.015 || 0.001|| 0.152
|}
<small><nowiki>*</nowiki> ''Not listed in stationpedia, approximated value''</small>

===Items===
Note that [[Gas Tank MKII]] and liquid variant are insulated, with zeros for all values
{| class="wikitable sortable"
|-
! Item!! Thermal Convection !! Thermal Radiation !! Solar Heating
|-
| <div class="stationeers-icon">[[image:ItemGasCanisterEmpty.png]]</div>[[Gas Canister]] || 0.04 || 0.04 || 0.081
|-
| <div class="stationeers-icon">[[image:ItemLiquidCanisterEmpty.png]]</div>[[Liquid Canister]] || 0.041|| 0.041 || 0.082
|-
| <div class="stationeers-icon">[[image:ItemGasCanisterSmart.png]]</div>[[Gas Canister (Smart)]] || 0.081 || 0.081 || 0.081
|-
| <div class="stationeers-icon">[[image:ItemLiquidCanisterSmart.png]]</div>[[Liquid Canister (Smart)]] || 0.084 || 0.084 || 0.084
|-
| <div class="stationeers-icon">[[image:DynamicGasCanisterEmpty.png]]</div>[[Portable Gas Tank]] || 0.129 || 0.129 || 0.515
|-
| <div class="stationeers-icon"></div>[[Portable Liquid Tank]] || 0.129 || 0.129 || 0.515
|}

===Devices===
{| class="wikitable sortable"
|-
! Device!! Thermal Convection !! Thermal Radiation !! Solar Heating
|-
| <div class="stationeers-icon">[[image:Furnace.jpg]]</div>[[Furnace]] || 0.816 || 0.816 || 4.08
|-
| <div class="stationeers-icon">[[image:StructureAdvancedFurnace.png]]</div>[[Advanced Furnace]] || 1.35 || 1.35 || 1.35
|-
| <div class="stationeers-icon">[[image:H2 Combustor.jpg]]</div>[[H2 Combustor]] || 0.506 || 0.506 || 0.506
|-
| <div class="stationeers-icon">[[image:Electrolyzer front.png]]</div>[[Electrolyzer]] || 0.526 || 0.526 || 0.526
|-
| <div class="stationeers-icon">[[image:Evaporation-chamber-icon.png]]</div>[[Evaporation Chamber]] || 0.007 || || 0.747
|-
| <div class="stationeers-icon">[[image:Condensation-chamber.png]]</div>[[Condensation Chamber]] || 0.007 || || 0.742
|-
| <div class="stationeers-icon">[[image:ItemHydroponicTray.png]]</div>[[Hydroponics Tray]] || 0.014|| 0.001 || 0.145
|-
| <div class="stationeers-icon">[[image:ItemHydroponicTray.png]]</div>[[Hydroponics Device]] || 0.146 || 0.146 || 0.146
|}
<small> ''Blanks not listed in stationpedia, assumed to be zero''</small>

===Suits===
{| class="wikitable sortable"
|-
! Suit!! Thermal Convection !! Thermal Radiation !! Solar Heating
|-
| <div class="stationeers-icon">[[image:ItemSpaceHelmet.png]]</div> [[Space Helmet]] || || || 1.26
|-
| <div class="stationeers-icon">[[image:ItemEvaSuit.png]]</div> [[EVA Suit]] || 0.205 || 0.205 || 8.19
|-
| <div class="stationeers-icon">[[image:ItemHardsuitHelmet.png]]</div> [[Hardsuit Helmet]] || || ||
|-
| <div class="stationeers-icon">[[image:ItemHardSuit.png]]</div> [[Hardsuit]] || 0.062 || 0.062 || 6.23
|-
| <div class="stationeers-icon"></div>[[HARM Helmet]] || || ||
|-
| <div class="stationeers-icon"></div>[[HARM Suit]] || || 0.04 || 0.159
|-
| <div class="stationeers-icon"></div> [[Emergency EVA Helmet]]|| || || 1
|-
| <div class="stationeers-icon">[[image:ItemEmergencyEvaSuit.png]]</div> [[Emergency EVA Suit]] || 0.132 || 0.132 || 0.662
|}
<small> ''Blanks not listed in stationpedia, assumed to be zero''</small>

=external links=

* [https://discord.com/channels/276525882049429515/395912153795788803/1393151312983621703 Discord post containing formulas for radiation and convection ]
* [https://discord.com/channels/276525882049429515/395912153795788803/1398761976477384755 Discord post containing formulas for counterflow heat exchanger]

Thermal Convection and Radiation Values

2025-12-15T17:50:34Z

Thoth: Add some links to discord posts about convection and radiation

This is a collection of thermal convection, radiation, and solar heating values for easy comparison to one another.

===Pipe Network===
Note that all equivalent liquid structures have the same values as their gas counterparts, except for the [[Kit (Liquid Radiator)| ''Liquid Pipe Convection Radiator'']] which is listed separately.<br>
Insulated tanks, pipes and in-line tanks have zero for all values.<br>
Solar heating does not seem to apply to pipe-mounted radiators.
{| class="wikitable sortable"
|-
! Pipe Network Structure !! Thermal Convection !! Thermal Radiation !! Solar Heating
|-
| <div class="stationeers-icon">[[image:ItemPipeStraight.png]]</div> [[Pipes|Pipe]] || 0.005|| ''0.001''* || 0.05
|-
| <div class="stationeers-icon">[[image:ItemKitPipeRadiator.png]]</div> [[Pipe Radiator|Pipe Radiator]] || 0.231 || 3.46 || 2.31
|-
| <div class="stationeers-icon">[[image:ItemPipeRadiator.png]]</div> [[Pipe Radiator|Pipe Convection Radiator]] || 1.05 || 0.79 || 0.105
|-
| <div class="stationeers-icon">[[image:ItemKitPipeRadiatorLiquid.png]]</div> [[Kit (Liquid Radiator)| ''Liquid Pipe Convection Radiator'']] || 1.02 || 0.763 || 0.102
|-
| <div class="stationeers-icon">[[image:ItemKitPassiveLargeRadiatorGas.png]]</div> [[Medium Radiator|Medium Radiator]] || 1.5 || 30 || 15
|-
| <div class="stationeers-icon">[[image:ItemKitPassiveLargeRadiatorGas.png]]</div> [[Medium Radiator|Medium Convection Radiator]] || 9.38 || 3 || 1.5
|-
| <div class="stationeers-icon">[[image:ItemKitLargeExtendableRadiator.png]]</div> [[Large Extendable Radiator]] || 0.736 || 73.6 || ''950 (at 100% efficiency)''*
|-
| <div class="stationeers-icon">[[image:ItemKitTank.png]]</div> [[Tank|Small Tank]] || 0.758 || 0.03 || 1.52
|-
| <div class="stationeers-icon">[[image:ItemKitTank.png]]</div> [[Tank|Large Tank]] || 4.24 || 0.17 || 8.49
|-
| <div class="stationeers-icon">[[image:StructureInLineTankGas.png]]</div> [[In-Line Tank Gas]] || 0.025 || 0.001 || 0.25
|-
| <div class="stationeers-icon">[[image:StructureInLineTankSmallGas.png]]</div> [[In-Line Tank Small Gas]] || 0.015 || 0.001|| 0.152
|}
<small><nowiki>*</nowiki> ''Not listed in stationpedia, approximated value''</small>

===Items===
Note that [[Gas Tank MKII]] and liquid variant are insulated, with zeros for all values
{| class="wikitable sortable"
|-
! Item!! Thermal Convection !! Thermal Radiation !! Solar Heating
|-
| <div class="stationeers-icon">[[image:ItemGasCanisterEmpty.png]]</div>[[Gas Canister]] || 0.04 || 0.04 || 0.081
|-
| <div class="stationeers-icon">[[image:ItemLiquidCanisterEmpty.png]]</div>[[Liquid Canister]] || 0.041|| 0.041 || 0.082
|-
| <div class="stationeers-icon">[[image:ItemGasCanisterSmart.png]]</div>[[Gas Canister (Smart)]] || 0.081 || 0.081 || 0.081
|-
| <div class="stationeers-icon">[[image:ItemLiquidCanisterSmart.png]]</div>[[Liquid Canister (Smart)]] || 0.084 || 0.084 || 0.084
|-
| <div class="stationeers-icon">[[image:DynamicGasCanisterEmpty.png]]</div>[[Portable Gas Tank]] || 0.129 || 0.129 || 0.515
|-
| <div class="stationeers-icon"></div>[[Portable Liquid Tank]] || 0.129 || 0.129 || 0.515
|}

===Devices===
{| class="wikitable sortable"
|-
! Device!! Thermal Convection !! Thermal Radiation !! Solar Heating
|-
| <div class="stationeers-icon">[[image:Furnace.jpg]]</div>[[Furnace]] || 0.816 || 0.816 || 4.08
|-
| <div class="stationeers-icon">[[image:StructureAdvancedFurnace.png]]</div>[[Advanced Furnace]] || 1.35 || 1.35 || 1.35
|-
| <div class="stationeers-icon">[[image:H2 Combustor.jpg]]</div>[[H2 Combustor]] || 0.506 || 0.506 || 0.506
|-
| <div class="stationeers-icon">[[image:Electrolyzer front.png]]</div>[[Electrolyzer]] || 0.526 || 0.526 || 0.526
|-
| <div class="stationeers-icon">[[image:Evaporation-chamber-icon.png]]</div>[[Evaporation Chamber]] || 0.007 || || 0.747
|-
| <div class="stationeers-icon">[[image:Condensation-chamber.png]]</div>[[Condensation Chamber]] || 0.007 || || 0.742
|-
| <div class="stationeers-icon">[[image:ItemHydroponicTray.png]]</div>[[Hydroponics Tray]] || 0.014|| 0.001 || 0.145
|-
| <div class="stationeers-icon">[[image:ItemHydroponicTray.png]]</div>[[Hydroponics Device]] || 0.146 || 0.146 || 0.146
|}
<small> ''Blanks not listed in stationpedia, assumed to be zero''</small>

===Suits===
{| class="wikitable sortable"
|-
! Suit!! Thermal Convection !! Thermal Radiation !! Solar Heating
|-
| <div class="stationeers-icon">[[image:ItemSpaceHelmet.png]]</div> [[Space Helmet]] || || || 1.26
|-
| <div class="stationeers-icon">[[image:ItemEvaSuit.png]]</div> [[EVA Suit]] || 0.205 || 0.205 || 8.19
|-
| <div class="stationeers-icon">[[image:ItemHardsuitHelmet.png]]</div> [[Hardsuit Helmet]] || || ||
|-
| <div class="stationeers-icon">[[image:ItemHardSuit.png]]</div> [[Hardsuit]] || 0.062 || 0.062 || 6.23
|-
| <div class="stationeers-icon"></div>[[HARM Helmet]] || || ||
|-
| <div class="stationeers-icon"></div>[[HARM Suit]] || || 0.04 || 0.159
|-
| <div class="stationeers-icon"></div> [[Emergency EVA Helmet]]|| || || 1
|-
| <div class="stationeers-icon">[[image:ItemEmergencyEvaSuit.png]]</div> [[Emergency EVA Suit]] || 0.132 || 0.132 || 0.662
|}
<small> ''Blanks not listed in stationpedia, assumed to be zero''</small>

=external links=

* [https://discord.com/channels/276525882049429515/395912153795788803/1393151312983621703| Discord post containing formulas for radiation and convection ]
* [https://discord.com/channels/276525882049429515/395912153795788803/1398761976477384755| Discord post containing formulas for counterflow heat exchanger]

Gas condensation

2025-12-12T02:21:13Z

Thoth: add some implementation details regarding cybernetics

While gas condensing into liquid is a problem that can lead to burst pipes and system failure, it can also be used to transfer energy between atmospheres.

Liquid [[Volatiles]], [[Oxygen]], and [[Nitrous Oxide]] are useful in [[Rocketry]]. Liquid [[Nitrogen]] is useful with [[Cryotube]]s to resurrect incapacitated players.

While there are devices like [[Condensation Valve]] , [[Expansion Valve]], [[Pressurant Valve]], and [[Purge Valve]], the real workhorses are the [[Evaporation Chamber]] and [[Condensation Chamber]] built from the [[Kit (Phase Change Device)]].

== Mars example ==

[[File:Mars condensation schematic.svg|frameless|Mars condensation schematic]]

This diagrams oversimplifies a few things. The condensers can fill the liquid pipes to bursting under some transient conditions.
* it is necessary to set the pollutant condenser to 3150-600*(VolumeOfLiquid/Volume) kPa[http://www.purplefrog.com/~thoth/stationeers-cookbook/condenser-pollutant-limiter.html]. This will tune the condenser to match the consumption of the gang of pollutant evaporators.
* It is necessary to set the gang of volatiles condensers to 4400-2000(VolumeOfLiquid/Volume) kPa[http://www.purplefrog.com/~thoth/stationeers-cookbook/condenser-volatiles-limiter.html]. This will tune the condensers to match the consumption of the volatiles evaporator.

Evaporation Chamber

2025-12-11T22:25:19Z

Thoth: first draft of the page describing the Evaporation chamber

{{Structurebox
| name = Evapration Chamber
| image = [[File:Evaporation-chamber-icon.png|frameless]]
| prefab_hash = -1429782576
| prefab_name = StructureEvaporationChamber
| placed_with_item = '''Kit (Phase Change Device)'''
| placed_on_grid = Small Grid
| const_with_tool1 = [[Wrench]]
| const_with_item1 = 2 x [[Steel Sheets]]
| const_with_tool2 = [[Welding Torch]]
| const_with_item2 = 2 x [[Steel Sheets]]
}}

The evaporator is a device focused on evaporating gasses by depressurizing them and warming them.
It includes a liquid input, a gas output, and a gas connection for the heat exchange gas. There is a setting for the target pressure that controls how much gas will be pumped out of the chamber into the connected pipe. Any gas that evaporates and brings the pressure above the target will be transferred to the output pipe. There is also a flush lever that will release all contents into the local atmosphere.

The evaporation chamber fills itself with the liquid input line. If the liquid evaporates, the chamber itself cools down due to the latent heat of condensation and any gasses in excess of the pressure set-point are pumped out via the gas output. The exchange gas connection equalizes the temperature between the chamber and the exchange gas by exchanging energy between the two. If the exchange gas is colder, then the chamber will cool down.
But almost every use case of the evaporator is for the exchange gas to be warmer than the chamber in order to replace the latent heat of condensation and support ongoing evaporation.

It is often paired with a [[Condensation Chamber]] to transfer heat from one system to another.

When the evaporator is turned off it no longer loads liquid from the input, or transfers excess gas to the output, but the chamber continues to equalize with the exchange gas. If not properly managed, this can lead to problems, both as the chamber reaches steady state, and again when the chamber is turned back on and pumps out the excess evaporated gas.

In one example, you could feed an evaporator with liquid [[Pollutant]] and set the chamber to 1900kPa. As the gas evaporates, the latent heat is drawn out of the gas in the chamber, cooling it. This is usually used to transfer heat from the exchange gas into the chamber. This can cool the exchange gas to as low as ?180 kelvin? (although the temperature will be different in an active system where the exchange gas is receiving heat from elsewhere).

=Failure modes=
==Ice==
It is possible to set the pressure low enough that it cools the gas to the point that it starts to form ice. For instance, an evaporator full of Pollutant at 600kPa can form ice which can accumulate to burst the pipes on the output side. This can be prevented if the exchange gas is warm enough to keep the chamber from approaching the freezing point, but it tends to happen when the system is left unattended and processes slow down. To prevent this, use a pressure setting such that the gas/liquid equilibrium temperature is above the freezing point.

==Output gas over-pressure==
While unlikely in an active system, it is theoretically possible that the evaporation chamber could pump gas into the output connection that causes pressure to rise until the pipe fails. This is most likely to happen when part of the greater system is deactivated and gas pipes shift into a new equilibrium. The easy solution is to use a [[Backpressure Regulator]] to transfer excess gas to storage.

==Exchange gas low pressure==
Low pressure in the exchange gas connection can limit the speed of heat transfer. 150kPa is a good starting point.

==Exchange gas freezing==
Make sure that the exchange gas can avoid condensation or freezing should the evaporation chamber achieve equilibrium.

File:Evaporation-chamber-icon.png

2025-12-11T22:24:21Z

Thoth: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=The icon for the Evaporation Chamber in the in-game encyclopedia}}
|date=2025-12-11
|source={{own}}
|author=[[User:Thoth|Thoth]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{licensing|generic}}

[[Category:Structures]]

Condensation Chamber

2025-12-11T22:13:04Z

Thoth: include clarification of the heat transfer mechanism suggested by discord, also fill in missing information for the structurebox

{{Structurebox
| name = Condensation Chamber
| image = [[File:Condensation-chamber.png|frameless]]
| prefab_hash = 1420719315
| prefab_name = StructureCondensationChamber
| placed_with_item = '''Kit (Phase Change Device)'''
| placed_on_grid = Small Grid
| const_with_tool1 = [[Wrench]]
| const_with_item1 = 2 x [[Steel Sheets]]
| const_with_tool2 = [[Welding Torch]]
| const_with_item2 = 2 x [[Steel Sheets]]
}}

The condenser is a device focused on condensing gasses by pressurizing them and cooling them.
It includes a gas input, a liquid output, and a gas connection for the heat exchange gas. There is a setting for the target pressure that controls how much gas will be loaded from the input into the chamber. There is also a flush lever that will release all contents into the local atmosphere.

==Operation==
The condensation chamber fills itself with the gas input line to the pressure set-point from the dial.
If the gasses condense, the chamber itself heats up due to the latent heat of condensation and the liquids leave out the liquid output.
The exchange gas connection equalizes the temperature between the chamber and the exchange gas by exchanging energy between the two.
If the exchange gas is warmer, then the chamber will heat up.
But almost every use case of the condenser is for the exchange gas to be cooler than the chamber in order to transport the latent heat of condensation away and support ongoing condensation.

It is often paired with an [[Evaporation Chamber]] to transfer heat from one system to another.

When the condenser is turned off it no longer loads gas from the input, or pumps liquid to the output. It continues to equalize with the exchange gas. If not properly managed, this can lead to problems, both as the chamber reaches steady state, and again when the chamber is turned back on and pumps out the condensed liquid.

==Example==
In one example you could feed it with [[Pollutant]] to 4000 KPa and use pressurized Mars atmosphere to cool it. As the gas condenses the remaining gas absorbs the latent heat of condensation and increases in temperature. Its temperature is slowly equalized with the temperature of the gas in the exchange connection. If the gas in the exchange connection is not cooled some other way (using radiators, or by replacing some of it with fresh atmosphere) then eventually the chamber will reach equilibrium with the exchange gas and no more liquid will condense. Any gas that does condense into liquid is transferred into the connected liquid pipe.

==Failure modes==
===Burst liquid pipe===
As liquid is transferred into the attached liquid pipe there is a possibility that the pipe will become so full of liquid that the gas in that pipe is squeezed beyond the pressure limit of the pipe (6MPa) and bursts. To prevent this, include cybernetics to either turn off the Condenser (good for "closed" liquid output like rocket fuel storage) or adjust its pressure to limit future condensation (good for loops that feed an evaporator) before the pipe becomes too full.

===Exchange gas low pressure===
Low pressure in the exchange gas connection can limit the speed of heat transfer. 150kPa is a good starting point.

File:Condensation-chamber.png

2025-12-11T22:09:04Z

Thoth: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=The icon for the condensation chamber from the in-game encyclopedia.}}
|date=2025-12-11
|source={{own}}
|author=[[User:Thoth|Thoth]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{licensing|generic}}

[[Category:Structures]]

Condensation Chamber

2025-12-11T18:07:00Z

Thoth: first draft of description of Condensation Chamber

{{Structurebox
| name = Condensation Chamber
| prefab_hash = ?
| prefab_name = ?
| placed_with_item = '''Kit (Phase Change Device)'''
| placed_on_grid = Small Grid
}}

The condenser is a device focused on condensing gasses by pressurizing them and cooling them.
It includes a gas input, a liquid output, and a gas connection for the heat exchange gas. There is a setting for the target pressure that controls how much gas will be loaded from the input into the chamber. There is also a flush lever that will release all contents into the local atmosphere.

It is often paired with an [[Evaporation Chamber]] to transfer heat from one system to another.

When the condenser is turned off it no longer loads gas from the input, or pumps liquid to the output. It continues to equalize with the exchange gas. If not properly managed, this can lead to problems, both as the chamber reaches steady state, and again when the chamber is turned back on and pumps out the condensed liquid.

==Example==
In one example you could feed it with [[Pollutant]] at 4000 KPa and use pressurized Mars atmosphere to cool it. As the gas condenses the remaining gas absorbs the latent heat of condensation and increases in temperature. Its temperature is slowly equalized with the temperature of the gas in the exchange connection. If the gas in the exchange connection is not cooled some other way (using radiators, or by replacing some of it with fresh atmosphere) then eventually the chamber will reach equilibrium with the exchange gas and no more liquid will condense. Any gas that does condense into liquid is transferred into the connected liquid pipe.

==Failure modes==
===Burst liquid pipe===
As liquid is transferred into the attached liquid pipe there is a possibility that the pipe will become so full of liquid that the gas in that pipe is squeezed beyond the pressure limit of the pipe (6MPa) and bursts. To prevent this, include cybernetics to either turn off the Condenser (good for "closed" liquid output like rocket fuel storage) or adjust its pressure to limit future condensation (good for loops that feed an evaporator) before the pipe becomes too full.

===Exchange gas low pressure===
Low pressure in the exchange gas connection can limit the speed of heat transfer. 150kPa is a good starting point.

Gas condensation

2025-12-10T19:19:10Z

Thoth: add mention of cryotubes

Rocket Engines

2025-12-10T19:13:11Z

Thoth: link to new Gas condensation article

[[Category:Rocketry]]

Rocket Engines give you their max output in kN with this you can calculate what they can reasonably carry into orbit depending on the planet or moon you are on. Force = Mass * Acceleration. Acceleration is equal to the planet's gravity, Mass is given in kg per part of the rocket, and Force is kN. If your thrust force listed below is less than the weight of the rocket in kN then you will not even take off. It is better to have a thrust much higher than the weight of the rocket or else you risk running out of fuel on launch and on landing.

[[Gas condensation|Liquid propellants]] bring greater efficiencies. Using Nitrous Oxide as oxidizer provides excessive thrust values. Keep in mind that N2O fuel mix is 1.9375 times heavier at same moles, or 2.15 times heavier at same volume, while thrust boost is around 1.5-1.7. Engine efficiency determines "bonus" thrust multiplier, meaning engine with higher efficiency will give more thrust consuming same amount of fuel. Thus using liquid engines is more favorable if one can cool fuel down, moreover Pressure Fed Engines consume fuel inversely proportional to its temperature. On the other hand if [[Volatiles]] and [[Oxygen]] are in excess (e.g. farm on [[Vulcan]]) is may be much easier to opt for Pressure Fed Gas Engine. It will provide ~40kN at 20°C.

<div style="width:auto; overflow:auto;">
{| class="wikitable sortable" style="width:100%;"
! rowspan=2 | Name
! rowspan=2 | Base Power Usage
! rowspan=2 | Rocket Mass Contribution
! rowspan=2 | Max Thrust
! colspan=2 | Real Max Thrust
! rowspan=2 | Efficiency
! rowspan=2 | Exhaust Velocity
|-

! Using O2
! Using N2O
|-

! <b>[[Pressure Fed Gas Engine]]</b>
| 10W
| 500kg
| 40,3kN
| 61,0kN
| 41,9kN<ref>N2O must be much hotter to avoid condensing therefore decreasing pumping rate</ref>
| 96%
| 3,86km/s (Isp: 394s)
|-

! <b>[[Pumped Gas Engine]]</b>
| 200W
| 500kg
| 16,2kN
| 16,5kN
| 24,5kN
| 100%
| 4,02km/s (Isp: 411s)
|-

! <b>[[Pumped Liquid Engine]]</b>
| 200W
| 500kg
| 17,6kN
| 18,7kN
| 31,3kN
| 140%
| 5,47km/s (Isp: 559s)
|-

! <b>[[Pressure Fed Liquid Engine]]</b>
| 20W
| 500kg
| 29,2kN
| 43,4kN - 38,1kN
| 74,5kN - 61,3kN
| 160%
| 6,18km/s (Isp: 631s)
|-

! colspan=8 | <i>Update 0.2.4726.21691 - 18/01/2024</i> <span class="right">[[Rocket_Engines]]</span>
|}
</div>

Gas condensation

2025-12-10T19:09:18Z

Thoth: starter page for gas condensation

While gas condensing into liquid is a problem that can lead to burst pipes and system failure, it can also be used to transfer energy between atmospheres, and liquid propellant is useful in [[Rocketry]].

While there are devices like [[Condensation Valve]] , [[Expansion Valve]], [[Pressurant Valve]], and [[Purge Valve]], the real workhorses are the [[Evaporation Chamber]] and [[Condensation Chamber]] built from the [[Kit (Phase Change Device)]].

# Mars example

[[File:Mars condensation schematic.svg|frameless|Mars condensation schematic]]

File:Mars condensation schematic.svg

2025-12-10T19:04:14Z

Thoth: User created page with UploadWizard

=={{int:filedesc}}==
{{Information
|description={{en|1=This is a schematic of a gas liquification chain optimized for Mars}}
|date=2025-08-08
|source={{own}}
|author=[[User:Thoth|Thoth]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{licensing|generic}}

[[Category:Liquid]]

Cryotube

2025-06-23T17:42:25Z

Thoth: discuss some practical problems that must be overcome to properly operate the chamber

<languages/>
<translate>

[[Category:Machines]]
{{Itembox
| name = Kit (Cryotube)
| createdwith = [[Hydraulic Pipe Bender]] '''MK2'''
| cost = 10g [[Gold]], 10g [[Copper]], 35g [[Steel]], 5g [[Silver]]
}}
{{Structurebox
| name = Cryotube
| image = [[File:Cyrotube.jpg|133KBpx|frameless|center|Cyrotube]]
| power_usage = 10W
| placed_with_item = [[Kit (Cryotube)]]
| placed_on_grid = Small Grid
| decon_with_tool1 = [[Hand Drill]]
| item_rec1 = [[Kit (Cryotube)]]
}}
== Description ==
A Cryotube can heal players and organs as well as revive dead players, the cryotube also functions as a [[sleeper]]; has one gas input, one power input, and one data input.

When opened the cryotube will expel its gas from the tube into the room it is in, it does not appear to backflow.

=== Healing Players ===
For healing, feed the cryotube any breathable air mix (Pure 02, O2/N2 mix etc.) at room temperature (0-30C). this will heal a player and repair damaged lungs. Be sure to have a system to filter out the C02.

=== Reviving Dead Players ===
To Revive a player, the cryotube must be fed more than 80Kpa of [[Nitrogen]] at a temperature of less than -150C, other gasses can be included so long as there is at least a partial pressure of 80kpa Nitrogen.<ref>[https://discord.com/channels/276525882049429515/811149668729356350/1138252121377079367 Discord] it's expecting 80 kPa of N2 at -150C - Risu</ref>

== Practical considerations ==

The pipe connection on the unit is for gas pipes. Avoid conditions that lead to significant build-up of liquid or ice inside the pipe.

The stationeer must remove their pressure suit to get into the cryotube so it should be in a room with a breathable atmosphere.

When the cryotube is opened gas is exchanged with the surrounding atmosphere. When it is closed gas is exchanged with the connected gas pipe. Ideally the connected gas supply will be similar to the room gas mix (i.e. 81% N2O, 19% O2 at 100kPa) . However, since the stationeer will be exhaling CO2 this will end up in the connected gas supply. When used as a resurrection chamber the CO2 that ends up in the cryogenic gas will freeze, and when too much crystalizes in the pipe, the pipe will fail.

=== Suggestion ===

One strategy for providing cryogenic gas to the chamber is to pressurize a pipe to 101 kPa with a breathable atmosphere (perhaps imported from the room containing the cryotube). Connect that pipe to the heat exchange connection of an [[Evaporation Chamber]] which is supplied with liquid nitrogen and is set for 800 kPa. This should (when supplied with cold enough liquid nitrogen) stabilize below -150C. This keeps the cryotube gas separate from the pure liquid nitrogen, and can be scrubbed of problematic gasses using [[Filtration]].

Remember that as the gas in the pipe cools the pressure diminishes, so a [[Pressure Regulator]] may be of use to load more gas from the room.

{{Data Network Header}}

{{Data Parameters}}
{| class="wikitable"
|-
! Parameter Name !! Data Type !! Description
|-
| Open || Boolean || Opens the CryoTube, when set to 1. Closes it, when set to 0.
|-
| On || Boolean || Turns the CryoTube on, when set to 1. Turns it off, when set to 0.
|}

{{Data Outputs}}
{| class="wikitable"
|-
! Output Name !! Data Type !! Description
|-
| Power || Boolean || Returns whether the CryoTube is turned on and receives power. (0 for no, 1 for yes)
|-
| Open || Boolean || Returns whether the CryoTube is open. (0 for no, 1 for yes)
|-
| Error || Boolean || Returns whether the CryoTube is flashing an error. (0 for no, 1 for yes)
|-
| On || Boolean || Returns whether the CryoTube is turned on. (0 for no, 1 for yes)
|-
| RequiredPower || Integer || Returns the current amount of power, required by the CryoTube, in watts.
|}

=== References === 
<references />

</translate>

Rocket Destination Code List

2024-09-20T16:27:52Z

Thoth: Add Mars

Rocket destination codes in Stationeers are displayed in the Map of of a [[Computer]] with a [[Rocket Control Motherboard]] are displayed as 8 pairs of decimal digits separated by dashes. For example Prograde Moon Transfer is 00-00-00-00-00-00-02-10 . The topology of the graph is encoded in the Destination code. The space map can be considered to have a "root" like Europa Orbit = 00-00-00-00-00-00-00-10 and each destination further away adds a 2-digit number to the left (see Prograde Moon Transfer above).

In the data parameters of the [[Rocket Avionics]] the DestinationCode and CurrentCode are represented as integers without the dashes, and do not need the leading zeros, and do not display the leading zeros in the Rocket panel of the Computer.

= Asteroid Belt =

{| class="wikitable"
|-
! Destination Code !! Name
|-
| 10|| Europa Orbit
|-
| 0110|| Io Orbit
|-
| 010110 || Tidal Fragments
|-
| 020110 || Io Condensate
|-
| 0210 || Prograde Moon Transfer
|-
| 010210 || Ersa
|-
| 020210 || Dia Fragments
|-
| 030210 || Retrograde Moon Transfer
|-
| 01030210 || Mneme Cluster
|-
| 02030210 || Lost Moon
|-
| 03030210 || Kore
|-
| 0310 || Ganymeded Orbit
|-
| 010310 || Ferrous Asteroids
|-
| 020310 || Geyser Spouts
|-
| 030310 || Callisto Orbit
|-
| 4010 || '''Asteroid Belt'''
|}

= Mars =

{| class="wikitable"
|-
! Destination Code !! Name
|-
| 16 || Mars Orbit
|-
| 0116 || Phobos
|-
| 010116 || Deimos
|-
| 01010116 || Mars Lagrange Transfer
|-
| 0101010116 || Mars L4
|-
| 010101010116 || Rich Asteroids
|-
| 020101010116 || Oxygenated Ice Cluster
|-
| 0201010116 || Mars L5
|-
| 010201010116 || Hydrogenated Gas Cloud
|-
| 020201010116 || Lost Moon Fragments
|-
| 02010116 || Ferrous Asteroid Sector
|-
| 03010116 || Columnar Asteroids
|-
| 020116 || Frozen Vapors
|-
| 030116 || Metallic Field
|-
| 040116 || Rocky Asteroid

|}

Rocket Overview

2024-09-20T15:27:59Z

Thoth: add link to Rocket Destination Code List

2023 December patch overhauled the rocket system. Instances of the old modular rocket disappeared when loading old saves.

The new system is even more modular that the old system. Under the old system you started with an engine and fuel tanks, and then added mining and storage modules and capped it off with a control nose cone.

The new system still has a vertical stack, but you have to arrange discrete components like fuel tanks, wiring, chutes, and pipes inside a grid within the rocket.

Before you even get started, you will need to make a [[Rocket Manufactory]].

== Building the Base Station ==
You need a [[Computer]] with a [[Rocket Control Motherboard]] attached to a [[Logic Uplink]] tuned to the [[Logic Rocket Downlink|downlink]] component on the rocket.

A [[Launch Mount]] must be built on a set of 4 ([[Steel Frames|steel]] or [[Iron Frames|iron]]) frames.

Add enough [[Launch Tower]] parts to support umbilicals corresponding to each of your umbilical sockets (Power, Gas|Liquid, Chute). Leave 2 metres between the rocket and the tower so the umbilicals have room. Warning: retract your umbilicals before launching.

== Building the Rocket ==

===Propulsion system===
* [[Engine Mount]]. This must be built on the Launch Mount.
* Some kind of engine: [[Pressure Fed Gas Engine]], [[Pumped Gas Engine]], [[Pressure Fed Liquid Engine]] or [[Pumped Liquid Engine]]
* One or more [[Fuselage]]s for fuel tanks
* One or more fuel tanks matching your engine: [[Special:MyLanguage/Kit (Rocket Gas Fuel Tank)|Gas Capsule Tank Small]], [[Special:MyLanguage/Kit (Rocket Gas Fuel Tank)|Gas Capsule Tank Medium]], [[Liquid Capsule Tank Small]] or [[Liquid Capsule Tank Medium]]
* [[Umbilical Socket (Gas)]] or [[Umbilical Socket (Liquid)]] depending on your engine
* [[Kit (Pipe)]] or [[Kit (Insulated Pipe)]] for connecting the fuel tanks and engine
Gas-fuelled rockets use a 2:1 [[Volatiles]]:[[Oxygen]] mixture. You can fit about 30,000 moles of gas in a medium capsule tank.

===Power payload system===
* One or more [[Fuselage]]s
* One or more [[Auxiliary Rocket Battery]] or [[Battery (Medium)]]
* [[Umbilical Socket (Power)]]

===Scanning payload system===
In order to map space you will need a rocket with the following:
* One or more [[Fuselage]]s
* [[Rocket Scanner]]
* [[Rocket Scanner Head]] (this is a consumable)
You do not need to put these on the same rocket as your mining equipment. Keeping them separate will allow you to map and mine separately.

===Mining payload system===
* One or more [[Fuselage]]s
* [[Umbilical Socket (Chute)]]
* [[Rocket Miner]]
* One of seven different drill heads for the Rocket Miner: [[Mining-Drill Head (Basic)]], [[Mining-Drill Head (Durable)]], [[Mining-Drill Head (High Speed Ice)]], [[Mining-Drill Head (High Speed Mineral)]], [[Mining-Drill Head (Ice)]], [[Mining-Drill Head (Long Term)]], [[Mining-Drill Head (Mineral)]]. This is a consumable item.
* One or more [[Cargo Storage (Small)]] or [[Cargo Storage (Medium)]]
Use [[Chute]]s to connect your miner to the storage and the storage to the umbilical socket.

===Guidance system===
* [[Logic Rocket Downlink]]
* [[Rocket Avionics]] (must be built or the rocket will not even show up on the computer)

===Rocket top===
* [[Fairing]] on the top

===Note===
Important: You do not have to build all of the systems from scratch and/or separately: you can combine parts of the payload and guidance system into the same Fuselages to optimize and keep the rocket as small as possible.

== See also ==
* [[Access Bridge]]
* [[Rocket Celestial Tracker]]
* [[Rocket Circuit Housing]]
* [[Transformer Small (Rocket)]]
* [[Rocket Destination Code List]]
* [http://www.purplefrog.com/~thoth/art/stationeers-rocket-engine/rocket-landing.html MIPS-based throttle control for rocket landing]

[[File:Stationeers-space-map.png|thumb|an example of the space map in the rocket control interface]]

[[Category:Rocketry]]
[[Category:Tutorials]]

Rocket Destination Code List

2024-09-20T15:27:34Z

Thoth: Created page with "Rocket destination codes in Stationeers are displayed in the Map of of a Computer with a Rocket Control Motherboard are displayed as 8 pairs of decimal digits separate..."

Rocket Overview

2024-09-20T15:11:09Z

Thoth: reference my external math paper about rocket landing

2023 December patch overhauled the rocket system. Instances of the old modular rocket disappeared when loading old saves.

The new system is even more modular that the old system. Under the old system you started with an engine and fuel tanks, and then added mining and storage modules and capped it off with a control nose cone.

The new system still has a vertical stack, but you have to arrange discrete components like fuel tanks, wiring, chutes, and pipes inside a grid within the rocket.

Before you even get started, you will need to make a [[Rocket Manufactory]].

== Building the Base Station ==
You need a [[Computer]] with a [[Rocket Control Motherboard]] attached to a [[Logic Uplink]] tuned to the [[Logic Rocket Downlink|downlink]] component on the rocket.

A [[Launch Mount]] must be built on a set of 4 ([[Steel Frames|steel]] or [[Iron Frames|iron]]) frames.

Add enough [[Launch Tower]] parts to support umbilicals corresponding to each of your umbilical sockets (Power, Gas|Liquid, Chute). Leave 2 metres between the rocket and the tower so the umbilicals have room. Warning: retract your umbilicals before launching.

== Building the Rocket ==

===Propulsion system===
* [[Engine Mount]]. This must be built on the Launch Mount.
* Some kind of engine: [[Pressure Fed Gas Engine]], [[Pumped Gas Engine]], [[Pressure Fed Liquid Engine]] or [[Pumped Liquid Engine]]
* One or more [[Fuselage]]s for fuel tanks
* One or more fuel tanks matching your engine: [[Special:MyLanguage/Kit (Rocket Gas Fuel Tank)|Gas Capsule Tank Small]], [[Special:MyLanguage/Kit (Rocket Gas Fuel Tank)|Gas Capsule Tank Medium]], [[Liquid Capsule Tank Small]] or [[Liquid Capsule Tank Medium]]
* [[Umbilical Socket (Gas)]] or [[Umbilical Socket (Liquid)]] depending on your engine
* [[Kit (Pipe)]] or [[Kit (Insulated Pipe)]] for connecting the fuel tanks and engine
Gas-fuelled rockets use a 2:1 [[Volatiles]]:[[Oxygen]] mixture. You can fit about 30,000 moles of gas in a medium capsule tank.

===Power payload system===
* One or more [[Fuselage]]s
* One or more [[Auxiliary Rocket Battery]] or [[Battery (Medium)]]
* [[Umbilical Socket (Power)]]

===Scanning payload system===
In order to map space you will need a rocket with the following:
* One or more [[Fuselage]]s
* [[Rocket Scanner]]
* [[Rocket Scanner Head]] (this is a consumable)
You do not need to put these on the same rocket as your mining equipment. Keeping them separate will allow you to map and mine separately.

===Mining payload system===
* One or more [[Fuselage]]s
* [[Umbilical Socket (Chute)]]
* [[Rocket Miner]]
* One of seven different drill heads for the Rocket Miner: [[Mining-Drill Head (Basic)]], [[Mining-Drill Head (Durable)]], [[Mining-Drill Head (High Speed Ice)]], [[Mining-Drill Head (High Speed Mineral)]], [[Mining-Drill Head (Ice)]], [[Mining-Drill Head (Long Term)]], [[Mining-Drill Head (Mineral)]]. This is a consumable item.
* One or more [[Cargo Storage (Small)]] or [[Cargo Storage (Medium)]]
Use [[Chute]]s to connect your miner to the storage and the storage to the umbilical socket.

===Guidance system===
* [[Logic Rocket Downlink]]
* [[Rocket Avionics]] (must be built or the rocket will not even show up on the computer)

===Rocket top===
* [[Fairing]] on the top

===Note===
Important: You do not have to build all of the systems from scratch and/or separately: you can combine parts of the payload and guidance system into the same Fuselages to optimize and keep the rocket as small as possible.

== See also ==
* [[Access Bridge]]
* [[Rocket Celestial Tracker]]
* [[Rocket Circuit Housing]]
* [[Transformer Small (Rocket)]]
* [http://www.purplefrog.com/~thoth/art/stationeers-rocket-engine/rocket-landing.html MIPS-based throttle control for rocket landing]

[[File:Stationeers-space-map.png|thumb|an example of the space map in the rocket control interface]]

[[Category:Rocketry]]
[[Category:Tutorials]]

Rocket Avionics

2024-09-13T02:20:58Z

Thoth: document data network parameters

{{Structurebox
| name = Rocket Avionics
| image = [[File:StructureRocketAvionics.png]]
| other =
| power_usage = 10W
| burst_pressure =
| prefab_hash = 808389066
| prefab_name = StructureRocketAvionics
| placed_with_item = [[Kit (Avionics)]]
| placed_on_grid =
| stage_image1 =
| const_with_tool1 = [[Screwdriver]]
| const_with_item1 = 2 x [[Electronic Parts]]
| decon_with_tool1 =
| item_rec1 =
| stage_image2 =
| const_with_tool2 = [[Welding Torch]]
| const_with_item2 = 4 x [[Steel Sheets]]
| decon_with_tool2 =
| item_rec2 =
}}
==Description==
Must be built on the rocket to show up on the base station computer.

=== Data network parameters ===
{| class="wikitable sortable" style="width:100%;"
! Parameter Name
! class="unsortable" | Data Type
! class="unsortable" | Value
! class="unsortable" | Description
|-

| Size
|-

| Richness
|-

| Density
|-

| CurrentCode
| integer
|
| The current location code of the rocket
|-

! Sites
| integer
|
| The number of mining sites adjacent to this map location. Will be -1 if there are none to Discover.
|-

| ChartedNavPoints
|-

| NavPoints
| integer
|
| a count of adjacent nav points
|-

| Survey
| float
| 0-1
| Represents the scanning progress for a location with harvestable resources. Will be -1 if there are none to Survey.
|-

| Chart
| float
| 0-1
| Represents the scanning progress for a location with adjacent primary locations (like a planet, moon, or lagrange transfer point). It will cycle between 0 and 1 for each nav point.
|-

| Discover
| float
| 0-1
| Represents the scanning progress for a location adjacent to harvestable resources (cloud of gas or cluster or rocks)
|-

|RatioPollutedWater
|-
| RatioLiquidHydrogen
|-
| Apex
|-

|ReEntryAltitude
|-
| FlightControlRule
|-
| BurnTimeREmaining
|-
| TimeToDestination
|-
| ThrustToWeight
|-
| Weight
|-
| Thrust
|-
| DryMass
|-
| Mass
|-
| AutoShutoff
|-
| ReferenceId
|-
| Acceleration
|-
| DestinationCode
|-
| Progress
|-
| PrefabHash
|-
| VelocityRelativeY
|-
| TotalMoles
|-
| RequiredPower
|
| 10
|-
| On
|-
| Quantity
|
| -1
|-
| Reagents
|-
| Temperature
|-
| Error
|-
! Mode
| integer
|
| 1 = Idle (not scanning, whether stationary or in transit); 2 = Mine; 3 = Survey; 4 = Discover; 5 = Chart
|-
| Power
|-

! rowspan="2" | On
| rowspan="2" | Boolean
| style="text-align:center;" | 0
| Turns the device off.
|-
| style="text-align:center;" | 1
| Turns the device on.
|-
! colspan="4" | <i>Update 0.2.4726.21691 - 19/01/2024</i> <span class="right">[[Pumped_Liquid_Engine/Data Network|/Data_Network]]</span>
|}

==See also==
* [[Rocket Overview]]
[[Category:Rocketry]]

Pumped Liquid Engine

2024-09-12T22:13:36Z

Thoth: add annotated screenshot of liquid fuel ports

{{Infobox | decat = yes
| title = Kit (Pumped Liquid Engine)
| image = [[File:ItemKitPumpedLiquidEngine.png]]
| header1 = Fabrication
{{Infobox | decat = yes | child = yes
| label1 = Created with
| data1 = [[Rocket_Manufactory|Rocket Manufactory (Tier One)]]
| label2 = Cost
| data2 = 60000 [[Energy]], 15g [[Ingot_(Steel)|Steel]], 5g [[Ingot_(Electrum)|Electrum]], 10g [[Ingot_(Constantan)|Constantan]]
}}
| header2 = Temperature
{{Infobox | decat = yes | child = yes
| label1 = Flashpoint
| data1 = 373K (100°C)
| label2 = Autoignition
| data2 = 573K (300°C)
}}
| header3 = Other properties
{{Infobox | decat = yes | child = yes
| label1 = Paintable
| data1 = Yes
| label2 = Stack Size
| data2 = 1
}}
| header4 = Prefabs
{{Infobox | decat = yes | child = yes
| label1 = Prefab Hash
| data1 = 1921918951
| label2 = Prefab Name
| data2 = ItemKitPumpedLiquidEngine
}}
}}

{{Infobox | decat = yes
| title = Pumped Liquid Engine
| image = [[File:StructurePumpedLiquidEngine.png]]
| header1 = Operation
{{Infobox | decat = yes | child = yes
| label10 = Base Power Usage
| data10 = 200W
| label11 = Rocket Mass Contribution
| data11 = 500kg
| label12 = Max Thrust
| data12 = 17,6kN
| label13 = Efficiency
| data13 = 140%
| label14 = Exhaust Velocity
| data14 = 5,47km/s (Isp: 559s)
}}
| header2 = Contruction
{{Infobox | decat = yes | child = yes
| label20 = Total cost
| data20 = 2,5g [[Ingot_(Iron)|Iron]], 17g [[Ingot_(Steel)|Steel]], 5g [[Ingot_(Electrum)|Electrum]], 10g [[Ingot_(Constantan)|Constantan]]
| label21 = Constructed from
| data21 = Kit (Pumped Liquid Engine)
| label22 = Placed on
| data22 =
| label23 = Size
| data23 =
}}
| header4 = Other properties
{{Infobox | decat = yes | child = yes
| label40 = Paintable
| data40 = Yes
}}
| header5 = Prefabs
{{Infobox | decat = yes | child = yes
| label50 = Prefab Hash
| data50 = -23091440019
| label51 = Prefab Name
| data51 = StructurePumpedLiquidEngine
}}
}}

== Description ==
<div style="width:auto; overflow:auto; border-radius:10px; background-color:white;"><p style="margin:5px 0px 5px 10px;"><i>"Liquid propellants bring greater efficiencies with [[Pumped Liquid Engine]]. Two inputs are provided so Stationeers can seperate their fuels, the Setting variable controls the mixing ratio of the inputs. The engine is designed to run on [[Volatiles|Liquid Volatiles]] and [[Oxygen|Liquid Oxygen]], some Stationeers have reported excessive thrust values by switching to [[Nitrous_Oxide|Liquid Nitrous Oxide]]."</i><br><b>- Stationpedia</b></p></div>

== Comparison ==
{{:Rocket_Engines}}

== Data Network Properties ==
<div class="mw-customtoggle-datanetworkproperties" style="width:auto; overflow:auto; text-indent:10px; border: 2px solid #253C60; border-radius:10px;"><b>Click here to see/hide all the <span style="color:#E57125;">data network properties</span></b></div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-datanetworkproperties"><br>{{:Pumped_Liquid_Engine/Data_Network}}</div>

== Plumbing ==

The most straightforward way to store fuel is to fill one tank with volatiles, and the other with oxidizer. In order to make the gasses match the display on the rocket control computer, the ingredients must be connected to the correct port on the rocket engine.

[[File:Rocket-engine-pumped-liquid.png|The two liquid ports on a rocket engine|400px]]

== Build States ==
<div class="mw-customtoggle-buildstates" style="width:auto; overflow:auto; text-indent:10px; border: 2px solid #253C60; border-radius:10px;"><b>Click here to see/hide all the <span style="color:#E57125;">build states</span></b></div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-buildstates"><br>{{:Pumped_Liquid_Engine/Build_States}}</div>

__NOTOC__

[[Category:Items]]
[[Category:Kits]]
[[Category:Rocketry]]

File:Rocket-engine-pumped-liquid.png

2024-09-12T22:11:59Z

Thoth:

rocket engine with the two liquid propellant connections labelled

Pumped Liquid Engine/Data Network

2024-09-12T22:04:41Z

Thoth: document Setting and Ratio

<div style="width:auto; overflow:auto;">
=== Input Data (Write) ===
{| class="wikitable sortable" style="width:100%;"
! Parameter Name
! class="unsortable" | Data Type
! class="unsortable" | Value
! class="unsortable" | Description
|-

! rowspan="2" | On
| rowspan="2" | Boolean
| style="text-align:center;" | 0
| Turns the device off.
|-
| style="text-align:center;" | 1
| Turns the device on.
|-

! Setting
| ???
|
| A variable setting that can be read or written, depending on the device.
|-

! Throttle
| ???
|
| Increases the rate at which the machine workes (range: 0-100)
|-

! colspan="4" | <i>Update 0.2.4726.21691 - 19/01/2024</i> <span class="right">[[Pumped_Liquid_Engine/Data Network|/Data_Network]]</span>
|}

=== Output Data (Read) ===
{| class="wikitable sortable" style="width:100%;"
! Parameter Name
! class="unsortable" | Data Type
! class="unsortable" | Value
! class="unsortable" | Description
|-

! Power
| Boolean
|
| Can be read to return if the device is correctly powered or not, set cia the power system, return 1 if powered and 0 if not.
|-

! Error
| Boolean
|
| 1 if device is in error state, otherwise 0.
|-

! Pressure
| ???
|
| The current pressure reading of the device.
|-

! Temperature
| ???
|
| The current temperature reading of the device.
|-

! Setting
| float
| 70
| A writable value to control the mixing Ratio percentage.
|-

! RatioOxygen
| ???
|
| The ratio of [[Oxygen]] in device atmosphere.
|-

! RatioCarbonDioxide
| ???
|
| The ratio of [[Carbon Dioxide]] in device atmosphere.
|-

! RatioNitrogen
| ???
|
| The ratio of [[Nitrogen]] in device atmosphere.
|-

! RatioPollutant
| ???
|
| The ratio of [[Pollutant]] in device atmosphere.
|-

! RatioVolatiles
| ???
|
| The ratio of [[Volatiles]] in device atmosphere.
|-

! RatioVolatiles
| ???
|
| The ratio of water in device atmosphere.
|-

! Maximum
| ???
|
| Maximum setting of the device.
|-

! Ratio
| float
| Setting/100.0
| read-only version of the Setting that converts from the percentage to a 0-1 fraction.
|-

! Ratio
| Boolean
|
| The current state of the device, 0 for off, 1 for on.
|-

! RequiredPower
| ???
|
| Idle operating power quantity, does not nevessarily include extra demand power.
|-

! TotalMoles
| ???
|
| Returns the total moles of the device.
|-

! RatioNitrousOxide
| ???
|
| The ratio of [[Nitrous Oxide]] in device atmosphere.
|-

! PrefabHash
| ???
|
| The hash of the structure.
|-

! Combustion
| Boolean
|
| The assess atmosphere is on fire. Returns 1 if atmosphere is on fire, 0 if not.
|-

! Throttle
| ???
|
| Increases the rate at which the machie works (range: 0-100)
|-

! ReferenceId
| ???
|
| Unique Reference Identifier for this object.
|-

! PassedMoles
| ???
|
| The number of moles that passed through this device on the previous simulation tick.
|-

! colspan="4" | <i>Update 0.2.4726.21691 - 19/01/2024</i> <span class="right">[[Pumped_Liquid_Engine/Data Network|/Data_Network]]</span>
|}
</div>

Advanced Composter

2024-09-11T17:10:44Z

Thoth: rewrite the recipes according to experimental results with latest release.

Taken from Stationeers Stationpedia... <br>
''"the advanced composter creates fertilizer out of organic matter.'' <br>
''It accepts food, decayed food, or biomass. It requires water and power to operate, accelerating the natural composting process.''<br>
''When processing, it releases Nitrogen and Volatiles, as well as a small amount of heat.''<br>
''Fertilizer is produced at a 1:3 ratio of fertilizer to ingredients. The fertilizer's effects on plants will vary depending on the respective proportions of its ingredients."''
<br>
{| class="wikitable"
|-
! INGREDIENTS !! EFFECT
|-
| Food || Increases Yield up to 2x
|-
| [[Decayed food]] || Increases Growth Speed up to 2x
|-
| [[Biomass]] || Increases Growth Cycles before the Fertilizer runs out, up to 5x
|}
<br>
Usage:
* Connect a [[Water|H2O]] pipe with at least 20 mol H2O
* Connect power
* Insert at least 3 ingredients into the input slot on the side
* Turn on the On switch, it will grind the ingredients
* Point at the panel and it will tell you how many are ready for processing. You need at least 3 to produce 1 fertilizer
* Press the Activate button, and it will start processing, including outputting H2 and N2
* When done processing, a fertilizer will be ejected from the output slot
More information:
* Constructed from the [[Kit (Advanced Composter)]] which can be produced in the [[Electronics Printer Mk. II]] (Tier Two)

== Recipes ==

* 3 [[Fern]] or 3 [[Biomass]] or 3 [[Decayed food]]
* ~20 moles of [[Water]]

produces

* 1 [[Fertilizer]]
* ~49 moles [[Nitrogen]] (at 45°C)
* ~49 moles [[Volatiles]]

The exact moles consumed or produced is slightly variable.

Kit (Grow Light)

2024-09-04T18:38:08Z

Thoth: fix mistake in illumination pattern

[[Category:Items]][[Category:Lights]]
{{Itembox
| name = Kit (GrowLight)
| image = [[File:ItemKitGrowLight.png|Kit(GrowLight)]]
| createdwith = [[Electronics Printer]]
| cost = 5g [[Copper]], 5g [[Steel]], 10g [[Electrum]]
}}
{{Structurebox
| name = Grow Light

| image = [[File:ItemGrowLight.png]]
| placed_with_item = [[Kit (Grow Light)]]
| power_usage = 70W
| placed_on_grid = Small Grid
| decon_with_tool1 = [[Hand Drill]]
| item_rec1 = [[Kit (Grow Light)]]
}}

==Description==
Provides artificial sunlight to grow crops.

Crops need [[Water]] and sunlight to grow. Without water the plant will wither and die. Without sunlight/UV light it will stop growing, but won't wither.

[[Guide_(Farming)|Guide (Farming)]] provides additional info on how to setup farming with hydroponic tray.

==Illumination pattern==
Lighting area is not a focused cone but a 7x6 rectangle.

[[File:GrowLight topDown 2024.svg|frameless|wall-mount grow light coverage]]

==Wall Mounting vs Ceiling Mounting==
Illumination Radius is at its maximum 2-4 '''<big>small grids</big>''' away which coincides with '''<big>one large grid size</big>''', so ceiling mounting has '''the best coverage of 41''', against 37 of wall mounting.
However this creates difficulty for [[Harvie]] as that can only be mounted on ceiling. Harvie also requires additional space for chutes on either side, so farming plots need to be two rows apart, negating the density benefit of ceiling mounting.

So when [[Harvie]] is expected, wall mounting is more flexible then ceiling mounting.


{{Data Network Header}}


{{Data Parameters}}
{| class="wikitable"
|-
! Parameter Name !! Data Type !! Description
|-
| On || Boolean ||
|}


{{Data Outputs}}
{| class="wikitable"
|-
! Output Name !! Data Type !! Description
|-
| On || Boolean ||
|-
| Power || Boolean ||
|-
| PrefabHash || Integer ||
|-
| RequiredPower || Integer ||
|-
|}

File:GrowLight topDown 2024.svg

2024-09-04T18:37:10Z

Thoth: Thoth uploaded a new version of File:GrowLight topDown 2024.svg

=={{int:filedesc}}==
{{Information
|description={{en|1=a diagram of grow light coverage using wall-mount}}
|date=2024-09-04
|source={{own}}
|author=[[User:Thoth|Thoth]]
|permission=
|other versions=
}}

=={{int:license-header}}==
{{licensing|generic}}

Kit (Grow Light)

2024-09-04T18:24:34Z

Thoth: revise grow light coverage diagram

[[Category:Items]][[Category:Lights]]
{{Itembox
| name = Kit (GrowLight)
| image = [[File:ItemKitGrowLight.png|Kit(GrowLight)]]
| createdwith = [[Electronics Printer]]
| cost = 5g [[Copper]], 5g [[Steel]], 10g [[Electrum]]
}}
{{Structurebox
| name = Grow Light

| image = [[File:ItemGrowLight.png]]
| placed_with_item = [[Kit (Grow Light)]]
| power_usage = 70W
| placed_on_grid = Small Grid
| decon_with_tool1 = [[Hand Drill]]
| item_rec1 = [[Kit (Grow Light)]]
}}

==Description==
Provides artificial sunlight to grow crops.

Crops need [[Water]] and sunlight to grow. Without water the plant will wither and die. Without sunlight/UV light it will stop growing, but won't wither.

[[Guide_(Farming)|Guide (Farming)]] provides additional info on how to setup farming with hydroponic tray.

==Illumination pattern==
Lighting area is not a focused cone but a 7x5 rectangle.

[[File:GrowLight topDown 2024.svg|frameless|wall-mount grow light coverage]]

==Wall Mounting vs Ceiling Mounting==
Illumination Radius is at its maximum 2-4 '''<big>small grids</big>''' away which coincides with '''<big>one large grid size</big>''', so ceiling mounting has '''the best coverage of 41''', against 37 of wall mounting.
However this creates difficulty for [[Harvie]] as that can only be mounted on ceiling. Harvie also requires additional space for chutes on either side, so farming plots need to be two rows apart, negating the density benefit of ceiling mounting.

So when [[Harvie]] is expected, wall mounting is more flexible then ceiling mounting.


{{Data Network Header}}


{{Data Parameters}}
{| class="wikitable"
|-
! Parameter Name !! Data Type !! Description
|-
| On || Boolean ||
|}


{{Data Outputs}}
{| class="wikitable"
|-
! Output Name !! Data Type !! Description
|-
| On || Boolean ||
|-
| Power || Boolean ||
|-
| PrefabHash || Integer ||
|-
| RequiredPower || Integer ||
|-
|}

File:GrowLight topDown 2024.svg

2024-09-04T18:22:12Z

Thoth: User created page with UploadWizard

IC10/instructions

2024-07-26T23:31:01Z

Thoth: turns out this is only a problem for the independent batch slot reader

<noinclude>
See [[IC10]] for the primary page for the IC10 instruction set. This page lists all available instructions
</noinclude>

== Utility ==

{{ICInstruction|instruction=alias|description=Labels register or device reference with name, device references also affect what shows on the screws on the IC base.|syntax=alias str r?{{!}}d?
|example=
{{ICCode|
alias dAutoHydro1 d0
alias vTemperature r0
}}}}
{{ICInstruction|instruction=define|description=Creates a label that will be replaced throughout the program with the provided value.|syntax=define str num
|example=
{{ICCode|
define ultimateAnswer 42
move r0 ultimateAnswer # Store 42 in register 0
}}}}
{{ICInstruction|instruction=hcf|description=Halt and catch fire|syntax=hcf}}
{{ICInstruction|instruction=sleep|description=Pauses execution on the IC for a seconds|syntax=sleep a(r?{{!}}num)}}
{{ICInstruction|instruction=yield|description=Pauses execution for 1 tick|syntax=yield}}

== Mathematical ==

{{ICInstruction|instruction=abs|description=Register = the absolute value of a|syntax=abs r? a(r?{{!}}num)
|example=
{{ICCode|
define negativeNumber -10
abs r0 negativeNumber # Compute the absolute value of -10 and store it in register 0
}}}}
{{ICInstruction|instruction=add|description=Register = a + b.|syntax=add r? a(r?{{!}}num) b(r?{{!}}num)
|example=
{{ICCode|add r0 r0 1 # increment r0 by one}}
{{ICCode|
define num1 10
define num2 20
add r0 num1 num2 # Add 10 and 20 and store the result in register 0
}}}}
{{ICInstruction|instruction=ceil|description=Register = smallest integer greater than a|syntax=ceil r? a(r?{{!}}num)
|example=
{{ICCode|
define floatNumber 10.3
ceil r0 floatNumber # Compute the ceiling of 10.3 and store it in register 0
}}}}
{{ICInstruction|instruction=div|description=Register = a / b|syntax=div r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=exp|description=exp(a) or e^a|syntax=exp r? a(r?{{!}}num)}}
{{ICInstruction|instruction=floor|description=Register = largest integer less than a|syntax=floor r? a(r?{{!}}num)}}
{{ICInstruction|instruction=log|description=base e log(a) or ln(a)|syntax=log r? a(r?{{!}}num)}}
{{ICInstruction|instruction=max|description=Register = max of a or b|syntax=max r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=min|description=Register = min of a or b|syntax=min r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=mod|description=Register = a mod b (note: NOT a % b)|syntax=mod r? a(r?{{!}}num) b(r?{{!}}num)
|example=
{{ICCode|
mod r0 10 20
# Expected: r0 = 10

mod r1 22 20
# Expected: r1 = 2

mod r2 22 -20
# Expected: r2 = 18

mod r2 22 -10
# Expected: r2 = 18
}}}}
{{ICInstruction|instruction=move|description=Register = provided num or register value.|syntax=move r? a(r?{{!}}num)
|example=
{{ICCode|move r0 42 # Store 42 in register 0}}}}
{{ICInstruction|instruction=mul|description=Register = a * b|syntax=mul r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=rand|description=Register = a random value x with 0 <= x < 1|syntax=rand r?}}
{{ICInstruction|instruction=round|description=Register = a rounded to nearest integer|syntax=round r? a(r?{{!}}num)}}
{{ICInstruction|instruction=sqrt|description=Register = square root of a|syntax=sqrt r? a(r?{{!}}num)}}
{{ICInstruction|instruction=sub|description=Register = a - b.|syntax=sub r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=trunc|description=Register = a with fractional part removed|syntax=trunc r? a(r?{{!}}num)}}

=== Mathematical / Trigonometric ===

{{ICInstruction|instruction=acos|description=Returns the angle (radians) whos cos is the specified value|syntax=acos r? a(r?{{!}}num)}}
{{ICInstruction|instruction=asin|description=Returns the angle (radians) whos sine is the specified value|syntax=asin r? a(r?{{!}}num)}}
{{ICInstruction|instruction=atan|description=Returns the angle (radians) whos tan is the specified value|syntax=atan r? a(r?{{!}}num)}}
{{ICInstruction|instruction=atan2|description=Returns the angle (radians) whose tangent is the quotient of two specified values: a (y) and b (x)|syntax=atan2 r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=cos|description=Returns the cosine of the specified angle (radians)|syntax=cos r? a(r?{{!}}num)}}
{{ICInstruction|instruction=sin|description=Returns the sine of the specified angle (radians)|syntax=sin r? a(r?{{!}}num)}}
{{ICInstruction|instruction=tan|description=Returns the tan of the specified angle (radians) |syntax=tan r? a(r?{{!}}num)}}

== Stack ==

{{ICInstruction|instruction=clr|description=Clears the stack memory for the provided device.|syntax=clr d?}}
{{ICInstruction|instruction=clrd|description=Seeks directly for the provided device id and clears the stack memory of that device|syntax=clrd id(r?{{!}}num)}}
{{ICInstruction|instruction=get|description=Using the provided device, attempts to read the stack value at the provided address, and places it in the register.|syntax=get r? d? address(r?{{!}}num)}}
{{ICInstruction|instruction=getd|description=Seeks directly for the provided device id, attempts to read the stack value at the provided address, and places it in the register.|syntax=getd r? id(r?{{!}}num) address(r?{{!}}num)}}
{{ICInstruction|instruction=peek|description=Register = the value at the top of the stack|syntax=peek r?}}
{{ICInstruction|instruction=poke|description=Stores the provided value at the provided address in the stack.|syntax=poke address(r?{{!}}num) value(r?{{!}}num)}}
{{ICInstruction|instruction=pop|description=Register = the value at the top of the stack and decrements sp|syntax=pop r?}}
{{ICInstruction|instruction=push|description=Pushes the value of a to the stack at sp and increments sp|syntax=push a(r?{{!}}num)}}
{{ICInstruction|instruction=put|description=Using the provided device, attempts to write the provided value to the stack at the provided address.|syntax=put d? address(r?{{!}}num) value(r?{{!}}num)}}
{{ICInstruction|instruction=putd|description=Seeks directly for the provided device id, attempts to write the provided value to the stack at the provided address.|syntax=putd id(r?{{!}}num) address(r?{{!}}num) value(r?{{!}}num)}}

== Slot/Logic ==

{{ICInstruction|instruction=l|description=Loads device LogicType to register by housing index value.|syntax=l r? d? logicType
|example=
Read from the device on d0 into register 0
{{ICCode|l r0 d0 Setting}}
Read the pressure from a sensor
{{ICCode|l r1 d5 Pressure}}
This also works with aliases. For example:
{{ICCode|
alias Sensor d0
l r0 Sensor Temperature
}}}}
{{ICInstruction|instruction=ld|description=Loads device LogicType to register by direct ID reference.|syntax=ld r? id(r?{{!}}num) logicType}}
{{ICInstruction|instruction=lr|description=Loads reagent of device's ReagentMode where a hash of the reagent type to check for. ReagentMode can be either Contents (0), Required (1), Recipe (2). Can use either the word, or the number.|syntax=lr r? d? reagentMode int}}
{{ICInstruction|instruction=ls|description=Loads slot LogicSlotType on device to register.|syntax=ls r? d? slotIndex logicSlotType
|example=
Read from the second slot of device on d0, stores 1 in r0 if it's occupied, 0 otherwise.
{{ICCode|ls r0 d0 2 Occupied}}
And here is the code to read the charge of an AIMeE:
{{ICCode|
alias robot d0
alias charge r10
ls charge robot 0 Charge
}}}}
{{ICInstruction|instruction=s|description=Stores register value to LogicType on device by housing index value.|syntax=s d? logicType r?
|example=
{{ICCode|
s d0 Setting r0
}}}}
{{ICInstruction|instruction=sd|description=Stores register value to LogicType on device by direct ID reference.|syntax=sd id(r?{{!}}num) logicType r?}}
{{ICInstruction|instruction=ss|description=Stores register value to device stored in a slot LogicSlotType on device.|syntax=ss d? slotIndex logicSlotType r?}}
{{ICInstruction|instruction=rmap|description=Given a reagent hash, store the corresponding prefab hash that the device expects to fulfill the reagent requirement. For example, on an autolathe, the hash for Iron will store the hash for ItemIronIngot.|syntax=rmap r? d? reagentHash(r?{{!}}num)}}

=== Slot/Logic / Batched ===

{{ICInstruction|instruction=lb|description=Loads LogicType from all output network devices with provided type hash using the provide batch mode. Average (0), Sum (1), Minimum (2), Maximum (3). Can use either the word, or the number.|syntax=lb r? deviceHash logicType batchMode
|example=
{{ICCode|lb r0 HASH("StructureWallLight") On Sum}}}}
{{ICInstruction|instruction=lbn|description=Loads LogicType from all output network devices with provided type and name hashes using the provide batch mode. Average (0), Sum (1), Minimum (2), Maximum (3). Can use either the word, or the number.|syntax=lbn r? deviceHash nameHash logicType batchMode}}
{{ICInstruction|instruction=lbns|description=Loads LogicSlotType from slotIndex from all output network devices with provided type and name hashes using the provide batch mode. Average (0), Sum (1), Minimum (2), Maximum (3). Can use either the word, or the number.|syntax=lbns r? deviceHash nameHash slotIndex logicSlotType batchMode}}
{{ICInstruction|instruction=lbs|description=Loads LogicSlotType from slotIndex from all output network devices with provided type hash using the provide batch mode. Average (0), Sum (1), Minimum (2), Maximum (3). Can use either the word, or the number.|syntax=lbs r? deviceHash slotIndex logicSlotType batchMode}}
{{ICInstruction|instruction=sb|description=Stores register value to LogicType on all output network devices with provided type hash.|syntax=sb deviceHash logicType r?
|example=
{{ICCode|sb HASH("StructureWallLight") On 1}}}}
{{ICInstruction|instruction=sbn|description=Stores register value to LogicType on all output network devices with provided type hash and name.|syntax=sbn deviceHash nameHash logicType r?}}
{{ICInstruction|instruction=sbs|description=Stores register value to LogicSlotType on all output network devices with provided type hash in the provided slot.|syntax=sbs deviceHash slotIndex logicSlotType r?}}

== Bitwise ==

{{ICInstruction|instruction=and|description=Performs a bitwise logical AND operation on the binary representation of two values. Each bit of the result is determined by evaluating the corresponding bits of the input values. If both bits are 1, the resulting bit is set to 1. Otherwise the resulting bit is set to 0.|syntax=and r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=nor|description=Performs a bitwise logical NOR (NOT OR) operation on the binary representation of two values. Each bit of the result is determined by evaluating the corresponding bits of the input values. If both bits are 0, the resulting bit is set to 1. Otherwise, if at least one bit is 1, the resulting bit is set to 0.|syntax=nor r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=not|description=Performs a bitwise logical NOT operation flipping each bit of the input value, resulting in a binary complement. If a bit is 1, it becomes 0, and if a bit is 0, it becomes 1.|syntax=not r? a(r?{{!}}num)
|note=
This is a bitwise operation, the NOT of 1 => -2, etc. You may want to use seqz instead}}
{{ICInstruction|instruction=or|description=Performs a bitwise logical OR operation on the binary representation of two values. Each bit of the result is determined by evaluating the corresponding bits of the input values. If either bit is 1, the resulting bit is set to 1. If both bits are 0, the resulting bit is set to 0.|syntax=or r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=sla|description=Performs a bitwise arithmetic left shift operation on the binary representation of a value. It shifts the bits to the left and fills the vacated rightmost bits with a copy of the sign bit (the most significant bit).|syntax=sla r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=sll|description=Performs a bitwise logical left shift operation on the binary representation of a value. It shifts the bits to the left and fills the vacated rightmost bits with zeros.|syntax=sll r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=sra|description=Performs a bitwise arithmetic right shift operation on the binary representation of a value. It shifts the bits to the right and fills the vacated leftmost bits with a copy of the sign bit (the most significant bit).|syntax=sra r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=srl|description=Performs a bitwise logical right shift operation on the binary representation of a value. It shifts the bits to the right and fills the vacated leftmost bits with zeros|syntax=srl r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=xor|description=Performs a bitwise logical XOR (exclusive OR) operation on the binary representation of two values. Each bit of the result is determined by evaluating the corresponding bits of the input values. If the bits are different (one bit is 0 and the other is 1), the resulting bit is set to 1. If the bits are the same (both 0 or both 1), the resulting bit is set to 0.|syntax=xor r? a(r?{{!}}num) b(r?{{!}}num)}}

== Comparison ==

{{ICInstruction|instruction=select|description=Register = b if a is non-zero, otherwise c|syntax=select r? a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)
|example=
{{ICCode|
select r1 r0 10 100
}}
|note=
This operation can be used as a simple ternary condition}}

=== Comparison / Device Pin ===

{{ICInstruction|instruction=sdns|description=Register = 1 if device is not set, otherwise 0|syntax=sdns r? d?}}
{{ICInstruction|instruction=sdse|description=Register = 1 if device is set, otherwise 0.|syntax=sdse r? d?}}

=== Comparison / Value ===

{{ICInstruction|instruction=sap|description=Register = 1 if abs(a - b) <= max(c * max(abs(a), abs(b)), float.epsilon * 8), otherwise 0|syntax=sap r? a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=sapz|description=Register = 1 if abs(a) <= max(b * abs(a), float.epsilon * 8), otherwise 0|syntax=sapz r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=seq|description=Register = 1 if a == b, otherwise 0|syntax=seq r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=seqz|description=Register = 1 if a == 0, otherwise 0|syntax=seqz r? a(r?{{!}}num)}}
{{ICInstruction|instruction=sge|description=Register = 1 if a >= b, otherwise 0|syntax=sge r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=sgez|description=Register = 1 if a >= 0, otherwise 0|syntax=sgez r? a(r?{{!}}num)}}
{{ICInstruction|instruction=sgt|description=Register = 1 if a > b, otherwise 0|syntax=sgt r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=sgtz|description=Register = 1 if a > 0, otherwise 0|syntax=sgtz r? a(r?{{!}}num)}}
{{ICInstruction|instruction=sle|description=Register = 1 if a <= b, otherwise 0|syntax=sle r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=slez|description=Register = 1 if a <= 0, otherwise 0|syntax=slez r? a(r?{{!}}num)}}
{{ICInstruction|instruction=slt|description=Register = 1 if a < b, otherwise 0|syntax=slt r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=sltz|description=Register = 1 if a < 0, otherwise 0|syntax=sltz r? a(r?{{!}}num)}}
{{ICInstruction|instruction=sna|description=Register = 1 if abs(a - b) > max(c * max(abs(a), abs(b)), float.epsilon * 8), otherwise 0|syntax=sna r? a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=snan|description=Register = 1 if a is NaN, otherwise 0|syntax=snan r? a(r?{{!}}num)}}
{{ICInstruction|instruction=snanz|description=Register = 0 if a is NaN, otherwise 1|syntax=snanz r? a(r?{{!}}num)}}
{{ICInstruction|instruction=snaz|description=Register = 1 if abs(a) > max(b * abs(a), float.epsilon), otherwise 0|syntax=snaz r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=sne|description=Register = 1 if a != b, otherwise 0|syntax=sne r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=snez|description=Register = 1 if a != 0, otherwise 0|syntax=snez r? a(r?{{!}}num)}}

== Branching ==

{{ICInstruction|instruction=j|description=Jump execution to line a|syntax=j int
|example=
{{ICCode|j 0 # jump line 0}}
{{ICCode|
j label # jump to a label

label:
# your code here
}}}}
{{ICInstruction|instruction=jal|description=Jump execution to line a and store next line number in ra|syntax=jal int
|example=
jal provides a way to do function calls in IC10 mips

{{ICCode|
move r0 1000
move r1 0
start:
jal average
s db Setting r0
yield
j start

average:
add r0 r0 r1
div r0 r0 2
j ra # jump back
}}}}
{{ICInstruction|instruction=jr|description=Relative jump to line a|syntax=jr int}}

=== Branching / Device Pin ===

{{ICInstruction|instruction=bdns|description=Branch to line a if device d isn't set|syntax=bdns d? a(r?{{!}}num)}}
{{ICInstruction|instruction=bdnsal|description=Jump execution to line a and store next line number if device is not set|syntax=bdnsal d? a(r?{{!}}num)}}
{{ICInstruction|instruction=bdse|description=Branch to line a if device d is set|syntax=bdse d? a(r?{{!}}num)}}
{{ICInstruction|instruction=bdseal|description=Jump execution to line a and store next line number if device is set|syntax=bdseal d? a(r?{{!}}num)
|example=
{{ICCode|
#Store line number and jump to line 32 if d0 is assigned.
bdseal d0 32
}}
{{ICCode|
#Store line in ra and jump to label HarvestCrop if device d0 is assigned.
bdseal d0 HarvestCrop
}}}}
{{ICInstruction|instruction=brdns|description=Relative jump to line a if device is not set|syntax=brdns d? a(r?{{!}}num)}}
{{ICInstruction|instruction=brdse|description=Relative jump to line a if device is set|syntax=brdse d? a(r?{{!}}num)}}

=== Branching / Comparison ===

{{ICInstruction|instruction=bap|description=Branch to line d if abs(a - b) <= max(c * max(abs(a), abs(b)), float.epsilon * 8)|syntax=bap a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
{{ICInstruction|instruction=brap|description=Relative branch to line d if abs(a - b) <= max(c * max(abs(a), abs(b)), float.epsilon * 8)|syntax=brap a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
{{ICInstruction|instruction=bapal|description=Branch to line c if a != b and store next line number in ra|syntax=bapal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
{{ICInstruction|instruction=bapz|description=Branch to line c if abs(a) <= max(b * abs(a), float.epsilon * 8)|syntax=bapz a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=brapz|description=Relative branch to line c if abs(a) <= max(b * abs(a), float.epsilon * 8)|syntax=brapz a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bapzal|description=Branch to line c if abs(a) <= max(b * abs(a), float.epsilon * 8) and store next line number in ra|syntax=bapzal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=beq|description=Branch to line c if a == b|syntax=beq a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=breq|description=Relative branch to line c if a == b|syntax=breq a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=beqal|description=Branch to line c if a == b and store next line number in ra|syntax=beqal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=beqz|description=Branch to line b if a == 0|syntax=beqz a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=breqz|description=Relative branch to line b if a == 0|syntax=breqz a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=beqzal|description=Branch to line b if a == 0 and store next line number in ra|syntax=beqzal a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bge|description=Branch to line c if a >= b|syntax=bge a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=brge|description=Relative jump to line c if a >= b|syntax=brge a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bgeal|description=Branch to line c if a >= b and store next line number in ra|syntax=bgeal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bgez|description=Branch to line b if a >= 0|syntax=bgez a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=brgez|description=Relative branch to line b if a >= 0|syntax=brgez a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bgezal|description=Branch to line b if a >= 0 and store next line number in ra|syntax=bgezal a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bgt|description=Branch to line c if a > b|syntax=bgt a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)
|example=
An example of a '''Schmitt''' trigger, turning on a device if the temperature is too low, and turning it off if it's too high and finally
doing nothing if the temperature is within the desired range.
{{ICCode|
alias sensor d0
alias device d1

define mintemp 293.15
define maxtemp 298.15

start:
yield
l r0 sensor Temperature
# If the temperature < mintemp, turn on the device
blt r0 mintemp turnOn
# If the temperature > maxtemp, turn off the device
bgt r0 maxtemp turnOff
j start

turnOn:
s device On 1
j start
turnOff:
s device On 0
j start
}}}}
{{ICInstruction|instruction=brgt|description=relative jump to line c if a > b|syntax=brgt a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bgtal|description=Branch to line c if a > b and store next line number in ra|syntax=bgtal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bgtz|description=Branch to line b if a > 0|syntax=bgtz a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=brgtz|description=Relative branch to line b if a > 0|syntax=brgtz a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bgtzal|description=Branch to line b if a > 0 and store next line number in ra|syntax=bgtzal a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=ble|description=Branch to line c if a <= b|syntax=ble a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=brle|description=Relative jump to line c if a <= b|syntax=brle a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bleal|description=Branch to line c if a <= b and store next line number in ra|syntax=bleal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=blez|description=Branch to line b if a <= 0|syntax=blez a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=brlez|description=Relative branch to line b if a <= 0|syntax=brlez a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=blezal|description=Branch to line b if a <= 0 and store next line number in ra|syntax=blezal a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=blt|description=Branch to line c if a < b|syntax=blt a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)
|example=
An example of a '''Schmitt''' trigger, turning on a device if the temperature is too low, and turning it off if it's too high and finally
doing nothing if the temperature is within the desired range.
{{ICCode|
alias sensor d0
alias device d1

define mintemp 293.15
define maxtemp 298.15

start:
yield
l r0 sensor Temperature
# If the temperature < mintemp, turn on the device
blt r0 mintemp turnOn
# If the temperature > maxtemp, turn off the device
bgt r0 maxtemp turnOff
j start

turnOn:
s device On 1
j start
turnOff:
s device On 0
j start
}}}}
{{ICInstruction|instruction=brlt|description=Relative jump to line c if a < b|syntax=brlt a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bltal|description=Branch to line c if a < b and store next line number in ra|syntax=bltal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bltz|description=Branch to line b if a < 0|syntax=bltz a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=brltz|description=Relative branch to line b if a < 0|syntax=brltz a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bltzal|description=Branch to line b if a < 0 and store next line number in ra|syntax=bltzal a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bna|description=Branch to line d if abs(a - b) > max(c * max(abs(a), abs(b)), float.epsilon * 8)|syntax=bna a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
{{ICInstruction|instruction=brna|description=Relative branch to line d if abs(a - b) > max(c * max(abs(a), abs(b)), float.epsilon * 8)|syntax=brna a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
{{ICInstruction|instruction=bnaal|description=Branch to line d if abs(a - b) <= max(c * max(abs(a), abs(b)), float.epsilon * 8) and store next line number in ra|syntax=bnaal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
{{ICInstruction|instruction=bnan|description=Branch to line b if a is not a number (NaN)|syntax=bnan a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=brnan|description=Relative branch to line b if a is not a number (NaN)|syntax=brnan a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bnaz|description=Branch to line c if abs(a) > max (b * abs(a), float.epsilon * 8)|syntax=bnaz a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=brnaz|description=Relative branch to line c if abs(a) > max(b * abs(a), float.epsilon * 8)|syntax=brnaz a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bnazal|description=Branch to line c if abs(a) > max (b * abs(a), float.epsilon * 8) and store next line number in ra|syntax=bnazal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bne|description=Branch to line c if a != b|syntax=bne a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=brne|description=Relative branch to line c if a != b|syntax=brne a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bneal|description=Branch to line c if a != b and store next line number in ra|syntax=bneal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bnez|description=branch to line b if a != 0|syntax=bnez a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=brnez|description=Relative branch to line b if a != 0|syntax=brnez a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bnezal|description=Branch to line b if a != 0 and store next line number in ra|syntax=bnezal a(r?{{!}}num) b(r?{{!}}num)}}

IC10/instructions

2024-07-26T20:29:27Z

Thoth: document lbns negative value bug

<noinclude>
See [[IC10]] for the primary page for the IC10 instruction set. This page lists all available instructions
</noinclude>

== Utility ==

{{ICInstruction|instruction=alias|description=Labels register or device reference with name, device references also affect what shows on the screws on the IC base.|syntax=alias str r?{{!}}d?
|example=
{{ICCode|
alias dAutoHydro1 d0
alias vTemperature r0
}}}}
{{ICInstruction|instruction=define|description=Creates a label that will be replaced throughout the program with the provided value.|syntax=define str num
|example=
{{ICCode|
define ultimateAnswer 42
move r0 ultimateAnswer # Store 42 in register 0
}}}}
{{ICInstruction|instruction=hcf|description=Halt and catch fire|syntax=hcf}}
{{ICInstruction|instruction=sleep|description=Pauses execution on the IC for a seconds|syntax=sleep a(r?{{!}}num)}}
{{ICInstruction|instruction=yield|description=Pauses execution for 1 tick|syntax=yield}}

== Mathematical ==

{{ICInstruction|instruction=abs|description=Register = the absolute value of a|syntax=abs r? a(r?{{!}}num)
|example=
{{ICCode|
define negativeNumber -10
abs r0 negativeNumber # Compute the absolute value of -10 and store it in register 0
}}}}
{{ICInstruction|instruction=add|description=Register = a + b.|syntax=add r? a(r?{{!}}num) b(r?{{!}}num)
|example=
{{ICCode|add r0 r0 1 # increment r0 by one}}
{{ICCode|
define num1 10
define num2 20
add r0 num1 num2 # Add 10 and 20 and store the result in register 0
}}}}
{{ICInstruction|instruction=ceil|description=Register = smallest integer greater than a|syntax=ceil r? a(r?{{!}}num)
|example=
{{ICCode|
define floatNumber 10.3
ceil r0 floatNumber # Compute the ceiling of 10.3 and store it in register 0
}}}}
{{ICInstruction|instruction=div|description=Register = a / b|syntax=div r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=exp|description=exp(a) or e^a|syntax=exp r? a(r?{{!}}num)}}
{{ICInstruction|instruction=floor|description=Register = largest integer less than a|syntax=floor r? a(r?{{!}}num)}}
{{ICInstruction|instruction=log|description=base e log(a) or ln(a)|syntax=log r? a(r?{{!}}num)}}
{{ICInstruction|instruction=max|description=Register = max of a or b|syntax=max r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=min|description=Register = min of a or b|syntax=min r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=mod|description=Register = a mod b (note: NOT a % b)|syntax=mod r? a(r?{{!}}num) b(r?{{!}}num)
|example=
{{ICCode|
mod r0 10 20
# Expected: r0 = 10

mod r1 22 20
# Expected: r1 = 2

mod r2 22 -20
# Expected: r2 = 18

mod r2 22 -10
# Expected: r2 = 18
}}}}
{{ICInstruction|instruction=move|description=Register = provided num or register value.|syntax=move r? a(r?{{!}}num)
|example=
{{ICCode|move r0 42 # Store 42 in register 0}}}}
{{ICInstruction|instruction=mul|description=Register = a * b|syntax=mul r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=rand|description=Register = a random value x with 0 <= x < 1|syntax=rand r?}}
{{ICInstruction|instruction=round|description=Register = a rounded to nearest integer|syntax=round r? a(r?{{!}}num)}}
{{ICInstruction|instruction=sqrt|description=Register = square root of a|syntax=sqrt r? a(r?{{!}}num)}}
{{ICInstruction|instruction=sub|description=Register = a - b.|syntax=sub r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=trunc|description=Register = a with fractional part removed|syntax=trunc r? a(r?{{!}}num)}}

=== Mathematical / Trigonometric ===

{{ICInstruction|instruction=acos|description=Returns the angle (radians) whos cos is the specified value|syntax=acos r? a(r?{{!}}num)}}
{{ICInstruction|instruction=asin|description=Returns the angle (radians) whos sine is the specified value|syntax=asin r? a(r?{{!}}num)}}
{{ICInstruction|instruction=atan|description=Returns the angle (radians) whos tan is the specified value|syntax=atan r? a(r?{{!}}num)}}
{{ICInstruction|instruction=atan2|description=Returns the angle (radians) whose tangent is the quotient of two specified values: a (y) and b (x)|syntax=atan2 r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=cos|description=Returns the cosine of the specified angle (radians)|syntax=cos r? a(r?{{!}}num)}}
{{ICInstruction|instruction=sin|description=Returns the sine of the specified angle (radians)|syntax=sin r? a(r?{{!}}num)}}
{{ICInstruction|instruction=tan|description=Returns the tan of the specified angle (radians) |syntax=tan r? a(r?{{!}}num)}}

== Stack ==

{{ICInstruction|instruction=clr|description=Clears the stack memory for the provided device.|syntax=clr d?}}
{{ICInstruction|instruction=clrd|description=Seeks directly for the provided device id and clears the stack memory of that device|syntax=clrd id(r?{{!}}num)}}
{{ICInstruction|instruction=get|description=Using the provided device, attempts to read the stack value at the provided address, and places it in the register.|syntax=get r? d? address(r?{{!}}num)}}
{{ICInstruction|instruction=getd|description=Seeks directly for the provided device id, attempts to read the stack value at the provided address, and places it in the register.|syntax=getd r? id(r?{{!}}num) address(r?{{!}}num)}}
{{ICInstruction|instruction=peek|description=Register = the value at the top of the stack|syntax=peek r?}}
{{ICInstruction|instruction=poke|description=Stores the provided value at the provided address in the stack.|syntax=poke address(r?{{!}}num) value(r?{{!}}num)}}
{{ICInstruction|instruction=pop|description=Register = the value at the top of the stack and decrements sp|syntax=pop r?}}
{{ICInstruction|instruction=push|description=Pushes the value of a to the stack at sp and increments sp|syntax=push a(r?{{!}}num)}}
{{ICInstruction|instruction=put|description=Using the provided device, attempts to write the provided value to the stack at the provided address.|syntax=put d? address(r?{{!}}num) value(r?{{!}}num)}}
{{ICInstruction|instruction=putd|description=Seeks directly for the provided device id, attempts to write the provided value to the stack at the provided address.|syntax=putd id(r?{{!}}num) address(r?{{!}}num) value(r?{{!}}num)}}

== Slot/Logic ==

{{ICInstruction|instruction=l|description=Loads device LogicType to register by housing index value.|syntax=l r? d? logicType
|example=
Read from the device on d0 into register 0
{{ICCode|l r0 d0 Setting}}
Read the pressure from a sensor
{{ICCode|l r1 d5 Pressure}}
This also works with aliases. For example:
{{ICCode|
alias Sensor d0
l r0 Sensor Temperature
}}}}
{{ICInstruction|instruction=ld|description=Loads device LogicType to register by direct ID reference.|syntax=ld r? id(r?{{!}}num) logicType}}
{{ICInstruction|instruction=lr|description=Loads reagent of device's ReagentMode where a hash of the reagent type to check for. ReagentMode can be either Contents (0), Required (1), Recipe (2). Can use either the word, or the number.|syntax=lr r? d? reagentMode int}}
{{ICInstruction|instruction=ls|description=Loads slot LogicSlotType on device to register.|syntax=ls r? d? slotIndex logicSlotType
|example=
Read from the second slot of device on d0, stores 1 in r0 if it's occupied, 0 otherwise.
{{ICCode|ls r0 d0 2 Occupied}}
And here is the code to read the charge of an AIMeE:
{{ICCode|
alias robot d0
alias charge r10
ls charge robot 0 Charge
}}}}
{{ICInstruction|instruction=s|description=Stores register value to LogicType on device by housing index value.|syntax=s d? logicType r?
|example=
{{ICCode|
s d0 Setting r0
}}}}
{{ICInstruction|instruction=sd|description=Stores register value to LogicType on device by direct ID reference.|syntax=sd id(r?{{!}}num) logicType r?}}
{{ICInstruction|instruction=ss|description=Stores register value to device stored in a slot LogicSlotType on device.|syntax=ss d? slotIndex logicSlotType r?}}
{{ICInstruction|instruction=rmap|description=Given a reagent hash, store the corresponding prefab hash that the device expects to fulfill the reagent requirement. For example, on an autolathe, the hash for Iron will store the hash for ItemIronIngot.|syntax=rmap r? d? reagentHash(r?{{!}}num)}}

=== Slot/Logic / Batched ===

{{ICInstruction|instruction=lb|description=Loads LogicType from all output network devices with provided type hash using the provide batch mode. Average (0), Sum (1), Minimum (2), Maximum (3). Can use either the word, or the number.|syntax=lb r? deviceHash logicType batchMode
|example=
{{ICCode|lb r0 HASH("StructureWallLight") On Sum}}}}
{{ICInstruction|instruction=lbn|description=Loads LogicType from all output network devices with provided type and name hashes using the provide batch mode. Average (0), Sum (1), Minimum (2), Maximum (3). Can use either the word, or the number.|syntax=lbn r? deviceHash nameHash logicType batchMode}}
{{ICInstruction|instruction=lbns|description=Loads LogicSlotType from slotIndex from all output network devices with provided type and name hashes using the provide batch mode. Average (0), Sum (1), Minimum (2), Maximum (3). Can use either the word, or the number. As of update 0.2.5087.23112 this has a bug where if all the values are <0 the result is zero. This can be a problem when checking for HydroponicsDevice.0.Seeding <0. |syntax=lbns r? deviceHash nameHash slotIndex logicSlotType batchMode}}
{{ICInstruction|instruction=lbs|description=Loads LogicSlotType from slotIndex from all output network devices with provided type hash using the provide batch mode. Average (0), Sum (1), Minimum (2), Maximum (3). Can use either the word, or the number.|syntax=lbs r? deviceHash slotIndex logicSlotType batchMode}}
{{ICInstruction|instruction=sb|description=Stores register value to LogicType on all output network devices with provided type hash.|syntax=sb deviceHash logicType r?
|example=
{{ICCode|sb HASH("StructureWallLight") On 1}}}}
{{ICInstruction|instruction=sbn|description=Stores register value to LogicType on all output network devices with provided type hash and name.|syntax=sbn deviceHash nameHash logicType r?}}
{{ICInstruction|instruction=sbs|description=Stores register value to LogicSlotType on all output network devices with provided type hash in the provided slot.|syntax=sbs deviceHash slotIndex logicSlotType r?}}

== Bitwise ==

{{ICInstruction|instruction=and|description=Performs a bitwise logical AND operation on the binary representation of two values. Each bit of the result is determined by evaluating the corresponding bits of the input values. If both bits are 1, the resulting bit is set to 1. Otherwise the resulting bit is set to 0.|syntax=and r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=nor|description=Performs a bitwise logical NOR (NOT OR) operation on the binary representation of two values. Each bit of the result is determined by evaluating the corresponding bits of the input values. If both bits are 0, the resulting bit is set to 1. Otherwise, if at least one bit is 1, the resulting bit is set to 0.|syntax=nor r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=not|description=Performs a bitwise logical NOT operation flipping each bit of the input value, resulting in a binary complement. If a bit is 1, it becomes 0, and if a bit is 0, it becomes 1.|syntax=not r? a(r?{{!}}num)
|note=
This is a bitwise operation, the NOT of 1 => -2, etc. You may want to use seqz instead}}
{{ICInstruction|instruction=or|description=Performs a bitwise logical OR operation on the binary representation of two values. Each bit of the result is determined by evaluating the corresponding bits of the input values. If either bit is 1, the resulting bit is set to 1. If both bits are 0, the resulting bit is set to 0.|syntax=or r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=sla|description=Performs a bitwise arithmetic left shift operation on the binary representation of a value. It shifts the bits to the left and fills the vacated rightmost bits with a copy of the sign bit (the most significant bit).|syntax=sla r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=sll|description=Performs a bitwise logical left shift operation on the binary representation of a value. It shifts the bits to the left and fills the vacated rightmost bits with zeros.|syntax=sll r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=sra|description=Performs a bitwise arithmetic right shift operation on the binary representation of a value. It shifts the bits to the right and fills the vacated leftmost bits with a copy of the sign bit (the most significant bit).|syntax=sra r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=srl|description=Performs a bitwise logical right shift operation on the binary representation of a value. It shifts the bits to the right and fills the vacated leftmost bits with zeros|syntax=srl r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=xor|description=Performs a bitwise logical XOR (exclusive OR) operation on the binary representation of two values. Each bit of the result is determined by evaluating the corresponding bits of the input values. If the bits are different (one bit is 0 and the other is 1), the resulting bit is set to 1. If the bits are the same (both 0 or both 1), the resulting bit is set to 0.|syntax=xor r? a(r?{{!}}num) b(r?{{!}}num)}}

== Comparison ==

{{ICInstruction|instruction=select|description=Register = b if a is non-zero, otherwise c|syntax=select r? a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)
|example=
{{ICCode|
select r1 r0 10 100
}}
|note=
This operation can be used as a simple ternary condition}}

=== Comparison / Device Pin ===

{{ICInstruction|instruction=sdns|description=Register = 1 if device is not set, otherwise 0|syntax=sdns r? d?}}
{{ICInstruction|instruction=sdse|description=Register = 1 if device is set, otherwise 0.|syntax=sdse r? d?}}

=== Comparison / Value ===

{{ICInstruction|instruction=sap|description=Register = 1 if abs(a - b) <= max(c * max(abs(a), abs(b)), float.epsilon * 8), otherwise 0|syntax=sap r? a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=sapz|description=Register = 1 if abs(a) <= max(b * abs(a), float.epsilon * 8), otherwise 0|syntax=sapz r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=seq|description=Register = 1 if a == b, otherwise 0|syntax=seq r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=seqz|description=Register = 1 if a == 0, otherwise 0|syntax=seqz r? a(r?{{!}}num)}}
{{ICInstruction|instruction=sge|description=Register = 1 if a >= b, otherwise 0|syntax=sge r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=sgez|description=Register = 1 if a >= 0, otherwise 0|syntax=sgez r? a(r?{{!}}num)}}
{{ICInstruction|instruction=sgt|description=Register = 1 if a > b, otherwise 0|syntax=sgt r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=sgtz|description=Register = 1 if a > 0, otherwise 0|syntax=sgtz r? a(r?{{!}}num)}}
{{ICInstruction|instruction=sle|description=Register = 1 if a <= b, otherwise 0|syntax=sle r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=slez|description=Register = 1 if a <= 0, otherwise 0|syntax=slez r? a(r?{{!}}num)}}
{{ICInstruction|instruction=slt|description=Register = 1 if a < b, otherwise 0|syntax=slt r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=sltz|description=Register = 1 if a < 0, otherwise 0|syntax=sltz r? a(r?{{!}}num)}}
{{ICInstruction|instruction=sna|description=Register = 1 if abs(a - b) > max(c * max(abs(a), abs(b)), float.epsilon * 8), otherwise 0|syntax=sna r? a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=snan|description=Register = 1 if a is NaN, otherwise 0|syntax=snan r? a(r?{{!}}num)}}
{{ICInstruction|instruction=snanz|description=Register = 0 if a is NaN, otherwise 1|syntax=snanz r? a(r?{{!}}num)}}
{{ICInstruction|instruction=snaz|description=Register = 1 if abs(a) > max(b * abs(a), float.epsilon), otherwise 0|syntax=snaz r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=sne|description=Register = 1 if a != b, otherwise 0|syntax=sne r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=snez|description=Register = 1 if a != 0, otherwise 0|syntax=snez r? a(r?{{!}}num)}}

== Branching ==

{{ICInstruction|instruction=j|description=Jump execution to line a|syntax=j int
|example=
{{ICCode|j 0 # jump line 0}}
{{ICCode|
j label # jump to a label

label:
# your code here
}}}}
{{ICInstruction|instruction=jal|description=Jump execution to line a and store next line number in ra|syntax=jal int
|example=
jal provides a way to do function calls in IC10 mips

{{ICCode|
move r0 1000
move r1 0
start:
jal average
s db Setting r0
yield
j start

average:
add r0 r0 r1
div r0 r0 2
j ra # jump back
}}}}
{{ICInstruction|instruction=jr|description=Relative jump to line a|syntax=jr int}}

=== Branching / Device Pin ===

{{ICInstruction|instruction=bdns|description=Branch to line a if device d isn't set|syntax=bdns d? a(r?{{!}}num)}}
{{ICInstruction|instruction=bdnsal|description=Jump execution to line a and store next line number if device is not set|syntax=bdnsal d? a(r?{{!}}num)}}
{{ICInstruction|instruction=bdse|description=Branch to line a if device d is set|syntax=bdse d? a(r?{{!}}num)}}
{{ICInstruction|instruction=bdseal|description=Jump execution to line a and store next line number if device is set|syntax=bdseal d? a(r?{{!}}num)
|example=
{{ICCode|
#Store line number and jump to line 32 if d0 is assigned.
bdseal d0 32
}}
{{ICCode|
#Store line in ra and jump to label HarvestCrop if device d0 is assigned.
bdseal d0 HarvestCrop
}}}}
{{ICInstruction|instruction=brdns|description=Relative jump to line a if device is not set|syntax=brdns d? a(r?{{!}}num)}}
{{ICInstruction|instruction=brdse|description=Relative jump to line a if device is set|syntax=brdse d? a(r?{{!}}num)}}

=== Branching / Comparison ===

{{ICInstruction|instruction=bap|description=Branch to line d if abs(a - b) <= max(c * max(abs(a), abs(b)), float.epsilon * 8)|syntax=bap a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
{{ICInstruction|instruction=brap|description=Relative branch to line d if abs(a - b) <= max(c * max(abs(a), abs(b)), float.epsilon * 8)|syntax=brap a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
{{ICInstruction|instruction=bapal|description=Branch to line c if a != b and store next line number in ra|syntax=bapal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
{{ICInstruction|instruction=bapz|description=Branch to line c if abs(a) <= max(b * abs(a), float.epsilon * 8)|syntax=bapz a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=brapz|description=Relative branch to line c if abs(a) <= max(b * abs(a), float.epsilon * 8)|syntax=brapz a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bapzal|description=Branch to line c if abs(a) <= max(b * abs(a), float.epsilon * 8) and store next line number in ra|syntax=bapzal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=beq|description=Branch to line c if a == b|syntax=beq a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=breq|description=Relative branch to line c if a == b|syntax=breq a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=beqal|description=Branch to line c if a == b and store next line number in ra|syntax=beqal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=beqz|description=Branch to line b if a == 0|syntax=beqz a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=breqz|description=Relative branch to line b if a == 0|syntax=breqz a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=beqzal|description=Branch to line b if a == 0 and store next line number in ra|syntax=beqzal a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bge|description=Branch to line c if a >= b|syntax=bge a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=brge|description=Relative jump to line c if a >= b|syntax=brge a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bgeal|description=Branch to line c if a >= b and store next line number in ra|syntax=bgeal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bgez|description=Branch to line b if a >= 0|syntax=bgez a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=brgez|description=Relative branch to line b if a >= 0|syntax=brgez a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bgezal|description=Branch to line b if a >= 0 and store next line number in ra|syntax=bgezal a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bgt|description=Branch to line c if a > b|syntax=bgt a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)
|example=
An example of a '''Schmitt''' trigger, turning on a device if the temperature is too low, and turning it off if it's too high and finally
doing nothing if the temperature is within the desired range.
{{ICCode|
alias sensor d0
alias device d1

define mintemp 293.15
define maxtemp 298.15

start:
yield
l r0 sensor Temperature
# If the temperature < mintemp, turn on the device
blt r0 mintemp turnOn
# If the temperature > maxtemp, turn off the device
bgt r0 maxtemp turnOff
j start

turnOn:
s device On 1
j start
turnOff:
s device On 0
j start
}}}}
{{ICInstruction|instruction=brgt|description=relative jump to line c if a > b|syntax=brgt a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bgtal|description=Branch to line c if a > b and store next line number in ra|syntax=bgtal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bgtz|description=Branch to line b if a > 0|syntax=bgtz a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=brgtz|description=Relative branch to line b if a > 0|syntax=brgtz a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bgtzal|description=Branch to line b if a > 0 and store next line number in ra|syntax=bgtzal a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=ble|description=Branch to line c if a <= b|syntax=ble a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=brle|description=Relative jump to line c if a <= b|syntax=brle a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bleal|description=Branch to line c if a <= b and store next line number in ra|syntax=bleal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=blez|description=Branch to line b if a <= 0|syntax=blez a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=brlez|description=Relative branch to line b if a <= 0|syntax=brlez a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=blezal|description=Branch to line b if a <= 0 and store next line number in ra|syntax=blezal a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=blt|description=Branch to line c if a < b|syntax=blt a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)
|example=
An example of a '''Schmitt''' trigger, turning on a device if the temperature is too low, and turning it off if it's too high and finally
doing nothing if the temperature is within the desired range.
{{ICCode|
alias sensor d0
alias device d1

define mintemp 293.15
define maxtemp 298.15

start:
yield
l r0 sensor Temperature
# If the temperature < mintemp, turn on the device
blt r0 mintemp turnOn
# If the temperature > maxtemp, turn off the device
bgt r0 maxtemp turnOff
j start

turnOn:
s device On 1
j start
turnOff:
s device On 0
j start
}}}}
{{ICInstruction|instruction=brlt|description=Relative jump to line c if a < b|syntax=brlt a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bltal|description=Branch to line c if a < b and store next line number in ra|syntax=bltal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bltz|description=Branch to line b if a < 0|syntax=bltz a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=brltz|description=Relative branch to line b if a < 0|syntax=brltz a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bltzal|description=Branch to line b if a < 0 and store next line number in ra|syntax=bltzal a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bna|description=Branch to line d if abs(a - b) > max(c * max(abs(a), abs(b)), float.epsilon * 8)|syntax=bna a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
{{ICInstruction|instruction=brna|description=Relative branch to line d if abs(a - b) > max(c * max(abs(a), abs(b)), float.epsilon * 8)|syntax=brna a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
{{ICInstruction|instruction=bnaal|description=Branch to line d if abs(a - b) <= max(c * max(abs(a), abs(b)), float.epsilon * 8) and store next line number in ra|syntax=bnaal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
{{ICInstruction|instruction=bnan|description=Branch to line b if a is not a number (NaN)|syntax=bnan a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=brnan|description=Relative branch to line b if a is not a number (NaN)|syntax=brnan a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bnaz|description=Branch to line c if abs(a) > max (b * abs(a), float.epsilon * 8)|syntax=bnaz a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=brnaz|description=Relative branch to line c if abs(a) > max(b * abs(a), float.epsilon * 8)|syntax=brnaz a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bnazal|description=Branch to line c if abs(a) > max (b * abs(a), float.epsilon * 8) and store next line number in ra|syntax=bnazal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bne|description=Branch to line c if a != b|syntax=bne a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=brne|description=Relative branch to line c if a != b|syntax=brne a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bneal|description=Branch to line c if a != b and store next line number in ra|syntax=bneal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bnez|description=branch to line b if a != 0|syntax=bnez a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=brnez|description=Relative branch to line b if a != 0|syntax=brnez a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bnezal|description=Branch to line b if a != 0 and store next line number in ra|syntax=bnezal a(r?{{!}}num) b(r?{{!}}num)}}

IC10

2024-07-25T15:45:41Z

Thoth: add short narrative about batch insructions and ReferenceIds

[[Category:IC10 Programming]]
=Scripting language for IC10 housings / chips=
MIPS is [[Stationeers]]' inspiration for the in-game scripting language called IC10. It runs on [[Integrated Circuit (IC10)|IC10 chips]] crafted at the [[Electronics Printer]].

==Registers==
Internal registers '''r?''': The IC contains 16 CPU registers, numbered '''r0''' to '''r15'''. From now on referred to as '''r?'''.

Device registers '''d? logicType''': Device registers are written to and from the IC. A device register is numbered '''d0''' to '''d5''' (select via screw), or '''db''' (connected device). From now on referred to as '''d?'''.

=== Logic and algorithmic with '''Internal registers''' ===
All calculations are exclusively performed to and from '''r?''' registers, or generally more understood as variables in programming. You can use aliases to give convenient names with the <code>alias string r?|d?</code>command (see below).

Internal registers can be manipulated in various ways.
* Write constant values <code>move r? (r?|num)</code>: Example: <code>move r0 2</code> sets r0 to the number 2.
* Calculate: Calculations are done to- and from these registers, like <code>add r? a(r?|num) b(r?|num)</code>. Example: <code>add r1 r0 3</code> adds 3 to r0, and writes to r1.

Note, for any kind of if statements or loop behaviours, knowing about labels, branching, and jumps is essential knowledge. See below.

=== IO to '''Device registers''' ===
Acronym '''d?''' stands for device, where ? is a number corresponding to the screw device selector on the socket.
You can also read/write to the device where the IC is planted in using device '''db'''.

Generally, there are up to 6 devices which can be set using the screwdriver '''d0''' to '''d5'''. A special device register '''db''' is the device wherever the IC is mounted upon. Very convenient for atmospheric devices where no separate IC socket is required.

Note, the IC is completely unaware where d? is actually connected to. So if you get a logicType error, check d? number, or check if the screw has been set opn the socket. An alias is only convenient to convey what is expected to be set on the d? screw, it does not actually set or program the screq.

* Read from device (load) <code>l r? d? logicType</code>: Reads logicType, like Pressure from a [[Sensors|gas sensor]], from device d? to register r?. Values can be read from connected devices and put into the register using the '''l''' (load) command. For example, if you want to load the state of a door. <br> Example: <code>l r0 Door Open</code> reads the 'Open' field of an object named 'Door', that would be connected to the IC housing of the chip.
* Write to a device (set) <code>s d? logicType r?</code>: Write a value from a register back to a device using the command <code>s d? logicType r?</code>. For example, if d0 is set to a door using the screwdriver, <code>s d0 Open 0</code> sets the 'Open' status of the d0 (a door) to 0, effectively closing the door.

=== batch IO to - '''Device registers''' ===
'''Batch writing''' needs to be done to a specific '''deviceHash''' instead of d?. Is unique per device type, which you can find in the [[Stationpedia]] entries.
* <code>lb r? deviceHash logicType batchMode</code>
* <code>sb deviceHash logicType r?</code>
Additionally, using the following batch commands, a '''nameHash''' can be provided to only modify devices with a certain name.
* <code>lbn r? deviceHash nameHash logicType batchMode </code>
* <code>sbn deviceHash nameHash logicType r?</code>

'''batchMode''' is a parameter equal to 0, 1, 2, or 3. These are also defined as the constants '''Average''', '''Sum''', '''Minimum''', and '''Maximum''' respectively. The word or number can be used.

Combining one of these functions with the <code>HASH()</code> function can be advantageous:

<code>lbn r0 HASH("StructureGasSensor") HASH("Sensor 1") Temperature Average</code>

This code will load the average temperature of all gas sensors on the network named "Sensor 1" onto register '''r0'''

If the batch read (lb/lbn) is done on a network without any matching devices the results will be as specified in the table:
{| class="wikitable"
|+ Batch read with no devices
|-
! Batch Mode !! Result
|-
| Average (0) || nan
|-
| Sum (1) || 0
|-
| Minimum (2) || 0
|-
| Maximum (3) || ninf
|}

=== Examples ===

Here are some examples demonstrating all three operations:

<code>move r0 10</code><br>Sets register '''r0''' to the value 10

<code>move r0 r1</code><br>Copies the value of register '''r1''' to register '''r0'''

<code>l r0 d0 Temperature</code><br>Reads the Temperature parameter from device '''d0''' and places the value in register '''r0'''.
Note: not all devices have a Temperature parameter, check the in-game stationpedia.

To set a device specific value (like '''On'''), you can write into this value.

<code>s d0 On r0</code><br>Writes the value from register '''r0''' out to '''On''' parameter of device '''d0'''. In this example the device will be turned On, if valve of register r0 equals 1, otherwise (register r0 equals 0) it will turned off. See section [[IC10#Device_Variables|Device Variables]].

It's recommended to use labels (like: ''someVariable'') instead of a direct reference to the register. See '''alias''' in section [[IC10#Instructions|Instructions]].

=== Special registers ===
There are two more registers. One called '''ra''' (return address) and one called '''sp''' (stack pointer). The '''ra''' is used by certain jump and branching instructions (those ending with '''-al''') to remember which line in the script it should return to. The '''sp''' tracks the next index within the stack (a memory that can store up to 512 values) to be pushed (written) to or popped (read) from. Neither '''ra''' or '''sp''' is protected, their values can be changed by instructions like any other register.

==Stack Memory==
;push r?: adds the value '''r?''' and increments the '''sp''' by 1.
;pop r?: loads the value in the stack memory at index <code>sp-1</code> into register '''r?''' and decrements the '''sp''' by 1.
;peek r?: loads the value in the stack memory at index <code>sp-1</code> into register '''r?'''.
;get r? d? address(r?|num): loads the value in the stack memory at index <code>address</code> on provided device into register '''r?'''.
;getd r? id(r?|num) address(r?|num): loads the value in the stack memory at index <code>address</code> on provided device id into register '''r?'''.
;put d? address(r?|num) value(r?|num): adds the value to the stack memory off the provided device at index <code>address</code>.
;putd id(r?|num) address(r?|num) value(r?|num) : adds the value to the stack memory off the provided device id at index <code>address</code>.

As mentioned previously, '''sp''' can be both written to and read from any time. When reading ('''peek''' or '''pop'''), '''sp''' must be between 1 and 512, inclusive. While writing ('''push'''), '''sp''' must be between 0 and 511, inclusive.

Stack memory is persistent on logic chips. This means that if you have a logic chip and push values to the stack, the code that pushes those values can be removed and the stack will retain those values.

Note that this does not carry over to any other logic chips which receive the program of the original; They will need to have their stack memories programmed individually.

'''Stack Traversing'''

Traversing the stack can be done similarly to how an array would be traversed in some other languages:
{{ICCode|
#this will traverse indices {min value} through {max value}-1
move sp {min value}
loop:
add sp sp 1
peek r0

#do something here with your stack values (loaded into r0)

blt sp {max value} loop

#continue on
}}

Alternatively, you can use the pop function's decrementing to make a more efficient loop:
{{ICCode|
move sp {max value}
add sp sp 1
loop:
pop r0

#do something here with your stack values (loaded into r0)

bgt sp {min value} loop

#continue on

}}

==Device Ports==
ICs can interact with up to 6 other devices via d0 - d5, as well as the device it's attached to via db. To change or set a device, use a screwdriver and adjust the device in the IC housing. You can read or set any of the device's properties, so it is possible to do things like read the pressure or oxygen content of a room on the same Device port.

Additionally, is possible to set other IC housings as devices, allowing you to create programs that run across multiple ICs together. For example, an Gas Mixing IC could check the ''' Setting''' field of a Atmosphere Sensor IC and act based on the value of the sensor chip.

The '''l''' (load) or '''s''' (set) instructions you have to read or set these values to your device. Examples:
{{ICCode|
#Reads the 'Temperature' from an atmosphere sensor
# at device port 'd0' into register 'r0'.
l r0 d0 Temperature
}}
{{ICCode|
# Writes the value of the register 'r0' to the
# device on port 'd1' into the variable 'Setting'.
s d1 Setting r0
}}

==Labels==
Labels are used to make it easier to jump between lines in the script. The label will have a numerical value that is the same as its line number. Even though it's possible to use a labels value for calculations, doing so is a bad idea since any changes to the code can change the line numbers of the labels.
{{ICCode|
main: # define a jump mark with label 'main'
j main # jumps back to 'main'
}}
==Constants==
Instead of using a register to store a fixed value, a constant can be made. Using this name will refer to the assigned value. With the help of Constants you can save register places.
{{ICCode|
# defines a Constant with name 'pi'
# and set its value to 3.14159
define pi 3.14159
}}

You can use these constants like any other variables (see: alias in section [[IC10#Instructions|Instructions]]). Example:
{{ICCode|
# set the value of register 'r0' to the value of constant named 'pi'.
move r0 pi
}}

==Indirect referencing==
This is a way of accessing a register by using another register as a pointer. Adding an additional r in front of the register turns on this behaviour. The value stored in the register being used as the pointer must be between 0 to 15, this will then point to a register from r0 to r15, higher or lower values will cause an error.
{{ICCode|
move r0 5 # stores the value 5 in r0
move rr0 10
# is now the same as 'move r5 10'
# since r0 has the value 5, rr0 points at the register r5
}}

Additional r's can be added to do indirect referencing multiple times in a row.
{{ICCode|
move r1 2
move r2 3
move rrr1 4
# is now the same as 'move r3 4'
# since r1 points at r2 which points at r3
}}

This also works with devices
{{ICCode|
move r0 2 # stores the value 2 in r0
s dr0 On 1
# is now the same as 's d2 On 1'
# r0 has the value 2 so dr0 points at d2
}}

==Network Referencing / Channels==

All cable networks have 8 Channels which can have data loaded from/stored to via a device and connection reference. Connections for each supported device are listed in the stationpedia. All 'connections' a device can make are a connection (pipe, chute, cable), but only cable networks have channels.

The 8 channels (Channel0 to Channel7) are however volatile, in that data is destroyed if any part of the cable network is changed, removed, or added to, and also whenever the world is exited. All these channels default to NaN. Strictly speaking, they default to what we would call "quiet NaN", in that its not an error it simply means its not a number yet. Recommend you use these channels for reading and writing between networks, rather than as a data store. This effectively means an IC can read all the networks for all devices to connected to it, so not just their own local network, but any networks any device they can reference is connected to.
{{ICCode|
# d0 is device zero, and the :0 refers
# to that device's 0 connection
l r0 d0:0 Channel0}}

For example: on an IC Housing, the 0 connection is the data port and 1 is power, so you could write out r0 to Channel0 of the power network of the Housing using <code>s db:1 Channel0 r0</code>

==Comments==
Comments can be placed using a '''#''' symbol. All comments are ignored by the game when it reads commands. Below is an example of valid code with two comments.
{{ICCode|
alias MyAlias r0 # Text after the hash tag will be ignored to the end of the line.
# You can also write comments on their own lines, like this.
}}

==Debugging advices==
The value stored in a register or variable can easily be displayed by writing it to the Setting parameter of the IC housing. This has no side effects. To see the value, just stand close to the IC housing and look directly at the housing.<br>
<code>s db Setting r0</code>. # sets/writes the value of register '''r0''' into the parameter '''Setting''' of the IC Housing('''db''')

To check if a certain block of code is executed, use the above trick but with a random number that you choose, like the line number.<br> This example will display the number 137 on the IC housing.<br>
<code>s db Setting 137</code> # sets/writes the number 137 into the parameter '''Setting''' of the IC Housing('''db''')

Always use unique names for labels. When a label is named after a IC10 keyword like "Temperature:" or "Setting:" the original meaning of the keyword is overwritten, so when an instruction tries to use it an error will occur.

A [[Cartridge#Configuration|configuration cartridge]] installed in a [[Handheld_Tablet|tablet]] can be used to see all available values and configuration parameter for all devices you focus on.

==Learning IC10==
IC10 can be difficult to get started with. So here is a list of instructions that are useful for beginners. These can be used to write many different scripts.

General:
* <code>alias</code> make the script easier to read by assigning a name to a register or device, example: <code>alias rTemperature r15</code>
* <code>label:</code> where "label" can be replaced with almost any word, jump and branch instructions can use these in place of line numbers, example: <code>start:</code>
* <code>yield</code> pause for 1-tick and then resume, if not used the script will automatically pause for 1-tick after 128 lines

<br>Jumps:
*<code>j someLabelName</code> jump to line with '''someLabelName'''
*<code>jal someLabelName</code> stores the next line number into the register ra (return address) and then jump to '''someLabelName'''
*<code>j ra</code> jump to register ra (return address)

<br>Branching (jump-if):<br>
<code>beq a(r?|num) b(r?|num) c(r?|num)</code> if '''a''' is equal to '''b''' goto '''c''' (label or linenumber) <br>
<code>bne a(r?|num) b(r?|num) c(r?|num)</code> if '''a''' not-equal '''b''' goto '''c''' (label or linenumber) <br>
<code>bgt a(r?|num) b(r?|num) c(r?|num)</code> if '''a''' greater than '''b''' goto '''c''' (label or linenumber) <br>
<code>blt a(r?|num) b(r?|num) c(r?|num)</code> if '''a''' less than '''b''' goto '''c''' (label or linenumber) <br>
The suffix -al can be added to each of these (example: beqal) to save the '''next''' line number into the "return address" register. this is called using <code>j ra</code>

<br>Device interactions:
<pre>
l (load)
lb (load batch, requires one of the following: 0(Average) / 1(Sum) / 2(Minimum) / 3(Maximum))
ls (load slot)
s (store)
sb (store batch)
</pre>

<br>Logic and Math:
<pre>
seqz (common NOT-gate: turns 0 into 1, and all other values into 0)
move
add (addition)
sub (subtraction)
mul (multiplication)
div (division)
</pre>

<br>Common device variables:
<pre>
On (1 is on, 0 is off)
Open (1 is open, 0 is closed)
Setting (meaning varies between devices, example: a LED display(console) will show this value)
Activate (1 usually means running, example: a Daylight sensor is 1 when the sun shines on it)
Temperature (in Kelvin, Celsius - 273.15)
Pressure (in kPa)
</pre>

<br>Notes:
<br>-All instructions and variables can be seen in-game in the IC editor window by clicking the "f", "x" and "s(x)" buttons on the top right.
<br>-The stationpedia is the best source to see which variables are available to each device.
<br>-Most scripts are loops, they end with a jump instruction that leads back up to the start. Otherwise they will just run once and then stop.

Two practice scripts:
<br>Automatic Night Light: Load "Activate" from a Daylight sensor, flip the value with a NOT-gate, store the value to the "On" variable of one or more lights.
<br>Automatic Wall Cooler: Read "Temperature" from a Gas Sensor. Branch if the value is greater than X, turn on the cooler. Branch if the value is less than Y, turn off the cooler. (Wall coolers need a minimum of 12.5 kPa pressure in the connected pipe)

----

== Accessing devices via batch or ReferenceId ==

The IC housing has 6 pins you can use to configure the devices it
uses. This provides flexibility to let the installer configure which
devices will be controlled by the IC.

Alternatives for accessing devices include the batch load/store and
the ReferenceId load/store instructions.

<pre>
# get the average charge ratio across station batteries
lb r0 HASH("StructureBattery") Ratio Average
</pre>

<pre>
# get the ReferenceId for the sorter named "Sorter Corn"
lbn r1 HASH("StructureLogicSorter") HASH("Sorter Corn") ReferenceId Maximum
ble r1 ninf ra
#use the ReferenceId to set that sorter's mode.
sd r1 Mode 1
</pre>

Using the 6 configuration pins makes it easy to write reusable MIPS
scripts where the installer uses the pins to select the devices that
will be managed.

Using batch-name instructions frees you from the hassle of adjusting
the pins, but requires you to name the devices via the [Labeler]. It
can also allow you to control more than 6 devices.

=== Batch instructions ===

lb, lbs, sb, sbs
lbn, lbns, sbn (missing: sbns)

=== foreign device instructions ===

clrd, getd, putd,
ld, sd, (no slot access yet)

=Instructions=
----

See [[IC10/instructions]]

{{:IC10/instructions}}

[https://www.cs.tufts.edu/comp/140/lectures/Day_3/mips_summary.pdf Other examples]

== Conditional functions cheatsheet ==
{| class="wikitable"
|-
! suffix !! description !! branch to line !! branch and store return address !! relative jump to line !! set register
|-
| prefix: || || b- || b-al || br- || s-
|-
| || unconditional || j || jal || jr ||
|-
| -eq || if a == b || beq || beqal || breq || seq
|-
| -eqz || if a == 0 || beqz || beqzal || breqz || seqz
|-
| -ge || if a >= b || bge || bgeal || brge || sge
|-
| -gez || if a >= 0 || bgez || bgezal || brgez || sgez
|-
| -gt || if a > b || bgt || bgtal || brgt || sgt
|-
| -gtz || if a > 0 || bgtz || bgtzal || brgtz || sgtz
|-
| -le || if a <= b || ble || bleal || brle || sle
|-
| -lez || if a <= 0 || blez || blezal || brlez || slez
|-
| -lt || if a < b || blt || bltal || brlt || slt
|-
| -ltz || if a < 0 || bltz || bltzal || brltz || sltz
|-
| -ne || if a != b || bne || bneal || brne || sne
|-
| -nez || if a != 0 || bnez || bnezal || brnez || snez
|-
| -nan || if a == NaN || bnan || || brnan || snan
|-
| -nanz || if a != NaN || || || || snanz
|-
| -dns || if device d is not set || bdns || bdnsal || brdns || sdns
|-
| -dse || if device d is set || bdse || bdseal || brdse || sdse
|-
| -ap || if a approximately equals b || bap || bapal || brap || sap
|-
| -apz || if a approximately equals 0 || bapz || bapzal || brapz || sapz
|-
| -na || if a not approximately equals b || bna || bnaal || brna || sna
|-
| -naz || if a not approximately equals 0 || bnaz || bnazal || brnaz || snaz
|}

All <code>b-</code> commands require target line as last argument, all <code>s-</code> commands require register to store result as first argument. All <code>br-</code> commands require number to jump relatively as last argument. e.g. <code>breq a b 3</code> means if a=b then jump to 3 lines after.

All approximate functions require additional argument denoting how close two numbers need to be considered equal. E.g.: <code>sap r0 100 101 0.01</code> will consider 100 and 101 almost equal (not more than 1%=0.01 different) and will set r0 to 1. The exact formula is <code>if abs(a - b) <= max(c * max(abs(a), abs(b)), float.epsilon * 8)</code> for <code>-ap</code> and is similar for other approximate functions.

https://en.wikipedia.org/wiki/Machine_epsilon
<br/>
'''Example:'''
FLT_EPSILON = 2^(−23) ≈ 1.19e−07; <span style="color:blue;">float (32 bit)</span>
DBL_EPSILON = 2^(−52) ≈ 2.20e−16; <span style="color:#4c9700;">double (64 bit)</span>
<br/>
<code>if abs(100 - 101) <= max(0.01 * max(abs(100), abs(101)), float.epsilon * 8)</code>
<code>if abs(-1) <= max(0.01 * 101), float.epsilon * 8)</code>
<code>if 1 <= max(0.01 * 101, float.epsilon * 8)</code>
<br/>
if 1 <= max(1.01, FLT_EPSILON * 8)
if 1 <= max(1.01, DBL_EPSILON * 8)
<br/>
<span style="color:blue;">if 1 <= max(1.01, 1.19e−07 * 8)</span>
<span style="color:#4c9700;">if 1 <= max(1.01, 2.20e−16 * 8)</span>
<br/>
<span style="color:blue;">if 1 <= max(1.01, 0.000000952)</span>
<span style="color:#4c9700;">if 1 <= max(1.01, 0.00000000000000176)</span>
<br/>
<span style="color:blue;">if 1 <= 1.01 TRUE 1</span>
<span style="color:#4c9700;">if 1 <= 1.01 TRUE 1</span>

==Device Variables==
-----

<div id="Activate"></div>
;Activate
:1 if device is activated (usually means running), otherwise 0
:<code>l r0 d0 Activate # sets r0 to 1 if on or 0 if off</code>

<div id="AirRelease"></div>
;AirRelease
<div id="Charge"></div>
;Charge
: The current charge the device has.
<div id="CLearMemory"></div>
;ClearMemory
: When set to 1, clears the counter memory (e.g. ExportCount). Will set itself back to 0 when triggered.
<div id="Color"></div>
;Color
: <div style="display: inline-block; vertical-align: top; height: 20px; width: 20px; border: 1px solid black; margin-right: 5px; background-color:#212AA5;"></div> 0 (or lower) = Blue
: <div style="display: inline-block; vertical-align: top; height: 20px; width: 20px; border: 1px solid black; margin-right: 5px; background-color:#7B7B7B;"></div> 1 = Grey
: <div style="display: inline-block; vertical-align: top; height: 20px; width: 20px; border: 1px solid black; margin-right: 5px; background-color:#3F9B39;"></div> 2 = Green
: <div style="display: inline-block; vertical-align: top; height: 20px; width: 20px; border: 1px solid black; margin-right: 5px; background-color:#FF662B;"></div> 3 = Orange
: <div style="display: inline-block; vertical-align: top; height: 20px; width: 20px; border: 1px solid black; margin-right: 5px; background-color:#E70200;"></div> 4 = Red
: <div style="display: inline-block; vertical-align: top; height: 20px; width: 20px; border: 1px solid black; margin-right: 5px; background-color:#FFBC1B;"></div> 5 = Yellow
: <div style="display: inline-block; vertical-align: top; height: 20px; width: 20px; border: 1px solid black; margin-right: 5px; background-color:#E7E7E7;"></div> 6 = White
: <div style="display: inline-block; vertical-align: top; height: 20px; width: 20px; border: 1px solid black; margin-right: 5px; background-color:#080908;"></div> 7 = Black
: <div style="display: inline-block; vertical-align: top; height: 20px; width: 20px; border: 1px solid black; margin-right: 5px; background-color:#633C2B;"></div> 8 = Brown
: <div style="display: inline-block; vertical-align: top; height: 20px; width: 20px; border: 1px solid black; margin-right: 5px; background-color:#63633F;"></div> 9 = Khaki
: <div style="display: inline-block; vertical-align: top; height: 20px; width: 20px; border: 1px solid black; margin-right: 5px; background-color:#E41C99;"></div> 10 = Pink
: <div style="display: inline-block; vertical-align: top; height: 20px; width: 20px; border: 1px solid black; margin-right: 5px; background-color:#732CA7;"></div> 11 (or higher) = Purple
<div id="CompletionRatio"></div>
;CompletionRatio
<div id="ElevatorLevel"></div>
;ElevatorLevel
<div id="ElevatorSpeed"></div>
;ElevatorSpeed
<div id="Error"></div>
;Error
: 1 if device is in error state, otherwise 0
<div id="ExportCount"></div>
;ExportCount
: How many items exporfted since last ClearMemory.
<div id="Filtration"></div>
;Filtration
: The current state of the filtration system. For example filtration = 1 for a Hardsuit when filtration is On.
<div id="Harvest"></div>
;Harvest
: Performs the harvesting action for any plant based machinery.
: <code>s d0 Harvest 1 # Performs 1 harvest action on device d0</code>
<div id="Horizontal"></div>
;Horizontal
<div id="HorizontalRatio"></div>
;HorizontalRatio
<div id="Idle"></div>
;Idle
<div id="ImportCount"></div>
;ImportCount
<div id="Lock"></div>
;Lock
<div id="Maximum"></div>
;Maximum
<div id="Mode"></div>
;Mode
<div id="On"></div>
;On
<div id="Open"></div>
;Open
<div id="Output"></div>
;Output
<div id="Plant"></div>
;Plant
: Performs the planting operation for any plant based machinery.
: <code>s d0 Plant 1 # Plants one crop in device d0</code>
<div id="PositionX"></div>
;PositionX
<div id="PositionY"></div>
;PositionY
<div id="PositionZ"></div>
;PositionZ
<div id="Power"></div>
;Power
<div id="PowerActual"></div>
;PowerActual
<div id="PowerPotential"></div>
;PowerPotential
<div id="PowerRequired"></div>
;PowerRequired
<div id="Pressure"></div>
;Pressure
<div id="PressureExternal"></div>
;PressureExternal
<div id="PressureInteral"></div>
;PressureInteral
<div id="PressureSetting"></div>
;PressureSetting
<div id="Quantity"></div>
;Quantity
: Total quantity in the device.
<div id="Ratio"></div>
;Ratio
: Context specific value depending on device, 0 to 1 based ratio.
<div id="RatioCarbonDioxide"></div>
;RatioCarbonDioxide
<div id="RatioNitrogen"></div>
;RatioNitrogen
: The ratio of nitrogen in device atmosphere.
<div id="RatioOxygen"></div>
;RatioOxygen
: The ratio of oxygen in device atmosphere.
<div id="RatioPollutant"></div>
;RatioPollutant
: The ratio of pollutant in device atmosphere.
<div id="RatioVolatiles"></div>
;RatioVolatiles
: The ratio of volatiles in device atmosphere.
<div id="RatioWater"></div>
;RatioWater
: The ratio of water in device atmosphere.
<div id="Reagents"></div>
;Reagents
<div id="RecipeHash"></div>
;RecipeHash
<div id="RequestHash"></div>
;ReferenceId
: Unique Identifier of a Device, this value is different for every device in a save.
<div id="ReferenceId"></div>
;RequestHash
<div id="RequiredPower"></div>
;RequiredPower
<div id="Setting"></div>
;Setting
<div id="SolarAngle"></div>
;SolarAngle
: Solar angle of the device.
: <code>l r0 d0 SolarAngle # Sets r0 to the solar angle of d0.</code>
<div id="Temperature"></div>
;Temperature
<div id="TemperatureSettings"></div>
;TemperatureSettings
<div id="TotalMoles"></div>
;TotalMoles
<div id="VelocityMagnitude"></div>
;VelocityMagnitude
<div id="VelocityRelativeX"></div>
;VelocityRelativeX
<div id="VelocityRelativeY"></div>
;VelocityRelativeY
<div id="VelocityRelativeZ"></div>
;VelocityRelativeZ
<div id="Vertical"></div>
;Vertical
: Vertical setting of the device.
<div id="VerticalRatio"></div>
;VerticalRatio
: Ratio of vertical setting for device.
<div id="Volume"></div>
;Volume
: Returns the device atmosphere volume

==Slot Variables==
In general (always?) slots are assigned as follows.
:Slot 0: Import
:Slot 1: Export
:Slot 2: Inside Machine
-----

<div id="Occupied"></div>
;Occupied
:<code>ls r0 d0 2 Occupied #Stores 1 in r0 if d0 has more seeds</code>
:<code>ls vOccupied dThisVictim 2 Occupied #stores 1 in vOccupied if dThisVictim has more seeds</code>
<div id="OccupantHash"></div>
;OccupantHash
<div id="Quantity"></div>
;Quantity
<div id="Damage"></div>
;Damage
<div id="Efficiency"></div>
;Efficiency
<div id="Health"></div>
;Health
<div id="Growth"></div>
;Growth
:<code>ls r0 d0 0 Growth # Store the numerical growth stage of d0 in r0</code>
<div id="Pressure"></div>
;Pressure
<div id="Temperature"></div>
;Temperature
<div id="Charge"></div>
;Charge
<div id="ChargeRatio"></div>
;ChargeRatio
<div id="Class"></div>
;Class
<div id="PressureWaste"></div>
;PressureWaste
<div id="PressureAir"></div>
;PressureAir
<div id="MaxQuantity"></div>
;MaxQuantity

<div id="Mature"></div>
;Mature
:<code>ls r0 d0 0 Mature # Store 1 in r0 if d0 has a mature crop</code>
:<code>ls vMature dThisVictim 0 Mature # Store 1 in vMature if dThisVictim has a mature crop</code>
;ReferenceId
: Unique Identifier of a Device, this value is different for every device in a save.
<div id="ReferenceId"></div>
----

=Examples=
Previous examples were obsolete due to game changes, or confusing, they have been moved into the Discussions section
----

===Harvie automation===
This script uses the batch instruction <code>sb ...</code> to control all Harvie devices on the network. But only one Harvie and one Tray will be the ''master'' and have their values read, the rest of the Harvies will repeat exactly what this unit does. Some problems with this design is that different types of crops mature at different speeds, and if seeds were manually planted and the master unit recieved the first seed, the harvesting action will be performed too early on all the other plants since they are growing a few seconds slower.

<div class="mw-collapsible mw-collapsed" data-expandtext="{{int:Expand, Automated Harvie Script}}" data-collapsetext="{{int:Collapse, Automated Harvie Script}}">
{{ICCode|
alias dHarvie d0
alias dTray d1

alias rHarvieHash r8
alias rTrayHash r9
l rHarvieHash dHarvie PrefabHash
l rTrayHash dTray PrefabHash

main:
yield
#read plant data from the Tray
ls r0 dTray 0 Mature
#harvestable plants return 1, young plants return 0
#nothing planted returns -1
beq r0 -1 plantCrop
beq r0 1 harvestCrop
ls r0 dTray 0 Seeding
#seeds available returns 1, all seeds picked returns 0
#plants too young or old for seeds returns -1
beq r0 1 harvestCrop
j main

plantCrop:
#stop the planting if no seeds available
#otherwise it will plant nothing repeatedly
ls r0 dHarvie 0 Occupied
beq r0 0 main
sb rHarvieHash Plant 1
j main

harvestCrop:
sb rHarvieHash Harvest 1
j main

### End Script ###

}}
</div>
<br>
-----

===Solar Panel 2-axis tracking===
<div class="mw-collapsible mw-collapsed" data-expandtext="{{int:Expand, Solar Panel 2-axis tracking}}" data-collapsetext="{{int:Collapse, Solar Panel 2-axis tracking}}">
{{ICCode|
#2 Axis Solar Tracking adapted from CowsAreEvil.
#Place all panels in uniform manner.
#Set one to 15 Vertical(Min value). 0 Horizontal.
#Take note direction panel faces.
#Place daylight sensor flat pointing in the direction
#the panel now faces. (Cable port facing opposite)

#Alias the sensor to d0
alias sensor d0

# define the Panel variants
define Heavy -934345724
define HeavyDual -1545574413
define Solar -2045627372
define SolarDual -539224550

start:
yield
#Check for daylight.
l r0 sensor Activate
beqz r0 reset
#Read the Horizontal data.
l r0 sensor Horizontal
#Set batch to the panels.
sb Heavy Horizontal r0
sb HeavyDual Horizontal r0
sb Solar Horizontal r0
sb SolarDual Horizontal r0
#Read the Vertical data and subtract 90
l r0 sensor Vertical
sub r0 90 r0
#Set batch to the panels.
sb Heavy Vertical r0
sb HeavyDual Vertical r0
sb Solar Vertical r0
sb SolarDual Vertical r0
j start

reset:
yield
sb Heavy Horizontal 270 #Edit this to face sunrise.
sb HeavyDual Horizontal 270 #Edit this
sb Solar Horizontal 270 #Edit this
sb SolarDual Horizontal 270 #Edit this
sb Heavy Vertical 0
sb HeavyDual Vertical 0
sb Solar Vertical 0
sb SolarDual Vertical 0
sleep 10
j start
}}
</div>
<br>
-----

===Example experiment: how many lines of code are executed each tick?===
To determine this, a script without <code>yield</code> will be used. It should have as few lines as possible (so no labels are used, but a reset value at the top will be needed) and count the number of lines, the IC Housing will be used to display the result.
{{ICCode|
move r0 1 #the first line has number 0
add r0 r0 3
s db Setting r0
j 1
}}

Result (the numbers appears every 0.5 seconds):
<br>127
<br>256 (+129)
<br>385 (+129)
<br>511 (+126)
<br>640 (+129)
<br>769 (+129)
<br>895 (+126)
<br>1024 (+129)
<br>1153 (+129)

There is a repeating +129, +129, +126 sequence, a hint that the real value is 128. Which also happens to be the number of lines in a script, which makes sense. A variation of this experiment will show that empty rows are also counted towards this number.

----
=Links=
----
* Stationeers online IC10 Emulators so you can develop your code without repeatedly dying in game
** [https://ic10.dev/] Stationeers Code Simulator
** [https://ic10emu.dev] Stationeers IC10 Editor & Emulator - A feature packed code editor for Stationeers IC10 code, paired with a robust debugger and emulator. Edit, test, and share code.
** [https://stationeering.com/tools/ic] Stationeering provides a simulation of the IC10 chip inside Stationeers. IDE with error checking, full visibility of stack and registers.
* [http://www.easy68k.com/] EASy68K is a 68000 Structured Assembly Language IDE.
* [https://marketplace.visualstudio.com/items?itemName=Traineratwot.stationeers-ic10] syntax highlighting for IC10 MIPS for Visual Studio Code (updated Feb 10th 2022)
* [https://pastebin.com/6Uw1KSRN] syntax highlighting for IC10 MIPS for KDE kwrite/kate text editor
* [https://drive.google.com/file/d/1yEsJ-u94OkuMQ8K6fY7Ja1HNpLcAdjo_/view] syntax highlighting for IC10 MIPS for Notepad++
* [https://drive.google.com/file/d/1Xrv5U0ZI5jDcPv7yX7EAAxaGk5hKP0xO/view?usp=sharing] syntax highlighting for IC10 MIPS for Notepad++ (updated: 11/08/2022)
* [https://pastebin.com/3kmGy0NN] syntax highlighting for IC10 MIPS for Notepad++ (updated: 23/03/2024)

----

=Index=
----

{|
|+Functions
<div class="mw-collapsible mw-collapsed">
*[[#abs|abs]]
*[[#add|add]]
*[[#alias|alias]]
*[[#and|and]]
*[[#beq|beq]]
*[[#bgez|bgez]]
*[[#bgtz|bgtz]]
*[[#blez|blez]]
*[[#bltz|bltz]]
*[[#bne|bne]]
*[[#breq|breq]]
*[[#brgez|brgez]]
*[[#brgtz|brgtz]]
*[[#brlez|brlez]]
*[[#brltz|brltz]]
*[[#brne|brne]]
*[[#ceil|cell]]
*[[#div|div]]
*[[#exp|exp]]
*[[#floor|floor]]
*[[#j|j]]
*[[#jr|jr]]
*[[#l|l]]
*[[#log|log]]
*[[#ls|ls]]
*[[#max|max]]
*[[#min|min]]
*[[#mod|mod]]
*[[#move|move]]
*[[#mul|mul]]
*[[#nor|nor]]
*[[#or|or]]
*[[#rand|rand]]
*[[#round|round]]
*[[#s|s]]
*[[#slt|slt]]
*[[#sqrt|sqrt]]
*[[#sub|sub]]
*[[#trunc|trunc]]
*[[#xor|xor]]xor
*[[#yield|yield]]
*[[##|#]]
</div>

|+Device Variables
<div class="mw-collapsible mw-collapsed">
*[[#Activate|Activate]]
*[[#AirRelease|AirRelease]]
*[[#Charge|Charge]]
*[[#CLearMemory|CLearMemory]]
*[[#Color|Color]]
*[[#CompletionRatio|CompletionRatio]]
*[[#ElevatorLevel|ElevatorLevel]]
*[[#ElevatorSpeed|ElevatorSpeed]]
*[[#Error|Error]]
*[[#ExportCount|ExportCount]]
*[[#Filtration|Filtration]]
*[[#Harvest|Harvest]]
*[[#Horizontal|Horizontal]]
*[[#HorizontalRatio|HorizontalRatio]]
*[[#Idle|Idle]]
*[[#ImportCount|ImportCount]]
*[[#Lock|Lock]]
*[[#Maximum|Maximum]]
*[[#Mode|Mode]]
*[[#On|On]]
*[[#Open|Open]]
*[[#Output|Output]]
*[[#Plant|Plant]]
*[[#PositionX|PositionX]]
*[[#PositionY|PositionY]]
*[[#PositionZ|PositionZ]]
*[[#Power|Power]]
*[[#PowerActual|PowerActual]]
*[[#PowerPotential|PowerPotential]]
*[[#PowerRequired|PowerRequired]]
*[[#Pressure|Pressure]]
*[[#PressureExternal|PressureExternal]]
*[[#PressureInteral|PressureInteral]]
*[[#PressureSetting|PressureSetting]]
*[[#Quantity|Quantity]]
*[[#Ratio|Ratio]]
*[[#RatioCarbonDioxide|RatioCarbonDioxide]]
*[[#RatioNitrogen|RatioNitrogen]]
*[[#RatioOxygen|RatioOxygen]]
*[[#RatioPollutant|RatioPollutant]]
*[[#RatioVolatiles|RatioVolatiles]]
*[[#RatioWater|RatioWater]]
*[[#Reagents|Reagents]]
*[[#RecipeHash|RecipeHash]]
*[[#RequestHash|RequestHash]]
*[[#RequiredPower|RequiredPower]]
*[[#Setting|Setting]]
*[[#SolarAngle|SolarAngle]]
*[[#Temperature|Temperature]]
*[[#TemperatureSettings|TemperatureSettings]]
*[[#TotalMoles|TotalMoles]]
*[[#VelocityMagnitude|VelocityMagnitude]]
*[[#VelocityRelativeX|VelocityRelativeX]]
*[[#VelocityRelativeY|VelocityRelativeY]]
*[[#VelocityRelativeZ|VelocityRelativeZ]]
*[[#Vertical|Vertical]]
*[[#VerticalRatio|VerticalRatio]]
*[[#Volume|Volume]]

</div>

|+Slot Variables
<div class="mw-collapsible mw-collapsed">
*[[#Occupied|Occupied]]
*[[#OccupantHash|OccupantHash]]
*[[#Quantity|Quantity]]
*[[#Damage|Damage]]
*[[#Efficiency|Efficiency]]
*[[#Health|Health]]
*[[#Growth|Growth]]
*[[#Pressure|Pressure]]
*[[#Temperature|Temperature]]
*[[#Charge|Charge]]
*[[#ChargeRatio|ChargeRatio]]
*[[#Class|Class]]
*[[#PressureWaste|PressureWaste]]
*[[#PressureAir|PressureAir]]
*[[#MaxQuantity|MaxQuantity]]
*[[#Mature|Mature]]
</div>

|}

Logic Sorter

2024-07-24T01:13:22Z

Thoth: add bit layout of the six current instructions

[[Category:Machines]]
[[Category:Import/Export]]
{{Structurebox
| name = Logic Sorter
| image = [[File:StructureLogicSorter.png]]
| prefab_hash = 873418029
| prefab_name = StructureLogicSorter
| power_usage = 5W
| placed_on_grid = Small Grid
| decon_with_tool1 = [[Hand Drill]]
| placed_with_item = [[Kit (Sorter)]]
| item_rec1 = [[Kit (Sorter)]]
}}
{{Distinguish|Sorter}}

==Description==

<blockquote><q>Contains an Internal Memory which is assessed to check whether something should be sorted. When an item is in the Import slot Slot, the stack is checked and if result is true the thing is moved to the Export2 slot slot, otherwise it is moved to the Export slot slot. The Mode is used in how the stack is assessed, by default the mode is ALL, so every instruction in the stack would need to return true.</q><br>
'''- Stationpedia'''</blockquote>

Logic sorter is similar in almost every way to the previous sorter but has a internal memory that can be configured with logic and bit shifting to sort items passing through. When an item enters the import slot, it is checked against the filters in memory. If the Mode is 0(All) then every filter must return true for the item to be sent to the export 2 slot. If the mode is 1(Any) then as long as one of the filters returns true, the item matches and will be sent to the export 2 slot.

==Filter Instructions==
Check the in game Stationpedia [F1 on your keyboard] for formatting and instruction sizes to determine how to populate the memory. Be warned that the stationpedia fails to document the endianness (bit 0 is the least significant bit). While the stationpedia does document that the Logic Sorter has 256 bytes of memory, it is addressed as 32 x 8-byte (64-bit) numbers.

If you wish your sorter to send [[Steel Ingot]]s to the second output you should place the value 0xd8f8af8d_01 ( = 931885190401 decimal ) into memory 0. More complicated programs will have to consider whether they want to use Mode 0 (match All), Mode 1 (match Any), or Mode 2 (match None).

It is more readable to calculate the instructions using MIPS like this:

<pre>
alias sorter d0
define steel HASH("ItemSteelIngot")
s sorter Mode 1 # Any
clr sorter # erase any stale instructions in RAM
sll r0 steel 8
or r0 r0 SorterInstruction.FilterPrefabHashEquals
put sorter 0 r0
</pre>

{| class="wikitable"
|-
! Sorter Instruction !! OP Code !! Description
|-
| FilterPrefabHashEquals || 1 || Compares Hash of item in import slot to the set hash and returns true if equal.
|-
| FilterPrefabHashNotEquals || 2 || Compares Hash of item in import slot to the set hash and returns true if not equal.
|-
| FilterSortingClassCompare || 3 || Compares the sorting class of an object in input slot. Example would be all ores.
|-
| FilterSlotTypeCompare || 4 || Compares the item type of an object in the input slot. See slot type table below for item comparisons.
|-
| FilterQuantityCompare || 5 || Compares the stack size of the items in the import slot.
|-
|LimitNextExecutionCount || 6 || Ensures the next executable instruction will only return true a specified number of times. Each time it returns true, it decrements by one.
|}

<pre>
MSB LSB
6666555555555544444444443333333333222222222211111111110000000000
3210987654321098765432109876543210987654321098765432109876543210
FilterPrefabHashEquals
########################( PREFAB_HASH)( 1)
FilterPrefabHashNotEquals
########################( PREFAB_HASH)( 2)
FilterSortingClassCompare
################################( SORTING_CLASS)(CONDOP)( 3)
FilterSlotTypeCompare
################################( SLOT_TYPE)(CONDOP)( 4)
FilterQuantityCompare
################################( QUANTITY)(CONDOP)( 5)
LimitNextExecutionByCount
########################( COUNT)( 6)
</pre>

{{Data Network Header}}

{{Data Parameters|
{{Data Parameters/row|Power|Boolean|w=0|Can be read to return if the Logic Sorter is correctly powered or not, set via the power system, return 1 if powered and 0 if not|multiple=2|0|Unpowered|1|Powered}}
{{Data Parameters/row|Mode|Integer|The mode of the Logic Sorter.|multiple=3|0|All|1|Any|2|None}}
{{Data Parameters/row|Error|Boolean|w=0|1 if device is in error state, otherwise 0|multiple=2|0|<p></p>|1|Error}}
{{Data Parameters/row|Lock|Boolean|Disable manual operation of the Logic Sorter.|multiple=2|0|Unlocked|1|Locked}}
{{Data Parameters/row|On|Boolean|The current state of the Logic Sorter.|multiple=2|0|Off|1|On}}
{{Data Parameters/row|RequiredPower|Integer|w=0|Idle operating power quantity, does not necessarily include extra demand power}}
{{Data Parameters/row|ClearMemory|Integer|r=0|When set to 1, clears the counter memory (e.g. ExportCount). Will set itself back to 0 when actioned}}
{{Data Parameters/row|ExportCount|Integer|w=0|How many items exported since last ClearMemory}}
{{Data Parameters/row|ImportCount|Integer|w=0|How many items imported since last ClearMemory}}
{{Data Parameters/row|PrefabHash|Integer|w=0|The hash of the structure}}
{{Data Parameters/row|ReferenceId|Integer|w=0|Unique Reference Identifier for this object}}
{{Data Parameters/row|NameHash|Integer|w=0|Provides the hash value for the name of the object as a 32 bit integer.}}
}}

=== Data Slots ===
These are all parameters, that can be read with a [[Kit_(Logic_I/O)#Slots_Reader|Slots Reader]]. The outputs are listed in the order a Slots Reader's "VAR" setting cycles through them.
{| class="wikitable"
|-
! Number || Name !! Description
|-
| 0 || Import || Import slot.
|-
| 1 || Export (reject) || Export slot.
|-
| 2 || Export (accept) || Export slot.
|-
| 3 || Data Disk || Diskslot
|}

{| class="wikitable"
|-
! Name !! Data Type !! Description
|-
| MaxQuantity || Integer || Returns maximum stacksize.
|-
| Damage || Integer || Item durability in percent.
|-
| Class || Integer || Item class ID for slot type comparison.
|-
| SortingClass || Integer || Class group of items.
|-
| Quantity || Integer || Size of item stack.
|-
| PrefabHash || Integer || Returns [[ItemHash]] of item in slot.
|-
| Occupied || Boolean || Returns whether the slot occupied. (0 for no, 1 for yes).
|-
| OccupantHash || Integer || Returns [[ItemHash]] of item in slot.
|-
|}

== Item Slot Classes / Types ==

Reading the ''class'' attribute of the input slot will give one of the following values:

Note that you can use <pre style="display: inline">SlotClass.<Item></pre> directly in IC code instead of the numeric value
*NOTE The classes listed in this section are FilterSlotTypeCompare and NOT sorting class. eg: SortingClass.Ores vs SlotClass.Ore

{| class="wikitable"
|+ Item values and descriptions
! Item !! Value !! Description !! Item !! Value !! Description !! Item !! Value !! Description
|-
| None || 0 || || Helmet || 1 || || Suit || 2 ||
|-
| Back || 3 || || GasFilter || 4 || || GasCanister || 5 ||
|-
| Motherboard || 6 || || Circuitboard || 7 || || DataDisk || 8 ||
|-
| Organ || 9 || || Ore || 10 || Includes reagent mixes from recycler and ices || Plant || 11 ||
|-
| Uniform || 12 || || Entity || 13 || || Battery || 14 ||
|-
| Egg || 15 || || Belt || 16 || || Tool || 17 ||
|-
| Appliance || 18 || || Ingot || 19 || || Torpedo || 20 ||
|-
| Cartridge || 21 || || AccessCard || 22 || || Magazine || 23 ||
|-
| Circuit || 24 || || Bottle || 25 || || ProgrammableChip || 26 ||
|-
| Glasses || 27 || || CreditCard || 28 || || DirtCanister || 29 ||
|-
| SensorProcessingUnit || 30 || || LiquidCanister || 31 || || LiquidBottle || 32 ||
|-
| Wreckage || 33 || || SoundCartridge || 34 || || DrillHead || 35 ||
|-
| ScanningHead || 36 || || Flare || 37 || || Blocked || 38 ||
|-
| SuitMod || 39 || || Crate || 40 || || Portables || 41 ||
|}

Logic Sorter

2024-07-23T01:58:42Z

Thoth: /* Filter Instructions */

[[Category:Machines]]
[[Category:Import/Export]]
{{Structurebox
| name = Logic Sorter
| image = [[File:StructureLogicSorter.png]]
| prefab_hash = 873418029
| prefab_name = StructureLogicSorter
| power_usage = 5W
| placed_on_grid = Small Grid
| decon_with_tool1 = [[Hand Drill]]
| placed_with_item = [[Kit (Sorter)]]
| item_rec1 = [[Kit (Sorter)]]
}}
{{Distinguish|Sorter}}

==Description==

<blockquote><q>Contains an Internal Memory which is assessed to check whether something should be sorted. When an item is in the Import slot Slot, the stack is checked and if result is true the thing is moved to the Export2 slot slot, otherwise it is moved to the Export slot slot. The Mode is used in how the stack is assessed, by default the mode is ALL, so every instruction in the stack would need to return true.</q><br>
'''- Stationpedia'''</blockquote>

Logic sorter is similar in almost every way to the previous sorter but has a internal memory that can be configured with logic and bit shifting to sort items passing through. When an item enters the import slot, it is checked against the filters in memory. If the Mode is 0(All) then every filter must return true for the item to be sent to the export 2 slot. If the mode is 1(Any) then as long as one of the filters returns true, the item matches and will be sent to the export 2 slot.

==Filter Instructions==
Check the in game Stationpedia [F1 on your keyboard] for formatting and instruction sizes to determine how to populate the memory. Be warned that the stationpedia fails to document the endianness (bit 0 is the least significant bit). While the stationpedia does document that the Logic Sorter has 256 bytes of memory, it is addressed as 32 x 8-byte (64-bit) numbers.

If you wish your sorter to send [[Steel Ingot]]s to the second output you should place the value 0xd8f8af8d_01 ( = 931885190401 decimal ) into memory 0. More complicated programs will have to consider whether they want to use Mode 0 (match All), Mode 1 (match Any), or Mode 2 (match None).

It is more readable to calculate the instructions using MIPS like this:

<pre>
alias sorter d0
define steel HASH("ItemSteelIngot")
s sorter Mode 1 # Any
clr sorter # erase any stale instructions in RAM
sll r0 steel 8
or r0 r0 SorterInstruction.FilterPrefabHashEquals
put sorter 0 r0
</pre>

{| class="wikitable"
|-
! Sorter Instruction !! OP Code !! Description
|-
| FilterPrefabHashEquals || 1 || Compares Hash of item in import slot to the set hash and returns true if equal.
|-
| FilterPrefabHashNotEquals || 2 || Compares Hash of item in import slot to the set hash and returns true if not equal.
|-
| FilterSortingClassCompare || 3 || Compares the sorting class of an object in input slot. Example would be all ores.
|-
| FilterSlotTypeCompare || 4 || Compares the item type of an object in the input slot. See slot type table below for item comparisons.
|-
| FilterQuantityCompare || 5 || Compares the stack size of the items in the import slot.
|-
|LimitNextExecutionCount || 6 || Ensures the next executable instruction will only return true a specified number of times. Each time it returns true, it decrements by one.
|}

{{Data Network Header}}

{{Data Parameters|
{{Data Parameters/row|Power|Boolean|w=0|Can be read to return if the Logic Sorter is correctly powered or not, set via the power system, return 1 if powered and 0 if not|multiple=2|0|Unpowered|1|Powered}}
{{Data Parameters/row|Mode|Integer|The mode of the Logic Sorter.|multiple=3|0|All|1|Any|2|None}}
{{Data Parameters/row|Error|Boolean|w=0|1 if device is in error state, otherwise 0|multiple=2|0|<p></p>|1|Error}}
{{Data Parameters/row|Lock|Boolean|Disable manual operation of the Logic Sorter.|multiple=2|0|Unlocked|1|Locked}}
{{Data Parameters/row|On|Boolean|The current state of the Logic Sorter.|multiple=2|0|Off|1|On}}
{{Data Parameters/row|RequiredPower|Integer|w=0|Idle operating power quantity, does not necessarily include extra demand power}}
{{Data Parameters/row|ClearMemory|Integer|r=0|When set to 1, clears the counter memory (e.g. ExportCount). Will set itself back to 0 when actioned}}
{{Data Parameters/row|ExportCount|Integer|w=0|How many items exported since last ClearMemory}}
{{Data Parameters/row|ImportCount|Integer|w=0|How many items imported since last ClearMemory}}
{{Data Parameters/row|PrefabHash|Integer|w=0|The hash of the structure}}
{{Data Parameters/row|ReferenceId|Integer|w=0|Unique Reference Identifier for this object}}
{{Data Parameters/row|NameHash|Integer|w=0|Provides the hash value for the name of the object as a 32 bit integer.}}
}}

=== Data Slots ===
These are all parameters, that can be read with a [[Kit_(Logic_I/O)#Slots_Reader|Slots Reader]]. The outputs are listed in the order a Slots Reader's "VAR" setting cycles through them.
{| class="wikitable"
|-
! Number || Name !! Description
|-
| 0 || Import || Import slot.
|-
| 1 || Export (reject) || Export slot.
|-
| 2 || Export (accept) || Export slot.
|-
| 3 || Data Disk || Diskslot
|}

{| class="wikitable"
|-
! Name !! Data Type !! Description
|-
| MaxQuantity || Integer || Returns maximum stacksize.
|-
| Damage || Integer || Item durability in percent.
|-
| Class || Integer || Item class ID for slot type comparison.
|-
| SortingClass || Integer || Class group of items.
|-
| Quantity || Integer || Size of item stack.
|-
| PrefabHash || Integer || Returns [[ItemHash]] of item in slot.
|-
| Occupied || Boolean || Returns whether the slot occupied. (0 for no, 1 for yes).
|-
| OccupantHash || Integer || Returns [[ItemHash]] of item in slot.
|-
|}

== Item Slot Classes / Types ==

Reading the ''class'' attribute of the input slot will give one of the following values:

Note that you can use <pre style="display: inline">SlotClass.<Item></pre> directly in IC code instead of the numeric value
*NOTE The classes listed in this section are FilterSlotTypeCompare and NOT sorting class. eg: SortingClass.Ores vs SlotClass.Ore

{| class="wikitable"
|+ Item values and descriptions
! Item !! Value !! Description !! Item !! Value !! Description !! Item !! Value !! Description
|-
| None || 0 || || Helmet || 1 || || Suit || 2 ||
|-
| Back || 3 || || GasFilter || 4 || || GasCanister || 5 ||
|-
| Motherboard || 6 || || Circuitboard || 7 || || DataDisk || 8 ||
|-
| Organ || 9 || || Ore || 10 || Includes reagent mixes from recycler and ices || Plant || 11 ||
|-
| Uniform || 12 || || Entity || 13 || || Battery || 14 ||
|-
| Egg || 15 || || Belt || 16 || || Tool || 17 ||
|-
| Appliance || 18 || || Ingot || 19 || || Torpedo || 20 ||
|-
| Cartridge || 21 || || AccessCard || 22 || || Magazine || 23 ||
|-
| Circuit || 24 || || Bottle || 25 || || ProgrammableChip || 26 ||
|-
| Glasses || 27 || || CreditCard || 28 || || DirtCanister || 29 ||
|-
| SensorProcessingUnit || 30 || || LiquidCanister || 31 || || LiquidBottle || 32 ||
|-
| Wreckage || 33 || || SoundCartridge || 34 || || DrillHead || 35 ||
|-
| ScanningHead || 36 || || Flare || 37 || || Blocked || 38 ||
|-
| SuitMod || 39 || || Crate || 40 || || Portables || 41 ||
|}

Logic Sorter

2024-07-23T01:54:23Z

Thoth: rephrase more compactly, and without using the inaccurate term "stack"

[[Category:Machines]]
[[Category:Import/Export]]
{{Structurebox
| name = Logic Sorter
| image = [[File:StructureLogicSorter.png]]
| prefab_hash = 873418029
| prefab_name = StructureLogicSorter
| power_usage = 5W
| placed_on_grid = Small Grid
| decon_with_tool1 = [[Hand Drill]]
| placed_with_item = [[Kit (Sorter)]]
| item_rec1 = [[Kit (Sorter)]]
}}
{{Distinguish|Sorter}}

==Description==

<blockquote><q>Contains an Internal Memory which is assessed to check whether something should be sorted. When an item is in the Import slot Slot, the stack is checked and if result is true the thing is moved to the Export2 slot slot, otherwise it is moved to the Export slot slot. The Mode is used in how the stack is assessed, by default the mode is ALL, so every instruction in the stack would need to return true.</q><br>
'''- Stationpedia'''</blockquote>

Logic sorter is similar in almost every way to the previous sorter but has a internal memory that can be configured with logic and bit shifting to sort items passing through. When an item enters the import slot, it is checked against the filters in memory. If the Mode is 0(All) then every filter must return true for the item to be sent to the export 2 slot. If the mode is 1(Any) then as long as one of the filters returns true, the item matches and will be sent to the export 2 slot.

==Filter Instructions==
Check the in game Stationpedia [F1 on your keyboard] for formatting and instruction sizes to determine how to populate the memory. Be warned that the stationpedia fails to document the endianness (bit 0 is the least significant bit). While the stationpedia does document that the Logic Sorter has 256 bytes of memory, it is addressed as 32 x 8-byte (64-bit) numbers.

If you wish your sorter to send [[Steel Ingot]]s to the second output you should place the value 0xd8f8af8d_01 ( = 931885190401 decimal ) into memory 0. More complicated programs will have to consider whether they want to use Mode 0 (match Any) or Mode 1 (match All).

It is more readable to calculate the instructions using MIPS like this:

<pre>
alias sorter d0
define steel HASH("ItemSteelIngot")
s sorter Mode 1 # Any
clr sorter # erase any stale instructions in RAM
sll r0 steel 8
or r0 r0 SorterInstruction.FilterPrefabHashEquals
put sorter 0 r0
</pre>

{| class="wikitable"
|-
! Sorter Instruction !! OP Code !! Description
|-
| FilterPrefabHashEquals || 1 || Compares Hash of item in import slot to the set hash and returns true if equal.
|-
| FilterPrefabHashNotEquals || 2 || Compares Hash of item in import slot to the set hash and returns true if not equal.
|-
| FilterSortingClassCompare || 3 || Compares the sorting class of an object in input slot. Example would be all ores.
|-
| FilterSlotTypeCompare || 4 || Compares the item type of an object in the input slot. See slot type table below for item comparisons.
|-
| FilterQuantityCompare || 5 || Compares the stack size of the items in the import slot.
|-
|LimitNextExecutionCount || 6 || Ensures the next executable instruction will only return true a specified number of times. Each time it returns true, it decrements by one.
|}

{{Data Network Header}}

{{Data Parameters|
{{Data Parameters/row|Power|Boolean|w=0|Can be read to return if the Logic Sorter is correctly powered or not, set via the power system, return 1 if powered and 0 if not|multiple=2|0|Unpowered|1|Powered}}
{{Data Parameters/row|Mode|Integer|The mode of the Logic Sorter.|multiple=3|0|All|1|Any|2|None}}
{{Data Parameters/row|Error|Boolean|w=0|1 if device is in error state, otherwise 0|multiple=2|0|<p></p>|1|Error}}
{{Data Parameters/row|Lock|Boolean|Disable manual operation of the Logic Sorter.|multiple=2|0|Unlocked|1|Locked}}
{{Data Parameters/row|On|Boolean|The current state of the Logic Sorter.|multiple=2|0|Off|1|On}}
{{Data Parameters/row|RequiredPower|Integer|w=0|Idle operating power quantity, does not necessarily include extra demand power}}
{{Data Parameters/row|ClearMemory|Integer|r=0|When set to 1, clears the counter memory (e.g. ExportCount). Will set itself back to 0 when actioned}}
{{Data Parameters/row|ExportCount|Integer|w=0|How many items exported since last ClearMemory}}
{{Data Parameters/row|ImportCount|Integer|w=0|How many items imported since last ClearMemory}}
{{Data Parameters/row|PrefabHash|Integer|w=0|The hash of the structure}}
{{Data Parameters/row|ReferenceId|Integer|w=0|Unique Reference Identifier for this object}}
{{Data Parameters/row|NameHash|Integer|w=0|Provides the hash value for the name of the object as a 32 bit integer.}}
}}

=== Data Slots ===
These are all parameters, that can be read with a [[Kit_(Logic_I/O)#Slots_Reader|Slots Reader]]. The outputs are listed in the order a Slots Reader's "VAR" setting cycles through them.
{| class="wikitable"
|-
! Number || Name !! Description
|-
| 0 || Import || Import slot.
|-
| 1 || Export (reject) || Export slot.
|-
| 2 || Export (accept) || Export slot.
|-
| 3 || Data Disk || Diskslot
|}

{| class="wikitable"
|-
! Name !! Data Type !! Description
|-
| MaxQuantity || Integer || Returns maximum stacksize.
|-
| Damage || Integer || Item durability in percent.
|-
| Class || Integer || Item class ID for slot type comparison.
|-
| SortingClass || Integer || Class group of items.
|-
| Quantity || Integer || Size of item stack.
|-
| PrefabHash || Integer || Returns [[ItemHash]] of item in slot.
|-
| Occupied || Boolean || Returns whether the slot occupied. (0 for no, 1 for yes).
|-
| OccupantHash || Integer || Returns [[ItemHash]] of item in slot.
|-
|}

== Item Slot Classes / Types ==

Reading the ''class'' attribute of the input slot will give one of the following values:

Note that you can use <pre style="display: inline">SlotClass.<Item></pre> directly in IC code instead of the numeric value
*NOTE The classes listed in this section are FilterSlotTypeCompare and NOT sorting class. eg: SortingClass.Ores vs SlotClass.Ore

{| class="wikitable"
|+ Item values and descriptions
! Item !! Value !! Description !! Item !! Value !! Description !! Item !! Value !! Description
|-
| None || 0 || || Helmet || 1 || || Suit || 2 ||
|-
| Back || 3 || || GasFilter || 4 || || GasCanister || 5 ||
|-
| Motherboard || 6 || || Circuitboard || 7 || || DataDisk || 8 ||
|-
| Organ || 9 || || Ore || 10 || Includes reagent mixes from recycler and ices || Plant || 11 ||
|-
| Uniform || 12 || || Entity || 13 || || Battery || 14 ||
|-
| Egg || 15 || || Belt || 16 || || Tool || 17 ||
|-
| Appliance || 18 || || Ingot || 19 || || Torpedo || 20 ||
|-
| Cartridge || 21 || || AccessCard || 22 || || Magazine || 23 ||
|-
| Circuit || 24 || || Bottle || 25 || || ProgrammableChip || 26 ||
|-
| Glasses || 27 || || CreditCard || 28 || || DirtCanister || 29 ||
|-
| SensorProcessingUnit || 30 || || LiquidCanister || 31 || || LiquidBottle || 32 ||
|-
| Wreckage || 33 || || SoundCartridge || 34 || || DrillHead || 35 ||
|-
| ScanningHead || 36 || || Flare || 37 || || Blocked || 38 ||
|-
| SuitMod || 39 || || Crate || 40 || || Portables || 41 ||
|}

Logic Sorter

2024-07-23T01:46:38Z

Thoth: add example MIPS

[[Category:Machines]]
[[Category:Import/Export]]
{{Structurebox
| name = Logic Sorter
| image = [[File:StructureLogicSorter.png]]
| prefab_hash = 873418029
| prefab_name = StructureLogicSorter
| power_usage = 5W
| placed_on_grid = Small Grid
| decon_with_tool1 = [[Hand Drill]]
| placed_with_item = [[Kit (Sorter)]]
| item_rec1 = [[Kit (Sorter)]]
}}
{{Distinguish|Sorter}}

==Description==

<blockquote><q>Contains an Internal Memory which is assessed to check whether something should be sorted. When an item is in the Import slot Slot, the stack is checked and if result is true the thing is moved to the Export2 slot slot, otherwise it is moved to the Export slot slot. The Mode is used in how the stack is assessed, by default the mode is ALL, so every instruction in the stack would need to return true.</q><br>
'''- Stationpedia'''</blockquote>

*This section is still a work in progress.
Logic sorter is similar in almost every way to the previous sorter but has a internal memory, a.k.a stack, that can be accessed with logic and bit shifting to sort items passing through. When an item enters the import slot, its checked against the stack and if the result is true, moves the item to the export 2 slot, otherwise its moved to the export slot. The mode is how the stack is assessed. If mode is set to "ALL", every instruction in the stack would need to return as true.

==Filter Instructions==
Check the in game Stationpedia [F1 on your keyboard] for formatting and instruction sizes to determine how to populate the memory. Be warned that the stationpedia fails to document the endianness (bit 0 is the least significant bit). While the stationpedia does document that the Logic Sorter has 256 bytes of memory, it is addressed as 32 x 8-byte (64-bit) numbers.

If you wish your sorter to send [[Steel Ingot]]s to the second output you should place the value 0xd8f8af8d_01 ( = 931885190401 decimal ) into memory 0. More complicated programs will have to consider whether they want to use Mode 0 (match Any) or Mode 1 (match All).

It is more readable to calculate the instructions using MIPS like this:

<pre>
alias sorter d0
define steel HASH("ItemSteelIngot")
s sorter Mode 1 # Any
clr sorter # erase any stale instructions in RAM
sll r0 steel 8
or r0 r0 SorterInstruction.FilterPrefabHashEquals
put sorter 0 r0
</pre>

{| class="wikitable"
|-
! Sorter Instruction !! OP Code !! Description
|-
| FilterPrefabHashEquals || 1 || Compares Hash of item in import slot to the set hash and returns true if equal.
|-
| FilterPrefabHashNotEquals || 2 || Compares Hash of item in import slot to the set hash and returns true if not equal.
|-
| FilterSortingClassCompare || 3 || Compares the sorting class of an object in input slot. Example would be all ores.
|-
| FilterSlotTypeCompare || 4 || Compares the item type of an object in the input slot. See slot type table below for item comparisons.
|-
| FilterQuantityCompare || 5 || Compares the stack size of the items in the import slot.
|-
|LimitNextExecutionCount || 6 || Ensures the next executable instruction will only return true a specified number of times. Each time it returns true, it decrements by one.
|}

{{Data Network Header}}

{{Data Parameters|
{{Data Parameters/row|Power|Boolean|w=0|Can be read to return if the Logic Sorter is correctly powered or not, set via the power system, return 1 if powered and 0 if not|multiple=2|0|Unpowered|1|Powered}}
{{Data Parameters/row|Mode|Integer|The mode of the Logic Sorter.|multiple=3|0|All|1|Any|2|None}}
{{Data Parameters/row|Error|Boolean|w=0|1 if device is in error state, otherwise 0|multiple=2|0|<p></p>|1|Error}}
{{Data Parameters/row|Lock|Boolean|Disable manual operation of the Logic Sorter.|multiple=2|0|Unlocked|1|Locked}}
{{Data Parameters/row|On|Boolean|The current state of the Logic Sorter.|multiple=2|0|Off|1|On}}
{{Data Parameters/row|RequiredPower|Integer|w=0|Idle operating power quantity, does not necessarily include extra demand power}}
{{Data Parameters/row|ClearMemory|Integer|r=0|When set to 1, clears the counter memory (e.g. ExportCount). Will set itself back to 0 when actioned}}
{{Data Parameters/row|ExportCount|Integer|w=0|How many items exported since last ClearMemory}}
{{Data Parameters/row|ImportCount|Integer|w=0|How many items imported since last ClearMemory}}
{{Data Parameters/row|PrefabHash|Integer|w=0|The hash of the structure}}
{{Data Parameters/row|ReferenceId|Integer|w=0|Unique Reference Identifier for this object}}
{{Data Parameters/row|NameHash|Integer|w=0|Provides the hash value for the name of the object as a 32 bit integer.}}
}}

=== Data Slots ===
These are all parameters, that can be read with a [[Kit_(Logic_I/O)#Slots_Reader|Slots Reader]]. The outputs are listed in the order a Slots Reader's "VAR" setting cycles through them.
{| class="wikitable"
|-
! Number || Name !! Description
|-
| 0 || Import || Import slot.
|-
| 1 || Export (reject) || Export slot.
|-
| 2 || Export (accept) || Export slot.
|-
| 3 || Data Disk || Diskslot
|}

{| class="wikitable"
|-
! Name !! Data Type !! Description
|-
| MaxQuantity || Integer || Returns maximum stacksize.
|-
| Damage || Integer || Item durability in percent.
|-
| Class || Integer || Item class ID for slot type comparison.
|-
| SortingClass || Integer || Class group of items.
|-
| Quantity || Integer || Size of item stack.
|-
| PrefabHash || Integer || Returns [[ItemHash]] of item in slot.
|-
| Occupied || Boolean || Returns whether the slot occupied. (0 for no, 1 for yes).
|-
| OccupantHash || Integer || Returns [[ItemHash]] of item in slot.
|-
|}

== Item Slot Classes / Types ==

Reading the ''class'' attribute of the input slot will give one of the following values:

Note that you can use <pre style="display: inline">SlotClass.<Item></pre> directly in IC code instead of the numeric value
*NOTE The classes listed in this section are FilterSlotTypeCompare and NOT sorting class. eg: SortingClass.Ores vs SlotClass.Ore

{| class="wikitable"
|+ Item values and descriptions
! Item !! Value !! Description !! Item !! Value !! Description !! Item !! Value !! Description
|-
| None || 0 || || Helmet || 1 || || Suit || 2 ||
|-
| Back || 3 || || GasFilter || 4 || || GasCanister || 5 ||
|-
| Motherboard || 6 || || Circuitboard || 7 || || DataDisk || 8 ||
|-
| Organ || 9 || || Ore || 10 || Includes reagent mixes from recycler and ices || Plant || 11 ||
|-
| Uniform || 12 || || Entity || 13 || || Battery || 14 ||
|-
| Egg || 15 || || Belt || 16 || || Tool || 17 ||
|-
| Appliance || 18 || || Ingot || 19 || || Torpedo || 20 ||
|-
| Cartridge || 21 || || AccessCard || 22 || || Magazine || 23 ||
|-
| Circuit || 24 || || Bottle || 25 || || ProgrammableChip || 26 ||
|-
| Glasses || 27 || || CreditCard || 28 || || DirtCanister || 29 ||
|-
| SensorProcessingUnit || 30 || || LiquidCanister || 31 || || LiquidBottle || 32 ||
|-
| Wreckage || 33 || || SoundCartridge || 34 || || DrillHead || 35 ||
|-
| ScanningHead || 36 || || Flare || 37 || || Blocked || 38 ||
|-
| SuitMod || 39 || || Crate || 40 || || Portables || 41 ||
|}

LARrE

2024-07-22T19:06:01Z

Thoth: rename LARrE to LArRE; explain Activate a little better

LARrE

2024-07-21T17:00:57Z

Thoth:

{{Itembox
| name = Kit (LARrE)
| image = [[File:ItemKitRoboticArm.png]]
| prefabhash = -1228287398
| prefabname = ItemKitRoboticArm
| stacks = 1
| slot_class = SlotClass.None
| sorting_class = SortingClass.Kits
| recipe_machine1 = Electronics Printer
| recipe_cost1 = 10g [[Inconel]], 5g [[Hastelloy]], 15g [[Astroloy]]
| constructs = [[LARrE Dock]]
}}
{{Structurebox
| name = LARrE Dock
| image = [[File:StructureRoboticArmDock.png]]
| prefab_hash = -1818718810
| prefab_name = StructureRoboticArmDock
| power_usage = 10W
| placed_on_grid = Small Grid
| decon_with_tool1 = [[Hand Drill]]
| placed_with_item = [[Kit (LARrE)]]
| item_rec1 = [[Kit (LARrE)]]
}}

== Description ==
<blockquote><q>The Linear Articulated Rail Entity or LARrE can be used to plant, harvest and fertilize plants in plant trays. It can also grab items from a [[Chute Export Bin]] and drop them in a [[Chute Import Bin]]. LARrE can interact with plant trays or chute bins built under a linear rail station or built under its dock.</q><br>
'''- Stationpedia'''</blockquote>

{{Data Network Header}}
{{Data Parameters|
{{Data Parameters/row|Power|Boolean|w=0|Can be read to return if the LARrE Dock is correctly powered or not, set via the power system, return 1 if powered and 0 if not|multiple=2|0|Unpowered|1|Powered}}
{{Data Parameters/row|Error|Boolean|w=0|1 if device is in error state, otherwise 0|multiple=2|0|<p></p>|1|Error}}
{{Data Parameters/row|Activate|Integer|1 if device is activated (usually means running), otherwise 0}}
{{Data Parameters/row|Setting|Integer|Set this to make LARrE move to a station}}
{{Data Parameters/row|On|Boolean|The current state of the LARrE Dock.|multiple=2|0|Off|1|On}}
{{Data Parameters/row|RequiredPower|Integer|w=0|Idle operating power quantity, does not necessarily include extra demand power}}
{{Data Parameters/row|Idle|Integer|w=0|Returns 1 if the LARrE Dock is currently idle (stationary), otherwise 0 (moving). Use this to detect if it has completed its movement/action.}}
{{Data Parameters/row|PrefabHash|Integer|w=0|The hash of the structure}}
{{Data Parameters/row|ReferenceId|Integer|w=0|Unique Reference Identifier for this object}}
{{Data Parameters/row|Index|Integer|w=0|The current index for the LARrE Dock on the rails. Can be non-integer. This usually does not correlate with Setting since it counts non-station rail sections.}}
{{Data Parameters/row|NameHash|Integer|w=0|Provides the hash value for the name of the object as a 32 bit integer.}}
}}

==== Data Slots ====
These are all parameters, that can be read with a [[Kit_(Logic_I/O)#Slots_Reader|Slots Reader]]. The outputs are listed in the order a Slots Reader's "VAR" setting cycles through them.
{| class="wikitable"
|-
! Number || Name !! Description
|-
| 0 || Occupied||
|-
| 0 || OccupantHash ||
|-
| 0 || Quantity ||
|-
| 0 || Damage ||
|-
| 0 || Class ||
|-
| 0 || MaxQuantity ||
|-
| 0 || PrefabHash ||
|-
| 0 || SortingCLass ||
|-
| 0 || ReferenceId ||
|}

LARrE

2024-07-09T01:52:31Z

Thoth: document Setting

{{Itembox
| name = Kit (LARrE)
| image = [[File:ItemKitRoboticArm.png]]
| createdwith = [[Electronics Printer]]
| cost = 10g [[Inconel]], 5g [[Hastelloy]], 15g [[Astroloy]]
}}
{{Structurebox
| name = LARrE Dock
| image = [[File:StructureRoboticArmDock.png]]
| placed_with_item = [[Kit (LARrE)]]
| power_usage = 10W
| placed_on_grid = Small Grid
| decon_with_tool1 = [[Hand Drill]]
| item_rec1 = [[Kit (LARrE)]]
}}

== Description ==

The Linear Articulated Rail Entity or LARrE can be used to plant, harvest, and fertilize plants in plant trays. It can also grab items from a Chute Export Bin and drop them in a Chute Import Bin. LARrE can interact with plant trays or chute bins built under a [[Linear Rail|linear rail]] station or built under its dock.

{{Data Parameters}}
{| class="wikitable"
|-
! Parameter Name !! Data Type !! Description
|-
| Activate || ?||
|-
| ClearMemory || Boolean ||
|-
| Error || ?
|-
| Idle || ?
|-
| Index || ?
|-
| NameHash || ?
|-
| On || ?
|-
| Power || ?
|-
| PrefabHash || ?
|-
| ReferenceId || ?
|-
| RequiredPower || ?
|-
| Setting || integer || Read which rail station LARrE is destined for. Write a value to make LARrE move.
|-
|}

==== Data Slots ====
These are all parameters, that can be read with a [[Kit_(Logic_I/O)#Slots_Reader|Slots Reader]]. The outputs are listed in the order a Slots Reader's "VAR" setting cycles through them.
{| class="wikitable"
|-
! Number || Name !! Description
|-
| 0 || Occupied||
|-
| 0 || OccupantHash ||
|-
| 0 || Quantity ||
|-
| 0 || Damage ||
|-
| 0 || Class ||
|-
| 0 || MaxQuantity ||
|-
| 0 || PrefabHash ||
|-
| 0 || SortingCLass ||
|-
| 0 || ReferenceId ||
|}

LARrE

2024-07-09T00:36:11Z

Thoth: new page for LARrE

{{Itembox
| name = Kit (LARrE)
| image = [[File:ItemKitRoboticArm.png]]
| createdwith = [[Electronics Printer]]
| cost = 10g [[Inconel]], 5g [[Hastelloy]], 15g [[Astroloy]]
}}
{{Structurebox
| name = LARrE Dock
| image = [[File:StructureRoboticArmDock.png]]
| placed_with_item = [[Kit (LARrE)]]
| power_usage = 10W
| placed_on_grid = Small Grid
| decon_with_tool1 = [[Hand Drill]]
| item_rec1 = [[Kit (LARrE)]]
}}

== Description ==

The Linear Articulated Rail Entity or LARrE can be used to plant, harvest, and fertilize plants in plant trays. It can also grab items from a Chute Export Bin and drop them in a Chute Import Bin. LARrE can interact with plant trays or chute bins built under a [[Linear Rail|linear rail]] station or built under its dock.

{{Data Parameters}}
{| class="wikitable"
|-
! Parameter Name !! Data Type !! Description
|-
| Activate || ?||
|-
| ClearMemory || Boolean ||
|-
| Error || ?
|-
| Idle || ?
|-
| Index || ?
|-
| NameHash || ?
|-
| On || ?
|-
| Power || ?
|-
| PrefabHash || ?
|-
| ReferenceId || ?
|-
| RequiredPower || ?
|-
| Setting || ?
|-
|}

==== Data Slots ====
These are all parameters, that can be read with a [[Kit_(Logic_I/O)#Slots_Reader|Slots Reader]]. The outputs are listed in the order a Slots Reader's "VAR" setting cycles through them.
{| class="wikitable"
|-
! Number || Name !! Description
|-
| 0 || Occupied||
|-
| 0 || OccupantHash ||
|-
| 0 || Quantity ||
|-
| 0 || Damage ||
|-
| 0 || Class ||
|-
| 0 || MaxQuantity ||
|-
| 0 || PrefabHash ||
|-
| 0 || SortingCLass ||
|-
| 0 || ReferenceId ||
|}

File:Three stairwells.png

2024-01-14T02:01:36Z

Thoth: Thoth uploaded a new version of File:Three stairwells.png

A picture of three stacked stairwells with various front opening options.

Stairwell

2024-01-13T12:21:05Z

Thoth: add screenshot

== Description ==
[[File:Three stairwells.png|thumb|right|three stacked stairwells]]
The Stairwell a 1x1x3 block. It requires at least one frame (or properly aligned stairwell) beneath it for support. All variants include a "landing" gap (requiring some other block like a frame to provide a surface) of approximately 1.5 meter (3/4 of a block), a 1x3-meter-long stair that ascends 2 meters (1 block) and only occupies half the width of the stairwell, and an upper 1.5-meter landing.

It is designed to be stacked to create zigzag stairwells. Attempting to create a one-direction chain of stairwells will fail. Even if you add a frame to support the second stairwell, the cap wall blocks travel from the lower stair to the upper stair.

Although the stairwell has many walls that prevent travel, these walls can not support wall-mounted devices (like consoles, logic elements or the like). The impassable cap walls also prevent stairwells from being used in-line in a corridor.

== Variants ==

The 2m cap walls are present in all variants. The only entry points will be on the long sides.

* Front Left (opposite the bottom of the stair)
* Front Right (adjacent the bottom of the stair)
* Back Left (farthest from the bottom of the stair)
* Back Right (underneath the stair)
* Front Passthrough (both sides of the bottom of the stair)
* Back Passthrough (both sides under the top of the stair)
* No Doors (there are no openings in the side walls of this variant)

File:Three stairwells.png

2024-01-13T12:18:20Z

Thoth:

A picture of three stacked stairwells with various front opening options.

Stairwell

2024-01-13T12:06:40Z

Thoth: first draft of the stairwell page

== Description ==
The Stairwell a 1x1x3 block. It requires at least one frame beneath it for support. All variants include a "landing" gap (requiring some other block like a frame to provide a surface) of approximately 1.5 meter (3/4 of a block), a 1x3-meter-long stair that ascends 2 meters (1 block) and only occupies half the width of the stairwell, and an upper 1.5-meter landing.

It is designed to be stacked to create zigzag stairwells. Attempting to create a one-direction chain of stairwells will fail. Even if you add a frame to support the second stairwell, the cap wall blocks travel from the lower stair to the upper stair.

Although the stairwell has many walls that prevent travel, these walls can not support wall-mounted devices (like consoles, logic elements or the like). The impassable cap walls also prevent stairwells from being used in-line in a corridor.

== Variants ==

The 2m cap walls are present in all variants. The only entry points will be on the long sides.

* Front Left (opposite the bottom of the stair)
* Front Right (adjacent the bottom of the stair)
* Back Left (farthest from the bottom of the stair)
* Back Right (underneath the stair)
* Front Passthrough (both sides of the bottom of the stair)
* Back Passthrough (both sides under the top of the stair)
* No Doors (there are no openings in the side walls of this variant)

Stairs

2024-01-13T11:41:18Z

Thoth: mention Stairwell

<languages />
<translate>

{{Itembox
| name = Kit (Stairs)
| image = [[File:ItemKitStairs.png]]
| stacks = 10
| createdwith = [[Autolathe]], [[Fabricator]]
| cost = 15g [[Iron Ingot|Iron]]
}}
{{Structurebox
| name = Stairs
| image = [[File:ItemKitStairs1.png.png]]
| placed_with_item = [[Kit (Stairs)]]
| placed_on_grid = Large Grid
| decon_with_tool1 = [[Hand Drill]]
| item_rec1 = [[Kit (Stairs)]]
}}

== Description == 
[[Stairs]] are created in the [[Autolathe]] or [[Fabricator]]. They are 1x1x2 (2 blocks long), causing them to have a very gradual slope.

The power input behind the stairs currently serves no function.

Contrast with the 1x1x3 [[Stairwell]].

<gallery>
ItemKitStairs1.png.png
</gallery>
</translate>