mirror of
https://github.com/KevinMidboe/python-gpiozero.git
synced 2025-10-29 17:50:37 +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.
71 lines
1.6 KiB
ReStructuredText
71 lines
1.6 KiB
ReStructuredText
=====================
|
|
API - Generic Classes
|
|
=====================
|
|
|
|
.. module:: gpiozero.devices
|
|
|
|
.. currentmodule:: gpiozero
|
|
|
|
The GPIO Zero class hierarchy is quite extensive. It contains several base
|
|
classes (most of which are documented in their corresponding chapters):
|
|
|
|
* :class:`Device` is the root of the hierarchy, implementing base functionality
|
|
like :meth:`~Device.close` and context manager handlers.
|
|
|
|
* :class:`GPIODevice` represents individual devices that attach to a single
|
|
GPIO pin
|
|
|
|
* :class:`SPIDevice` represents devices that communicate over an SPI interface
|
|
(implemented as four GPIO pins)
|
|
|
|
* :class:`InternalDevice` represents devices that are entirely internal to
|
|
the Pi (usually operating system related services)
|
|
|
|
* :class:`CompositeDevice` represents devices composed of multiple other
|
|
devices like HATs
|
|
|
|
There are also several `mixin classes`_ for adding important functionality
|
|
at numerous points in the hierarchy, which is illustrated below (mixin classes
|
|
are represented in purple, while abstract classes are shaded lighter):
|
|
|
|
.. image:: images/device_hierarchy.*
|
|
|
|
.. _mixin classes: https://en.wikipedia.org/wiki/Mixin
|
|
|
|
Device
|
|
======
|
|
|
|
.. autoclass:: Device(\*, pin_factory=None)
|
|
:members: close, closed, value, is_active
|
|
|
|
ValuesMixin
|
|
===========
|
|
|
|
.. autoclass:: ValuesMixin(...)
|
|
:members:
|
|
|
|
SourceMixin
|
|
===========
|
|
|
|
.. autoclass:: SourceMixin(...)
|
|
:members:
|
|
|
|
SharedMixin
|
|
===========
|
|
|
|
.. autoclass:: SharedMixin(...)
|
|
:members: _shared_key
|
|
|
|
EventsMixin
|
|
===========
|
|
|
|
.. autoclass:: EventsMixin(...)
|
|
:members:
|
|
|
|
HoldMixin
|
|
=========
|
|
|
|
.. autoclass:: HoldMixin(...)
|
|
:members:
|
|
|