IC10

2020-12-23T17:35:29Z

90.213.59.36: typo corrected in Device Vaariables section ('of' to 'if)

[[Category:MIPS Programming]]
=MIPS scripting language for IC10 housings / chips=

<pre>
# Text after a # will be ignored to the end of the line. The amount of white
# space between arguments isn't important, but new lines start a new command.
</pre>

<br>
==Functions==
----

<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="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="#"></div>
; #
: # The following text will be ignored during compiling; use this to create comments.

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

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

====This example script automates autohydro units and powers the lights off during the day when they're not needed. (Hit Expand)====
Uses aliases, sub-routines and comments to minimize lines of code and adaptability.
<div class="mw-collapsible mw-collapsed" data-expandtext="{{int:Expand Sample AutoHydro Script}}" data-collapsetext="{{int:Collapse Sample AutoHydro Script}}">
<pre>
alias vMature r0
alias vOccupied r1
alias isDayLight r2
alias isOccupied r3
alias dSensor d5

#start of Program Loop
start:
l isDayLight dSensor Activate #Check if it's daytime or not.

# For each device, harvest, plant, powerdown, then power on depending on conditions.
alias dThisVictim d0 #Begin processing device 0
bdseal dThisVictim HarvestCrop
bdseal dThisVictim PlantCrop
bgtzal isDayLight PowerDown
blezal isDayLight TurnitOn
alias dThisVictim d1 #Begin processing device 1
bdseal dThisVictim HarvestCrop
bdseal dThisVictim PlantCrop
bgtzal isDayLight PowerDown
blezal isDayLight TurnitOn
alias dThisVictim d2 #Begin processing device 2
bdseal dThisVictim HarvestCrop
bdseal dThisVictim PlantCrop
bgtzal isDayLight PowerDown
blezal isDayLight TurnitOn
alias dThisVictim d3 #Begin processing device 3
bdseal dThisVictim HarvestCrop
bdseal dThisVictim PlantCrop
bgtzal isDayLight PowerDown
blezal isDayLight TurnitOn
alias dThisVictim d4 #Begin processing device 4
bdseal dThisVictim HarvestCrop
bdseal dThisVictim PlantCrop
bgtzal isDayLight PowerDown
blezal isDayLight TurnitOn
#Can't do a D5 because that's our sensor.

j start #Return to the beginning of the program loop. (Yields here may save processing power)

HarvestCrop:
ls vMature dThisVictim 0 Mature
blez vMature ra #If the crop is not mature, return
s dThisVictim Harvest 1 #If the crop is mature, harvest it (one).
j ra #return

PlantCrop:
ls vOccupied dThisVictim 2 Occupied #seeds to plant
blez vOccupied ra #If the machine has no seeds to plant, return.
ls vOccupied dThisVictim 0 Occupied #something growing
bgtz vOccupied ra # If the crop plot is occupied, return.
s dThisVictim Plant 1 # if we made it this far, plant the crop
j ra #return

PowerDown:
s dThisVictim On 0 #Power the machine down.

j ra #Jump to line we came from

TurnitOn:
s dThisVictim On 1 #Power the machine up
j ra

##########
#### End Script
##########
</pre>
</div>
<br>
-----

<BR>
This is a sample timer command set, alternating between 1 for 1 tick (0.5s), then off for 2 ticks (1s).

<pre>
move r0 0 # Line 0: move the value 0 to register0
sub r1 r0 3 # Line 1: subtract 3 from the value in r0 and write it to r1
bltz r1 4 # Line 2: jump to line 4 if r1 < 0 (skip the next line)
move r0 0 # Line 3: move the value 0 to register0
slt o r0 1 # Line 4: if r0 < 1 write 1 to the output, otherwise 0.
add r0 r0 1 # Line 5: increment r0 by 1
yield # Line 6: wait until next power tick (0.5s)
j 1 # Line 7: jump back to line 1

##########
#### End Script
##########
</pre>
-----

Example:

<pre>
so you will do l r0 d0 SolarAngle
Sorry had last args swapped
That would read in the value
while,
s d1 Vertical r0
Would write the contents of r0 into the devices 1's Vertical property
additionally you can make some aliases
alias SolarSensor d0
l r0 SolarSensor SolarAngle

##########
#### End Script
##########
</pre>
-----
Another example:

<pre>
Now the IC is inserted into the housing. The screws D0-D5 can be adjusted directly to the equipment (sensor, console, solar panel, etc.). The ports 'o' and 'i0-i2' have been removed. Instead, commands that directly read and write hardware parameters are added.
l <register> <data_channel> <parameter>
reads the value of the parameter
s <data_channel> <parameter> <register_or_value>
writes the value of the parameter
ls <register> <data_channel> <slot_number> <parameter>
reads the parameter value from the slot
For example,
l r0 d0 Horizontal

s d5 Activate 1

ls r3 db 0 OccupantHash

##########
#### End Script
##########
</pre>

==Links==
-----
* [https://stationeering.com/tools/ic] Stationeering.com offers a programmable circuits simulator so you can develop your code without repeatedly dying in game!
* [https://hastebin.com/uwuhidozun.md]
* [http://www.easy68k.com/]
* [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++

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

|}

Stationeers Community Wiki - User contributions [en]

IC10