Stationeers Community Wiki - User contributions [en]

Transformer

2026-01-15T20:16:59Z

SemlerPDX: /* Notes */ clarified details on the 10W draw of transformers

[[Category:Power]]
{{Itembox
| name = Kit (Transformer)
| image = [[File:{{#setmainimage:ItemKitTransformerSmall.png}}]]
| stacks = No
| createdwith = [[Electronics Printer]], [[Fabricator]]
| cost = 10x [[Iron]], 1x [[Gold]] , 3x [[Copper]]
}}
{{Itembox
| name = Kit Transformer (Large)
| image = [[File:{{#setmainimage:ItemKitTransformer.png}}]]
| stacks = No
| createdwith = [[Electronics Printer]], [[Fabricator]]
| cost = 10x [[Steel]], 5x [[Electrum]]
}}

==Description==
The transformer is used to control the maximum amount of power that will flow on a cable, preventing the cables from overloading on high power draw.
There are three variants of the transformer:

The Transformer (Small) requires 1x Kit (Transformer) to place and is limited to 5,000 W of output. It can be placed in any orientation on a supporting surface (floor, wall, or ceiling) and is available as Transformer Reversed (Small).

The Transformer (Medium) requires 3x Kit (Transformer) to place and is limited to 25,000 W of output. Similarly, it can be placed on any floor, wall, or ceiling and is available as a Transformer Reversed (Medium).

The Transformer (Large) requires 1x Kit Transformer (Large) to place and is limited to 50,000 W of output. It can only be placed in one orientation, ideally the floor, but it can be stacked above floor level by placing it partway into a frame.

==Usage==
Given that the transformer can limit power very specifically (with large 100 W increments or small 10 W increments), you can control or stop the output line from drawing more than the transformer gives out. This can be used to control many items that don't have a changing power usage, such as lights, volume pumps, pipe regulators, active vents, and more. This is similar to the [[Area Power Controller]] but does not have a battery buffer.

==Notes==
Data will not flow through a transformer, isolating the circuit behind their input. <br>
The transformers seem to generate a large amount of heat. 

The Transformer will use 10W itself (all sizes). This 10W will come from the input side of the transformer, and will not appear as draw on the output side of the transformer.

===Data Network Properties===
These are all Data Network properties of this device. This list is not tested at all for the Transformer Small and not complete for Transformer (kit/large variant).

==Data Parameters==
These are all parameters, that can be written to with a Logic Writer, Batch Writer, or Integrated Circuit (IC10). The outputs are listed in the order a Logic Writer's "VAR" setting cycles through them.
{| class="wikitable"
|-
! Parameter Name !! Data Type !! Description
|-
| On || Boolean || Turns the Transformer on when set to 1. Turns it off when set to 0.
|-
| Lock || Boolean || Locks the Transformer when set to 1. Unlocks it when set to 0
|-
| Setting || Integer || Sets the Transformer's power (in Watts) limit.
|}

==Data Outputs==
These are all parameters, that can be read with a Logic Reader or a Slot Reader. The outputs are listed in the order a Logic Reader's "VAR" setting cycles through them. You cannot read ratios in IC2 chip (so far)
{| class="wikitable"
|-
! Parameter Name !! Data Type !! Description
|-
| On|| Boolean|| Returns whether the Transformer is turned on. (0 for no, 1 for yes)
|-
| Maximum || Integer|| Maximum setting of this device. (How high the device can be set, see description for specific numbers.)
|-
| Lock || Boolean|| Returns whether the Transformer is locked. (0 for no, 1 for yes)
|-
| Error || Boolean|| 1 if device is in error state, otherwise 0.
|-
| Setting || Integer || Returns the current power limit (in Watts) of the Transformer.
|-
| RequiredPower || Integer || Idle operating power quantity. (how much power, in watts, the device itself is using, rather than how much power it is passing through.)
|-
| Ratio || Float || Ratio of the current power limit to the maximum power limit of the device
|-
| PrefabHash|| Integer || The hash of the device. (Can be found in the Stationpedia.)
|-
| Power|| Boolean || Returns 1 if the device is powered and on, otherwise 0.
|}

Transformer

2026-01-15T20:14:17Z

SemlerPDX: /* Notes */ removed incorrect note about heavy cables required on all transformer inputs

[[Category:Power]]
{{Itembox
| name = Kit (Transformer)
| image = [[File:{{#setmainimage:ItemKitTransformerSmall.png}}]]
| stacks = No
| createdwith = [[Electronics Printer]], [[Fabricator]]
| cost = 10x [[Iron]], 1x [[Gold]] , 3x [[Copper]]
}}
{{Itembox
| name = Kit Transformer (Large)
| image = [[File:{{#setmainimage:ItemKitTransformer.png}}]]
| stacks = No
| createdwith = [[Electronics Printer]], [[Fabricator]]
| cost = 10x [[Steel]], 5x [[Electrum]]
}}

==Description==
The transformer is used to control the maximum amount of power that will flow on a cable, preventing the cables from overloading on high power draw.
There are three variants of the transformer:

The Transformer (Small) requires 1x Kit (Transformer) to place and is limited to 5,000 W of output. It can be placed in any orientation on a supporting surface (floor, wall, or ceiling) and is available as Transformer Reversed (Small).

The Transformer (Medium) requires 3x Kit (Transformer) to place and is limited to 25,000 W of output. Similarly, it can be placed on any floor, wall, or ceiling and is available as a Transformer Reversed (Medium).

The Transformer (Large) requires 1x Kit Transformer (Large) to place and is limited to 50,000 W of output. It can only be placed in one orientation, ideally the floor, but it can be stacked above floor level by placing it partway into a frame.

==Usage==
Given that the transformer can limit power very specifically (with large 100 W increments or small 10 W increments), you can control or stop the output line from drawing more than the transformer gives out. This can be used to control many items that don't have a changing power usage, such as lights, volume pumps, pipe regulators, active vents, and more. This is similar to the [[Area Power Controller]] but does not have a battery buffer.

==Notes==
Data will not flow through a transformer, isolating the circuit behind their input. <br>
The transformers seem to generate a large amount of heat. 

The Transformer will use 10W itself (all sizes).

===Data Network Properties===
These are all Data Network properties of this device. This list is not tested at all for the Transformer Small and not complete for Transformer (kit/large variant).

==Data Parameters==
These are all parameters, that can be written to with a Logic Writer, Batch Writer, or Integrated Circuit (IC10). The outputs are listed in the order a Logic Writer's "VAR" setting cycles through them.
{| class="wikitable"
|-
! Parameter Name !! Data Type !! Description
|-
| On || Boolean || Turns the Transformer on when set to 1. Turns it off when set to 0.
|-
| Lock || Boolean || Locks the Transformer when set to 1. Unlocks it when set to 0
|-
| Setting || Integer || Sets the Transformer's power (in Watts) limit.
|}

==Data Outputs==
These are all parameters, that can be read with a Logic Reader or a Slot Reader. The outputs are listed in the order a Logic Reader's "VAR" setting cycles through them. You cannot read ratios in IC2 chip (so far)
{| class="wikitable"
|-
! Parameter Name !! Data Type !! Description
|-
| On|| Boolean|| Returns whether the Transformer is turned on. (0 for no, 1 for yes)
|-
| Maximum || Integer|| Maximum setting of this device. (How high the device can be set, see description for specific numbers.)
|-
| Lock || Boolean|| Returns whether the Transformer is locked. (0 for no, 1 for yes)
|-
| Error || Boolean|| 1 if device is in error state, otherwise 0.
|-
| Setting || Integer || Returns the current power limit (in Watts) of the Transformer.
|-
| RequiredPower || Integer || Idle operating power quantity. (how much power, in watts, the device itself is using, rather than how much power it is passing through.)
|-
| Ratio || Float || Ratio of the current power limit to the maximum power limit of the device
|-
| PrefabHash|| Integer || The hash of the device. (Can be found in the Stationpedia.)
|-
| Power|| Boolean || Returns 1 if the device is powered and on, otherwise 0.
|}

IC10

2026-01-15T20:08:28Z

SemlerPDX: /* Stack Memory */ added new poke instruction

[[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 on 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 screw.

* 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>

All hashes used in the game are CRC-32 checksums computed from the strings they represent.

'''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
|}

<nowiki>*</nowiki> This apparently used to result in pinf, but in version 0.2.6091.26702 both lb and lbn are returning 0.

pinf and ninf are the IC10 constants for "positive infinity" and "negative infinity" respectively, and work much like other numerical constants.

=== 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''' nor '''sp''' is protected, their values can be changed by instructions like any other register.

==Stack Memory==
The Stack is a memory that can hold 512 different values. Each IC10 has its own Stack, and some devices (like the Logical Sorter) also have a Stack.
;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?'''.
;poke address(r?|num) value(r?|num): Stores the provided value at the provided address in the stack.
;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

}}

==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.
}}

==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, it's 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
}}

==Numeric values==
Registers and constants are usually decimal values using double-precision floating point (confirmed?).

Unlike real CPU architectures, integers are not supported as a distinct type, but double FP can represent integers up to about 54 bits before rounding causes problems (the exact number depending what bit patterns you happen to have).

Numbers can be written in hexadecimal by preceding the value with a $ symbol. Values larger than 54 bits might get corrupted. Hex numbers are typically used for ReferenceId values.

Examples:
{{ICCode|
move r0 12345
move r1 123.456
move r2 $E1B2
}}

==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
}}

== Dynamically changing LogicType when interacting with Device Registers ==
When the <code>l</code> or <code>s</code> instructions are used to read from or write to a Device Register, the LogicType is the variable that will be interacted with (example: in <code>l r0 myDevice Temperature</code> the LogicType is the Temperature). In most scripts the LogicType will be hardcoded. But it's also possible to change the LogicType dynamically. The LogicType is an enum, where each type is identified by a unique integer value. This makes it possible to cycle through them in various ways, either as a list placed on the Stack, or by increasing the LogicType value via addition in each loop.
{{ICCode|
#loop through a list of LogicTypes
push LogicType.RatioOxygen
push LogicType.RatioVolatiles
push LogicType.Temperature
loop:
pop r1
l r0 myDevice r1
...
bgtz sp loop #loop until the Stack is empty}}

==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>
{{ICCode|
#read all 8 channels with a loop and
#place the values in r0 to r7
move r15 LogicType.Channel0 #LogicType integer
move r14 0 #pointer for indirect referencing
loop:
l rr14 db:0 r15
add r15 r15 1 #next channel
add r14 r14 1 #next register
ble r15 LogicType.Channel7 loop
}}

==Logic gates, Bitwise and Logical==

All logic gates in MIPS have a bitwise behavior. The available gates are NOT, AND, OR, XOR and NOR (XNOR and NAND are missing).

In Bitwise operations, each bit is matched separately, which includes the sign bit.

To understand what is going on with bitwise operations, a little bit of computer theory is needed. In Stationeers each register uses 64 bits for integer values (a number without decimals), where the 64th bit is the sign-bit (0 for positive and 1 for negative). Since the number 0 is counted as a positive value, this gives each register a range of (2^63 - 1) to -2^63. Negative numbers also behave according to Two's complement (https://en.wikipedia.org/wiki/Two%27s_complement). Which means that a number with a sign-bit of 1 will have all of its number bits flipped as well, so that the decimal value of -1 is represented by a binary value of sixtyfour 1's (this is the smallest possible negative integer since zero counts as a positive integer).

MIPS have binary notation (https://en.wikipedia.org/wiki/Binary_number) that is activated by placing a % in front of the number. The _ characters are ignored and only used for readability.

<code>not r0 0</code><br>
<code># 0 = %00000000_00000000_00000000_00000000_00000000_00000000_00000000_00000000</code><br>
<code># flip all bits</code><br>
<code># -1 = %11111111_11111111_11111111_11111111_11111111_11111111_11111111_11111111</code><br>
<code># r0 equals -1</code>

<code>and r0 3 6</code><br>
<code># 3 = %011</code><br>
<code># 6 = %110</code><br>
<code># only the bits in the "2" position are matching</code><br>
<code># r0 equals %010 = 2</code>

Logical operations can still be performed via alternative instructions. But these are not perfect substitutes, they treat negative values differently, and some can produce non-binary outputs. When using these, keep in mind that devices that wants a binary value will treat any non-binary values like this: >= 1 counts as "1" and <1 counts as "0".

<code># r0 = result</code><br>
<code># r1 = input A</code><br>
<code># r2 = input B</code><br>

<code>Logical NOT = seqz r0 r1</code><br>
<code>Logical AND = min r0 r1 r2</code><br>
<code>Logical OR = max r0 r1 r2</code><br>

<code>Logical XOR = sne r0 r1 r2 (only for binary inputs)</code><br>
<code>Logical NAND = not and</code><br>
<code>Logical NOR = not or</code><br>
<code>Logical XNOR = not xor</code>

==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 unless the housing is an [[Air Conditioner]]. 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.

{{ICCode|
# get the average charge ratio across station batteries
lb r0 HASH("StructureBattery") Ratio Average
}}

{{ICCode|
# 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
}}

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 [[Labeller]]. It
can also allow you to control more than 6 devices.

=== Batch instructions ===

The batch instructions can address multiple devices only via their '''PrefabHash''' generated from the prefab name using the `HASH("Name")` macro or copied directly from the [[Stationpedia]]. A prefab hash is always an integer. All devices that can be read with logic contain the logic value '''PrefabHash''' and '''NameHash'''.

See [[#Slot.2FLogic_.2F_Batched|Batched instructions]] for a comprehensive list of all batch instructions.

[[#sb|sb]], [[#sbn|sbn]], [[#sbs|sbs]], (no sbns)<br>
[[#lb|lb]], [[#lbs|lbs]], [[#lbn|lbn]], [[#lbns|lbns]]

=== Direct reference instructions ===

Direct reference instructions can address a specific device via its '''ReferenceId'''.

[[#clrd|clrd]], [[#getd|getd]], [[#putd|putd]],<br>
[[#ld|ld]], [[#sd|sd]], (no slot access via reference ID)

=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/>
<span style="color:blue;">if 1 <= max(1.01, FLT_EPSILON * 8)</span>
<span style="color:#4c9700;">if 1 <= max(1.01, DBL_EPSILON * 8)</span>
<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 (exceptions exist such as filtration units) 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>
-----

===IC10 Schmitt Trigger - Sensor Range Based Device Toggle===
This script demonstrates the IC10 style Schmitt Trigger Pattern in basic examples using the <code>select</code> instruction with its ternary condition to toggle a device <code>On</code> state based on a range of sensor readings. Examples for both styles are provided below, i.e. 'cooling' or 'heating', for 'below min' or 'greater than max' style range-based toggle. A temperature based control is shown in the examples, but any sensor reading could be used to dynamically toggle a device <code>On</code> state such pressure, charge ratio, solar angle, etc.

<div class="mw-collapsible mw-collapsed" data-expandtext="{{int:Expand, IC10 Schmitt Trigger Pattern}}" data-collapsetext="{{int:Collapse, IC10 Schmitt Trigger Pattern}}">
{{ICCode|
# ---- IC10 Schmitt Trigger ----
# -- Standard - i.e. "cooling"

#When the temperature sensor device reports a value
# higher than TempMax and the valve is not On, the
# valve will turn On.

#When the valve is On, and the sensor device reports
# higher than TempMin, the valve will remain on.

#Once that sensor reports a temperature lower than
# TempMin, the valve will once again shut off and
# this cycle will continue indefinitely:

define TempMax 296.15 #23C
define TempMin 283.15 #10C

alias Valve d0
alias Sensor d1

example1:
yield
l r0 Valve On
select r0 r0 TempMin TempMax
l r1 Sensor Temperature
sgt r0 r1 r0
s Valve On r0
j example1

# ---- IC10 Schmitt Trigger ----
# -- Inverted - i.e. "heating"
#When the temperature sensor device reports a value
# lower than TempMin and the valve is not On, the
# valve will turn On.

#When the valve is On, and the sensor device reports
# lower than TempMax, the valve will remain on.

#Once that sensor reports a temperature higher than
# TempMax, the valve will once again shut off and
# this cycle will continue indefinitely:

define TempMax 296.15 #23C
define TempMin 283.15 #10C

alias Valve d0
alias Sensor d1

example2:
yield
l r0 Valve On
select r0 r0 TempMax TempMin
l r1 Sensor Temperature
slt r0 r1 r0
s Valve On r0
j example2

}}
</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.

===Push & Pop return address when calling multiple levels of functions===
More advanced scripts, or scripts that wish to be more generic, may want to allow calling more than one level of function. Allowing this requires pushing the current <code>ra</code> register before calling the function, then popping <code>ra</code> back afterward.

For example, imagine that the main loop of the code wants to call function <code>orientPanelsToStar</code>, which would calculate the panels' orientations, then place them in <code>r0</code> and <code>r1</code>, and then in turn itself call <code>orientPanelsTo</code>, which would set the orientations of all panels based on the precomputed values of <code>r0</code> and <code>r1</code>. Doing so requires <code>orientPanelsToStar</code> to push <code>ra</code> before calling <code>orientPanelsTo</code>, as show in the code below.

{{ICCode|
orientPanelsToStar:
# Save return address set by the 'jal' instruction
push ra

# ...Calculate panels' orientation, for example leaving the results in r0 and r1...

# Now call orientPanelsTo to actually set the panels' orientation
# based on the computed values of r0 and r1.
jal orientPanelsTo

# ...Call other functions here if desired...

# Restore the return address of orientPanelsToStar itself
pop ra
# Return to caller
j ra

##########

orientPanelsTo:
# ...Actually set panels' orientation...

# Return to caller
j ra
}}

This code would behave incorrectly if <code>push ra</code> and <code>pop ra</code> were not present: within <code>orientPanelsToStar</code>, doing <code>jal orientPanelsTo</code> would replace the current value of the <code>ra</code> register, permanently erasing where <code>orientPanelsToStar</code> itself should jump back to once done. Pushing and popping <code>ra</code> effectively saves its value until we need it again.

(A tempting but wrong approach to 'saving' <code>ra</code> would be to <code>move</code> it within a different register (e.g. <code>r15</code>) before calling <code>orientPanelsTo</code>, however that only permits two levels of functions, since if <code>orientPanelsTo</code> itself wants to call another function, it would not be able to use <code>r15</code> to save its <code>ra</code> register since <code>r15</code> already saves <code>orientPanelsToStar</code>'s return address. Just pushing/popping <code>ra</code> fixes all issues, allowing for a ginormous maximum function call depth of 512!)

As a last note, if the script will push/pop values like <code>ra</code>, starting the script by clearing the stack (which where push/pop move the data to) by running <code>clr db</code> is advisable, unless the IC10 chip is not inserted inside an IC Housing (e.g. inserted in the slot of an Air Conditioner), since <code>clr db</code> will cause an error in this case. To do so, run <code>clr db</code> before the script's main loop.

----

=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)
* [https://github.com/SnorreSelmer/stationeers_ic10/blob/main/README.md] Repo with a lot of code examples
----

=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>

|}

User:SemlerPDX

2026-01-07T23:11:10Z

SemlerPDX: YT link update

[[File:SemlerPDX Logo.png|thumb|left]]
<br>
Upstanding Lunatic<br>
Stationeers Community Contributor<br>
Author of [https://veterans-gaming.com/avcs AVCS profiles for VoiceAttack]<br>
Community Manager at [https://veterans-gaming.com Veterans-Gaming]<br>
[https://www.youtube.com/@SemlerPDX SemlerPDX Stationeers Videos & Clips on YouTube]

User:SemlerPDX

2025-10-06T19:23:37Z

SemlerPDX: Pic and aboutme lines added

[[File:SemlerPDX Logo.png|thumb|left]]
<br>
Upstanding Lunatic<br>
Stationeers Community Contributor<br>
Author of [https://veterans-gaming.com/avcs AVCS profiles for VoiceAttack]<br>
Community Manager at [https://veterans-gaming.com Veterans-Gaming]<br>
[https://www.youtube.com/playlist?list=PLCUtHj0YVK1-gts_RyTuRO944foi569D2 SemlerPDX Stationeers Videos & Clips on YouTube]

File:SemlerPDX Logo.png

2025-10-06T19:19:12Z

SemlerPDX:

Avatar logo of SemlerPDX

Solar Logic Circuits Guide

2025-09-25T21:22:07Z

SemlerPDX: Adjusted wording and removed note discouraging new users to learn IC10

[[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-25)

==Solar tracking using Logic Chips - Moon ==

Solar tracking on the [[Worlds|Moon]] is very minimal and straightforward due to its having a near 0° solar angle. You will need the following:

* x1 [[Sensors|Daylight Sensor]]
* x1 [[Logic I/O|Logic Reader]]
* x1 [[Logic I/O|Batch Writer]]
* [[Cables|Cable Coil]]s, a [[Wrench]], a [[Screwdriver]], and [[Wire Cutters]] at a minimum

The orientation of the [[Sensors|Daylight Sensor]] is important for any solar logic control circuit. Since we are only controlling the vertical alignment (0° solar angle negates the need for horizontal control), the direction of the data port does not matter; however, '''the blue solar face of the [[Sensors|Daylight Sensor]] must face either east or west'''. You will have to manually adjust the angle of the horizontal angle on the [[Solar Panel]] with a [[Wrench]], dependent on the orientation you build the [[Solar Panel]], and whether the [[Sensors|Daylight Sensor]] faces east or west. Simply wait for the sun to be up and adjust until the panel is ~98% efficient.

Hook up the logical components as follows:

{| class="wikitable"
|-
! '''Component''' !! '''Port A''' !! '''Connection A''' !! '''Port B''' !! '''Connection B''' !! '''Port C''' !! '''Connection C'''
|-
| [[Logic I/O|Logic Reader]] || IN || [[Sensors|Daylight Sensor]] || VAR || Vertical || N/A || N/A
|-
| [[Logic I/O|Batch Writer]] || IN || [[Logic I/O|Logic Reader]] || OUT VAR || Vertical || OUT TYPE || [[Solar Panel]]
|}

==Solar tracking using Logic Chips - Non-Moon ==

'''THE FOLLOWING INFORMATION NEEDS TESTING ON A NON-MOON PLANET., I (ERIZAMANU) DON'T HAVE A WORKING NON-MOON SAVE (IM GOING FOR YEAR ACHIEVEMENT ON THE MOON RN) FOLLOWING THE TERRAIN UPDATE, SO IF SOMEONE COULD VERIFY THIS CIRCUIT OFF THE MOON AND DM ME I WOULD BE ETERNALLY GRATEFUL THANKS'''

Solar tracking not on the [[Worlds|Moon]] remains straightforward, however is inherently more complicated due to not having a near 0° solar angle. You will need the following:

* x1 [[Sensors|Daylight Sensor]]
* x2 [[Logic I/O|Logic Reader]]
* x2 [[Logic I/O|Batch Writer]]
* [[Cables|Cable Coil]]s, a [[Wrench]], a [[Screwdriver]], and [[Wire Cutters]] at a minimum
* A [[Labeller]] is recommended to differentiate horizontal/vertical components, but not required

The orientation of the [[Sensors|Daylight Sensor]] is important for any solar logic control circuit. Since we are controlling both the vertical and horizontal alignments, '''the direction of the data port''' does matter, and '''must face either north or south'''. Additionally, '''the blue solar face of the [[Sensors|Daylight Sensor]] must face either east or west''', and the '''[[Solar Panel]] power port must face east or west'''. The pairing of the facings is as follows:

{| class="wikitable"
|-
! !! '''Blue Face / [[Solar Panel]] Power Port''' !! '''[[Sensors|Daylight Sensor]] Data Port'''
|-
| Option 1 || West || South
|-
| Option 2 || East || North
|}

Hook up the logical components as follows:

{| class="wikitable"
|-
! '''Component''' !! '''Port A''' !! '''Connection A''' !! '''Port B''' !! '''Connection B''' !! '''Port C''' !! '''Connection C'''
|-
| Vertical [[Logic I/O|Logic Reader]] || IN || [[Sensors|Daylight Sensor]] || VAR || Vertical || N/A || N/A
|-
| Vertical [[Logic I/O|Batch Writer]] || IN || Vertical [[Logic I/O|Logic Reader]] || OUT VAR || Vertical || OUT TYPE || [[Solar Panel]]
|-
| Horizontal [[Logic I/O|Logic Reader]] || IN || [[Sensors|Daylight Sensor]] || VAR || Horizontal || N/A || N/A
|-
| Horizontal [[Logic I/O|Batch Writer]] || IN || Horizontal [[Logic I/O|Logic Reader]] || OUT VAR || Horizontal || OUT TYPE || [[Solar Panel]]
|}

== Solar tracking using IC-10 ==

Using the in-game [[IC10]] code is a complicated process that requires learning and/or knowledge of programming in an assembly-level language similar to [https://en.wikipedia.org/wiki/MIPS_architecture MIPS], which IC10 was based upon/inspired by. Even if you are not proficient at programming, given its simplistic nature, a solar tracking script is a great way to start learning [[IC10]], and the general logic and programming skills required to write even more complicated and advanced [[IC10]] code to automate your systems in Stationeers.

If you are unable or prefer not to learn [[IC10]], you can find all sorts of prewritten [[IC10]] code such as [https://steamcommunity.com/sharedfiles/filedetails/?id=1892925984 Tallinu's IC10 Free-form Solar Tracking Script].

== Geometry Of [[Solar Panel|Solar Panel]]s and [[Sensors|Daylight Sensors]] ==

<gallery>
daylight sensor horizontal.png|Geometry of horizontal values measured by daylight sensor
daylight sensor vertical.png|Geometry of vertical values measured by daylight sensor
solar panel yaw-Horizontal setting.png|Horizontal rotation of a solar panel
solar-horiz-formulas.svg|Equations relating horizontal sensor measurements from various orientations to solar panel horizontal rotation
</gallery>

== Credits // Additonal Information ==

The majority of this content is written by Erizamanu. Feel free to DM me with '''constructive''' suggestions or questions via Discord.

The previous page content was removed following an exchange on the Stationeers Discord between Fuddnir (Previous primary writer) and Risu. The current circuit is an optimized (2 fewer components) version of Fuddnir's circuit that I developed for use in my game.

See the Revision History under Actions for the full change logs.

Sensors

2025-09-21T20:23:57Z

SemlerPDX: Fixed power use of Daylight Sensor from 10W to 0W

[[Category:Solar power]]
<languages />
<translate>{{Itembox
| name = Kit (Sensors)
| image = {{{image|[[File:ItemKitSensor.png]]}}}
| stacks = 5
| constructs = Daylight, Motion, Gas, Occupancy or Proximity Sensor
| createdwith = [[Electronics Printer]]
| cost = 3g [[Iron]], 1g [[Gold]], 1g [[Copper]]
}}

{{Structurebox
| name = Daylight Sensor
| prefab_hash = 1076425094
| prefab_name = StructureDaylightSensor
| power_usage = 0W
| image = [[File:StructureDaylightSensor.png]]
| placed_with_item = [[Kit (Sensors)]]
| placed_on_grid = Small Grid, On Frames
| decon_with_tool1 = [[Hand Drill]]
| item_rec1 = [[Kit (Sensors)]]
}}

{{Structurebox
| name = Motion Sensor
| prefab_hash = -1713470563
| prefab_name = StructureMotionSensor
| power_usage = 0W
| image = [[File:ItemMotionSensor.png]]
| placed_with_item = [[Kit (Sensors)]]
| placed_on_grid = Small Grid, On Frames
| decon_with_tool1 = [[Hand Drill]]
| item_rec1 = [[Kit (Sensors)]]
}}

{{Structurebox
| name = Gas Sensor
| prefab_hash = -1252983604
| prefab_name = StructureGasSensor
| power_usage = 1W
| image = [[File:ItemGasSensor.png]]
| placed_with_item = [[Kit (Sensors)]]
| placed_on_grid = Small Grid, On Frames
| decon_with_tool1 = [[Hand Drill]]
| item_rec1 = [[Kit (Sensors)]]
}}

{{Structurebox
| name = Occupancy Sensor
| prefab_hash = 322782515
| prefab_name = StructureOccupancySensor
| power_usage = 0W
| image = [[File:StructureOccupancySensor.png]]
| placed_with_item = [[Kit (Sensors)]]
| placed_on_grid = Small Grid, On Frames
| decon_with_tool1 = [[Hand Drill]]
| item_rec1 = [[Kit (Sensors)]]
}}

{{Structurebox
| name = Proximity Sensor
| prefab_hash = 568800213
| prefab_name = StructureProximitySensor
| power_usage = 0W
| image = [[File:StructureProximitySensor.png]]
| placed_with_item = [[Kit (Sensors)]]
| placed_on_grid = Small Grid, On Frames
| decon_with_tool1 = [[Hand Drill]]
| item_rec1 = [[Kit (Sensors)]]
}}

= Description = 

Sensors are used to detect various parameters of their surroundings. <br/>
Only the [[Sensors#Daylight_Sensor|Daylight Sensor]] can be accessed directly by pointing at it. The other sensors require a [[Handheld Tablet]] with a [[Cartridge#Configuration|Configuration Cartridge]] to be accessed manually.<br/>
Their outputs can also be accessed using a [[Kit_(Logic_I/O)#Logic_Reader|Logic Reader]] or an [[Integrated Circuit (IC10)|Integrated Circuit]] inserted in an [[Kit (IC Housing)|IC Housing]].

<gallery>
File:Daylight_sensor.jpg|In-game view of daylight sensor
File:Gas_sensor.jpg|In-game view of gas sensor
File:Motion_sensor.jpg|In-game view of motion sensor
</gallery>

= <big>Daylight Sensor</big> = 

The daylight sensor reports whether the sun hits the large grid the sensor is in, as well as the solar angle. Looking at the sensor will provide a tool-tip readout of this information, even when not connected to the network. The orientation of the daylight sensor is important, it will read different angle values depending on the orientation.
<gallery>
File:Daylight sensor horizontal.png|Horizontal parameter
File:Daylight sensor vertical.png|Vertical parameter
</gallery>
== Modes ==
{{warning|While the <kbd>Mode</kbd> and <kbd>SolarAngle</kbd> properties described below are still available, they are being deprecated in favor of <kbd>Horizontal</kbd> and <kbd>Vertical</kbd> data properties.
While <kbd>Vertical</kbd> and <kbd>Vertical mode</kbd> have the same value, '''<kbd>Horizontal</kbd> and <kbd>Horizontal mode</kbd> have opposite values''' (inverted sign).}}
The daylight sensor has a <kbd>Mode</kbd> property which can be set with [[Kit_(Logic_I/O)#Logic_Writer|Logic Writer]] and [[Kit_(Logic_Memory)|Memory chip]], or with an [[Integrated Circuit (IC10)|Integrated Circuit]]:
{| class="wikitable"
|-
! Value !! Name !! Description
|-
| 0 || Default || The sensor will return the absolute value of the angle formed by the source of light and the normal vector of the sensor (towards which the grey/green part is facing). 0 means the source of light is facing to the sensor, 90 means it is aligned with the surface the sensor was laid on, and 180 means the source of light is in the back of the sensor. The angle is always a positive value between 0 and 180.
|-
| 1 || Horizontal || Returns the angle from the position of the source of light parallel to the surface of the sensor. The angle can be negative, ranging between -180 and +180.
|-
| 2 || Vertical || The sensor measures the angle from the position of the light source perpendicular to the surface of the sensor.
|}

<gallery>
File:Daylight sensor horizontal mode.png|Values of SolarAngle in Horizontal mode
File:Daylight sensor vertical.png|Values of SolarAngle in Vertical mode
</gallery>
=== Examples ===
* If you lay a sensor on the ground, facing upwards, connector towards south,configured in horizontal mode, it will work like a compass with 0 = north, 90 = east, 180 = south and -90 = west

* On the Moon/space : <br/> '''Note: these values are approximation and may vary slightly because of realistic orbital simulation'''
** If the daylight sensor is fixed on the floor, it will report 90 degrees at sunrise, up to 0 degrees at noon, back to 90 degrees at sunset, to 180 degrees at midnight, and back to 90 at sunrise.
** If fixed on a ceiling the cycle will be opposite, i.e.: 90 -> 180 -> 90 -> 0 -> 90.
** If fixed to an east facing wall, the cycle from sunrise is: 0 -> 90 -> 180 -> 90 -> 0.
** If fixed to a west facing wall, the cycle is opposite, i.e.: 180 -> 90 -> 0 -> 90 -> 180.
** If fixed to a north or south facing wall it will stay at 90 degrees all the time.

== Solar tracking ==

Tracking the sun using a Daylight Sensor allow [[Solar_Panel|Solar Panels]] to be more efficient by making them perpendicular to the light rays. <br/>
However, the orientation of the Daylight Sensor and Solar Panels must be taken into account and a [[Kit_(Logic_Processor)#Math_Unit|Math Unit]] may be required to correct the offset. <br/>
This [[Solar_Logic_Circuits_Guide|guide]] explains in detail how to set up a solar tracking circuit for solar panels.

{{Data Network Header}}
{{Data Parameters|
{{Data Parameters/row|Mode|Integer|w=1|SolarAngle mode|multiple=3|0|Default|1|Horizontal|2|Vertical}}
{{Data Parameters/row|Activate|Boolean|w=1|1 if the device is running, 0 otherwise}}
{{Data Parameters/row|Horizontal|Float|w=1|Same absolute value <kbd>SolarAngle</kbd> reported for <kbd>Horizontal</kbd> mode but with an inverted sign}}
{{Data Parameters/row|Vertical|Float|w=1|Same as <kbd>SolarAngle</kbd> reported for <kbd>Vertical</kbd> mode}}
{{Data Parameters/row|SolarAngle|Float|w=0|See [[Sensors#Modes|Modes]] above. Probably soon deprecated in favor of <kbd>Horizontal</kbd> and <kbd>Vertical</kbd>}}
{{Data Parameters/row|On|Boolean|w=1|0 if Off, 1 if On}}
{{Data Parameters/row|PrefabHash|Integer|w=0|The hash of the structure}}
{{Data Parameters/row|SolarIrradiance|Float|w=0|The current solar irradiance (in W/m²)}}
{{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}}
}}

= <big>Motion Sensor</big> =

The motion sensor activates when a player or a non static object (such as a thrown item or a portable device) enters the large grid cube where the sensor is located, and deactivates when there are no more players or objects. Despite its name, the sensor will stay activated even if the entity does not move inside the cube.<br/>
This sensor can be useful to build systems that activate when the player is in a specific position (such as automatic doors for example). To check an entire room or area, see [[Sensors#Occupancy_Sensor|Occupancy Sensor]] and [[Sensors#Proximity_Sensor|Proximity Sensor]].

{{Data Network Header}}
{{Data Parameters|
{{Data Parameters/row|Activate|Boolean|w=1|1 if an entity is detected, 0 otherwise. Even though the game consider it writable, trying to write this variable won't actually its value.}}
{{Data Parameters/row|Quantity|Integer|w=0|Number of detected entities}}
{{Data Parameters/row|On|Boolean|w=1|0 if Off, 1 if On (has no effect)}}
{{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}}
}}

= <big>Gas Sensor</big> =

The gas sensor will report information about the gas in the current atmosphere, such as pressure, temperature and gases ratio.<br/>
''Note: Temperature is given in Kelvin, while your suit gives a readout in Celsius. To convert, use Celsius + 273.15 = Kelvin''

{{Data Network Header}}<br/>
'''The gas sensor has no Input parameters, it's a read only device.'''
{{Data Parameters|
{{Data Parameters/row|Pressure|Float|w=0|In kPa}}
{{Data Parameters/row|Temperature|Float|w=0|In Kelvin}}
{{Data Parameters/row|Combustion|Boolean|w=0|1 if the atmosphere is on fire, 0 otherwise}}
{{Data Parameters/row|RatioOxygen|Float|w=0|Ratio of gaseous [[Oxygen]] in the atmosphere}}
{{Data Parameters/row|RatioHydrogen|Float|w=0|Ratio of gaseous Hydrogen in the atmosphere (Hydrogen is deprecated and has been replaced by [[Volatiles]])}}
{{Data Parameters/row|RatioCarbonDioxide|Float|w=0|Ratio of gaseous [[Carbon Dioxide]] in the atmosphere}}
{{Data Parameters/row|RatioNitrogen|Float|w=0|Ratio of gaseous [[Nitrogen]] in the atmosphere}}
{{Data Parameters/row|RatioPollutant|Float|w=0|Ratio of gaseous [[Pollutant]] in the atmosphere}}
{{Data Parameters/row|RatioVolatiles|Float|w=0|Ratio of gaseous [[Volatiles]] in the atmosphere}}
{{Data Parameters/row|RatioNitrousOxide|Float|w=0|Ratio of gaseous [[Nitrous Oxide]] in the atmosphere}}
{{Data Parameters/row|RatioSteam|Float|w=0|Ratio of gaseous [[Water]] in the atmosphere}}

{{Data Parameters/row|RatioLiquidOxygen|Float|w=0|Ratio of liquid [[Oxygen]] in the atmosphere}}
{{Data Parameters/row|RatioLiquidHydrogen|Float|w=0|Ratio of liquid Hydrogen in the atmosphere (Hydrogen is deprecated and has been replaced by [[Volatiles]])}}
{{Data Parameters/row|RatioLiquidCarbonDioxide|Float|w=0|Ratio of liquid [[Carbon Dioxide]] in the atmosphere}}
{{Data Parameters/row|RatioLiquidNitrogen|Float|w=0|Ratio of liquid [[Nitrogen]] in the atmosphere}}
{{Data Parameters/row|RatioLiquidPollutant|Float|w=0|Ratio of liquid [[Pollutant]] in the atmosphere}}
{{Data Parameters/row|RatioLiquidVolatiles|Float|w=0|Ratio of liquid [[Volatiles]] in the atmosphere}}
{{Data Parameters/row|RatioLiquidNitrousOxide|Float|w=0|Ratio of liquid [[Nitrous Oxide]] in the atmosphere}}
{{Data Parameters/row|RatioWater|Float|w=0|Ratio of liquid [[Water]] in the atmosphere}}
{{Data Parameters/row|RatioPollutedWater|Float|w=0|Ratio of liquid [[Polluted Water]] in the atmosphere}}

{{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}}
}}

= <big>Occupancy Sensor</big> =

The Occupancy Sensor detects the presence of a player when placed within a defined room. A defined room is when the game detects the space is entirely closed off from the rest of the world with walls, doors, etc. These do not need to be in the finished state to count as sealing a room.<br/>
''Note: You can determine if a room is define by using the [[Cartridge#Atmos_Analyzer|Atmos Analyzer]] [[Cartridge]] with the [[Handheld_Tablet|tablet]]. If the top says "Room #" the room is sufficiently closed in.''<br/>

Unlike to the [[Sensors#Motion_Sensor|Motion Sensor]], the Occupancy Sensor does not detect other entities such as thrown items or portable devices.<br/>
The Occupancy Sensor can be configured with a [[Cartridge#Atmos_Analyzer|Access Controller]] [[Cartridge]] in a [[Handheld_Tablet|tablet]] to only detect and report players equipped with a specific [[Access Card]].<br/>

This sensor can be great for systems that need to be activated when a player enters or leaves a room, such as lighting and other machines to preserve energy.<br/>
To detect players outside of a base or in a certain part of room only, the [[Sensor#Motion_Sensor|Motion Sensor]] and the [[Sensor#Proximity_Sensor|Proximity Sensor]] can be used.

{{Data Network Header}}<br/>
'''The occupancy sensor has no Input parameters, it's a read only device.'''
{{Data Parameters|
{{Data Parameters/row|Activate|Boolean|w=0|1 if a player is detected, 0 otherwise}}
{{Data Parameters/row|Quantity|Integer|w=0|Number of players detected}}
{{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}}
}}

= <big>Proximity Sensor</big> =

The Proximity Sensor will detect players inside a spherical zone with a radius set by the <code>Setting</code> parameter. This value can be up to 250m and can be set using the dial on the sensor. <br/>
''Note: By pressing the Quantity Change key, you can increment by 10 instead of 1 when using the dial.''<br/>

Like the [[Sensors#Occupancy_Sensor|Occupancy Sensor]], the Proximity Sensor can be configured with a [[Cartridge#Atmos_Analyzer|Access Controller]] [[Cartridge]] in a [[Handheld_Tablet|tablet]] to only detect and report players equipped with a specific [[Access Card]].<br/>
Unlike to the [[Sensors#Motion_Sensor|Motion Sensor]], the Proximity Sensor does not detect other entities such as thrown items or portable devices.<br/>

{{Data Network Header}}<br/>
{{Data Parameters|
{{Data Parameters/row|Activate|Boolean|w=0|1 if a player is detected, 0 otherwise}}
{{Data Parameters/row|Setting|Float|w=1|Range of the sensor in meter (0 to 250}}
{{Data Parameters/row|Quantity|Integer|w=0|Number of players detected}}
{{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}}
}}

</translate>

File:Filter system BASIC.png

2025-09-21T06:42:55Z

SemlerPDX: SemlerPDX uploaded a new version of File:Filter system BASIC.png

A more simplified basic filtration layout for scrubbing air in a base.

Air Filtration System

2025-09-21T06:39:18Z

SemlerPDX: Removed pointless one-way valve

[[Category: Tutorials]]
<languages />
<translate>

This is an air filtration system that will scrub all bad gases from the air, place them in a tank and cool down the air at the same time. A second simplified system is listed below, which merely vents any gas not matching base air back to the world.


[[File:Filter system.png|thumb]]

=== Filter System (Dual) Items Used === 


* [[Active Vent]]
* [[Atmospherics|Atmospherics(Filtration)]]
* [[Filter|Filters (CO2, Pollutant, Volatiles)]]
* [[Passive Vent]]
* [[Pipes]]
* [[Pipe Meter]]
* [[Pipe Radiator]]
* [[Pipe Volume Pump]]
* [[Tank]]

<hr>

This is a more basic simplified air filtration system, which merely vents any gas not matching base air (Oxygen/Nitrogen) back to the world atmosphere.


[[File:Filter system BASIC.png|thumb]]

=== Filter System (Basic) Items Used === 


* [[Active Vent]]
* [[Atmospherics|Atmospherics(Filtration)]]
* [[Filter|Filters (Oxygen, Nitrogen)]]
* [[Passive Vent]]
* [[Pipes]]
* [[Pipe Volume Pump]]
</translate>

File:Filter system BASIC.png

2025-09-21T06:38:30Z

SemlerPDX: SemlerPDX uploaded a new version of File:Filter system BASIC.png

A more simplified basic filtration layout for scrubbing air in a base.

IC10

2025-08-06T20:26:59Z

SemlerPDX: Moved the IC10 Schmitt Trigger example I added below the Solar Panel Tracking example

[[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 on 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 screw.

* 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>

All hashes used in the game are CRC-32 checksums computed from the strings they represent.

'''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) || inf
|-
| 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==
The Stack is a memory that can hold 512 different values. Each IC10 has its own Stack, and some devices (like the Logical Sorter) also have a Stack.
;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

}}

==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.
}}

==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
}}

==Numeric values==
Registers and constants are usually decimal values using double-precision floating point (confirmed?).

Unlike real CPU architectures, integers are not supported as a distinct type, but double FP can represent integers up to about 54 bits before rounding causes problems (the exact number depending what bit patterns you happen to have).

Numbers can be written in hexadecimal by preceding the value with a $ symbol. Values larger than 54 bits might get corrupted. Hex numbers are typically used for ReferenceId values.

Examples:
{{ICCode|
move r0 12345
move r1 123.456
move r2 $E1B2
}}

==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
}}

== Dynamically changing LogicType when interacting with Device Registers ==
When the <code>l</code> or <code>s</code> instructions are used to read from or write to a Device Register, the LogicType is the variable that will be interacted with (example: in <code>l r0 myDevice Temperature</code> the LogicType is the Temperature). In most scripts the LogicType will be hardcoded. But it's also possible to change the LogicType dynamically. The LogicType is an enum, where each type is identified by a unique integer value. This makes it possible to cycle through them in various ways, either as a list placed on the Stack, or by increasing the LogicType value via addition in each loop.
{{ICCode|
#loop through a list of LogicTypes
push LogicType.RatioOxygen
push LogicType.RatioVolatiles
push LogicType.Temperature
loop:
pop r1
l r0 myDevice r1
...
bgtz sp loop #loop until the Stack is empty}}

==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>
{{ICCode|
#read all 8 channels with a loop and
#place the values in r0 to r7
move r15 LogicType.Channel0 #LogicType integer
move r14 0 #pointer for indirect referencing
loop:
l rr14 db:0 r15
add r15 r15 1 #next channel
add r14 r14 1 #next register
ble r15 LogicType.Channel7 loop
}}

==Logic gates, Bitwise and Logical==

All logic gates in MIPS have a bitwise behavior. The available gates are NOT, AND, OR, XOR and NOR (XNOR and NAND are missing).

In Bitwise operations, each bit is matched separately, which includes the sign bit.

To understand what is going on with bitwise operations, a little bit of computer theory is needed. In Stationeers each register uses 64 bits for integer values (a number without decimals), where the 64th bit is the sign-bit (0 for positive and 1 for negative). Since the number 0 is counted as a positive value, this gives each register a range of (2^63 - 1) to -2^63. Negative numbers also behave according to Two's complement (https://en.wikipedia.org/wiki/Two%27s_complement). Which means that a number with a sign-bit of 1 will have all of its number bits flipped as well, so that the decimal value of -1 is represented by a binary value of sixtyfour 1's (this is the smallest possible negative integer since zero counts as a positive integer).

MIPS have binary notation (https://en.wikipedia.org/wiki/Binary_number) that is activated by placing a % in front of the number. The _ characters are ignored and only used for readability.

<code>not r0 0</code><br>
<code># 0 = %00000000_00000000_00000000_00000000_00000000_00000000_00000000_00000000</code><br>
<code># flip all bits</code><br>
<code># -1 = %11111111_11111111_11111111_11111111_11111111_11111111_11111111_11111111</code><br>
<code># r0 equals -1</code>

<code>and r0 3 6</code><br>
<code># 3 = %011</code><br>
<code># 6 = %110</code><br>
<code># only the bits in the "2" position are matching</code><br>
<code># r0 equals %010 = 2</code>

Logical operations can still be performed via alternative instructions. But these are not perfect substitutes, they treat negative values differently, and some can produce non-binary outputs. When using these, keep in mind that devices that wants a binary value will treat any non-binary values like this: >= 1 counts as "1" and <1 counts as "0".

<code># r0 = result</code><br>
<code># r1 = input A</code><br>
<code># r2 = input B</code><br>

<code>Logical NOT = seqz r0 r1</code><br>
<code>Logical AND = min r0 r1 r2</code><br>
<code>Logical OR = max r0 r1 r2</code><br>

<code>Logical XOR = sne r0 r1 r2 (only for binary inputs)</code><br>
<code>Logical NAND = not and</code><br>
<code>Logical NOR = not or</code><br>
<code>Logical XNOR = not xor</code>

==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.

{{ICCode|
# get the average charge ratio across station batteries
lb r0 HASH("StructureBattery") Ratio Average
}}

{{ICCode|
# 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
}}

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 [[Labeller]]. It
can also allow you to control more than 6 devices.

=== Batch instructions ===

The batch instructions can address multiple devices only via their '''PrefabHash''' generated from the prefab name using the `HASH("Name")` macro or copied directly from the [[Stationpedia]]. A prefab hash is always an integer. All devices that can be read with logic contain the logic value '''PrefabHash''' and '''NameHash'''.

See [[#Slot.2FLogic_.2F_Batched|Batched instructions]] for a comprehensive list of all batch instructions.

[[#sb|sb]], [[#sbn|sbn]], [[#sbs|sbs]], (no sbns)<br>
[[#lb|lb]], [[#lbs|lbs]], [[#lbn|lbn]], [[#lbns|lbns]]

=== Direct reference instructions ===

Direct reference instructions can address a specific device via its '''ReferenceId'''.

[[#clrd|clrd]], [[#getd|getd]], [[#putd|putd]],<br>
[[#ld|ld]], [[#sd|sd]], (no slot access via reference ID)

=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/>
<span style="color:blue;">if 1 <= max(1.01, FLT_EPSILON * 8)</span>
<span style="color:#4c9700;">if 1 <= max(1.01, DBL_EPSILON * 8)</span>
<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 (exceptions exist such as filtration units) 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>
-----

===IC10 Schmitt Trigger - Sensor Range Based Device Toggle===
This script demonstrates the IC10 style Schmitt Trigger Pattern in basic examples using the <code>select</code> instruction with its ternary condition to toggle a device <code>On</code> state based on a range of sensor readings. Examples for both styles are provided below, i.e. 'cooling' or 'heating', for 'below min' or 'greater than max' style range-based toggle. A temperature based control is shown in the examples, but any sensor reading could be used to dynamically toggle a device <code>On</code> state such pressure, charge ratio, solar angle, etc.

<div class="mw-collapsible mw-collapsed" data-expandtext="{{int:Expand, IC10 Schmitt Trigger Pattern}}" data-collapsetext="{{int:Collapse, IC10 Schmitt Trigger Pattern}}">
{{ICCode|
# ---- IC10 Schmitt Trigger ----
# -- Standard - i.e. "cooling"

#When the temperature sensor device reports a value
# higher than TempMax and the valve is not On, the
# valve will turn On.

#When the valve is On, and the sensor device reports
# higher than TempMin, the valve will remain on.

#Once that sensor reports a temperature lower than
# TempMin, the valve will once again shut off and
# this cycle will continue indefinitely:

define TempMax 296.15 #23C
define TempMin 283.15 #10C

alias Valve d0
alias Sensor d1

example1:
yield
l r0 Valve On
select r0 r0 TempMin TempMax
l r1 Sensor Temperature
sgt r0 r1 r0
s Valve On r0
j example1

# ---- IC10 Schmitt Trigger ----
# -- Inverted - i.e. "heating"
#When the temperature sensor device reports a value
# lower than TempMin and the valve is not On, the
# valve will turn On.

#When the valve is On, and the sensor device reports
# lower than TempMax, the valve will remain on.

#Once that sensor reports a temperature higher than
# TempMax, the valve will once again shut off and
# this cycle will continue indefinitely:

define TempMax 296.15 #23C
define TempMin 283.15 #10C

alias Valve d0
alias Sensor d1

example2:
yield
l r0 Valve On
select r0 r0 TempMax TempMin
l r1 Sensor Temperature
slt r0 r1 r0
s Valve On r0
j example2

}}
</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.

===Push & Pop return address when calling multiple levels of functions===
More advanced scripts, or scripts that wish to be more generic, may want to allow calling more than one level of function. Allowing this requires pushing the current <code>ra</code> register before calling the function, then popping <code>ra</code> back afterward.

For example, imagine that the main loop of the code wants to call function <code>orientPanelsToStar</code>, which would calculate the panels' orientations, then place them in <code>r0</code> and <code>r1</code>, and then in turn itself call <code>orientPanelsTo</code>, which would set the orientations of all panels based on the precomputed values of <code>r0</code> and <code>r1</code>. Doing so requires <code>orientPanelsToStar</code> to push <code>ra</code> before calling <code>orientPanelsTo</code>, as show in the code below.

{{ICCode|
orientPanelsToStar:
# Save return address set by the 'jal' instruction
push ra

# ...Calculate panels' orientation, for example leaving the results in r0 and r1...

# Now call orientPanelsTo to actually set the panels' orientation
# based on the computed values of r0 and r1.
jal orientPanelsTo

# ...Call other functions here if desired...

# Restore the return address of orientPanelsToStar itself
pop ra
# Return to caller
j ra

##########

orientPanelsTo:
# ...Actually set panels' orientation...

# Return to caller
j ra
}}

This code would behave incorrectly if <code>push ra</code> and <code>pop ra</code> were not present: within <code>orientPanelsToStar</code>, doing <code>jal orientPanelsTo</code> would replace the current value of the <code>ra</code> register, permanently erasing where <code>orientPanelsToStar</code> itself should jump back to once done. Pushing and popping <code>ra</code> effectively saves its value until we need it again.

(A tempting but wrong approach to 'saving' <code>ra</code> would be to <code>move</code> it within a different register (e.g. <code>r15</code>) before calling <code>orientPanelsTo</code>, however that only permits two levels of functions, since if <code>orientPanelsTo</code> itself wants to call another function, it would not be able to use <code>r15</code> to save its <code>ra</code> register since <code>r15</code> already saves <code>orientPanelsToStar</code>'s return address. Just pushing/popping <code>ra</code> fixes all issues, allowing for a ginormous maximum function call depth of 512!)

As a last note, if the script will push/pop values like <code>ra</code>, starting the script by clearing the stack (which where push/pop move the data to) by running <code>clr db</code> is advisable, unless the IC10 chip is not inserted inside an IC Housing (e.g. inserted in the slot of an Air Conditioner), since <code>clr db</code> will cause an error in this case. To do so, run <code>clr db</code> before the script's main loop.

----

=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>

|}

IC10

2025-08-06T20:21:52Z

SemlerPDX: /* Examples */

[[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 on 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 screw.

* 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>

All hashes used in the game are CRC-32 checksums computed from the strings they represent.

'''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) || inf
|-
| 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==
The Stack is a memory that can hold 512 different values. Each IC10 has its own Stack, and some devices (like the Logical Sorter) also have a Stack.
;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

}}

==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.
}}

==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
}}

==Numeric values==
Registers and constants are usually decimal values using double-precision floating point (confirmed?).

Unlike real CPU architectures, integers are not supported as a distinct type, but double FP can represent integers up to about 54 bits before rounding causes problems (the exact number depending what bit patterns you happen to have).

Numbers can be written in hexadecimal by preceding the value with a $ symbol. Values larger than 54 bits might get corrupted. Hex numbers are typically used for ReferenceId values.

Examples:
{{ICCode|
move r0 12345
move r1 123.456
move r2 $E1B2
}}

==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
}}

== Dynamically changing LogicType when interacting with Device Registers ==
When the <code>l</code> or <code>s</code> instructions are used to read from or write to a Device Register, the LogicType is the variable that will be interacted with (example: in <code>l r0 myDevice Temperature</code> the LogicType is the Temperature). In most scripts the LogicType will be hardcoded. But it's also possible to change the LogicType dynamically. The LogicType is an enum, where each type is identified by a unique integer value. This makes it possible to cycle through them in various ways, either as a list placed on the Stack, or by increasing the LogicType value via addition in each loop.
{{ICCode|
#loop through a list of LogicTypes
push LogicType.RatioOxygen
push LogicType.RatioVolatiles
push LogicType.Temperature
loop:
pop r1
l r0 myDevice r1
...
bgtz sp loop #loop until the Stack is empty}}

==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>
{{ICCode|
#read all 8 channels with a loop and
#place the values in r0 to r7
move r15 LogicType.Channel0 #LogicType integer
move r14 0 #pointer for indirect referencing
loop:
l rr14 db:0 r15
add r15 r15 1 #next channel
add r14 r14 1 #next register
ble r15 LogicType.Channel7 loop
}}

==Logic gates, Bitwise and Logical==

All logic gates in MIPS have a bitwise behavior. The available gates are NOT, AND, OR, XOR and NOR (XNOR and NAND are missing).

In Bitwise operations, each bit is matched separately, which includes the sign bit.

To understand what is going on with bitwise operations, a little bit of computer theory is needed. In Stationeers each register uses 64 bits for integer values (a number without decimals), where the 64th bit is the sign-bit (0 for positive and 1 for negative). Since the number 0 is counted as a positive value, this gives each register a range of (2^63 - 1) to -2^63. Negative numbers also behave according to Two's complement (https://en.wikipedia.org/wiki/Two%27s_complement). Which means that a number with a sign-bit of 1 will have all of its number bits flipped as well, so that the decimal value of -1 is represented by a binary value of sixtyfour 1's (this is the smallest possible negative integer since zero counts as a positive integer).

MIPS have binary notation (https://en.wikipedia.org/wiki/Binary_number) that is activated by placing a % in front of the number. The _ characters are ignored and only used for readability.

<code>not r0 0</code><br>
<code># 0 = %00000000_00000000_00000000_00000000_00000000_00000000_00000000_00000000</code><br>
<code># flip all bits</code><br>
<code># -1 = %11111111_11111111_11111111_11111111_11111111_11111111_11111111_11111111</code><br>
<code># r0 equals -1</code>

<code>and r0 3 6</code><br>
<code># 3 = %011</code><br>
<code># 6 = %110</code><br>
<code># only the bits in the "2" position are matching</code><br>
<code># r0 equals %010 = 2</code>

Logical operations can still be performed via alternative instructions. But these are not perfect substitutes, they treat negative values differently, and some can produce non-binary outputs. When using these, keep in mind that devices that wants a binary value will treat any non-binary values like this: >= 1 counts as "1" and <1 counts as "0".

<code># r0 = result</code><br>
<code># r1 = input A</code><br>
<code># r2 = input B</code><br>

<code>Logical NOT = seqz r0 r1</code><br>
<code>Logical AND = min r0 r1 r2</code><br>
<code>Logical OR = max r0 r1 r2</code><br>

<code>Logical XOR = sne r0 r1 r2 (only for binary inputs)</code><br>
<code>Logical NAND = not and</code><br>
<code>Logical NOR = not or</code><br>
<code>Logical XNOR = not xor</code>

==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.

{{ICCode|
# get the average charge ratio across station batteries
lb r0 HASH("StructureBattery") Ratio Average
}}

{{ICCode|
# 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
}}

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 [[Labeller]]. It
can also allow you to control more than 6 devices.

=== Batch instructions ===

The batch instructions can address multiple devices only via their '''PrefabHash''' generated from the prefab name using the `HASH("Name")` macro or copied directly from the [[Stationpedia]]. A prefab hash is always an integer. All devices that can be read with logic contain the logic value '''PrefabHash''' and '''NameHash'''.

See [[#Slot.2FLogic_.2F_Batched|Batched instructions]] for a comprehensive list of all batch instructions.

[[#sb|sb]], [[#sbn|sbn]], [[#sbs|sbs]], (no sbns)<br>
[[#lb|lb]], [[#lbs|lbs]], [[#lbn|lbn]], [[#lbns|lbns]]

=== Direct reference instructions ===

Direct reference instructions can address a specific device via its '''ReferenceId'''.

[[#clrd|clrd]], [[#getd|getd]], [[#putd|putd]],<br>
[[#ld|ld]], [[#sd|sd]], (no slot access via reference ID)

=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/>
<span style="color:blue;">if 1 <= max(1.01, FLT_EPSILON * 8)</span>
<span style="color:#4c9700;">if 1 <= max(1.01, DBL_EPSILON * 8)</span>
<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 (exceptions exist such as filtration units) 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
----

===IC10 Schmitt Trigger - Sensor Range Based Device Toggle===
This script demonstrates the IC10 style Schmitt Trigger Pattern in basic examples using the <code>select</code> instruction with its ternary condition to toggle a device <code>On</code> state based on a range of sensor readings. Examples for both styles are provided below, i.e. 'cooling' or 'heating', for 'below min' or 'greater than max' style range-based toggle. A temperature based control is shown in the examples, but any sensor reading could be used to dynamically toggle a device <code>On</code> state such pressure, charge ratio, solar angle, etc.

<div class="mw-collapsible mw-collapsed" data-expandtext="{{int:Expand, IC10 Schmitt Trigger Pattern}}" data-collapsetext="{{int:Collapse, IC10 Schmitt Trigger Pattern}}">
{{ICCode|
# ---- IC10 Schmitt Trigger ----
# -- Standard - i.e. "cooling"

#When the temperature sensor device reports a value
# higher than TempMax and the valve is not On, the
# valve will turn On.

#When the valve is On, and the sensor device reports
# higher than TempMin, the valve will remain on.

#Once that sensor reports a temperature lower than
# TempMin, the valve will once again shut off and
# this cycle will continue indefinitely:

define TempMax 296.15 #23C
define TempMin 283.15 #10C

alias Valve d0
alias Sensor d1

example1:
yield
l r0 Valve On
select r0 r0 TempMin TempMax
l r1 Sensor Temperature
sgt r0 r1 r0
s Valve On r0
j example1

# ---- IC10 Schmitt Trigger ----
# -- Inverted - i.e. "heating"
#When the temperature sensor device reports a value
# lower than TempMin and the valve is not On, the
# valve will turn On.

#When the valve is On, and the sensor device reports
# lower than TempMax, the valve will remain on.

#Once that sensor reports a temperature higher than
# TempMax, the valve will once again shut off and
# this cycle will continue indefinitely:

define TempMax 296.15 #23C
define TempMin 283.15 #10C

alias Valve d0
alias Sensor d1

example2:
yield
l r0 Valve On
select r0 r0 TempMax TempMin
l r1 Sensor Temperature
slt r0 r1 r0
s Valve On r0
j example2

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

===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.

===Push & Pop return address when calling multiple levels of functions===
More advanced scripts, or scripts that wish to be more generic, may want to allow calling more than one level of function. Allowing this requires pushing the current <code>ra</code> register before calling the function, then popping <code>ra</code> back afterward.

For example, imagine that the main loop of the code wants to call function <code>orientPanelsToStar</code>, which would calculate the panels' orientations, then place them in <code>r0</code> and <code>r1</code>, and then in turn itself call <code>orientPanelsTo</code>, which would set the orientations of all panels based on the precomputed values of <code>r0</code> and <code>r1</code>. Doing so requires <code>orientPanelsToStar</code> to push <code>ra</code> before calling <code>orientPanelsTo</code>, as show in the code below.

{{ICCode|
orientPanelsToStar:
# Save return address set by the 'jal' instruction
push ra

# ...Calculate panels' orientation, for example leaving the results in r0 and r1...

# Now call orientPanelsTo to actually set the panels' orientation
# based on the computed values of r0 and r1.
jal orientPanelsTo

# ...Call other functions here if desired...

# Restore the return address of orientPanelsToStar itself
pop ra
# Return to caller
j ra

##########

orientPanelsTo:
# ...Actually set panels' orientation...

# Return to caller
j ra
}}

This code would behave incorrectly if <code>push ra</code> and <code>pop ra</code> were not present: within <code>orientPanelsToStar</code>, doing <code>jal orientPanelsTo</code> would replace the current value of the <code>ra</code> register, permanently erasing where <code>orientPanelsToStar</code> itself should jump back to once done. Pushing and popping <code>ra</code> effectively saves its value until we need it again.

(A tempting but wrong approach to 'saving' <code>ra</code> would be to <code>move</code> it within a different register (e.g. <code>r15</code>) before calling <code>orientPanelsTo</code>, however that only permits two levels of functions, since if <code>orientPanelsTo</code> itself wants to call another function, it would not be able to use <code>r15</code> to save its <code>ra</code> register since <code>r15</code> already saves <code>orientPanelsToStar</code>'s return address. Just pushing/popping <code>ra</code> fixes all issues, allowing for a ginormous maximum function call depth of 512!)

As a last note, if the script will push/pop values like <code>ra</code>, starting the script by clearing the stack (which where push/pop move the data to) by running <code>clr db</code> is advisable, unless the IC10 chip is not inserted inside an IC Housing (e.g. inserted in the slot of an Air Conditioner), since <code>clr db</code> will cause an error in this case. To do so, run <code>clr db</code> before the script's main loop.

----

=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>

|}

Guide (Filtration)

2025-02-16T08:04:21Z

SemlerPDX: Added 'see also' section header with link back to Air Filtration Systems page with diagrams

Place the Kit (Atmospherics) and change the variant to Filtration.<br>
Place [[filter]]s in the machine for what you want to filter out.<br>
There are three filtration pipe connections.<br>
Filtration Input is where you connect the incoming atmosphere to be passed through the Filtration Atmospherics.<br>
Filtration Waste is the remaining mix after extracting whatever the filters did.<br>
Filtration Output is the filtered material for which you placed filters in the machine for.<br>
If run without filters or the filters are exhausted, all input gases will be moved directly to waste.
<br>
=See Also=
* [[Air_Filtration_System]]

Guide (Filtration)

2025-02-16T08:01:02Z

SemlerPDX: Added 'see also' with link back to Air Filtration Systems page with diagrams

Air Filtration System

2025-02-16T07:43:19Z

SemlerPDX: Added new simplified filtration unit (scrubbing) example and diagram image

[[Category: Tutorials]]
<languages />
<translate>

This is an air filtration system that will scrub all bad gases from the air, place them in a tank and cool down the air at the same time. A second simplified system is listed below, which merely vents any gas not matching base air back to the world.


[[File:Filter system.png|thumb]]

=== Filter System (Dual) Items Used === 


* [[Active Vent]]
* [[Atmospherics|Atmospherics(Filtration)]]
* [[Filter|Filters (CO2, Pollutant, Volatiles)]]
* [[Passive Vent]]
* [[Pipes]]
* [[Pipe Meter]]
* [[Pipe Radiator]]
* [[Pipe Volume Pump]]
* [[Tank]]

<hr>

This is a more basic simplified air filtration system, which merely vents any gas not matching base air (Oxygen/Nitrogen) back to the world atmosphere.


[[File:Filter system BASIC.png|thumb]]

=== Filter System (Basic) Items Used === 


* [[Active Vent]]
* [[Atmospherics|Atmospherics(Filtration)]]
* [[Filter|Filters (Oxygen, Nitrogen)]]
* [[Pipe Valve|One Way Valve (Gas)]]
* [[Passive Vent]]
* [[Pipes]]
* [[Pipe Volume Pump]]
</translate>

File:Filter system BASIC.png

2025-02-16T07:20:37Z

SemlerPDX:

A more simplified basic filtration layout for scrubbing air in a base.