Toggle search
Toggle menu
770
1.4K
2.3K
33.3K
Stationeers Community Wiki
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

IC10/instructions: Difference between revisions

From Stationeers Community Wiki
More actions
← Older edit
VisualWikitext
Emilgardis (talk | contribs)
460 edits
No edit summary
RA2lover (talk | contribs)
poweruser, Administrators
986 edits
m add jal ra workaround
 
(39 intermediate revisions by 9 users not shown)
Line 1: Line 1:
<noinclude>
See [[IC10]] for the primary page for the IC10 instruction set. This page lists all available instructions
</noinclude>
== Utility ==
== Utility ==


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


{{MipsInstruction|instruction=abs|description=Register = the absolute value of a|syntax=abs r? a(r?{{!}}num)
{{ICInstruction
|example=
| instruction = abs
<pre>
| description = Register = the absolute value of a
add r0 r0 1 # increment r0 by one
| syntax = abs r? a(r?{{!}}num)
</pre>
| example = {{ICCode|
define negativeNumber -10
abs r0 negativeNumber # Compute the absolute value of -10 and store it in register 0
}}
}}{{ICInstruction
| instruction = sgn
| syntax = sgn r a(r?{{!}}num)
| description = Stores the sign of a in the register: -1 if a is negative, 1 if positive, 0 if a is 0 (or not a number).
}}{{ICInstruction
| instruction = add
| description = Register = a + b.
| syntax = add r? a(r?{{!}}num) b(r?{{!}}num)
| example = {{ICCode|add r0 r0 1 # increment r0 by one}}
{{ICCode|
define num1 10
define num2 20
add r0 num1 num2 # Add 10 and 20 and store the result in register 0
}}
}}
{{ICInstruction
| instruction = ceil
| description = Register = smallest integer greater than a
| syntax = ceil r? a(r?{{!}}num)
| example = {{ICCode|
define floatNumber 10.3
ceil r0 floatNumber # Compute the ceiling of 10.3 and store it in register 0
}}
}}
{{ICInstruction
| instruction = div
| description = Register = a / b
| syntax = div r? a(r?{{!}}num) b(r?{{!}}num)
}}
{{ICInstruction
| instruction = pow
| description = Stores the result of raising a to the power of b in the register. Follows IEEE-754 standard for floating point arithmetic.
| syntax = pow r? a(r?{{!}}num) b(r?{{!}}num)
}}
{{ICInstruction
| instruction = exp
| description = exp(a) or e^a
| syntax = exp r? a(r?{{!}}num)
}}
{{ICInstruction
| instruction = floor
| description = Register = largest integer less than a
| syntax = floor r? a(r?{{!}}num)
}}
{{ICInstruction
| instruction = log
| description = base e log(a) or ln(a)
| syntax = log r? a(r?{{!}}num)
}}
{{ICInstruction
| instruction = max
| description = Register = max of a or b
| note = If any of the values is NaN, NaN is returned.
| syntax = max r? a(r?{{!}}num) b(r?{{!}}num)
}}
{{ICInstruction
| instruction = min
| description = Register = min of a or b
| note = If any of the values is NaN, NaN is returned.
| syntax = min r? a(r?{{!}}num) b(r?{{!}}num)
}}{{ICInstruction
| instruction = clamp
| syntax = clamp r? a(r?{{!}}num) min(r?{{!}}num) max(r?{{!}}num)
| description = Stores a clamped to the inclusive inclusive range [min, max] in the register provided.
| note = Functionally equivalent to min(max(a,min),max).<br>If any of the values are NaN, NaN is returned.
| example = clamp 100 10 50 = 50<br>
clamp 0 10 50 = 10<br>
clamp 20 10 50 = 20<br>
}}{{ICInstruction
| instruction = mod
| description = Register = a mod b (note: NOT a % b)
| syntax = mod r? a(r?{{!}}num) b(r?{{!}}num)
| example = {{ICCode|
mod r0 10 20 # Expected: r0 = 10
mod r1 22 20 # Expected: r1 = 2
mod r2 22 -20 # Expected: r2 = 18
mod r2 22 -10 # Expected: r2 = 18
mod r2 -7 4 # Expected: r2 = 1
mod r2 -7 9 # Expected: r2 = 2
}}
}}
}}
{{MipsInstruction|instruction=add|description=Register = a + b.|syntax=add r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=mul|description=Register = a * b|syntax=mul r? a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=ceil|description=Register = smallest integer greater than a|syntax=ceil r? a(r?{{!}}num)}}
{{ICInstruction|instruction=rand|description=Register = a random value x with 0 <= x < 1|syntax=rand r?}}
{{MipsInstruction|instruction=div|description=Register = a / b|syntax=div r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=round|description=Register = a rounded to nearest integer|syntax=round r? a(r?{{!}}num)}}
{{MipsInstruction|instruction=exp|description=Register = exp(a) or e^a|syntax=exp r? a(r?{{!}}num)}}
{{ICInstruction|instruction=sqrt|description=Register = square root of a|syntax=sqrt r? a(r?{{!}}num)}}
{{MipsInstruction|instruction=floor|description=Register = largest integer less than a|syntax=floor r? a(r?{{!}}num)}}
{{ICInstruction|instruction=sub|description=Register = a - b.|syntax=sub r? a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=log|description=Register = base e log(a) or ln(a)|syntax=log r? a(r?{{!}}num)}}
{{ICInstruction|instruction=trunc|description=Register = a with fractional part removed|syntax=trunc r? a(r?{{!}}num)}}
{{MipsInstruction|instruction=max|description=Register = max of a or b|syntax=max r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=lerp|description=Linearly interpolates between a and b by the ratio c, and places the result in the register provided. The ratio c will be clamped between 0 and 1.|syntax=lerp r? a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{MipsInstruction|instruction=min|description=Register = min of a or b|syntax=min r? a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=mod|description=Register = a mod b (note: NOT a % b)|syntax=mod r? a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=move|description=Register = provided num or register value.|syntax=move r? a(r?{{!}}num)}}
{{MipsInstruction|instruction=mul|description=Register = a * b|syntax=mul r? a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=rand|description=Register = a random value x with 0 <= x < 1|syntax=rand r?}}
{{MipsInstruction|instruction=round|description=Register = a rounded to nearest integer|syntax=round r? a(r?{{!}}num)}}
{{MipsInstruction|instruction=sqrt|description=Register = square root of a|syntax=sqrt r? a(r?{{!}}num)}}
{{MipsInstruction|instruction=sub|description=Register = a - b.|syntax=sub r? a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=trunc|description=Register = a with fractional part removed|syntax=trunc r? a(r?{{!}}num)}}


== Trigonometric ==
=== Mathematical / Trigonometric ===


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


== Stack ==
== Stack ==


{{MipsInstruction|instruction=clr|description=Clears the stack memory for the provided device.|syntax=clr d?}}
{{ICInstruction
{{MipsInstruction|instruction=get|description=Using the provided device, attempts to read the stack value at the provided address, and places it in the register.|syntax=get r? d? address(r?{{!}}num)}}
| instruction = clr
{{MipsInstruction|instruction=getd|description=Seeks directly for the provided device id, attempts to read the stack value at the provided address, and places it in the register.|syntax=getd r? id(r?{{!}}num) address(r?{{!}}num)}}
| description = Clears the stack memory for the provided device.
{{MipsInstruction|instruction=peek|description=Register = the value at the top of the stack|syntax=peek r?}}
| note = Throws a DeviceNotFound exception when used on inaccessible devices.<br><br>
{{MipsInstruction|instruction=poke|description=Register = the value at the top of the stack|syntax=poke address(r?{{!}}num) value(r?{{!}}num)}}
 
{{MipsInstruction|instruction=pop|description=Register = the value at the top of the stack and decrements sp|syntax=pop r?}}
Throws a MemoryNotReadable exception when used on devices without a writable stack memory. (likely a bug)
{{MipsInstruction|instruction=push|description=Pushes the value of a to the stack at sp and increments sp|syntax=push a(r?{{!}}num)}}
| syntax = clr d?
{{MipsInstruction|instruction=put|description=Using the provided device, attempt to write the provided value to the stack at the provided address.|syntax=put d? address(r?{{!}}num) value(r?{{!}}num)}}
}}
{{MipsInstruction|instruction=putd|description=Seeks directly for the provided device id, attempts to write the provided value to the stack at the provided address.|syntax=putd id(r?{{!}}num) address(r?{{!}}num) value(r?{{!}}num)}}
{{ICInstruction
| instruction = clrd
| description = Seeks directly for the provided device id and clears the stack memory of that device
| note = Throws a DeviceNotFound exception when used on inaccessible devices.<br><br>
 
Throws a MemoryNotWriteable exception when used on devices without a writable stack memory.
| syntax = clrd id(r?{{!}}num)
}}
{{ICInstruction
| instruction = get
| description = Using the provided device, attempts to read the stack value at the provided address, and places it in the register.
| note = Throws a DeviceNotFound exception when used on inaccessible devices.<br><br>
 
Throws a MemoryNotReadable exception when used on devices without a readable stack memory.
| syntax = get r? device(d?{{!}}r?{{!}}id) address(r?{{!}}num)
}}
{{ICInstruction
| instruction = getd
| description = Seeks directly for the provided device id, attempts to read the stack value at the provided address, and places it in the register.
| note = Throws a DeviceNotFound exception when used on inaccessible devices.<br><br>
 
Throws a MemoryNotReadable exception when used on devices without a readable stack memory.
| syntax = getd r? id(r?{{!}}id) address(r?{{!}}num)
}}
{{ICInstruction
| instruction = peek
| description = Reads the value at stack address sp-1 and saves it into the provided register.
| note = Out-of-bounds reads result in a stack underflow/overflow exception.
| syntax = peek r?
}}
{{ICInstruction
| instruction = poke
| description = Stores the provided value at the provided address in the stack.
| note = Out-of-bounds writes result in a stack underflow/overflow exception.<br><br>
 
There is no built-in instruction for reading IC10 stack memory at arbitrary addresses. Although circuit housings can use get db, machines with an IC slot need to use a stack pointer assignment followed by a peek as a workaround.
| syntax = poke address(r?{{!}}num) value(r?{{!}}num)
}}
{{ICInstruction
| instruction = pop
| description = Decrements the stack pointer, then returns the writes the value at the resulting stack pointer address into the provided register.
| note = Out-of-bounds reads result in a stack underflow/overflow exception.
| syntax = pop r?
}}
{{ICInstruction
| instruction = push
| description = Writes the provided value to the stack pointer address, then increments the stack pointer.
| note = Out-of-bounds writes throw a Stack underflow/overflow exception.
| syntax = push a(r?{{!}}num)
}}
{{ICInstruction
| instruction = put
| description = Using the provided device, attempts to write the provided value to its stack at the provided address.
| note = Throws a DeviceNotFound exception when used on inaccessible devices.<br><br>
 
Throws a MemoryNotWritable exception when used on devices without a writable stack memory.<br><br>
 
Intercepts exceptions thrown by the device during the attempt to write to the device's stack, passing stack overflow/underflow exceptions through and throwing Unknown exceptions for other exception types.
| syntax = put device(d?{{!}}r?{{!}}id) address(r?{{!}}num) value(r?{{!}}num)
}}
{{ICInstruction
| instruction = putd
| description = Seeks directly for the provided device id, attempts to write the provided value to the stack at the provided address.
| note = Throws a DeviceNotFound exception when used on inaccessible devices.<br><br>
 
Throws a MemoryNotWritable exception when used on devices without a writable stack memory.<br><br>
 
Intercepts exceptions thrown by the device during the attempt to write to the device's stack, passing stack overflow/underflow exceptions through and throwing Unknown exceptions for other exception types.
| syntax = putd id(r?{{!}}id) address(r?{{!}}num) value(r?{{!}}num)
}}


== Slot/Logic ==
== Slot/Logic ==


{{MipsInstruction|instruction=l|description=Loads device LogicType to register by housing index value.|syntax=l r? d? logicType|example=
{{ICInstruction|instruction=l|description=Loads device LogicType to register by housing index value.|syntax=l r? device(d?{{!}}r?{{!}}id) logicType
|example=
Read from the device on d0 into register 0
Read from the device on d0 into register 0
<pre>l r0 d0 Setting</pre>
{{ICCode|l r0 d0 Setting}}
Read the pressure from a sensor
Read the pressure from a sensor
<pre>l r1 d5 Pressure</pre>
{{ICCode|l r1 d5 Pressure}}
This also works with aliases. For example:
This also works with aliases. For example:
<pre>
{{ICCode|
alias Sensor d0
alias Sensor d0
l r0 Sensor Temperature
l r0 Sensor Temperature
</pre>
}}}}
{{ICInstruction
| instruction = lr
| description = Loads reagent of device's ReagentMode where a hash of the reagent type to check for. ReagentMode can be either Contents (0), Required (1), Recipe (2). Can use either the word, or the number.
| note = Instruction performs different actions depending on the provided reagent mode.
<br>Valid reagentMode values:
<br>
<br>LogicReagentMode.Contents (0): Return how much reagentHash reagent is present in the device.
<br>LogicReagentMode.Required (1): Return how much additional reagentHash reagent is missing to complete the device's currently selected recipe.
<br>LogicReagentMode.Recipe (2): Return how much reagentHash reagent the device's currently selected recipe requires.
<br>LogicReagentMode.TotalContents (3): Return the total amount of reagents a  device contains, ignoring reagentHash. Equivalent to "l r device Reagents".
<br>
<br>Other reagent modes throw an UnhandledReagentMode exception.
<br>
<br>Instruction throws an IncorrectReagentDevice exception on Required and Recipe LogicReagentModes if attempting to use them on a device that can't select a recipe, such as a Furnace.
| syntax = lr r? device(d?{{!}}r?{{!}}id) reagentMode reagentHash
}}
}}
{{MipsInstruction|instruction=ld|description=Loads device LogicType to register by direct ID reference.|syntax=ld r? id(r?{{!}}num) logicType}}
{{ICInstruction|instruction=ls|description=Loads slot LogicSlotType on device to register.|syntax=ls r? device(d?{{!}}r?{{!}}id) slotIndex logicSlotType
{{MipsInstruction|instruction=lr|description=Loads reagent of device's ReagentMode where a hash of the reagent type to check for. ReagentMode can be either Contents (0), Required (1), Recipe (2). Can use either the word, or the number.|syntax=lr r? d? reagentMode int}}
{{MipsInstruction|instruction=ls|description=Loads slot LogicSlotType on device to register.|syntax=ls r? d? slotIndex logicSlotType
|example=
|example=
Read from the second slot of device on d0, stores 1 in r0 if it's occupied, 0 otherwise.
Read from the second slot of device on d0, stores 1 in r0 if it's occupied, 0 otherwise.
<pre>ls r0 d0 2 Occupied</pre>
{{ICCode|ls r0 d0 2 Occupied}}
And here is the code to read the charge of an AIMeE:<br/>
And here is the code to read the charge of an AIMeE:
<pre>
{{ICCode|
alias robot d0 <br/>
alias robot d0
alias charge r10 <br/>
alias charge r10
ls charge robot 0 Charge  
ls charge robot 0 Charge
</pre>
}}}}
}}
{{ICInstruction|instruction=s|description=Stores register value to LogicType on device by housing index value.|syntax=s device(d?{{!}}r?{{!}}id) logicType r?
{{MipsInstruction|instruction=s|description=Stores register value to LogicType on device by housing index value.|syntax=s d? logicType r?{{!}}num
|example=
|example=
<pre>
{{ICCode|
s d0 Setting r0
s d0 Setting r0
</pre>
}}}}
}}
{{ICInstruction|instruction=ss|description=Stores register value to device stored in a slot LogicSlotType on device.|syntax=ss device(d?{{!}}r?{{!}}id) slotIndex logicSlotType r?}}
{{MipsInstruction|instruction=sd|description=Stores register value to LogicType on device by direct ID reference.|syntax=sd id(r?{{!}}num) logicType r?}}
{{ICInstruction|instruction=rmap|description=Given a reagent hash (signed 32bit int), store the corresponding prefab hash that the device expects to fulfill the reagent requirement. For example, on an autolathe, the hash for Iron will store the hash for ItemIronIngot.|syntax=rmap r? d? reagentHash(r?{{!}}num)}}
{{MipsInstruction|instruction=ss|description=Stores register value to device stored in a slot LogicSlotType on device.|syntax=ss d? slotIndex logicSlotType r?{{!}}num}}


== Batched ==
=== Slot/Logic / Batched ===


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


== Bitwise = =
== Bitwise ==


{{MipsInstruction|instruction=and|description=Performs a bitwise logical AND operation on the binary representation of two values. Each bit of the result is determined by evaluating the corresponding bits of the input values. If both bits are 1, the resulting bit is set to 1. Otherwise the resulting bit is set to 0.|syntax=and r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=and|description=Performs a bitwise logical AND operation on the binary representation of two values. Each bit of the result is determined by evaluating the corresponding bits of the input values. If both bits are 1, the resulting bit is set to 1. Otherwise the resulting bit is set to 0.|syntax=and r? a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=nor|description=Performs a bitwise logical NOR (NOT OR) operation on the binary representation of two values. Each bit of the result is determined by evaluating the corresponding bits of the input values. If both bits are 0, the resulting bit is set to 1. Otherwise, if at least one bit is 1, the resulting bit is set to 0.|syntax=nor r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=nor|description=Performs a bitwise logical NOR (NOT OR) operation on the binary representation of two values. Each bit of the result is determined by evaluating the corresponding bits of the input values. If both bits are 0, the resulting bit is set to 1. Otherwise, if at least one bit is 1, the resulting bit is set to 0.|syntax=nor r? a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=not|description=Performs a bitwise logical NOT operation flipping each bit of the input value, resulting in a binary complement. If a bit is 1, it becomes 0, and if a bit is 0, it becomes 1.|syntax=not r? a(r?{{!}}num)}}
{{ICInstruction|instruction=not|description=Performs a bitwise logical NOT operation flipping each bit of the input value, resulting in a binary complement. If a bit is 1, it becomes 0, and if a bit is 0, it becomes 1.|syntax=not r? a(r?{{!}}num)
{{MipsInstruction|instruction=or|description=Performs a bitwise logical OR operation on the binary representation of two values. Each bit of the result is determined by evaluating the corresponding bits of the input values. If either bit is 1, the resulting bit is set to 1. If both bits are 0, the resulting bit is set to 0.|syntax=or r? a(r?{{!}}num) b(r?{{!}}num)}}
|note=
{{MipsInstruction|instruction=sla|description=Performs a bitwise arithmetic left shift operation on the binary representation of a value. It shifts the bits to the left and fills the vacated rightmost bits with a copy of the sign bit (the most significant bit).|syntax=sla r? a(r?{{!}}num) b(r?{{!}}num)}}
This is a bitwise operation, the NOT of 1 => -2, etc. You may want to use seqz instead}}
{{MipsInstruction|instruction=sll|description=Performs a bitwise logical left shift operation on the binary representation of a value. It shifts the bits to the left and fills the vacated rightmost bits with zeros.|syntax=sll r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=or|description=Performs a bitwise logical OR operation on the binary representation of two values. Each bit of the result is determined by evaluating the corresponding bits of the input values. If either bit is 1, the resulting bit is set to 1. If both bits are 0, the resulting bit is set to 0.|syntax=or r? a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=sra|description=Performs a bitwise arithmetic right shift operation on the binary representation of a value. It shifts the bits to the right and fills the vacated leftmost bits with a copy of the sign bit (the most significant bit).|syntax=sra r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=sla|description=Performs a bitwise arithmetic left shift operation on the binary representation of a value. It shifts the bits to the left and fills the vacated rightmost bits with zeros (note that this is indistinguishable from 'sll').|syntax=sla r? a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=srl|description=Performs a bitwise logical right shift operation on the binary representation of a value. It shifts the bits to the right and fills the vacated leftmost bits with zeros|syntax=srl r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=sll|description=Performs a bitwise logical left shift operation on the binary representation of a value. It shifts the bits to the left and fills the vacated rightmost bits with zeros.|syntax=sll r? a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=xor|description=Performs a bitwise logical XOR (exclusive OR) operation on the binary representation of two values. Each bit of the result is determined by evaluating the corresponding bits of the input values. If the bits are different (one bit is 0 and the other is 1), the resulting bit is set to 1. If the bits are the same (both 0 or both 1), the resulting bit is set to 0.|syntax=xor r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=sra|description=Performs a bitwise arithmetic right shift operation on the binary representation of a value. It shifts the bits to the right and fills the vacated leftmost bits with a copy of the sign bit (the most significant bit).|syntax=sra r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=srl|description=Performs a bitwise logical right shift operation on the binary representation of a value. It shifts the bits to the right and fills the vacated leftmost bits with zeros|syntax=srl r? a(r?{{!}}num) b(r?{{!}}num)}}{{ICInstruction
| instruction = rol
| syntax = rol r? a(r?{{!}}num) b(r?{{!}}num)
| description = Performs a bitwise left rotation on the binary representation of a by b places, wrapping the bits shifted out of the most significant position back into the least significant position.
| example = rol $DEADBEEFCAFE2000 16 -> $BEEFCAFE2000DEAD
}}{{ICInstruction
| instruction = ror
| syntax = ror r? a(r?{{!}}num) b(r?{{!}}num)
| description = Performs a bitwise right rotation on the binary representation of A by B places, wrapping the bits shifted out of the least significant position back into the most significant position.
| example = ror $1234, 4 -> $4000000000000123
}}{{ICInstruction|instruction=xor|description=Performs a bitwise logical XOR (exclusive OR) operation on the binary representation of two values. Each bit of the result is determined by evaluating the corresponding bits of the input values. If the bits are different (one bit is 0 and the other is 1), the resulting bit is set to 1. If the bits are the same (both 0 or both 1), the resulting bit is set to 0.|syntax=xor r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction
| instruction = ext
| description = Extracts a bit field from source value, beginning at bit offset for length bits and places result in the provided register. Payload cannot exceed 53 bits in final length.
| note = Throws a ShiftUnderflow exception if offset is smaller than 1 or length is smaller than 0.<br>
Throws a ShiftOverflow exception if offset is greater than or equal to 53 bits.<br>
Throws a PayloadOverflow exception if length is greater than 53 bits.
| example = {{ICCode|
move r0 $DEADBEEF
ext r1 r0 8 16 #After execution, r1's value is $ADBE
}}
| syntax = ext r? source(r?{{!}}num) offset(r?{{!}}num) length(r?{{!}}num)
}}
{{ICInstruction
| instruction = ins
| description = Inserts a bit field into the provided register, beginning at bit offset for length bits. Payload cannot exceed 53 bits in final length.
| syntax = ins r? field(r?{{!}}num) offset(r?{{!}}num) length(r?{{!}}num)
| note = Throws a ShiftUnderflow exception if length is smaller than 1 or offset is smaller than 0.<br>
Throws a ShiftOverflow exception if offset is greater than 53 bits.<br>
Throws a PayloadOverflow exception if offset+length is greater to or equal to 53 bits.<br>
| example = {{ICCode|move r0 $DE0000EF
move r1 $ADBE
ins r0 r1 8 16 #inserts field r1 at bit 8 for 16 bits, result: $DEADBEEF}}
}}


== Comparison ==
== Comparison ==


{{MipsInstruction|instruction=select|description=Register = b if a is non-zero, otherwise c|syntax=select r? a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=select|description=Register = b if a is non-zero, otherwise c|syntax=select r? a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)
|example=
<b>1)</b><br/>
move r0 <s style="text-decoration-line:underline;text-decoration-color:red;">0</s><br/>
select <s style="text-decoration-line:underline;text-decoration-color:red;>r1</s> r0 10 <s style="text-decoration-line:underline;text-decoration-color:red;>200</s>
{{ICCode|
move r0 0
select r1 r0 10 200
}}
<br/>after run, <s style="text-decoration-line:underline;text-decoration-color:red;">r1 = 200</s>
<br/><br/><b>2)</b><br/>
move r0 <s style="text-decoration-line:underline;text-decoration-color:red;">5</s><br/>
select <s style="text-decoration-line:underline;text-decoration-color:red;>r1</s> r0 <s style="text-decoration-line:underline;text-decoration-color:red;>10</s> 200
{{ICCode|
move r0 1
select r1 r0 10 100
}}
<br/>after run, <s style="text-decoration-line:underline;text-decoration-color:red;">r1 = 10</s>
|note=
This operation can be used as a simple ternary condition}}


== Compare Device Pin ==
=== Comparison / Device Pin ===


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


== Compare Value ==
=== Comparison / Value ===


{{MipsInstruction|instruction=sap|description=Register = 1 if abs(a - b) <= max(c * max(abs(a), abs(b)), float.epsilon * 8), otherwise 0|syntax=sap r? a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=sap|description=Register = 1 if abs(a - b) <= max(c * max(abs(a), abs(b)), float.epsilon * 8), otherwise 0|syntax=sap r? a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)
{{MipsInstruction|instruction=sapz|description=Register = 1 if abs(a) <= max(b * abs(a), float.epsilon * 8), otherwise 0|syntax=sapz r? a(r?{{!}}num) b(r?{{!}}num)}}
|example=
{{MipsInstruction|instruction=seq|description=Register = 1 if a = b, otherwise 0|syntax=seq r? a(r?{{!}}num) b(r?{{!}}num)}}
Set register to 1 if a and b are close enough to each other with the scaling factor of c. Equivalent to Python [https://docs.python.org/3/library/math.html#math.isclose math.isclose]}}
{{MipsInstruction|instruction=seqz|description=Register = 1 if a = 0, otherwise 0|syntax=seqz r? a(r?{{!}}num)}}
{{ICInstruction|instruction=sapz|description=Register = 1 if abs(a) <= max(b * abs(a), float.epsilon * 8), otherwise 0|syntax=sapz r? a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=sge|description=Register = 1 if a >= b, otherwise 0|syntax=sge r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=seq|description=Register = 1 if a == b, otherwise 0|syntax=seq r? a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=sgez|description=Register = 1 if a >= 0, otherwise 0|syntax=sgez r? a(r?{{!}}num)}}
{{ICInstruction|instruction=seqz|description=Register = 1 if a == 0, otherwise 0|syntax=seqz r? a(r?{{!}}num)}}
{{MipsInstruction|instruction=sgt|description=Register = 1 if a > b, otherwise 0|syntax=sgt r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=sge|description=Register = 1 if a >= b, otherwise 0|syntax=sge r? a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=sgtz|description=Register = 1 if a > 0, otherwise 0|syntax=sgtz r? a(r?{{!}}num)}}
{{ICInstruction|instruction=sgez|description=Register = 1 if a >= 0, otherwise 0|syntax=sgez r? a(r?{{!}}num)}}
{{MipsInstruction|instruction=sle|description=Register = 1 if a <= b, otherwise 0|syntax=sle r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=sgt|description=Register = 1 if a > b, otherwise 0|syntax=sgt r? a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=slez|description=Register = 1 if a <= 0, otherwise 0|syntax=slez r? a(r?{{!}}num)}}
{{ICInstruction|instruction=sgtz|description=Register = 1 if a > 0, otherwise 0|syntax=sgtz r? a(r?{{!}}num)}}
{{MipsInstruction|instruction=slt|description=Register = 1 if a < b, otherwise 0|syntax=slt r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=sle|description=Register = 1 if a <= b, otherwise 0|syntax=sle r? a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=sltz|description=Register = 1 if a < 0, otherwise 0|syntax=sltz r? a(r?{{!}}num)}}
{{ICInstruction|instruction=slez|description=Register = 1 if a <= 0, otherwise 0|syntax=slez r? a(r?{{!}}num)}}
{{MipsInstruction|instruction=sna|description=Register = 1 if abs(a - b) > max(c * max(abs(a), abs(b)), float.epsilon * 8), otherwise 0|syntax=sna r? a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=slt|description=Register = 1 if a < b, otherwise 0|syntax=slt r? a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=snan|description=Register = 1 if a is NaN, otherwise 0|syntax=snan r? a(r?{{!}}num)}}
{{ICInstruction|instruction=sltz|description=Register = 1 if a < 0, otherwise 0|syntax=sltz r? a(r?{{!}}num)}}
{{MipsInstruction|instruction=snanz|description=Register = 0 if a is NaN, otherwise 1|syntax=snanz r? a(r?{{!}}num)}}
{{ICInstruction|instruction=sna|description=Register = 1 if abs(a - b) > max(c * max(abs(a), abs(b)), float.epsilon * 8), otherwise 0|syntax=sna r? a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{MipsInstruction|instruction=snaz|description=Register = 1 if abs(a) > max(b * abs(a), float.epsilon), otherwise 0|syntax=snaz r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=snan|description=Register = 1 if a is NaN, otherwise 0|syntax=snan r? a(r?{{!}}num)}}
{{MipsInstruction|instruction=sne|description=Register = 1 if a != b, otherwise 0|syntax=sne r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=snanz|description=Register = 0 if a is NaN, otherwise 1|syntax=snanz r? a(r?{{!}}num)}}
{{MipsInstruction|instruction=snez|description=Register = 1 if a != 0, otherwise 0|syntax=snez r? a(r?{{!}}num)}}
{{ICInstruction|instruction=snaz|description=Register = 1 if abs(a) > max(b * abs(a), float.epsilon), otherwise 0|syntax=snaz r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=sne|description=Register = 1 if a != b, otherwise 0|syntax=sne r? a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=snez|description=Register = 1 if a != 0, otherwise 0|syntax=snez r? a(r?{{!}}num)}}


== Branching ==
== Branching ==


{{MipsInstruction|instruction=j|description=Jump execution to line a|syntax=j int}}
{{ICInstruction|instruction=j|description=Jump execution to line a|syntax=j int
{{MipsInstruction|instruction=jal|description=Jump execution to line a and store next line number in ra|syntax=jal int}}
|example=
{{MipsInstruction|instruction=jr|description=Relative jump to line a|syntax=jr int}}
{{ICCode|j 0 # jump line 0}}
{{ICCode|
j label # jump to a label
 
label:
# your code here
}}}}
{{ICInstruction
| instruction = jal
| description = Jump execution to line a and store next line number in ra
| syntax = jal int
| note = Actual behavior as of The Power Line Update (Q3 2026) stores the next line number in ra before jumping execution to line a. This results in jal ra being a no-op (likely a bug).<br><br>
As a workaround, an always-taken branch-and-link can be used instead (for example, beqzal 0 ra).
| example = jal provides a way to do function calls in IC10 mips
 
{{ICCode|
move r0 1000
move r1 0
start:
jal average
s db Setting r0
yield
j start
 
average:
add r0 r0 r1
div r0 r0 2
j ra # jump back
}}
}}
{{ICInstruction|instruction=jr|description=Relative jump to line a|syntax=jr int}}


== Branch Device Pin ==
=== Branching / Device Pin ===


{{MipsInstruction|instruction=bdns|description=Branch to line a if device d isn't set|syntax=bdns d? a(r?{{!}}num)}}
{{ICInstruction|instruction=bdnvl|description=Will branch to line a if the provided device not valid for a load instruction for the provided logic type.|syntax=bdnvl device(d?{{!}}r?{{!}}id) logicType a(r?{{!}}num)}}
{{MipsInstruction|instruction=bdnsal|description=Jump execution to line a and store next line number if device is not set|syntax=bdnsal d? a(r?{{!}}num)}}
{{ICInstruction|instruction=bdnvs|description=Will branch to line a if the provided device not valid for a store instruction for the provided logic type.|syntax=bdnvs device(d?{{!}}r?{{!}}id) logicType a(r?{{!}}num)}}
{{MipsInstruction|instruction=bdse|description=Branch to line a if device d is set|syntax=bdse d? a(r?{{!}}num)}}
{{ICInstruction|instruction=bdns|description=Branch to line a if device d isn't set|syntax=bdns d? a(r?{{!}}num)}}
{{MipsInstruction|instruction=bdseal|description=Jump execution to line a and store next line number if device is set|syntax=bdseal d? a(r?{{!}}num)
{{ICInstruction|instruction=bdnsal|description=Jump execution to line a and store next line number if device is not set|syntax=bdnsal d? a(r?{{!}}num)}}
{{ICInstruction|instruction=bdse|description=Branch to line a if device d is set|syntax=bdse d? a(r?{{!}}num)}}
{{ICInstruction|instruction=bdseal|description=Jump execution to line a and store next line number if device is set|syntax=bdseal d? a(r?{{!}}num)
|example=
|example=
<pre>
{{ICCode|
bdseal d0 32 #Store line number and jump to line 32 if d0 is assigned.
#Store line number and jump to line 32 if d0 is assigned.
</pre>
bdseal d0 32
<pre>
bdseal d0 HarvestCrop #Store line in ra and jump to label HarvestCrop if device d0 is assigned.
</pre>
}}
}}
{{MipsInstruction|instruction=brdns|description=Relative jump to line a if device is not set|syntax=brdns d? a(r?{{!}}num)}}
{{ICCode|
{{MipsInstruction|instruction=brdse|description=Relative jump to line a if device is set|syntax=brdse d? a(r?{{!}}num)}}
#Store line in ra and jump to label HarvestCrop if device d0 is assigned.
bdseal d0 HarvestCrop
}}}}
{{ICInstruction|instruction=brdns|description=Relative branch to line a if device is not set|syntax=brdns d? a(r?{{!}}num)}}
{{ICInstruction|instruction=brdse|description=Relative branch to line a if device is set|syntax=brdse d? a(r?{{!}}num)}}
 
=== Branching / Comparison ===
 
{{ICInstruction|instruction=bap|description=Branch to line d if abs(a - b) <= max(c * max(abs(a), abs(b)), float.epsilon * 8)|syntax=bap a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)
|example=
Branch if a and b are close enough to each other with the scaling factor of c. Equivalent to Python [https://docs.python.org/3/library/math.html#math.isclose math.isclose]}}
{{ICInstruction|instruction=brap|description=Relative branch to line d if abs(a - b) <= max(c * max(abs(a), abs(b)), float.epsilon * 8)|syntax=brap a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
{{ICInstruction|instruction=bapal|description=Branch to line c if a != b and store next line number in ra|syntax=bapal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
{{ICInstruction|instruction=bapz|description=Branch to line c if abs(a) <= max(b * abs(a), float.epsilon * 8)|syntax=bapz a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=brapz|description=Relative branch to line c if abs(a) <= max(b * abs(a), float.epsilon * 8)|syntax=brapz a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bapzal|description=Branch to line c if abs(a) <= max(b * abs(a), float.epsilon * 8) and store next line number in ra|syntax=bapzal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=beq|description=Branch to line c if a == b|syntax=beq a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=breq|description=Relative branch to line c if a == b|syntax=breq a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=beqal|description=Branch to line c if a == b and store next line number in ra|syntax=beqal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=beqz|description=Branch to line b if a == 0|syntax=beqz a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=breqz|description=Relative branch to line b if a == 0|syntax=breqz a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=beqzal|description=Branch to line b if a == 0 and store next line number in ra|syntax=beqzal a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bge|description=Branch to line c if a >= b|syntax=bge a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=brge|description=Relative branch to line c if a >= b|syntax=brge a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bgeal|description=Branch to line c if a >= b and store next line number in ra|syntax=bgeal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bgez|description=Branch to line b if a >= 0|syntax=bgez a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=brgez|description=Relative branch to line b if a >= 0|syntax=brgez a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bgezal|description=Branch to line b if a >= 0 and store next line number in ra|syntax=bgezal a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bgt|description=Branch to line c if a > b|syntax=bgt a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)
|example=
An example of a '''Schmitt''' trigger, turning on a device if the temperature is too low, and turning it off if it's too high and finally
doing nothing if the temperature is within the desired range.
{{ICCode|
alias sensor d0
alias device d1
 
define mintemp 293.15
define maxtemp 298.15
 
start:
yield
l r0 sensor Temperature
# If the temperature < mintemp, turn on the device
blt r0 mintemp turnOn
# If the temperature > maxtemp, turn off the device
bgt r0 maxtemp turnOff
j start
 
turnOn:
s device On 1
j start
turnOff:
s device On 0
j start
}}}}
{{ICInstruction|instruction=brgt|description=relative branch to line c if a > b|syntax=brgt a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bgtal|description=Branch to line c if a > b and store next line number in ra|syntax=bgtal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bgtz|description=Branch to line b if a > 0|syntax=bgtz a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=brgtz|description=Relative branch to line b if a > 0|syntax=brgtz a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bgtzal|description=Branch to line b if a > 0 and store next line number in ra|syntax=bgtzal a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=ble|description=Branch to line c if a <= b|syntax=ble a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=brle|description=Relative branch to line c if a <= b|syntax=brle a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bleal|description=Branch to line c if a <= b and store next line number in ra|syntax=bleal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=blez|description=Branch to line b if a <= 0|syntax=blez a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=brlez|description=Relative branch to line b if a <= 0|syntax=brlez a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=blezal|description=Branch to line b if a <= 0 and store next line number in ra|syntax=blezal a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=blt|description=Branch to line c if a < b|syntax=blt a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)
|example=
An example of a '''Schmitt''' trigger, turning on a device if the temperature is too low, and turning it off if it's too high and finally
doing nothing if the temperature is within the desired range.
{{ICCode|
alias sensor d0
alias device d1
 
define mintemp 293.15
define maxtemp 298.15


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


{{MipsInstruction|instruction=bap|description=Branch to line d if abs(a - b) <= max(c * max(abs(a), abs(b)), float.epsilon * 8)|syntax=bap a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
turnOn:
{{MipsInstruction|instruction=bapal|description=Branch to line d if abs(a - b) <= max(c * max(abs(a), abs(b)), float.epsilon * 8) and store next line number in ra|syntax=bapal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
s device On 1
{{MipsInstruction|instruction=bapz|description=Branch to line c if abs(a) <= max(b * abs(a), float.epsilon * 8)|syntax=bapz a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
j start
{{MipsInstruction|instruction=bapzal|description=Branch to line c if abs(a) <= max(b * abs(a), float.epsilon * 8) and store next line number in ra|syntax=bapzal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
turnOff:
{{MipsInstruction|instruction=beq|description=Branch to line c if a = b|syntax=beq a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
s device On 0
{{MipsInstruction|instruction=beqal|description=Branch to line c if a = b and store next line number in ra|syntax=beqal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
j start
{{MipsInstruction|instruction=beqz|description=Branch to line b if a = 0|syntax=beqz a(r?{{!}}num) b(r?{{!}}num)}}
}}}}
{{MipsInstruction|instruction=beqzal|description=Branch to line b if a = 0 and store next line number in ra|syntax=beqzal a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=brlt|description=Relative branch to line c if a < b|syntax=brlt a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{MipsInstruction|instruction=bge|description=Branch to line c if a >= b|syntax=bge a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bltal|description=Branch to line c if a < b and store next line number in ra|syntax=bltal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{MipsInstruction|instruction=bgeal|description=Branch to line c if a >= b and store next line number in ra|syntax=bgeal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bltz|description=Branch to line b if a < 0|syntax=bltz a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=bgez|description=Branch to line b if a >= 0|syntax=bgez a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=brltz|description=Relative branch to line b if a < 0|syntax=brltz a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=bgezal|description=Branch to line b if a >= 0 and store next line number in ra|syntax=bgezal a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bltzal|description=Branch to line b if a < 0 and store next line number in ra|syntax=bltzal a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=bgt|description=Branch to line c if a > b|syntax=bgt a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bna|description=Branch to line d if abs(a - b) > max(c * max(abs(a), abs(b)), float.epsilon * 8)|syntax=bna a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
{{MipsInstruction|instruction=bgtal|description=Branch to line c if a > b and store next line number in ra|syntax=bgtal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=brna|description=Relative branch to line d if abs(a - b) > max(c * max(abs(a), abs(b)), float.epsilon * 8)|syntax=brna a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
{{MipsInstruction|instruction=bgtz|description=Branch to line b if a > 0|syntax=bgtz a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bnaal|description=Branch to line d if abs(a - b) <= max(c * max(abs(a), abs(b)), float.epsilon * 8) and store next line number in ra|syntax=bnaal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
{{MipsInstruction|instruction=bgtzal|description=Branch to line b if a > 0 and store next line number in ra|syntax=bgtzal a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bnan|description=Branch to line b if a is not a number (NaN)|syntax=bnan a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=ble|description=Branch to line c if a <= b|syntax=ble a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=brnan|description=Relative branch to line b if a is not a number (NaN)|syntax=brnan a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=bleal|description=Branch to line c if a <= b and store next line number in ra|syntax=bleal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bnaz|description=Branch to line c if abs(a) > max (b * abs(a), float.epsilon * 8)|syntax=bnaz a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{MipsInstruction|instruction=blez|description=Branch to line b if a <= 0|syntax=blez a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=brnaz|description=Relative branch to line c if abs(a) > max(b * abs(a), float.epsilon * 8)|syntax=brnaz a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{MipsInstruction|instruction=blezal|description=Branch to line b if a <= 0 and store next line number in ra|syntax=blezal a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bnazal|description=Branch to line c if abs(a) > max (b * abs(a), float.epsilon * 8) and store next line number in ra|syntax=bnazal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{MipsInstruction|instruction=blt|description=Branch to line c if a < b|syntax=blt a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=bne|description=Branch to line c if a != b|syntax=bne a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{MipsInstruction|instruction=bltal|description=Branch to line c if a < b and store next line number in ra|syntax=bltal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{ICInstruction|instruction=brne|description=Relative branch to line c if a != b|syntax=brne a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{MipsInstruction|instruction=bltz|description=Branch to line b if a < 0|syntax=bltz a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bneal|description=Branch to line c if a != b and store next line number in ra|syntax=bneal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{MipsInstruction|instruction=bltzal|description=Branch to line b if a < 0 and store next line number in ra|syntax=bltzal a(r?{{!}}num) b(r?{{!}}num)}}
{{ICInstruction|instruction=bnez|description=branch to line b if a != 0|syntax=bnez a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=bna|description=Branch to line d if abs(a - b) > max(c * max(abs(a), abs(b)), float.epsilon * 8)|syntax=bna a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
{{ICInstruction|instruction=brnez|description=Relative branch to line b if a != 0|syntax=brnez a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=bnaal|description=Branch to line d if abs(a - b) <= max(c * max(abs(a), abs(b)), float.epsilon * 8) and store next line number in ra|syntax=bnaal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
{{ICInstruction|instruction=bnezal|description=Branch to line b if a != 0 and store next line number in ra|syntax=bnezal a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=bnan|description=Branch to line b if a is not a number (NaN)|syntax=bnan a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=bnaz|description=Branch to line c if abs(a) > max (b * abs(a), float.epsilon * 8)|syntax=bnaz a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{MipsInstruction|instruction=bnazal|description=Branch to line c if abs(a) > max (b * abs(a), float.epsilon * 8) and store next line number in ra|syntax=bnazal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{MipsInstruction|instruction=bne|description=Branch to line c if a != b|syntax=bne a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{MipsInstruction|instruction=bneal|description=Branch to line c if a != b and store next line number in ra|syntax=bneal a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{MipsInstruction|instruction=bnez|description=branch to line b if a != 0|syntax=bnez a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=bnezal|description=Branch to line b if a != 0 and store next line number in ra|syntax=bnezal a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=brap|description=Relative branch to line d if abs(a - b) <= max(c * max(abs(a), abs(b)), float.epsilon * 8)|syntax=brap a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
{{MipsInstruction|instruction=brapz|description=Relative branch to line c if abs(a) <= max(b * abs(a), float.epsilon * 8)|syntax=brapz a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{MipsInstruction|instruction=breq|description=Relative branch to line c if a = b|syntax=breq a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{MipsInstruction|instruction=breqz|description=Relative branch to line b if a = 0|syntax=breqz a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=brge|description=Relative jump to line c if a >= b|syntax=brge a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{MipsInstruction|instruction=brgez|description=Relative branch to line b if a >= 0|syntax=brgez a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=brgt|description=relative jump to line c if a > b|syntax=brgt a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{MipsInstruction|instruction=brgtz|description=Relative branch to line b if a > 0|syntax=brgtz a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=brle|description=Relative jump to line c if a <= b|syntax=brle a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{MipsInstruction|instruction=brlez|description=Relative branch to line b if a <= 0|syntax=brlez a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=brlt|description=Relative jump to line c if a < b|syntax=brlt a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{MipsInstruction|instruction=brltz|description=Relative branch to line b if a < 0|syntax=brltz a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=brna|description=Relative branch to line d if abs(a - b) > max(c * max(abs(a), abs(b)), float.epsilon * 8)|syntax=brna a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num) d(r?{{!}}num)}}
{{MipsInstruction|instruction=brnan|description=Relative branch to line b if a is not a number (NaN)|syntax=brnan a(r?{{!}}num) b(r?{{!}}num)}}
{{MipsInstruction|instruction=brnaz|description=Relative branch to line c if abs(a) > max(b * abs(a), float.epsilon * 8)|syntax=brnaz a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{MipsInstruction|instruction=brne|description=Relative branch to line c if a != b|syntax=brne a(r?{{!}}num) b(r?{{!}}num) c(r?{{!}}num)}}
{{MipsInstruction|instruction=brnez|description=Relative branch to line b if a != 0|syntax=brnez a(r?{{!}}num) b(r?{{!}}num)}}

Latest revision as of 14:31, 14 September 2026

See IC10 for the primary page for the IC10 instruction set. This page lists all available instructions


Utility

§ 
alias str r?|d?

Labels register or device reference with name, device references also affect what shows on the screws on the IC base.

Example:

alias dAutoHydro1 d0
alias vTemperature r0


§ 
define str num

Creates a label that will be replaced throughout the program with the provided value.

Example:

define ultimateAnswer 42
move r0 ultimateAnswer # Store 42 in register 0


§ 
move r? a(r?|num)

Register = provided num or register value.

Example:

move r0 42 # Store 42 in register 0


§ 
yield

Pauses execution for 1 tick



§ 
sleep a(r?|num)

Pauses execution on the IC for a seconds



§ 
hcf

Halt and catch fire

Note:

Creates a small explosion, destroying the chip and starting fires on flammable atmospheres.

Mathematical

§ 
abs r? a(r?|num)

Register = the absolute value of a

Example:

define negativeNumber -10
abs r0 negativeNumber # Compute the absolute value of -10 and store it in register 0


§ 
sgn r a(r?|num)

Stores the sign of a in the register: -1 if a is negative, 1 if positive, 0 if a is 0 (or not a number).



§ 
add r? a(r?|num) b(r?|num)

Register = a + b.

Example:

add r0 r0 1 # increment r0 by one
define num1 10
define num2 20
add r0 num1 num2 # Add 10 and 20 and store the result in register 0


§ 
ceil r? a(r?|num)

Register = smallest integer greater than a

Example:

define floatNumber 10.3
ceil r0 floatNumber # Compute the ceiling of 10.3 and store it in register 0


§ 
div r? a(r?|num) b(r?|num)

Register = a / b



§ 
pow r? a(r?|num) b(r?|num)

Stores the result of raising a to the power of b in the register. Follows IEEE-754 standard for floating point arithmetic.



§ 
exp r? a(r?|num)

exp(a) or e^a



§ 
floor r? a(r?|num)

Register = largest integer less than a



§ 
log r? a(r?|num)

base e log(a) or ln(a)



§ 
max r? a(r?|num) b(r?|num)

Register = max of a or b

Note:

If any of the values is NaN, NaN is returned.


§ 
min r? a(r?|num) b(r?|num)

Register = min of a or b

Note:

If any of the values is NaN, NaN is returned.


§ 
clamp r? a(r?|num) min(r?|num) max(r?|num)

Stores a clamped to the inclusive inclusive range [min, max] in the register provided.

Note:

Functionally equivalent to min(max(a,min),max).
If any of the values are NaN, NaN is returned.

Example:

clamp 100 10 50 = 50
clamp 0 10 50 = 10
clamp 20 10 50 = 20


§ 
mod r? a(r?|num) b(r?|num)

Register = a mod b (note: NOT a % b)

Example:

mod r0 10 20 # Expected: r0=10
mod r1 22 20 # Expected: r1 = 2
mod r2 22 -20 # Expected: r2 = 18
mod r2 22 -10 # Expected: r2 = 18
mod r2 -7 4 # Expected: r2 = 1
mod r2 -7 9 # Expected: r2 = 2


§ 
mul r? a(r?|num) b(r?|num)

Register = a * b



§ 
rand r?

Register = a random value x with 0 <= x < 1



§ 
round r? a(r?|num)

Register = a rounded to nearest integer



§ 
sqrt r? a(r?|num)

Register = square root of a



§ 
sub r? a(r?|num) b(r?|num)

Register = a - b.



§ 
trunc r? a(r?|num)

Register = a with fractional part removed



§ 
lerp r? a(r?|num) b(r?|num) c(r?|num)

Linearly interpolates between a and b by the ratio c, and places the result in the register provided. The ratio c will be clamped between 0 and 1.



Mathematical / Trigonometric

§ 
acos r? a(r?|num)

Returns the angle (radians) whos cos is the specified value



§ 
asin r? a(r?|num)

Returns the angle (radians) whos sine is the specified value



§ 
atan r? a(r?|num)

Returns the angle (radians) whos tan is the specified value



§ 
atan2 r? a(r?|num) b(r?|num)

Returns the angle (radians) whose tangent is the quotient of two specified values: a (y) and b (x)



§ 
cos r? a(r?|num)

Returns the cosine of the specified angle (radians)



§ 
sin r? a(r?|num)

Returns the sine of the specified angle (radians)



§ 
tan r? a(r?|num)

Returns the tan of the specified angle (radians)



Stack

§ 
clr d?

Clears the stack memory for the provided device.

Note:

Throws a DeviceNotFound exception when used on inaccessible devices.

Throws a MemoryNotReadable exception when used on devices without a writable stack memory. (likely a bug)


§ 
clrd id(r?|num)

Seeks directly for the provided device id and clears the stack memory of that device

Note:

Throws a DeviceNotFound exception when used on inaccessible devices.

Throws a MemoryNotWriteable exception when used on devices without a writable stack memory.


§ 
get r? device(d?|r?|id) address(r?|num)

Using the provided device, attempts to read the stack value at the provided address, and places it in the register.

Note:

Throws a DeviceNotFound exception when used on inaccessible devices.

Throws a MemoryNotReadable exception when used on devices without a readable stack memory.


§ 
getd r? id(r?|id) address(r?|num)

Seeks directly for the provided device id, attempts to read the stack value at the provided address, and places it in the register.

Note:

Throws a DeviceNotFound exception when used on inaccessible devices.

Throws a MemoryNotReadable exception when used on devices without a readable stack memory.


§ 
peek r?

Reads the value at stack address sp-1 and saves it into the provided register.

Note:

Out-of-bounds reads result in a stack underflow/overflow exception.


§ 
poke address(r?|num) value(r?|num)

Stores the provided value at the provided address in the stack.

Note:

Out-of-bounds writes result in a stack underflow/overflow exception.

There is no built-in instruction for reading IC10 stack memory at arbitrary addresses. Although circuit housings can use get db, machines with an IC slot need to use a stack pointer assignment followed by a peek as a workaround.


§ 
pop r?

Decrements the stack pointer, then returns the writes the value at the resulting stack pointer address into the provided register.

Note:

Out-of-bounds reads result in a stack underflow/overflow exception.


§ 
push a(r?|num)

Writes the provided value to the stack pointer address, then increments the stack pointer.

Note:

Out-of-bounds writes throw a Stack underflow/overflow exception.


§ 
put device(d?|r?|id) address(r?|num) value(r?|num)

Using the provided device, attempts to write the provided value to its stack at the provided address.

Note:

Throws a DeviceNotFound exception when used on inaccessible devices.

Throws a MemoryNotWritable exception when used on devices without a writable stack memory.

Intercepts exceptions thrown by the device during the attempt to write to the device's stack, passing stack overflow/underflow exceptions through and throwing Unknown exceptions for other exception types.


§ 
putd id(r?|id) address(r?|num) value(r?|num)

Seeks directly for the provided device id, attempts to write the provided value to the stack at the provided address.

Note:

Throws a DeviceNotFound exception when used on inaccessible devices.

Throws a MemoryNotWritable exception when used on devices without a writable stack memory.

Intercepts exceptions thrown by the device during the attempt to write to the device's stack, passing stack overflow/underflow exceptions through and throwing Unknown exceptions for other exception types.


Slot/Logic

§ 
l r? device(d?|r?|id) logicType

Loads device LogicType to register by housing index value.

Example:

Read from the device on d0 into register 0 

l r0 d0 Setting

Read the pressure from a sensor 

l r1 d5 Pressure

This also works with aliases. For example: 

alias Sensor d0
l r0 Sensor Temperature


§ 
lr r? device(d?|r?|id) reagentMode reagentHash

Loads reagent of device's ReagentMode where a hash of the reagent type to check for. ReagentMode can be either Contents (0), Required (1), Recipe (2). Can use either the word, or the number.

Note:

Instruction performs different actions depending on the provided reagent mode.
Valid reagentMode values:

LogicReagentMode.Contents (0): Return how much reagentHash reagent is present in the device.
LogicReagentMode.Required (1): Return how much additional reagentHash reagent is missing to complete the device's currently selected recipe.
LogicReagentMode.Recipe (2): Return how much reagentHash reagent the device's currently selected recipe requires.
LogicReagentMode.TotalContents (3): Return the total amount of reagents a device contains, ignoring reagentHash. Equivalent to "l r device Reagents".

Other reagent modes throw an UnhandledReagentMode exception.

Instruction throws an IncorrectReagentDevice exception on Required and Recipe LogicReagentModes if attempting to use them on a device that can't select a recipe, such as a Furnace.


§ 
ls r? device(d?|r?|id) slotIndex logicSlotType

Loads slot LogicSlotType on device to register.

Example:

Read from the second slot of device on d0, stores 1 in r0 if it's occupied, 0 otherwise. 

ls r0 d0 2 Occupied

And here is the code to read the charge of an AIMeE: 

alias robot d0
alias charge r10
ls charge robot 0 Charge


§ 
s device(d?|r?|id) logicType r?

Stores register value to LogicType on device by housing index value.

Example:

s d0 Setting r0


§ 
ss device(d?|r?|id) slotIndex logicSlotType r?

Stores register value to device stored in a slot LogicSlotType on device.



§ 
rmap r? d? reagentHash(r?|num)

Given a reagent hash (signed 32bit int), store the corresponding prefab hash that the device expects to fulfill the reagent requirement. For example, on an autolathe, the hash for Iron will store the hash for ItemIronIngot.



Slot/Logic / Batched

§ 
lb r? deviceHash logicType batchMode

Loads LogicType from all output network devices with provided type hash using the provide batch mode. Average (0), Sum (1), Minimum (2), Maximum (3). Can use either the word, or the number.

Example:

lb r0 HASH("StructureWallLight") On Sum


§ 
lbn r? deviceHash nameHash logicType batchMode

Loads LogicType from all output network devices with provided type and name hashes using the provide batch mode. Average (0), Sum (1), Minimum (2), Maximum (3). Can use either the word, or the number.



§ 
lbns r? deviceHash nameHash slotIndex logicSlotType batchMode

Loads LogicSlotType from slotIndex from all output network devices with provided type and name hashes using the provide batch mode. Average (0), Sum (1), Minimum (2), Maximum (3). Can use either the word, or the number.



§ 
lbs r? deviceHash slotIndex logicSlotType batchMode

Loads LogicSlotType from slotIndex from all output network devices with provided type hash using the provide batch mode. Average (0), Sum (1), Minimum (2), Maximum (3). Can use either the word, or the number.



§ 
sb deviceHash logicType r?

Stores register value to LogicType on all output network devices with provided type hash.

Example:

sb HASH("StructureWallLight") On 1


§ 
sbn deviceHash nameHash logicType r?

Stores register value to LogicType on all output network devices with provided type hash and name.



§ 
sbs deviceHash slotIndex logicSlotType r?

Stores register value to LogicSlotType on all output network devices with provided type hash in the provided slot.



Bitwise

§ 
and r? a(r?|num) b(r?|num)

Performs a bitwise logical AND operation on the binary representation of two values. Each bit of the result is determined by evaluating the corresponding bits of the input values. If both bits are 1, the resulting bit is set to 1. Otherwise the resulting bit is set to 0.



§ 
nor r? a(r?|num) b(r?|num)

Performs a bitwise logical NOR (NOT OR) operation on the binary representation of two values. Each bit of the result is determined by evaluating the corresponding bits of the input values. If both bits are 0, the resulting bit is set to 1. Otherwise, if at least one bit is 1, the resulting bit is set to 0.



§ 
not r? a(r?|num)

Performs a bitwise logical NOT operation flipping each bit of the input value, resulting in a binary complement. If a bit is 1, it becomes 0, and if a bit is 0, it becomes 1.

Note:

This is a bitwise operation, the NOT of 1 => -2, etc. You may want to use seqz instead


§ 
or r? a(r?|num) b(r?|num)

Performs a bitwise logical OR operation on the binary representation of two values. Each bit of the result is determined by evaluating the corresponding bits of the input values. If either bit is 1, the resulting bit is set to 1. If both bits are 0, the resulting bit is set to 0.



§ 
sla r? a(r?|num) b(r?|num)

Performs a bitwise arithmetic left shift operation on the binary representation of a value. It shifts the bits to the left and fills the vacated rightmost bits with zeros (note that this is indistinguishable from 'sll').



§ 
sll r? a(r?|num) b(r?|num)

Performs a bitwise logical left shift operation on the binary representation of a value. It shifts the bits to the left and fills the vacated rightmost bits with zeros.



§ 
sra r? a(r?|num) b(r?|num)

Performs a bitwise arithmetic right shift operation on the binary representation of a value. It shifts the bits to the right and fills the vacated leftmost bits with a copy of the sign bit (the most significant bit).



§ 
srl r? a(r?|num) b(r?|num)

Performs a bitwise logical right shift operation on the binary representation of a value. It shifts the bits to the right and fills the vacated leftmost bits with zeros



§ 
rol r? a(r?|num) b(r?|num)

Performs a bitwise left rotation on the binary representation of a by b places, wrapping the bits shifted out of the most significant position back into the least significant position.

Example:

rol $DEADBEEFCAFE2000 16 -> $BEEFCAFE2000DEAD


§ 
ror r? a(r?|num) b(r?|num)

Performs a bitwise right rotation on the binary representation of A by B places, wrapping the bits shifted out of the least significant position back into the most significant position.

Example:

ror $1234, 4 -> $4000000000000123


§ 
xor r? a(r?|num) b(r?|num)

Performs a bitwise logical XOR (exclusive OR) operation on the binary representation of two values. Each bit of the result is determined by evaluating the corresponding bits of the input values. If the bits are different (one bit is 0 and the other is 1), the resulting bit is set to 1. If the bits are the same (both 0 or both 1), the resulting bit is set to 0.



§ 
ext r? source(r?|num) offset(r?|num) length(r?|num)

Extracts a bit field from source value, beginning at bit offset for length bits and places result in the provided register. Payload cannot exceed 53 bits in final length.

Note:

Throws a ShiftUnderflow exception if offset is smaller than 1 or length is smaller than 0.
Throws a ShiftOverflow exception if offset is greater than or equal to 53 bits.
Throws a PayloadOverflow exception if length is greater than 53 bits.

Example:

move r0 $DEADBEEF
ext r1 r0 8 16 #After execution, r1's value is $ADBE


§ 
ins r? field(r?|num) offset(r?|num) length(r?|num)

Inserts a bit field into the provided register, beginning at bit offset for length bits. Payload cannot exceed 53 bits in final length.

Note:

Throws a ShiftUnderflow exception if length is smaller than 1 or offset is smaller than 0.
Throws a ShiftOverflow exception if offset is greater than 53 bits.
Throws a PayloadOverflow exception if offset+length is greater to or equal to 53 bits.

Example:

move r0 $DE0000EF
move r1 $ADBE
ins r0 r1 8 16 #inserts field r1 at bit 8 for 16 bits, result: $DEADBEEF


Comparison

§ 
select r? a(r?|num) b(r?|num) c(r?|num)

Register = b if a is non-zero, otherwise c

Note:

This operation can be used as a simple ternary condition

Example:

1)
move r0 0
select r1 r0 10 200 

move r0 0
select r1 r0 10 200


after run, r1 = 200

2)
move r0 5
select r1 r0 10 200 

move r0 1
select r1 r0 10 100

after run, r1 = 10


Comparison / Device Pin

§ 
sdns r? device(d?|r?|id)

Register = 1 if device is not set, otherwise 0



§ 
sdse r? device(d?|r?|id)

Register = 1 if device is set, otherwise 0.



Comparison / Value

§ 
sap r? a(r?|num) b(r?|num) c(r?|num)

Register = 1 if abs(a - b) <= max(c * max(abs(a), abs(b)), float.epsilon * 8), otherwise 0

Example:

Set register to 1 if a and b are close enough to each other with the scaling factor of c. Equivalent to Python math.isclose


§ 
sapz r? a(r?|num) b(r?|num)

Register = 1 if abs(a) <= max(b * abs(a), float.epsilon * 8), otherwise 0



§ 
seq r? a(r?|num) b(r?|num)

Register = 1 if a == b, otherwise 0



§ 
seqz r? a(r?|num)

Register = 1 if a == 0, otherwise 0



§ 
sge r? a(r?|num) b(r?|num)

Register = 1 if a >= b, otherwise 0



§ 
sgez r? a(r?|num)

Register = 1 if a >= 0, otherwise 0



§ 
sgt r? a(r?|num) b(r?|num)

Register = 1 if a > b, otherwise 0



§ 
sgtz r? a(r?|num)

Register = 1 if a > 0, otherwise 0



§ 
sle r? a(r?|num) b(r?|num)

Register = 1 if a <= b, otherwise 0



§ 
slez r? a(r?|num)

Register = 1 if a <= 0, otherwise 0



§ 
slt r? a(r?|num) b(r?|num)

Register = 1 if a < b, otherwise 0



§ 
sltz r? a(r?|num)

Register = 1 if a < 0, otherwise 0



§ 
sna r? a(r?|num) b(r?|num) c(r?|num)

Register = 1 if abs(a - b) > max(c * max(abs(a), abs(b)), float.epsilon * 8), otherwise 0



§ 
snan r? a(r?|num)

Register = 1 if a is NaN, otherwise 0



§ 
snanz r? a(r?|num)

Register = 0 if a is NaN, otherwise 1



§ 
snaz r? a(r?|num) b(r?|num)

Register = 1 if abs(a) > max(b * abs(a), float.epsilon), otherwise 0



§ 
sne r? a(r?|num) b(r?|num)

Register = 1 if a != b, otherwise 0



§ 
snez r? a(r?|num)

Register = 1 if a != 0, otherwise 0



Branching

§ 
j int

Jump execution to line a

Example:

j 0 # jump line 0
j label # jump to a label

label:
# your code here


§ 
jal int

Jump execution to line a and store next line number in ra

Note:

Actual behavior as of The Power Line Update (Q3 2026) stores the next line number in ra before jumping execution to line a. This results in jal ra being a no-op (likely a bug).

As a workaround, an always-taken branch-and-link can be used instead (for example, beqzal 0 ra).

Example:

jal provides a way to do function calls in IC10 mips 

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

average:
add r0 r0 r1
div r0 r0 2
j ra # jump back


§ 
jr int

Relative jump to line a



Branching / Device Pin

§ 
bdnvl device(d?|r?|id) logicType a(r?|num)

Will branch to line a if the provided device not valid for a load instruction for the provided logic type.



§ 
bdnvs device(d?|r?|id) logicType a(r?|num)

Will branch to line a if the provided device not valid for a store instruction for the provided logic type.



§ 
bdns d? a(r?|num)

Branch to line a if device d isn't set



§ 
bdnsal d? a(r?|num)

Jump execution to line a and store next line number if device is not set



§ 
bdse d? a(r?|num)

Branch to line a if device d is set



§ 
bdseal d? a(r?|num)

Jump execution to line a and store next line number if device is set

Example:

#Store line number and jump to line 32 if d0 is assigned.
bdseal d0 32

#Store line in ra and jump to label HarvestCrop if device d0 is assigned.
bdseal d0 HarvestCrop


§ 
brdns d? a(r?|num)

Relative branch to line a if device is not set



§ 
brdse d? a(r?|num)

Relative branch to line a if device is set



Branching / Comparison

§ 
bap a(r?|num) b(r?|num) c(r?|num) d(r?|num)

Branch to line d if abs(a - b) <= max(c * max(abs(a), abs(b)), float.epsilon * 8)

Example:

Branch if a and b are close enough to each other with the scaling factor of c. Equivalent to Python math.isclose


§ 
brap a(r?|num) b(r?|num) c(r?|num) d(r?|num)

Relative branch to line d if abs(a - b) <= max(c * max(abs(a), abs(b)), float.epsilon * 8)



§ 
bapal a(r?|num) b(r?|num) c(r?|num) d(r?|num)

Branch to line c if a != b and store next line number in ra



§ 
bapz a(r?|num) b(r?|num) c(r?|num)

Branch to line c if abs(a) <= max(b * abs(a), float.epsilon * 8)



§ 
brapz a(r?|num) b(r?|num) c(r?|num)

Relative branch to line c if abs(a) <= max(b * abs(a), float.epsilon * 8)



§ 
bapzal a(r?|num) b(r?|num) c(r?|num)

Branch to line c if abs(a) <= max(b * abs(a), float.epsilon * 8) and store next line number in ra



§ 
beq a(r?|num) b(r?|num) c(r?|num)

Branch to line c if a == b



§ 
breq a(r?|num) b(r?|num) c(r?|num)

Relative branch to line c if a == b



§ 
beqal a(r?|num) b(r?|num) c(r?|num)

Branch to line c if a == b and store next line number in ra



§ 
beqz a(r?|num) b(r?|num)

Branch to line b if a == 0



§ 
breqz a(r?|num) b(r?|num)

Relative branch to line b if a == 0



§ 
beqzal a(r?|num) b(r?|num)

Branch to line b if a == 0 and store next line number in ra



§ 
bge a(r?|num) b(r?|num) c(r?|num)

Branch to line c if a >= b



§ 
brge a(r?|num) b(r?|num) c(r?|num)

Relative branch to line c if a >= b



§ 
bgeal a(r?|num) b(r?|num) c(r?|num)

Branch to line c if a >= b and store next line number in ra



§ 
bgez a(r?|num) b(r?|num)

Branch to line b if a >= 0



§ 
brgez a(r?|num) b(r?|num)

Relative branch to line b if a >= 0



§ 
bgezal a(r?|num) b(r?|num)

Branch to line b if a >= 0 and store next line number in ra



§ 
bgt a(r?|num) b(r?|num) c(r?|num)

Branch to line c if a > b

Example:

An example of a Schmitt trigger, turning on a device if the temperature is too low, and turning it off if it's too high and finally doing nothing if the temperature is within the desired range. 

alias sensor d0
alias device d1

define mintemp 293.15
define maxtemp 298.15

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

turnOn:
s device On 1
j start
turnOff:
s device On 0
j start


§ 
brgt a(r?|num) b(r?|num) c(r?|num)

relative branch to line c if a > b



§ 
bgtal a(r?|num) b(r?|num) c(r?|num)

Branch to line c if a > b and store next line number in ra



§ 
bgtz a(r?|num) b(r?|num)

Branch to line b if a > 0



§ 
brgtz a(r?|num) b(r?|num)

Relative branch to line b if a > 0



§ 
bgtzal a(r?|num) b(r?|num)

Branch to line b if a > 0 and store next line number in ra



§ 
ble a(r?|num) b(r?|num) c(r?|num)

Branch to line c if a <= b



§ 
brle a(r?|num) b(r?|num) c(r?|num)

Relative branch to line c if a <= b



§ 
bleal a(r?|num) b(r?|num) c(r?|num)

Branch to line c if a <= b and store next line number in ra



§ 
blez a(r?|num) b(r?|num)

Branch to line b if a <= 0



§ 
brlez a(r?|num) b(r?|num)

Relative branch to line b if a <= 0



§ 
blezal a(r?|num) b(r?|num)

Branch to line b if a <= 0 and store next line number in ra



§ 
blt a(r?|num) b(r?|num) c(r?|num)

Branch to line c if a < b

Example:

An example of a Schmitt trigger, turning on a device if the temperature is too low, and turning it off if it's too high and finally doing nothing if the temperature is within the desired range. 

alias sensor d0
alias device d1

define mintemp 293.15
define maxtemp 298.15

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

turnOn:
s device On 1
j start
turnOff:
s device On 0
j start


§ 
brlt a(r?|num) b(r?|num) c(r?|num)

Relative branch to line c if a < b



§ 
bltal a(r?|num) b(r?|num) c(r?|num)

Branch to line c if a < b and store next line number in ra



§ 
bltz a(r?|num) b(r?|num)

Branch to line b if a < 0



§ 
brltz a(r?|num) b(r?|num)

Relative branch to line b if a < 0



§ 
bltzal a(r?|num) b(r?|num)

Branch to line b if a < 0 and store next line number in ra



§ 
bna a(r?|num) b(r?|num) c(r?|num) d(r?|num)

Branch to line d if abs(a - b) > max(c * max(abs(a), abs(b)), float.epsilon * 8)



§ 
brna a(r?|num) b(r?|num) c(r?|num) d(r?|num)

Relative branch to line d if abs(a - b) > max(c * max(abs(a), abs(b)), float.epsilon * 8)



§ 
bnaal a(r?|num) b(r?|num) c(r?|num) d(r?|num)

Branch to line d if abs(a - b) <= max(c * max(abs(a), abs(b)), float.epsilon * 8) and store next line number in ra



§ 
bnan a(r?|num) b(r?|num)

Branch to line b if a is not a number (NaN)



§ 
brnan a(r?|num) b(r?|num)

Relative branch to line b if a is not a number (NaN)



§ 
bnaz a(r?|num) b(r?|num) c(r?|num)

Branch to line c if abs(a) > max (b * abs(a), float.epsilon * 8)



§ 
brnaz a(r?|num) b(r?|num) c(r?|num)

Relative branch to line c if abs(a) > max(b * abs(a), float.epsilon * 8)



§ 
bnazal a(r?|num) b(r?|num) c(r?|num)

Branch to line c if abs(a) > max (b * abs(a), float.epsilon * 8) and store next line number in ra



§ 
bne a(r?|num) b(r?|num) c(r?|num)

Branch to line c if a != b



§ 
brne a(r?|num) b(r?|num) c(r?|num)

Relative branch to line c if a != b



§ 
bneal a(r?|num) b(r?|num) c(r?|num)

Branch to line c if a != b and store next line number in ra



§ 
bnez a(r?|num) b(r?|num)

branch to line b if a != 0



§ 
brnez a(r?|num) b(r?|num)

Relative branch to line b if a != 0



§ 
bnezal a(r?|num) b(r?|num)

Branch to line b if a != 0 and store next line number in ra


Retrieved from "https://stationeers-wiki.com/index.php?title=IC10/instructions&oldid=28171"
Last modified
This page was last edited on 14 September 2026, at 14:31.