Files
python-gpiozero/docs/api_other.rst
Dave Jones 4cc4b1c132 Restructure index
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.
2017-07-14 21:46:27 +01:00

54 lines
1.2 KiB
ReStructuredText

======================
API - Internal Devices
======================
.. module:: gpiozero.other_devices
.. currentmodule:: gpiozero
GPIO Zero also provides several "internal" devices which represent facilities
provided by the operating system itself. These can be used to react to things
like the time of day, or whether a server is available on the network.
.. warning::
These devices are experimental and their API is not yet considered stable.
We welcome any comments from testers, especially regarding new "internal
devices" that you'd find useful!
TimeOfDay
=========
.. autoclass:: TimeOfDay
PingServer
==========
.. autoclass:: PingServer
CPUTemperature
==============
.. autoclass:: CPUTemperature
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/other_device_hierarchy.*
The following sections document these base classes for advanced users that wish
to construct classes for their own devices.
InternalDevice
==============
.. autoclass:: InternalDevice()
:members: