From 4e8764f43d81e17342355cbfad37e00bd0f1a97b Mon Sep 17 00:00:00 2001 From: caternuson Date: Thu, 27 Jun 2024 10:39:04 -0700 Subject: [PATCH] update doc string for value --- adafruit_ads1x15/analog_in.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/adafruit_ads1x15/analog_in.py b/adafruit_ads1x15/analog_in.py index 310c092..e13e11e 100644 --- a/adafruit_ads1x15/analog_in.py +++ b/adafruit_ads1x15/analog_in.py @@ -49,7 +49,12 @@ def __init__( @property def value(self) -> int: - """Returns the value of an ADC pin as an integer.""" + """The value on the analog pin between 0 and 65535 + inclusive (16-bit). (read-only) + + Even if the underlying analog to digital converter (ADC) is + lower resolution, the value is 16-bit. + """ return self._ads.read( self._pin_setting, is_differential=self.is_differential ) << (16 - self._ads.bits)