Improved Comments

Added comments for new functions

Author: RoaCode

adafruit_ads1x15/ads1x15.py

@@ -252,15 +252,15 @@ def _write_register(self, reg: int, value: int):
             i2c.write(self.buf)
 
     def write_comparator_low_threshold(self, value: int):
-        """Write 16 bit value to register."""
+        """Write 16 bit value to Comparator Low Threshold register."""
         self.buf[0] = _ADS1X15_POINTER_LO_THRES
         self.buf[1] = (value >> 8) & 0xFF
         self.buf[2] = value & 0xFF
         with self.i2c_device as i2c:
             i2c.write(self.buf)
 
     def write_comparator_high_threshold(self, value: int):
-        """Write 16 bit value to register."""
+        """Write 16 bit value to Comparator High Threshold register."""
         self.buf[0] = _ADS1X15_POINTER_HI_THRES
         self.buf[1] = (value >> 8) & 0xFF
         self.buf[2] = value & 0xFF

adafruit_ads1x15/analog_in.py

@@ -66,5 +66,6 @@ def voltage(self) -> float:
         return volts
 
     def ADC_value(self, volts: float) -> int:
+        """Calculates integer for threshold registers from voltage level input"""
         value = int((volts * 32767) / _ADS1X15_PGA_RANGE[self._ads.gain])
         return value

examples/ads1x15_comparator_example.py

@@ -25,9 +25,12 @@
 # Create Interrupt-driven input to track comparator changes
 int_pin = countio.Counter(board.GP9, edge=countio.Edge.RISE)
 
+# Set comparator to assert after 1 ADC conversion
 ads.compqueue = 1
-ads.write_comparator_low_threshold(0x3E80)
-ads.write_comparator_high_threshold(0x3E90)
+# Set comparator low threshold to 2V
+ads.write_comparator_low_threshold(chan.ADC_value(2))
+# Set comparator high threshold to 2.002V. High threshold must be above low threshold
+ads.write_comparator_high_threshold(chan.ADC_value(2.002))
 
 count = 0
 while True: