mirror of
https://github.com/KevinMidboe/python-gpiozero.git
synced 2025-12-08 20:39:01 +00:00
Generic docs need reST
Conversion of all docs to reST so that the generic docs can link easily with the rest of the docs.
This commit is contained in:
44
docs/api_output.rst
Normal file
44
docs/api_output.rst
Normal file
@@ -0,0 +1,44 @@
|
||||
==============
|
||||
Output Devices
|
||||
==============
|
||||
|
||||
.. currentmodule:: gpiozero
|
||||
|
||||
These output device component interfaces have been provided for simple use of
|
||||
everyday components. Components must be wired up correctly before use in code.
|
||||
|
||||
.. note::
|
||||
|
||||
All GPIO pin numbers use Broadcom (BCM) numbering. See the :doc:`recipes`
|
||||
page for more information.
|
||||
|
||||
|
||||
LED
|
||||
===
|
||||
|
||||
.. autoclass:: LED(pin, active_high=True)
|
||||
:members: on, off, toggle, blink, pin, is_lit
|
||||
|
||||
PWMLED
|
||||
======
|
||||
|
||||
.. autoclass:: PWMLED(pin, frequency=100)
|
||||
:members: on, off, toggle, blink, pin, is_lit, value
|
||||
|
||||
Buzzer
|
||||
======
|
||||
|
||||
.. autoclass:: Buzzer(pin, active_high=True)
|
||||
:members: on, off, toggle, beep, pin, is_active
|
||||
|
||||
RGBLED
|
||||
======
|
||||
|
||||
.. autoclass:: RGBLED(red, green, blue)
|
||||
:members: on, off, red, green, blue, value
|
||||
|
||||
Motor
|
||||
=====
|
||||
|
||||
.. autoclass:: Motor(forward, backward)
|
||||
:members: forward, backward, stop
|
||||
Reference in New Issue
Block a user