mirror of
https://github.com/KevinMidboe/python-gpiozero.git
synced 2025-10-29 09:40:36 +00:00
4cc4b1c132
Move the API to the end, recipes all grouped together up-front (with remote GPIO setup just before the remote GPIO recipes). Tweak some headings so everything looks a little more consistent in the (now shorter) ToC. Also added module index tags.
100 lines
2.6 KiB
ReStructuredText
100 lines
2.6 KiB
ReStructuredText
====================
|
|
API - Output Devices
|
|
====================
|
|
|
|
.. module:: gpiozero.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, initial_value=False, pin_factory=None)
|
|
:members: on, off, toggle, blink, pin, is_lit
|
|
|
|
PWMLED
|
|
======
|
|
|
|
.. autoclass:: PWMLED(pin, \*, active_high=True, initial_value=0, frequency=100, pin_factory=None)
|
|
:members: on, off, toggle, blink, pulse, pin, is_lit, value
|
|
|
|
RGBLED
|
|
======
|
|
|
|
.. autoclass:: RGBLED(red, green, blue, \*, active_high=True, initial_value=(0, 0, 0), pwm=True, pin_factory=None)
|
|
:members: on, off, toggle, blink, pulse, red, green, blue, is_lit, color
|
|
|
|
Buzzer
|
|
======
|
|
|
|
.. autoclass:: Buzzer(pin, \*, active_high=True, initial_value=False, pin_factory=None)
|
|
:members: on, off, toggle, beep, pin, is_active
|
|
|
|
Motor
|
|
=====
|
|
|
|
.. autoclass:: Motor(forward, backward, \*, pwm=True, pin_factory=None)
|
|
:members: forward, backward, stop
|
|
|
|
Servo
|
|
=====
|
|
|
|
.. autoclass:: Servo(pin, \*, initial_value=0, min_pulse_width=1/1000, max_pulse_width=2/1000, frame_width=20/1000, pin_factory=None)
|
|
:inherited-members:
|
|
:members:
|
|
|
|
AngularServo
|
|
============
|
|
|
|
.. autoclass:: AngularServo(pin, \*, initial_angle=0, min_angle=-90, max_angle=90, min_pulse_width=1/1000, max_pulse_width=2/1000, frame_width=20/1000, pin_factory=None)
|
|
:inherited-members:
|
|
:members:
|
|
|
|
Base Classes
|
|
============
|
|
|
|
The classes in the sections above are derived from a series of base classes,
|
|
some of which are effectively abstract. The classes form the (partial)
|
|
hierarchy displayed in the graph below (abstract classes are shaded lighter
|
|
than concrete classes):
|
|
|
|
.. image:: images/output_device_hierarchy.*
|
|
|
|
The following sections document these base classes for advanced users that wish
|
|
to construct classes for their own devices.
|
|
|
|
DigitalOutputDevice
|
|
===================
|
|
|
|
.. autoclass:: DigitalOutputDevice(pin, \*, active_high=True, initial_value=False, pin_factory=None)
|
|
:members:
|
|
|
|
PWMOutputDevice
|
|
===============
|
|
|
|
.. autoclass:: PWMOutputDevice(pin, \*, active_high=True, initial_value=0, frequency=100, pin_factory=None)
|
|
:members:
|
|
|
|
OutputDevice
|
|
============
|
|
|
|
.. autoclass:: OutputDevice(pin, \*, active_high=True, initial_value=False, pin_factory=None)
|
|
:members:
|
|
|
|
GPIODevice
|
|
==========
|
|
|
|
.. autoclass:: GPIODevice(pin, \*, pin_factory=None)
|
|
:members:
|
|
:noindex:
|
|
|