Stationeers Community Wiki - User contributions [en]

IC10

2023-09-04T00:10:36Z

2607:9000:2000:15:0:0:0:A45E: /* Solar Panel 2-axis tracking */ typo

[[Category:MIPS Programming]]
=MIPS scripting language for IC10 housings / chips=
MIPS is [[Stationeers]]' in-game scripting language. 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 algoritmic 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 convinent 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 decice register '''db''' is the device wherever the IC is mounted upon. Very convinent for atmospheric devices where no seperate IC socket is reguired.

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

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

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

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

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

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

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

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 [[MIPS#Device_Variables|Device Variables]].

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

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

==Stack Memory==
;push r?: adds the value of register '''r?''' to the stack memory at index '''sp''' 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?'''.

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:
<blockquote>
<nowiki />#this will traverse indices {min value} through {max value} - 1

move sp {min value}

loop:

add sp sp 1

peek r0
<nowiki />#do something here with your stack values (loaded into r0)

blt sp {max value} loop

<nowiki />#continue on

</blockquote>

Alternatively, you can use the pop function's decrementing to make a more efficient loop:

<blockquote>
move sp {max value}

add sp sp 1

loop:

pop r0

<nowiki />#do something here with your stack values (loaded into r0)

bgt sp {min value} loop

<nowiki />#continue on

</blockquote>

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

<code>l r0 d0 Temperature</code> #Reads the '''Temperature''' from an atmosphere sensor at device port '''d0''' into register '''r0'''.

<code>s d1 Setting r0 </code> # Writes the value of the register '''r0''' to the device on port '''d1''' into the variable '''Setting'''.

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

<br><code>main:</code> # define a jump mark with label '''main'''
<br><code>j main</code> # 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.
<br><code>define pi 3.14159</code> # defines a Constant with name '''pi''' and set it's value to 3.14159

You can use these constants like any other variables (see: alias in section [[MIPS#Instructions|Instructions]]). Example:
<br><code>move r0 pi</code> # set the value of register '''r0''' to the value of constant named '''pi'''.

==Indirect referencing==
This is a way of accessing a register by using another register as a pointer. Adding an additional r infront 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.

<code>move r0 5</code> stores the value 5 in r0
<br><code>move rr0 10</code> is now the same as <code>move r5 10</code> 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.
<br><code>move r1 2</code>
<br><code>move r2 3</code>
<br><code>move rrr1 4</code> is now the same as <code>move r3 4</code> since r1 points at r2 which points at r3

This also works with devices
<br><code>move r0 2</code> stores the value 2 in r0
<br><code>s dr0 On 1</code> is now the same as <code>s d2 On 1</code>, r0 has the value 2 so dr0 points at d2

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

<code> alias MyAlias r0 # Text after the hash tag will be ignored to the end of the line. </code> <br>
<code> # You can also write comments on their own lines, like this. </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 MIPS 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 MIPS==
MIPS 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 MIPS 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 minumum of 12.5 kPa pressure in the connected pipe)

----

=Instructions=
----

<div id="alias"></div>
;alias
:alias str r? d? # labels register or device reference with name. When alias is applied to a device, it will affect what shows on the screws in the IC base. (housing)
<code>alias vTemperature r0</code>
<br>
<code>alias dAutoHydro1 d0</code>

<div id="move"></div>
;move
:d s # stores the value of s in d
<code>move r0 42 # Store 42 in register 0</code>

<div id="l"></div>
<div id="load"></div>
;l (load)
:l r# d# parameter
Reads from a device (d#) and stores the value in a register (r#)

<code>l r0 d0 Setting</code><br>Read from the device on d0 into register 0

<code>l r1 d5 Pressure</code><br>Read the pressure from a sensor

This also works with aliases. For example:<br/>
<code>
alias Sensor d0 <br/>
l r0 Sensor Temperature
</code>

<div id="ls"></div>
<div id="load slot"></div>
;ls (load slot)
:ls r# d# slotNum parameter
Reads from a slot (slotNum) of a device (d#) and stores the value in a register (r#)

<code>ls r0 d0 2 Occupied</code><br>Read from the second slot of device on d0, stores 1 in r0 if it's occupied, 0 otherwise.

And here is the code to read the charge of an AIMeE:<br/>
<code>
alias robot d0 <br/>
alias charge r0 <br/>
ls charge robot 0 Charge
</code>

<div id="s"></div>
<div id="set"></div>
;s (set)
:s d# parameter r#
Writes a setting to a device.

<code>s d0 Setting r0</code>

<div id="add"></div>
;add
:d s t # calculates s + t and stores the result in d
<code>add r0 r1 1 # add 1 to r1 and store the result as r0</code>
<br>
<code>add r0 r0 1 # increment r0 by one</code>
<div id="sub"></div>
;sub
:d s t # calculates s - t and stores the result in d
<div id="mul"></div>
;mul
:d s t # calculates s * t and stores the result in d
<div id="div"></div>
;div
:d s t # calculates s / t and stores the result in d
<div id="mod"></div>
;mod
:d s t
::# calculates s mod t and stores the result in d. Note this
::# doesn't behave like the % operator - the result will be
::# positive even if the either of the operands are negative

<div id="slt"></div>
;slt
:d s t # stores 1 in d if s < t, 0 otherwise

<div id="sqrt"></div>
;sqrt
:d s # calculates sqrt(s) and stores the result in d
<div id="round"></div>
;round
:d s # finds the rounded value of s and stores the result in d
<div id="trunc"></div>
;trunc
:d s # finds the truncated value of s and stores the result in d
<div id="ceil"></div>
;ceil
: d s # calculates the ceiling of s and stores the result in d
<div id="floor"></div>
;floor
: d s # calculates the floor of s and stores the result in d

<div id="max"></div>
;max
: d s t # calculates the maximum of s and t and stores the result in d
<div id="min"></div>
;min
: d s t # calculates the minimum of s and t and stores the result in d
<div id="abs"></div>
;abs
: d s # calculates the absolute value of s and stores the result in d
<div id="log"></div>
;log
: d s # calculates the natural logarithm of s and stores the result
::# in d
<div id="exp"></div>
;exp
: d s # calculates the exponential of s and stores the result in d
<div id="rand"></div>
;rand
: d # selects a random number uniformly at random between 0 and 1
::# inclusive and stores the result in d

::# boolean arithmetic uses the C convention that 0 is false and any non-zero
::# value is true.
<div id="and"></div>
;and
: d s t # stores 1 in d if both s and t have non-zero values,
::# 0 otherwise
<div id="or"></div>
;or
: d s t # stores 1 in d if either s or t have non-zero values,
::# 0 otherwise
<div id="xor"></div>
;xor
: d s t # stores 1 in d if exactly one of s and t are non-zero,
::# 0 otherwise
<div id="nor"></div>
;nor
: d s t # stores 1 in d if both s and t equal zero, 0 otherwise
::# Lines are numbered starting at zero
<div id="j"></div>
;j
: a # jumps to line a.
<div id="bltz"></div>
;bltz
: s a # jumps to line a if s < 0
<div id="blez"></div>
;blez
: s a # jumps to line a if s <= 0

<div id="bgez"></div>
;bgez
: s a # jumps to line a if s >= 0
<div id="bgtz"></div>
;bgtz
: s a # jumps to line a if s > 0
<div id="beq"></div>
;beq
: s t a # jumps to line a if s == t
<div id="bne"></div>
;bne
: s t a # jumps to line a if s != t
<div id="bdseal"></div>
;bdseal
: d? a(r?|num) # Jump execution to line a and store current line number if device d? is set.
<code>bdseal d0 32 #Store line number and jump to line 32 if d0 is assigned.</code>
<BR>
<code>bdseal dThisVictim HarvestCrop #Store line in ra and jump to sub HarvestCrop if device dThisVictim is assigned.</code>

<div id="yield"></div>
;yield
: # ceases code execution for this power tick

<div id="lb"></div>
;lb
: r? deviceHash logicType batchMode # Loads LogicType from all output network devices with the provided type hash using the provided batch mode. Average (0), Sum (1), Minimum (2), Maximum (3). Can use either the word, or the number. The result is stored into r?.

<div id="sb"></div>
;sb
: deviceHash logicType r? # Stores the register value to LogicType on all output network devices with the provided type hash.

<div id="lbn"></div>
;lbn
: r? deviceHash nameHash logicType batchMode # Loads LogicType from all output network devices with the provided type and name hashes using provided batch mode. Average(0), Sum (1), Minimum (2), Maximum (3). Can use either the word, or the number. The result is stored into r?.

<div id="sbn"></div>
;sbn
: deviceHash nameHash logicType r? # Stores the register value to LogicType on all output network devices with the provided type and name hashes.

<div id="#"></div>
; #
: # The following text will be ignored during compiling; use this to create comments.

[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
|-
| -dns || if device d is not set || bdns || bdnsal || brdns || sdns
|-
| -dse || if device d is set || bdse || bdseal || brdse || sdse
|-
| -ap || if a approximately equals b || bap || bapal || brap || sap
|-
| -apz || if a approximately equals 0 || bapz || bapzal || brapz || sapz
|-
| -na || if a not approximately equals b || bna || bnaal || brna || sna
|-
| -naz || if a not approximately equals 0 || bnaz || bnazal || brnaz || snaz
|}

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

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

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

==Device Variables==
-----

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

<div id="AirRelease"></div>
;AirRelease
<div id="Charge"></div>
;Charge
: The current charge the device has.
<div id="CLearMemory"></div>
;ClearMemory
: When set to 1, clears the counter memory (e.g. ExportCount). Will set itself back to 0 when triggered.
<div id="Color"></div>
;Color
: <span style="color:blue;">▇▇▇</span>  0 (or lower) = Blue
: <span style="color:grey;">▇▇▇</span> 1 = Grey
: <span style="color:green;">▇▇▇</span> 2 = Green
: <span style="color:orange;">▇▇▇</span> 3 = Orange
: <span style="color:red;">▇▇▇</span> 4 = Red
: <span style="color:yellow;">▇▇▇</span> 5 = Yellow
: <span style="color:white;">▇▇▇</span> 6 = White
: <span style="color:black;">▇▇▇</span> 7 = Black
: <span style="color:brown;">▇▇▇</span> 8 = Brown
: <span style="color:khaki;">▇▇▇</span> 9 = Khaki
: <span style="color:pink;">▇▇▇</span> 10 = Pink
: <span style="color:purple;">▇▇▇</span> 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>
;RequestHash
<div id="RequiredPower"></div>
;RequiredPower
<div id="Setting"></div>
;Setting
<div id="SolarAngle"></div>
;SolarAngle
: Solar angle of the device.
: <code>l r0 d0 SolarAngle # Sets r0 to the solar angle of d0.</code>
<div id="Temperature"></div>
;Temperature
<div id="TemperatureSettings"></div>
;TemperatureSettings
<div id="TotalMoles"></div>
;TotalMoles
<div id="VelocityMagnitude"></div>
;VelocityMagnitude
<div id="VelocityRelativeX"></div>
;VelocityRelativeX
<div id="VelocityRelativeY"></div>
;VelocityRelativeY
<div id="VelocityRelativeZ"></div>
;VelocityRelativeZ
<div id="Vertical"></div>
;Vertical
: Vertical setting of the device.
<div id="VerticalRatio"></div>
;VerticalRatio
: Ratio of vertical setting for device.
<div id="Volume"></div>
;Volume
: Returns the device atmosphere volume

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

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

<div id="Mature"></div>
;Mature
:<code>ls r0 d0 0 Mature # Store 1 in r0 if d0 has a mature crop</code>
:<code>ls vMature dThisVictim 0 Mature # Store 1 in vMature if dThisVictim has a mature crop</code>

----

=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}}">
<pre>
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 ###

</pre>
</div>
<br>
-----

===Solar Panel 2-axis tracking===
This script was copied from the [[Solar_Logic_Circuits_Guide]] (code provided by bti, comments and readability changes by Fudd79)
<div class="mw-collapsible mw-collapsed" data-expandtext="{{int:Expand, Solar Panel 2-axis tracking}}" data-collapsetext="{{int:Collapse, Solar Panel 2-axis tracking}}">
<pre>
# This code assumes the following:
# Daylight Sensor data-port points north
# Solar Panel data-port points east

alias sensor d0
alias v_angle r0
alias h_angle r1
alias sun_up r2

define solar_panel_hash -539224550
define heavy_solar_panel_hash -1545574413

start:
# Check to see if sun is up
l sun_up sensor Activate
# Go to reset if it's not
beqz sun_up reset

# Calculate vertical angle
l v_angle sensor Vertical
div v_angle v_angle 1.5
sub v_angle 50 v_angle

# Write vertical angle to all solar panels
sb solar_panel_hash Vertical v_angle
sb heavy_solar_panel_hash Vertical v_angle

# Obtain horizontal angle
l h_angle sensor Horizontal

# Write horizontal angle to all solar panels
sb solar_panel_hash Horizontal h_angle
sb heavy_solar_panel_hash Horizontal h_angle

# Go to start again
yield
j start

reset:
# Park solar panels vertically facing sunrise
sb solar_panel_hash Vertical 0
sb heavy_solar_panel_hash Vertical 0
# Park solar panels horizontally facing sunrise
sb solar_panel_hash Horizontal -90
sb heavy_solar_panel_hash Horizontal -90
# Wait 10 seconds
sleep 10
# Go to start again
j start

### End Script ###

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

<pre>
move r0 1 #the first line has number 0
add r0 r0 3
s db Setting r0
j 1
</pre>

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

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

----
=Links=
----
* [https://stationeering.com/tools/ic] Stationeering.com offers a programmable circuits simulator so you can develop your code without repeatedly dying in game!
* [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://pastebin.com/3kmGy0NN] syntax highlighting for IC10 MIPS for Notepad++ (updated: 05/05/2021)
* [https://drive.google.com/file/d/1Xrv5U0ZI5jDcPv7yX7EAAxaGk5hKP0xO/view?usp=sharing] syntax highlighting for IC10 MIPS for Notepad++ (updated: 11/08/2022)

----

=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

2023-09-03T21:33:03Z

2607:9000:2000:15:0:0:0:A45E: /* IO to Device registers */ typo

[[Category:MIPS Programming]]
=MIPS scripting language for IC10 housings / chips=
MIPS is [[Stationeers]]' in-game scripting language. 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 algoritmic 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 convinent 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 decice register '''db''' is the device wherever the IC is mounted upon. Very convinent for atmospheric devices where no seperate IC socket is reguired.

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

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

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

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

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

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

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

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 [[MIPS#Device_Variables|Device Variables]].

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

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

==Stack Memory==
;push r?: adds the value of register '''r?''' to the stack memory at index '''sp''' 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?'''.

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:
<blockquote>
<nowiki />#this will traverse indices {min value} through {max value} - 1

move sp {min value}

loop:

add sp sp 1

peek r0
<nowiki />#do something here with your stack values (loaded into r0)

blt sp {max value} loop

<nowiki />#continue on

</blockquote>

Alternatively, you can use the pop function's decrementing to make a more efficient loop:

<blockquote>
move sp {max value}

add sp sp 1

loop:

pop r0

<nowiki />#do something here with your stack values (loaded into r0)

bgt sp {min value} loop

<nowiki />#continue on

</blockquote>

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

<code>l r0 d0 Temperature</code> #Reads the '''Temperature''' from an atmosphere sensor at device port '''d0''' into register '''r0'''.

<code>s d1 Setting r0 </code> # Writes the value of the register '''r0''' to the device on port '''d1''' into the variable '''Setting'''.

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

<br><code>main:</code> # define a jump mark with label '''main'''
<br><code>j main</code> # 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.
<br><code>define pi 3.14159</code> # defines a Constant with name '''pi''' and set it's value to 3.14159

You can use these constants like any other variables (see: alias in section [[MIPS#Instructions|Instructions]]). Example:
<br><code>move r0 pi</code> # set the value of register '''r0''' to the value of constant named '''pi'''.

==Indirect referencing==
This is a way of accessing a register by using another register as a pointer. Adding an additional r infront 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.

<code>move r0 5</code> stores the value 5 in r0
<br><code>move rr0 10</code> is now the same as <code>move r5 10</code> 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.
<br><code>move r1 2</code>
<br><code>move r2 3</code>
<br><code>move rrr1 4</code> is now the same as <code>move r3 4</code> since r1 points at r2 which points at r3

This also works with devices
<br><code>move r0 2</code> stores the value 2 in r0
<br><code>s dr0 On 1</code> is now the same as <code>s d2 On 1</code>, r0 has the value 2 so dr0 points at d2

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

<code> alias MyAlias r0 # Text after the hash tag will be ignored to the end of the line. </code> <br>
<code> # You can also write comments on their own lines, like this. </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 MIPS 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 MIPS==
MIPS 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 MIPS 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 minumum of 12.5 kPa pressure in the connected pipe)

----

=Instructions=
----

<div id="alias"></div>
;alias
:alias str r? d? # labels register or device reference with name. When alias is applied to a device, it will affect what shows on the screws in the IC base. (housing)
<code>alias vTemperature r0</code>
<br>
<code>alias dAutoHydro1 d0</code>

<div id="move"></div>
;move
:d s # stores the value of s in d
<code>move r0 42 # Store 42 in register 0</code>

<div id="l"></div>
<div id="load"></div>
;l (load)
:l r# d# parameter
Reads from a device (d#) and stores the value in a register (r#)

<code>l r0 d0 Setting</code><br>Read from the device on d0 into register 0

<code>l r1 d5 Pressure</code><br>Read the pressure from a sensor

This also works with aliases. For example:<br/>
<code>
alias Sensor d0 <br/>
l r0 Sensor Temperature
</code>

<div id="ls"></div>
<div id="load slot"></div>
;ls (load slot)
:ls r# d# slotNum parameter
Reads from a slot (slotNum) of a device (d#) and stores the value in a register (r#)

<code>ls r0 d0 2 Occupied</code><br>Read from the second slot of device on d0, stores 1 in r0 if it's occupied, 0 otherwise.

And here is the code to read the charge of an AIMeE:<br/>
<code>
alias robot d0 <br/>
alias charge r0 <br/>
ls charge robot 0 Charge
</code>

<div id="s"></div>
<div id="set"></div>
;s (set)
:s d# parameter r#
Writes a setting to a device.

<code>s d0 Setting r0</code>

<div id="add"></div>
;add
:d s t # calculates s + t and stores the result in d
<code>add r0 r1 1 # add 1 to r1 and store the result as r0</code>
<br>
<code>add r0 r0 1 # increment r0 by one</code>
<div id="sub"></div>
;sub
:d s t # calculates s - t and stores the result in d
<div id="mul"></div>
;mul
:d s t # calculates s * t and stores the result in d
<div id="div"></div>
;div
:d s t # calculates s / t and stores the result in d
<div id="mod"></div>
;mod
:d s t
::# calculates s mod t and stores the result in d. Note this
::# doesn't behave like the % operator - the result will be
::# positive even if the either of the operands are negative

<div id="slt"></div>
;slt
:d s t # stores 1 in d if s < t, 0 otherwise

<div id="sqrt"></div>
;sqrt
:d s # calculates sqrt(s) and stores the result in d
<div id="round"></div>
;round
:d s # finds the rounded value of s and stores the result in d
<div id="trunc"></div>
;trunc
:d s # finds the truncated value of s and stores the result in d
<div id="ceil"></div>
;ceil
: d s # calculates the ceiling of s and stores the result in d
<div id="floor"></div>
;floor
: d s # calculates the floor of s and stores the result in d

<div id="max"></div>
;max
: d s t # calculates the maximum of s and t and stores the result in d
<div id="min"></div>
;min
: d s t # calculates the minimum of s and t and stores the result in d
<div id="abs"></div>
;abs
: d s # calculates the absolute value of s and stores the result in d
<div id="log"></div>
;log
: d s # calculates the natural logarithm of s and stores the result
::# in d
<div id="exp"></div>
;exp
: d s # calculates the exponential of s and stores the result in d
<div id="rand"></div>
;rand
: d # selects a random number uniformly at random between 0 and 1
::# inclusive and stores the result in d

::# boolean arithmetic uses the C convention that 0 is false and any non-zero
::# value is true.
<div id="and"></div>
;and
: d s t # stores 1 in d if both s and t have non-zero values,
::# 0 otherwise
<div id="or"></div>
;or
: d s t # stores 1 in d if either s or t have non-zero values,
::# 0 otherwise
<div id="xor"></div>
;xor
: d s t # stores 1 in d if exactly one of s and t are non-zero,
::# 0 otherwise
<div id="nor"></div>
;nor
: d s t # stores 1 in d if both s and t equal zero, 0 otherwise
::# Lines are numbered starting at zero
<div id="j"></div>
;j
: a # jumps to line a.
<div id="bltz"></div>
;bltz
: s a # jumps to line a if s < 0
<div id="blez"></div>
;blez
: s a # jumps to line a if s <= 0

<div id="bgez"></div>
;bgez
: s a # jumps to line a if s >= 0
<div id="bgtz"></div>
;bgtz
: s a # jumps to line a if s > 0
<div id="beq"></div>
;beq
: s t a # jumps to line a if s == t
<div id="bne"></div>
;bne
: s t a # jumps to line a if s != t
<div id="bdseal"></div>
;bdseal
: d? a(r?|num) # Jump execution to line a and store current line number if device d? is set.
<code>bdseal d0 32 #Store line number and jump to line 32 if d0 is assigned.</code>
<BR>
<code>bdseal dThisVictim HarvestCrop #Store line in ra and jump to sub HarvestCrop if device dThisVictim is assigned.</code>

<div id="yield"></div>
;yield
: # ceases code execution for this power tick

<div id="lb"></div>
;lb
: r? deviceHash logicType batchMode # Loads LogicType from all output network devices with the provided type hash using the provided batch mode. Average (0), Sum (1), Minimum (2), Maximum (3). Can use either the word, or the number. The result is stored into r?.

<div id="sb"></div>
;sb
: deviceHash logicType r? # Stores the register value to LogicType on all output network devices with the provided type hash.

<div id="lbn"></div>
;lbn
: r? deviceHash nameHash logicType batchMode # Loads LogicType from all output network devices with the provided type and name hashes using provided batch mode. Average(0), Sum (1), Minimum (2), Maximum (3). Can use either the word, or the number. The result is stored into r?.

<div id="sbn"></div>
;sbn
: deviceHash nameHash logicType r? # Stores the register value to LogicType on all output network devices with the provided type and name hashes.

<div id="#"></div>
; #
: # The following text will be ignored during compiling; use this to create comments.

[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
|-
| -dns || if device d is not set || bdns || bdnsal || brdns || sdns
|-
| -dse || if device d is set || bdse || bdseal || brdse || sdse
|-
| -ap || if a approximately equals b || bap || bapal || brap || sap
|-
| -apz || if a approximately equals 0 || bapz || bapzal || brapz || sapz
|-
| -na || if a not approximately equals b || bna || bnaal || brna || sna
|-
| -naz || if a not approximately equals 0 || bnaz || bnazal || brnaz || snaz
|}

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

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

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

==Device Variables==
-----

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

<div id="AirRelease"></div>
;AirRelease
<div id="Charge"></div>
;Charge
: The current charge the device has.
<div id="CLearMemory"></div>
;ClearMemory
: When set to 1, clears the counter memory (e.g. ExportCount). Will set itself back to 0 when triggered.
<div id="Color"></div>
;Color
: <span style="color:blue;">▇▇▇</span>  0 (or lower) = Blue
: <span style="color:grey;">▇▇▇</span> 1 = Grey
: <span style="color:green;">▇▇▇</span> 2 = Green
: <span style="color:orange;">▇▇▇</span> 3 = Orange
: <span style="color:red;">▇▇▇</span> 4 = Red
: <span style="color:yellow;">▇▇▇</span> 5 = Yellow
: <span style="color:white;">▇▇▇</span> 6 = White
: <span style="color:black;">▇▇▇</span> 7 = Black
: <span style="color:brown;">▇▇▇</span> 8 = Brown
: <span style="color:khaki;">▇▇▇</span> 9 = Khaki
: <span style="color:pink;">▇▇▇</span> 10 = Pink
: <span style="color:purple;">▇▇▇</span> 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>
;RequestHash
<div id="RequiredPower"></div>
;RequiredPower
<div id="Setting"></div>
;Setting
<div id="SolarAngle"></div>
;SolarAngle
: Solar angle of the device.
: <code>l r0 d0 SolarAngle # Sets r0 to the solar angle of d0.</code>
<div id="Temperature"></div>
;Temperature
<div id="TemperatureSettings"></div>
;TemperatureSettings
<div id="TotalMoles"></div>
;TotalMoles
<div id="VelocityMagnitude"></div>
;VelocityMagnitude
<div id="VelocityRelativeX"></div>
;VelocityRelativeX
<div id="VelocityRelativeY"></div>
;VelocityRelativeY
<div id="VelocityRelativeZ"></div>
;VelocityRelativeZ
<div id="Vertical"></div>
;Vertical
: Vertical setting of the device.
<div id="VerticalRatio"></div>
;VerticalRatio
: Ratio of vertical setting for device.
<div id="Volume"></div>
;Volume
: Returns the device atmosphere volume

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

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

<div id="Mature"></div>
;Mature
:<code>ls r0 d0 0 Mature # Store 1 in r0 if d0 has a mature crop</code>
:<code>ls vMature dThisVictim 0 Mature # Store 1 in vMature if dThisVictim has a mature crop</code>

----

=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}}">
<pre>
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 ###

</pre>
</div>
<br>
-----

===Solar Panel 2-axis tracking===
This script was copied from the [[Solar_Logic_Circuits_Guide]] (code provided by bti, comments and readability changes by Fudd79)
<div class="mw-collapsible mw-collapsed" data-expandtext="{{int:Expand, Solar Panel 2-axis tracking}}" data-collapsetext="{{int:Collapse, Solar Panel 2-axis tracking}}">
<pre>
# This code assumes the following:
# Daylight Sensor data-port points north
# Solar Panel data-port points east

alias sensor d0
alias v_angle r0
alias h_angle r1
alias sun_up r2

define solar_panel_hash -539224550
define heavy_solar_panel_hash -1545574413

start:
# Check to see if sun is up
l sun_up sensor Activate
# Go to reset if it's not
beqz sun_up reset

# Calculate vertical angle
l v_angle sensor Vertical
div v_angle v_angle 1.5
sub v_angle 50 v_angle

# Write vertical angle to all solar panels
sb solar_panel_hash Vertical v_angle
sb heavy_solar_panel_hash Vertical v_angle

# Obtain horizontal angle
l h_angle sensor Horizontal

# Write vertical angle to all solar panels
sb solar_panel_hash Horizontal h_angle
sb heavy_solar_panel_hash Horizontal h_angle

# Go to start again
yield
j start

reset:
# Park solar panels vertically facing sunrise
sb solar_panel_hash Vertical 0
sb heavy_solar_panel_hash Vertical 0
# Park solar panels horizontally facing sunrise
sb solar_panel_hash Horizontal -90
sb heavy_solar_panel_hash Horizontal -90
# Wait 10 seconds
sleep 10
# Go to start again
j start

### End Script ###

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

<pre>
move r0 1 #the first line has number 0
add r0 r0 3
s db Setting r0
j 1
</pre>

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

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

----
=Links=
----
* [https://stationeering.com/tools/ic] Stationeering.com offers a programmable circuits simulator so you can develop your code without repeatedly dying in game!
* [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://pastebin.com/3kmGy0NN] syntax highlighting for IC10 MIPS for Notepad++ (updated: 05/05/2021)
* [https://drive.google.com/file/d/1Xrv5U0ZI5jDcPv7yX7EAAxaGk5hKP0xO/view?usp=sharing] syntax highlighting for IC10 MIPS for Notepad++ (updated: 11/08/2022)

----

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

|}

Pipe Volume Pump

2023-09-03T14:22:09Z

2607:9000:2000:15:0:0:0:A45E: valve only goes up to 10 in-game

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

{{Itembox
| name = Pipe Volume Pump
| image = [[File:ItemPipeVolumePump.png]]
| stacks = 5
| createdwith = [[Hydraulic Pipe Bender]], [[Fabricator]]
| cost = 5g [[Iron]], 2g [[Gold]], 3g [[Copper]]
}}

== Description == 


Used to pump gasses throughout a pipe, featuring an adjustable valve 0-10 Liters and requiring power (2W per Liter). All the gasses in the pipes behind it will be completely pushed in front of it when powered, and blocks any flow of gasses in either direction when unpowered.

Note that valve settings are for the rate at which the pump operates, in volume per tick (0.5 seconds).

To calculate the moles per tick, use the following equation:
n = (P * V) / (R * T)

Where:
* P = Input pressure
* V = The volume you set
* n = Moles per tick
* R = Gas constant (8.3144)
* T = Input temperature (in Kelvin)

{{Data Network Header}}

{{Data Parameters}}
{| class="wikitable"
|-
! Parameter Name !! Data Type !! Description
|-
| Lock || Boolean ||
|-
| Setting || Integer || Sets the flow rate between 0 - 100 Liters
|-
| On || Boolean ||
|-
|}

{{Data Outputs}}
{| class="wikitable"
|-
! Output Name !! Data Type !! Description
|-
| Maximum ||
|-
| Lock || Boolean ||
|-
| Error ||
|-
| Setting ||
|-
| RequiredPower ||
|-
| Ratio ||
|-
| PrefabHash ||
|-
| Power ||
|-
| On ||
|}
</translate>

Guide (Airlock) Atmosphere to Atmosphere

2023-09-03T14:20:15Z

2607:9000:2000:15:0:0:0:A45E: /* Troubleshooting */ typo

[[Category:Guides]][[Category:Atmospherics]]
<languages/>
<translate>
==Description==
An Atmosphere to Atmosphere Airlock is a [[Room]] that can evacuate its internal volume and refill it with either of the two differing [[Atmosphere]]s it connects. It has two airtight [[Portal]]s which do not open simultaneously. An Atmosphere to Atmosphere Airlock allows passage between two environments without the exchange of [[Gas]]es or [[Pressure]].

An Atmosphere to Atmosphere Airlock can be controlled automatically using a [[Circuitboard (Advanced Airlock)]] installed within a [[Console]] which will refer to each of the two separated environments as either "interior" or "exterior".

When activated with the interior-portal open, the system will automatically close the interior-portal and will activate the interior-[[Active Vent|Active-Vent]] to try to evacuate the interior-atmosphere from the airlock chamber. Once a total vacuum is achieved within all of the [[Large Grid Atmosphere|Large Grid Volume]]s in which selected [[Gas Sensor]]s reside, the airlock will activate the exterior-Active-Vent to try to pressurize the chamber with exterior-atmosphere. Only after the internal pressure within all of the Large Grid Volumes in which selected Gas Sensors reside equals or exceeds the "External ###Pa" specified in the [[Circuitboard (Advanced Airlock)#Settings|Circuitboard's settings]] will the exterior-portal automatically open.

When activated with the exterior-portal open, a similar process to the above is executed, swapping interior for exterior, exterior for interior, and the final airlock pressure governed by the "Internal ###Pa" setting instead.

==Materials==
Material requirements for a minimnum Atmosphere to Atmosphere Airlock are:
* 2 x [[Portal]]: variants of either [[Kit (Airlock)]], [[Kit (Blast Door)]], [[Kit (Door)]], or [[Kit (Docking Port)]]
* 1 x [[Kit (Consoles) Console|Kit (Consoles) Console]]
* 1 x [[Circuitboard (Advanced Airlock)]]
* 1 x [[Glass Sheets]]
* 1 x [[Data Disk]]
* 1 x [[Kit (Sensors) Gas Sensor]]
* 2 x [[Kit (Active Vent)]]
* 2 x [[Kit (Passive Vent)]] (optional)
* 1 x [[Kit (Flashing Light)]] (optional)
* 1 x [[Kit (Power Controller)]] (optional)
* 4 x [[Kit (Pipe)]]
* # x [[Cable Coil]]

==Construction==
A minimum Atmosphere to Atmosphere Airlock can be constructed using the following instructions:

# Place two [[Portal]]s one [[Large Grid]] apart with the power and data ports facing into the airlock's interior.
# Using the [[Labeller]], rename each portal as "Interior-Door" and "Exterior-Door" appropriately.
# Ensure the "Exterior-Door" is OPEN, and the "Interior-Door" is CLOSED.
# Enclose the four remaining sides of the airlock chamber with airtight [[Frames]], [[Walls]], or [[Windows]].
# Place [[Console]], [[Active Vent]]s, [[Gas Sensor]], and optional [[Flashing Light]] and [[Power Controller]] somewhere within the airlock's interior.
# Ensure all placed devices are attached to the same [[Wire Network]] including the portals' power and data ports.
# Ensure the airlock's wire network is connected to an active [[Power Supply]] and all devices can receive power.
# Using the Labeller, rename each Active Vent as "Interior Vent" and "Exterior Vent" appropriately.
# Attach a [[Pipe Network]] to each Active Vent large enough to hold the volume of the airlock or pass it through to a [[Passive Vent]] placed in the "interior" or "exterior" environment.
# Ensure "interior" and "exterior" pipe networks are not connected together or to any other pipe networks.[[File:Guide adv airlock bare.jpg|thumb|advanced airlock with 2 walls removed for better visibility]]
# Insert [[Circuitboard (Advanced Airlock)]] into the console, then place the [[Glass Sheet]] onto the console.
# Insert [[Data Disk]] into the side slot of Console then power on the Console.[[File:Guide adv airlock config0.png|thumb|slot to insert data disk]]
# '''The following steps may be done with the game paused.'''
# Use the console's up and down arrows to scroll through the list of devices. Click to select. Click again to deselect if incorrect
# Find and click "Exterior-Door" followed by all caps and green "EXTERIOR". NOTE: SELECT THIS FIRST![[File:Guide adv airlock config1.png|thumb|make sure to click the exterior door and vent first]]
# Ensure the Exterior-Door's lock-indicator has turned from green to red.
# Find and click "Exterior-Vent" followed by all caps and green "EXTERIOR". NOTE: SELECT THIS SECOND!
# Find and click "Interior-Door" followed by all caps and green "INTERIOR".
# Ensure the Interior-Door's lock-indicator has turned from green to red.
# Find and click "Interior-Vent" followed by all caps and green "INTERIOR".
# Find and click "Gas Sensor" followed by all caps and green "SENSOR".
# Find and click "Flashing Light" followed by all caps and green "LIGHT". (optional)
# Toward the top left of the Console find and click "External ###Pa". Set to match the exterior-environment's typical pressure. (optional)
# Toward the top right of the Console find and click "Internal ###Pa". Set to match the interior-environment's typical pressure. (optional)[[File:Guide adv airlock config3.png|thumb|set pressures appropriate to each side]]
# Remove Data Disk from the side slot of Console.
<br>If there is an error the console screen will say so and the power light will flash yellow.

==Console Slaves==
Additional consoles are useful when airlocks become large or remote control is desired. Multiple [[Circuitboard (Advanced Airlock)#Console Slave|Console Slave]]s can be attached using the following instructions:

# Using the [[Labeller]], rename the original [[Console]] as "Master Console".
# Place additional consoles such that they all attached to the same [[Wire Network]] connected to the "Master Console".
# Using the Labeller, rename each additional console as "Slave Console 1", "Slave Console 2" ...
# Insert [[Circuitboard (Advanced Airlock)]] into each additional console, then place a [[Glass Sheet]] onto the additional consoles.
# Insert [[Data Disk]] into the side slot of the powered on "Master Console".
# Use the "Master Console's" up and down arrows to scroll through the list of devices. Click to select. Click again to deselect if incorrect
# Find and click "Slave Console #" followed by all caps and green "MAKE SLAVE" for each additional console.
# Remove Data Disk from the side slot of "Master Console".
# Power on each additional console.
<br>If there is an error the console screen will say so and the power light will flash yellow.

==Troubleshooting==
When powered, all associated doors and vents are locked, preventing their manual use even when power is subsequently denied. This can be a problem when trapped within an airlock during a power outage. Best practise is to ensure the airlock's wire network is connected to an emergency [[Power Supply]] such as a [[Battery Cell]] equipped [[Power Controller]].

If the "External #Pa" or "Internal #Pa" are set to 0, the corresponding pressurization phase will be skipped, speeding up the cycle time, but can result in large wind currents when doors open.

A pressurization phase will stall if there is not enough gas available to the interior or exterior [[Active Vent]] to reach the set "Internal #Pa" or "External #Pa" specified in the [[Circuitboard (Advanced Airlock)#Settings|Circuitboard's settings]]. Such stalled pressurization can be skipped by clicking the yellow "Cancel Pressurize" button on a console.

A depressurization phase will stall if a complete vacuum cannot be achieved within the [[Large Grid Atmosphere|Large Grid Volume]]s in which all selected [[Gas Sensor]]s reside. Such stalled depressurization can be skipped by clicking the yellow "Cancel Depressurize" button on a console, but atmospheric mixing may occur. In larger airlocks, ensure there is one Gas Sensor per Large Grid to prevent premature repressurization and the resulting mixture of interior and exterior atmospheres.

The setup of slave consoles <em>may</em> still be bugged in such a way that after initial setup the slave console will show the config of an airlock, but be grayed out and not accept any input. It has been noted in several community posts that saving the game, quitting out of the game, and then reloading the save will allow the slave consoles to work after the reload.

==See Also==
* [[Guide (Airlock)]]
* [[Guide (Airlock) Atmosphere to Vacuum]]
* [[Guide (Airlock) Docking Ports]]

* [[Circuitboard (Advanced Airlock)]]
* [[Circuitboard (Airlock)]]
* [[Kit (Airlock)]]
</translate>

Talk:Mars

2023-09-03T12:47:05Z

2607:9000:2000:15:0:0:0:A45E: page is entirely wrong

None of the information here matches whats on https://stationeers-wiki.com/Worlds

Which one is correct? They should be fixed