Signal Processor - Revision history

Grissess: /* Functions */ If we're including that, might as well talk about the general form

2022-11-21T17:03:09Z

‎Functions: If we're including that, might as well talk about the general form

Jrddunbr: Added note about square root

2022-07-04T01:03:51Z

Added note about square root

Omega Haxors: Replaced instances of "Asserted" with "Pulsed" to improve readability

2020-06-24T07:47:03Z

Replaced instances of "Asserted" with "Pulsed" to improve readability

Omega Haxors: RS function's description is no longer needlessly complicated

2020-06-24T07:39:34Z

RS function's description is no longer needlessly complicated

Random832: /* Boolean operators */ > and < don't belong here, they return 0 and 1 but don't do the input conversion described here, and it's important to emphasize that = does

2020-05-06T05:44:16Z

‎Boolean operators: > and < don't belong here, they return 0 and 1 but don't do the input conversion described here, and it's important to emphasize that = does

Random832: Add some functions that weren't documented here that appear in the current source code [2dcd467678a7908eec4ee3de73980367bec47b0d]

2020-05-06T05:43:29Z

Add some functions that weren't documented here that appear in the current source code [2dcd467678a7908eec4ee3de73980367bec47b0d]

DennisQt: /* Redstone Cost */

2019-12-29T15:56:13Z

‎Redstone Cost

DennisQt at 13:13, 30 August 2019

2019-08-30T13:13:37Z

Jrddunbr: /* Redstone Cost */ (am actually a derp)

2019-08-29T21:16:02Z

‎Redstone Cost: (am actually a derp)

Jrddunbr: /* Redstone Cost */

2019-08-29T21:13:51Z

‎Redstone Cost

@@ Line 68: / Line 68: @@
 * '''sin(x), cos(x), asin(x), acos(x)''': Performs trigonometry, using radians for angle units.
 * '''abs(x)''': Turns any negative number positive.
-* '''pow(x, y)''': Calculates x to the y power. Tip: you can use '''pow(x, 0.5)''' for square root.
+* '''pow(x, y)''': Calculates x to the y power. Tip: you can use '''pow(x, 0.5)''' for square root (or '''pow(x, 1/n)''' for any ''n''th root).
 * '''scale(x, in0, in1, out0, out1)''':  Scales x from within range in0 (min) and in1 (max) to within range out0 (min) and out1 (max) in a linearly proportional manner.
 * '''batteryCharge(x)''': Returns the battery charge, given the open-circuit voltage of a battery expressed as a fraction of its nominal voltage. For example, batteryCharge(1) can be a 50V battery at 50V, a 200V battery at 200V or a battery bank with 800V nominal voltage at 800V. Since the battery voltage can go above it's nominal voltage, the value given to the function has to be able to get above 1(represents the battery's nominal voltage) too. This is achieved by rescaling the value given by a probe that can measure voltages above the battery's nominal voltage. For example the value given by a probe that can measure from 0V to 60V connected to a 50V battery has to be multiplied with 1.2(60V / 50V = 1.2) so 50V at the battery is represented as 1 to the function instead of 0.83 as given by the probe.

@@ Line 68: / Line 68: @@
 * '''sin(x), cos(x), asin(x), acos(x)''': Performs trigonometry, using radians for angle units.
 * '''abs(x)''': Turns any negative number positive.
-* '''pow(x, y)''': Calculates x to the y power.
+* '''pow(x, y)''': Calculates x to the y power. Tip: you can use '''pow(x, 0.5)''' for square root.
 * '''scale(x, in0, in1, out0, out1)''':  Scales x from within range in0 (min) and in1 (max) to within range out0 (min) and out1 (max) in a linearly proportional manner.
 * '''batteryCharge(x)''': Returns the battery charge, given the open-circuit voltage of a battery expressed as a fraction of its nominal voltage. For example, batteryCharge(1) can be a 50V battery at 50V, a 200V battery at 200V or a battery bank with 800V nominal voltage at 800V. Since the battery voltage can go above it's nominal voltage, the value given to the function has to be able to get above 1(represents the battery's nominal voltage) too. This is achieved by rescaling the value given by a probe that can measure voltages above the battery's nominal voltage. For example the value given by a probe that can measure from 0V to 60V connected to a 50V battery has to be multiplied with 1.2(60V / 50V = 1.2) so 50V at the battery is represented as 1 to the function instead of 0.83 as given by the probe.

@@ Line 75: / Line 75: @@
 * '''ramp(period)''': Generates a sawtooth wave, at the given period.
-* '''rs(reset, set)''': Holds a Boolean value. When Set is TRUE, output becomes 1. When Reset is TRUE, output becomes 0.
+* '''rs(reset, set)''': Holds a Boolean value. When Set is pulsed, output becomes 1. When Reset is pulsed, output becomes 0.
-* '''integrate(value, resetTrigger)''': Sums "value" over time, and returns the sum. Resets if resetTrigger is asserted.
+* '''integrate(value, resetTrigger)''': Sums "value" over time, and returns the sum. Resets if resetTrigger is pulsed.
 * '''integrate(value, min, max)''': Sums "value" over time. Will never return values outside of its min/max bounds; its internal counter is bounded to these values. Does not have a reset trigger.
-* '''derivate(value)''': At each tick, returns the difference between the current and previous tick.
+* '''derivate(value)''': At each tick, outputs the difference between the current and previous tick.
-* '''rc(tao, value)''': Returns the moving average of "value" across the last "tao" seconds.
+* '''rc(tao, value)''': Outputs the moving average of "value" across the last "tao" seconds.
 * '''pid(target, actual, p, i, d, minV, maxV)''': Returns min(minV, max(maxV, pid(target, hit, p, i, d)))
 * '''pid(target, actual, p, i, d)''': This implements a PID controller. See below under [[#PID_Controller_procedure]].

@@ Line 75: / Line 75: @@
 * '''ramp(period)''': Generates a sawtooth wave, at the given period.
-* '''rs(reset, set)''': Initially returns 0. When set is asserted—set to 0.6 or higher—it begins returning 1, and will maintain this return value until reset is asserted, at which point it returns to 0.
+* '''rs(reset, set)''': Holds a Boolean value. When Set is TRUE, output becomes 1. When Reset is TRUE, output becomes 0.
 * '''integrate(value, resetTrigger)''': Sums "value" over time, and returns the sum. Resets if resetTrigger is asserted.
 * '''integrate(value, min, max)''': Sums "value" over time. Will never return values outside of its min/max bounds; its internal counter is bounded to these values. Does not have a reset trigger.

@@ Line 60: / Line 60: @@
 === Boolean operators ===
-The >, <, &, |, = and ^ operators exist. These operate by reading any value less than 0.5 as "false", 0.5 or larger as "true". So, for example, 0.3 | 0.7 = 1, while 0.3 & 0.7 = 0.
+The &, |, = and ^ operators exist. These operate by reading any value less than 0.5 as "false", 0.5 or larger as "true". So, for example, 0.3 | 0.7 = 1, while 0.3 & 0.7 = 0.
 === Functions ===

@@ Line 43: / Line 43: @@
 === Arithmetic ===
-The Signal Processor can handle Addition(+), Subtraction(-), Multiplication(*), Division(/), and Modulus(%)
+The Signal Processor can handle Addition(+), Subtraction(-), Multiplication(*), Division(/), and Modulus(%). It can use the unary minus (-) operator to invert the sign of an argument.
 The mathematical functions will process internally, and have no limit, but all results will be clamped upon exporting. Keep in mind that inputs are represented as a percentage from 0 to 1, with 25V appearing as 0.5 (50%)
@@ Line 52: / Line 52: @@
 First, the input voltage is multiplied by 50 to convert it into a Voltage value (rather than a percent) This turns the input 0.5 into the whole number 25. Next, the number is doubled. Once all that is complete, the result is divided by 50 to return it back to a % value, ready to be exported as the new value: 1 (or 50V) Converting to a voltage value then back may seem like extra work, but being able to work with an intuitive number make the Signal Processor much easier to work with.
 === Boolean operators ===
@@ Line 61: / Line 66: @@
 * '''if(a, b, c)''': If a >= 0.5, this returns b; otherwise, c.
 * '''min(x, y), max(x, y)''': Respectively, the smaller or larger of x and y.
-* '''sin(x), cos(x)''': Performs trigonometry, interpreting x as radians.
+* '''sin(x), cos(x), asin(x), acos(x)''': Performs trigonometry, using radians for angle units.
 * '''abs(x)''': Turns any negative number positive.
 * '''scale(x, in0, in1, out0, out1)''':  Scales x from within range in0 (min) and in1 (max) to within range out0 (min) and out1 (max) in a linearly proportional manner.
 * '''batteryCharge(x)''': Returns the battery charge, given the open-circuit voltage of a battery expressed as a fraction of its nominal voltage. For example, batteryCharge(1) can be a 50V battery at 50V, a 200V battery at 200V or a battery bank with 800V nominal voltage at 800V. Since the battery voltage can go above it's nominal voltage, the value given to the function has to be able to get above 1(represents the battery's nominal voltage) too. This is achieved by rescaling the value given by a probe that can measure voltages above the battery's nominal voltage. For example the value given by a probe that can measure from 0V to 60V connected to a 50V battery has to be multiplied with 1.2(60V / 50V = 1.2) so 50V at the battery is represented as 1 to the function instead of 0.83 as given by the probe.

@@ Line 118: / Line 118: @@
 |if()                                     || 2
 |-
-|mix(), max()                             || 2
+|min(), max()                             || 2
 |-
 |sin(), cos()                             || 2

@@ Line 115: / Line 115: @@
 |-
 |abs()                                    || 1
 |-
 |if()                                     || 2
@@ Line 133: / Line 131: @@
 |-
 |integrate()                              || 4
 |-
 |batteryCharge()                          || 8

@@ Line 135: / Line 135: @@
 |-
 |batteryCharge()                          || 8
 |-
 |pid(target, actual, p, i, d, minV, maxV) || 14
 |}

@@ Line 113: / Line 113: @@
 |-
 |Boolean operators                        || 1
 |-
 |if()                                     || 2
@@ Line 119: / Line 123: @@
 |-
 |sin(), cos()                             || 2
 |-
 |ramp()                                   || 3
 |-
 |rs()                                     || 3
 |-
 |derivate()                               || 3
 |-
 |rc()                                     || 3
 |-
 |pid(target, actual, p, i, d, minV, maxV) || 14