Add Kompari-inspired contrib script (#290)

* Initial commit of the new Kompari module

* Typo

* Output analog signals on CV4-6 instead of just CV6

Author: chrisib

software/contrib/README.md

@@ -61,6 +61,14 @@ The division of the master clock that each LFO runs at, as well as each of their
 <i>Author: [roryjamesallen](https://github.com/roryjamesallen)</i>
 <br><i>Labels: LFO</i>
 
+### Kompari \[ [documentation](/software/contrib/kompari.md) | [script](/software/contrib/kompari.py) \]
+
+Compares `AIN` to `K1` and `K2`, outputting 5V digital signals on `CV1`-`CV5`, and an analogue output signal based on
+comparing all 3 sources.
+
+<i>Author: [chrisib](https://github.com/chrisib)</i>
+<br><i>Labels: logic, gates, binary operators</i>
+
 ### Logic \[ [documentation](/software/contrib/logic.md) | [script](/software/contrib/logic.py) \]
 
 Treats both inputs as digital on/off signals and outputs the results of binary AND, OR, XOR, NAND, NOR, and XNOR operations on outputs 1-6.

software/contrib/kompari.md

@@ -0,0 +1,16 @@
+# Kompari
+
+This program is a EuriPi re-imagining of Allen Synthesis' Kompari module.
+
+## Inputs & Outputs
+
+`AIN` is used for the input signal.  `K1` and `K2` define the lower & upper bounds for comparisons based on
+the knob position.
+
+Outputs:
+- `CV1` +5V if `K1` < `AIN`, otherwise 0
+- `CV2` +5V if `AIN` < `K2`, otherwise 0
+- `CV3` +5V if `K1` < `AIN` < `K2`, otherwise 0
+- `CV4` `max(K1, AIN)`
+- `CV5` `min(AIN, K2)`
+- `CV6` `max(K1, min(AIN, K2))`

software/contrib/kompari.py

@@ -0,0 +1,68 @@
+#!/usr/bin/env python3
+"""A EuroPi re-imagining of the Kompari module
+
+Input A is provided in AIN.  K1 and K2 provide the lower and upper bounds
+
+Outputs:
+- CV1: +5V if K1 < AIN, otherwise 0
+- CV2: +5V if AIN < K2, otherwise 0
+- CV3: +5V if K1 < AIN < K2, otherwise 0
+- CV4: max( K1, AIN )
+- CV5: min( AIN, K2 )
+- CV6: max( K1, min( AIN, K2 ) ) )
+
+B1, B2, and DIN are not used
+
+@author Chris Iverach-Brereton
+@year 2023
+"""
+
+from europi import *
+from europi_script import EuroPiScript
+
+class Kompari(EuroPiScript):
+    """The main Kompari script.  See module comment for usage
+    """
+    HIGH_VOLTAGE = 5.0
+    LOW_VOLTAGE = 0.0
+
+    def __init__(self):
+        super().__init__()
+
+    @classmethod
+    def display_name(cls):
+        return "Kompari"
+
+    def main(self):
+        """Run the main loop
+        """
+        while True:
+            lower_bound = k1.percent()
+            upper_bound = k2.percent()
+            x = ain.percent()
+
+            if lower_bound < x:
+                cv1.voltage(self.HIGH_VOLTAGE)
+            else:
+                cv1.voltage(self.LOW_VOLTAGE)
+
+            if x < upper_bound:
+                cv2.voltage(self.HIGH_VOLTAGE)
+            else:
+                cv2.voltage(self.LOW_VOLTAGE)
+
+            if lower_bound < x and x < upper_bound:
+                cv3.voltage(self.HIGH_VOLTAGE)
+            else:
+                cv3.voltage(self.LOW_VOLTAGE)
+
+            cv4.voltage(max(lower_bound, x) * MAX_OUTPUT_VOLTAGE)
+            cv5.voltage(min(x, upper_bound) * MAX_OUTPUT_VOLTAGE)
+            cv6.voltage(max(lower_bound, min(x, upper_bound)) * MAX_OUTPUT_VOLTAGE)
+
+            oled.fill(0)
+            oled.centre_text(f"{lower_bound:0.1f}  {x:0.1f}  {upper_bound:0.1f}")
+            oled.show()
+
+if __name__ == "__main__":
+    Kompari().main()

software/contrib/menu.py

@@ -26,6 +26,7 @@
     "contrib.harmonic_lfos.HarmonicLFOs",
     "contrib.hello_world.HelloWorld",
     "contrib.knob_playground.KnobPlayground",
+    "contrib.kompari.Kompari",
     "contrib.logic.Logic",
     "contrib.master_clock.MasterClock",
     "contrib.noddy_holder.NoddyHolder",