mirror of
https://github.com/KevinMidboe/python-gpiozero.git
synced 2025-10-29 17:50:37 +00:00
Fix prototypes in docs
The prototypes in the docs are rigged to make out the first parameter as mandatory (as it effectively is); however this does mean you've got to remember to update the prototype when you modify it in the code! :)
This commit is contained in:
@@ -67,13 +67,13 @@ Input Devices
|
||||
Output Devices
|
||||
==============
|
||||
|
||||
.. autoclass:: OutputDevice(pin, active_high=True)
|
||||
.. autoclass:: OutputDevice(pin, active_high=True, initial_value=False)
|
||||
:members:
|
||||
|
||||
.. autoclass:: PWMOutputDevice(pin, frequency=100)
|
||||
.. autoclass:: PWMOutputDevice(pin, active_high=True, initial_value=0, frequency=100)
|
||||
:members:
|
||||
|
||||
.. autoclass:: DigitalOutputDevice(pin, active_high=True)
|
||||
.. autoclass:: DigitalOutputDevice(pin, active_high=True, initial_value=False)
|
||||
:members:
|
||||
|
||||
Mixin Classes
|
||||
|
||||
@@ -16,25 +16,25 @@ everyday components. Components must be wired up correctly before use in code.
|
||||
LED
|
||||
===
|
||||
|
||||
.. autoclass:: LED(pin, active_high=True)
|
||||
.. autoclass:: LED(pin, active_high=True, initial_value=False)
|
||||
:members: on, off, toggle, blink, pin, is_lit
|
||||
|
||||
PWMLED
|
||||
======
|
||||
|
||||
.. autoclass:: PWMLED(pin, frequency=100)
|
||||
.. autoclass:: PWMLED(pin, active_high=True, initial_value=0, frequency=100)
|
||||
:members: on, off, toggle, blink, pin, is_lit, value
|
||||
|
||||
Buzzer
|
||||
======
|
||||
|
||||
.. autoclass:: Buzzer(pin, active_high=True)
|
||||
.. autoclass:: Buzzer(pin, active_high=True, initial_value=False)
|
||||
:members: on, off, toggle, beep, pin, is_active
|
||||
|
||||
RGBLED
|
||||
======
|
||||
|
||||
.. autoclass:: RGBLED(red, green, blue)
|
||||
.. autoclass:: RGBLED(red, green, blue, active_high=True)
|
||||
:members: on, off, red, green, blue, value
|
||||
|
||||
Motor
|
||||
|
||||
@@ -207,12 +207,19 @@ class LED(DigitalOutputDevice):
|
||||
led.on()
|
||||
|
||||
:param int pin:
|
||||
The GPIO pin which the button is attached to. See :doc:`notes` for
|
||||
valid pin numbers.
|
||||
The GPIO pin which the LED is attached to. See :doc:`notes` for valid
|
||||
pin numbers.
|
||||
|
||||
:param bool active_high:
|
||||
If ``True`` (the default), then the LED will be lit when the GPIO port
|
||||
is high.
|
||||
If ``True`` (the default), the LED will operate normally with the
|
||||
circuit described above. If ``False`` you should wire the cathode to
|
||||
the GPIO pin, and the anode to a 3V3 pin (via a limiting resistor).
|
||||
|
||||
:param bool initial_value:
|
||||
If ``False`` (the default), the LED will be off initially. If
|
||||
``None``, the LED will be left in whatever state the pin is found in
|
||||
when configured for output (warning: this can be on). If ``True``, the
|
||||
LED will be switched on initially.
|
||||
"""
|
||||
pass
|
||||
|
||||
@@ -239,8 +246,15 @@ class Buzzer(DigitalOutputDevice):
|
||||
valid pin numbers.
|
||||
|
||||
:param bool active_high:
|
||||
If ``True`` (the default), then the buzzer will sound when the GPIO
|
||||
port is high.
|
||||
If ``True`` (the default), the buzzer will operate normally with the
|
||||
circuit described above. If ``False`` you should wire the cathode to
|
||||
the GPIO pin, and the anode to a 3V3 pin.
|
||||
|
||||
:param bool initial_value:
|
||||
If ``False`` (the default), the buzzer will be silent initially. If
|
||||
``None``, the buzzer will be left in whatever state the pin is found in
|
||||
when configured for output (warning: this can be on). If ``True``, the
|
||||
buzzer will be switched on initially.
|
||||
"""
|
||||
pass
|
||||
|
||||
@@ -446,11 +460,22 @@ class PWMLED(PWMOutputDevice):
|
||||
an optional resistor to prevent the LED from burning out.
|
||||
|
||||
:param int pin:
|
||||
The GPIO pin which the device is attached to. See :doc:`notes` for
|
||||
The GPIO pin which the LED is attached to. See :doc:`notes` for
|
||||
valid pin numbers.
|
||||
|
||||
:param bool active_high:
|
||||
If ``True`` (the default), the :meth:`on` method will set the GPIO to
|
||||
HIGH. If ``False``, the :meth:`on` method will set the GPIO to LOW (the
|
||||
:meth:`off` method always does the opposite).
|
||||
|
||||
:param bool initial_value:
|
||||
If ``0`` (the default), the LED will be off initially. Other values
|
||||
between 0 and 1 can be specified as an initial brightness for the LED.
|
||||
Note that ``None`` cannot be specified (unlike the parent class) as
|
||||
there is no way to tell PWM not to alter the state of the pin.
|
||||
|
||||
:param int frequency:
|
||||
The frequency (in Hz) of pulses emitted to drive the device. Defaults
|
||||
The frequency (in Hz) of pulses emitted to drive the LED. Defaults
|
||||
to 100Hz.
|
||||
"""
|
||||
pass
|
||||
@@ -491,6 +516,11 @@ class RGBLED(SourceMixin, CompositeDevice):
|
||||
|
||||
:param int blue:
|
||||
The GPIO pin that controls the blue component of the RGB LED.
|
||||
|
||||
:param bool active_high:
|
||||
If ``True`` (the default), the :meth:`on` method will set the GPIOs to
|
||||
HIGH. If ``False``, the :meth:`on` method will set the GPIOs to LOW
|
||||
(the :meth:`off` method always does the opposite).
|
||||
"""
|
||||
def __init__(self, red=None, green=None, blue=None, active_high=True):
|
||||
if not all([red, green, blue]):
|
||||
|
||||
Reference in New Issue
Block a user