KevinMidboe/python-gpiozero
1
0
Fork 0
mirror of https://github.com/KevinMidboe/python-gpiozero.git synced 2025-10-29 17:50:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #362 from lurch/patch-3

Browse Source 
Document Button default values
This commit is contained in:
Ben Nuttall
2016-06-09 21:22:47 +01:00
committed by GitHub
parent 8b81057f8b ee458214a0
commit 996b0dcd4a
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
gpiozero/input_devices.py
View File

@@ -251,16 +251,18 @@ class Button(HoldMixin, DigitalInputDevice):
:param float bounce_time:
If ``None`` (the default), no software bounce compensation will be
performed. Otherwise, this is the length in time (in seconds) that the
performed. Otherwise, this is the length of time (in seconds) that the
component will ignore changes in state after an initial change.
:param float hold_time:
The length of time (in seconds) to wait after the button is pushed,
until executing the :attr:`when_held` handler.
until executing the :attr:`when_held` handler. Defaults to ``1``.
:param bool hold_repeat:
If ``True``, the :attr:`when_held` handler will be repeatedly executed
as long as the device remains active, every *hold_time* seconds.
as long as the device remains active, every *hold_time* seconds. If
``False`` (the default) the :attr:`when_held` handler will be only be
executed once per hold.
"""
def __init__(
self, pin=None, pull_up=True, bounce_time=None,