Skip to content

Commit 06be85a

Browse files
authored
Merge pull request gpiozero#744 from RPi-Distro/value-docs
Fix gpiozero#379 (again ;)
2 parents e49bbbd + 69fc0f7 commit 06be85a

18 files changed

+893
-1117
lines changed

docs/_static/keep-me

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This file only exists for git to notice the directory

docs/api_input.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,35 +56,35 @@ Button
5656
------
5757

5858
.. autoclass:: Button(pin, \*, pull_up=True, active_state=None, bounce_time=None, hold_time=1, hold_repeat=False, pin_factory=None)
59-
: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
59+
: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
6060

6161

6262
LineSensor (TRCT5000)
6363
---------------------
6464

6565
.. autoclass:: LineSensor(pin, \*, queue_len=5, sample_rate=100, threshold=0.5, partial=False, pin_factory=None)
66-
:members: wait_for_line, wait_for_no_line, pin, line_detected, when_line, when_no_line
66+
:members: wait_for_line, wait_for_no_line, pin, line_detected, when_line, when_no_line, value
6767

6868

6969
MotionSensor (D-SUN PIR)
7070
------------------------
7171

7272
.. autoclass:: MotionSensor(pin, \*, queue_len=1, sample_rate=10, threshold=0.5, partial=False, pin_factory=None)
73-
:members: wait_for_motion, wait_for_no_motion, pin, motion_detected, when_motion, when_no_motion
73+
:members: wait_for_motion, wait_for_no_motion, pin, motion_detected, when_motion, when_no_motion, value
7474

7575

7676
LightSensor (LDR)
7777
-----------------
7878

7979
.. autoclass:: LightSensor(pin, \*, queue_len=5, charge_time_limit=0.01, threshold=0.1, partial=False, pin_factory=None)
80-
:members: wait_for_light, wait_for_dark, pin, light_detected, when_light, when_dark
80+
:members: wait_for_light, wait_for_dark, pin, light_detected, when_light, when_dark, value
8181

8282

8383
DistanceSensor (HC-SR04)
8484
------------------------
8585

8686
.. autoclass:: DistanceSensor(echo, trigger, \*, queue_len=30, max_distance=1, threshold_distance=0.3, partial=False, pin_factory=None)
87-
:members: wait_for_in_range, wait_for_out_of_range, trigger, echo, when_in_range, when_out_of_range, max_distance, distance, threshold_distance
87+
:members: wait_for_in_range, wait_for_out_of_range, trigger, echo, when_in_range, when_out_of_range, max_distance, distance, threshold_distance, value
8888

8989

9090
Base Classes
@@ -105,7 +105,7 @@ DigitalInputDevice
105105
------------------
106106

107107
.. autoclass:: DigitalInputDevice(pin, \*, pull_up=False, active_state=None, bounce_time=None, pin_factory=None)
108-
:members: wait_for_active, wait_for_inactive, when_activated, when_deactivated, active_time, inactive_time
108+
:members: wait_for_active, wait_for_inactive, when_activated, when_deactivated, active_time, inactive_time, value
109109

110110

111111
SmoothedInputDevice
-168 Bytes
Binary file not shown.
-5.34 KB
Loading

docs/images/composite_device_hierarchy.svg

Lines changed: 167 additions & 222 deletions
Loading

docs/images/device_hierarchy.pdf

-524 Bytes
Binary file not shown.

docs/images/device_hierarchy.png

-26.1 KB
Loading

docs/images/device_hierarchy.svg

Lines changed: 511 additions & 680 deletions
Loading
-51 Bytes
Binary file not shown.
-1.38 KB
Loading

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy