Make value return int

Value should always be numeric in nature; is_active is the "pure" bool
version. This commit also deals with sorting "value" attributes
correctly in the docs.

Author: waveform80

docs/api_input.rst

@@ -56,21 +56,21 @@ Button
 ------
 
 .. autoclass:: Button(pin, \*, pull_up=True, active_state=None, bounce_time=None, hold_time=1, hold_repeat=False, pin_factory=None)
-    :members: wait_for_press, wait_for_release, pin, is_pressed, is_held, hold_time, held_time, hold_repeat, pull_up, when_pressed, when_released, when_held
+    :members: wait_for_press, wait_for_release, pin, is_pressed, is_held, hold_time, held_time, hold_repeat, pull_up, when_pressed, when_released, when_held, value
 
 
 LineSensor (TRCT5000)
 ---------------------
 
 .. autoclass:: LineSensor(pin, \*, queue_len=5, sample_rate=100, threshold=0.5, partial=False, pin_factory=None)
-    :members: wait_for_line, wait_for_no_line, pin, line_detected, when_line, when_no_line
+    :members: wait_for_line, wait_for_no_line, pin, line_detected, when_line, when_no_line, value
 
 
 MotionSensor (D-SUN PIR)
 ------------------------
 
 .. autoclass:: MotionSensor(pin, \*, queue_len=1, sample_rate=10, threshold=0.5, partial=False, pin_factory=None)
-    :members: wait_for_motion, wait_for_no_motion, pin, motion_detected, when_motion, when_no_motion
+    :members: wait_for_motion, wait_for_no_motion, pin, motion_detected, when_motion, when_no_motion, value
 
 
 LightSensor (LDR)

gpiozero/devices.py

@@ -524,7 +524,7 @@ def __init__(self, pin=None, **kwargs):
         self._inactive_state = False
 
     def _state_to_value(self, state):
-        return bool(state == self._active_state)
+        return int(state == self._active_state)
 
     def _read(self):
         try:

gpiozero/input_devices.py

@@ -191,7 +191,10 @@ def __init__(
             raise
 
     def _pin_changed(self, ticks, state):
-        self._fire_events(ticks, self._state_to_value(state))
+        # XXX This is a bit of a hack; _fire_events takes *is_active* rather
+        # than *value*. Here we're assuming no-one's overridden the default
+        # implementation of *is_active*.
+        self._fire_events(ticks, bool(self._state_to_value(state)))
 
 
 class SmoothedInputDevice(EventsMixin, InputDevice):
@@ -420,10 +423,6 @@ class Button(HoldMixin, DigitalInputDevice):
     :param pin_factory:
         See :doc:`api_pins` for more information (this is an advanced feature
         which most users can ignore).
-
-    .. attribute:: value
-
-        Returns 1 if the button is currently pressed, and 0 if it is not.
     """
     def __init__(
             self, pin=None, pull_up=True, active_state=None, bounce_time=None,
@@ -434,6 +433,13 @@ def __init__(
         self.hold_time = hold_time
         self.hold_repeat = hold_repeat
 
+    @property
+    def value(self):
+        """
+        Returns 1 if the button is currently pressed, and 0 if it is not.
+        """
+        return super(Button, self).value
+
 Button.is_pressed = Button.is_active
 Button.pressed_time = Button.active_time
 Button.when_pressed = Button.when_activated
@@ -504,12 +510,6 @@ class LineSensor(SmoothedInputDevice):
         which most users can ignore).
 
     .. _CamJam #3 EduKit: http://camjam.me/?page_id=1035
-
-    .. attribute:: value
-
-        Returns a value representing the average of the queued values. This
-        is nearer 0 for black under the sensor, and nearer 1 for white under
-        the sensor.
     """
     def __init__(
             self, pin=None, pull_up=False, active_state=None, queue_len=5,
@@ -525,6 +525,15 @@ def __init__(
             self.close()
             raise
 
+    @property
+    def value(self):
+        """
+        Returns a value representing the average of the queued values. This
+        is nearer 0 for black under the sensor, and nearer 1 for white under
+        the sensor.
+        """
+        return super(LineSensor, self).value
+
     @property
     def line_detected(self):
         return not self.is_active
@@ -594,13 +603,6 @@ class MotionSensor(SmoothedInputDevice):
     :param pin_factory:
         See :doc:`api_pins` for more information (this is an advanced feature
         which most users can ignore).
-
-    .. attribute:: value
-
-        With the default *queue_len* of 1, this is effectively boolean where 0
-        means no motion detected and 1 means motion detected. If you specify
-        a *queue_len* greater than 1, this will be an averaged value where
-        values closer to 1 imply motion detection.
     """
     def __init__(
             self, pin=None, pull_up=False, active_state=None, queue_len=1,
@@ -615,6 +617,16 @@ def __init__(
             self.close()
             raise
 
+    @property
+    def value(self):
+        """
+        With the default *queue_len* of 1, this is effectively boolean where 0
+        means no motion detected and 1 means motion detected. If you specify
+        a *queue_len* greater than 1, this will be an averaged value where
+        values closer to 1 imply motion detection.
+        """
+        return super(MotionSensor, self).value
+
 MotionSensor.motion_detected = MotionSensor.is_active
 MotionSensor.when_motion = MotionSensor.when_activated
 MotionSensor.when_no_motion = MotionSensor.when_deactivated
@@ -675,10 +687,6 @@ class LightSensor(SmoothedInputDevice):
         which most users can ignore).
 
     .. _CamJam #2 EduKit: http://camjam.me/?page_id=623
-
-    .. attribute:: value
-
-        Returns a value between 0 (dark) and 1 (light).
     """
     def __init__(
             self, pin=None, queue_len=5, charge_time_limit=0.01,
@@ -724,6 +732,13 @@ def _read(self):
                 self.pin_factory.ticks_diff(self._charge_time, start) /
                 self.charge_time_limit)
 
+    @property
+    def value(self):
+        """
+        Returns a value between 0 (dark) and 1 (light).
+        """
+        return super(LightSensor, self).value
+
 LightSensor.light_detected = LightSensor.is_active
 LightSensor.when_light = LightSensor.when_activated
 LightSensor.when_dark = LightSensor.when_deactivated
@@ -827,13 +842,6 @@ class DistanceSensor(SmoothedInputDevice):
         which most users can ignore).
 
     .. _CamJam #3 EduKit: http://camjam.me/?page_id=1035
-
-    .. attribute:: value
-
-        Returns a value between 0, indicating the reflector is either touching
-        the sensor or is sufficiently near that the sensor can't tell the
-        difference, and 1, indicating the reflector is at or beyond the
-        specified *max_distance*.
     """
     ECHO_LOCK = Lock()
 
@@ -916,6 +924,16 @@ def distance(self):
         """
         return self.value * self._max_distance
 
+    @property
+    def value(self):
+        """
+        Returns a value between 0, indicating the reflector is either touching
+        the sensor or is sufficiently near that the sensor can't tell the
+        difference, and 1, indicating the reflector is at or beyond the
+        specified *max_distance*.
+        """
+        return super(DistanceSensor, self).value
+
     @property
     def trigger(self):
         """

gpiozero/output_devices.py

@@ -134,9 +134,8 @@ def toggle(self):
     @property
     def value(self):
         """
-        Returns :data:`True` if the device is currently active and
-        :data:`False` otherwise. Setting this property changes the state of the
-        device.
+        Returns 1 if the device is currently active and 0 otherwise. Setting
+        this property changes the state of the device.
         """
         return super(OutputDevice, self).value
 
@@ -214,7 +213,7 @@ def __init__(
 
     @property
     def value(self):
-        return self._read()
+        return super(DigitalOutputDevice, self).value
 
     @value.setter
     def value(self, value):
@@ -451,7 +450,7 @@ def value(self):
         The duty cycle of the PWM device. 0.0 is off, 1.0 is fully on. Values
         in between may be specified for varying levels of power in the device.
         """
-        return self._read()
+        return super(PWMOutputDevice, self).value
 
     @value.setter
     def value(self, value):