mirror of
https://git.kernel.org/pub/scm/libs/libgpiod/libgpiod.git
synced 2026-10-24 00:48:53 +03:00
We now have comprehensive documentation available online on readthedocs. Let's not duplicate docs in README - move all information into the sphinx files. While at it: make the remaining README use markdown. Reviewed-by: Vincent Fazio <vfazio@xes-inc.com> Link: https://lore.kernel.org/r/20250211-improve-docs-v4-17-dc56702c2ca8@linaro.org Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
42 lines
1.1 KiB
ReStructuredText
42 lines
1.1 KiB
ReStructuredText
..
|
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
|
SPDX-FileCopyrightText: 2024-2025 Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
|
|
|
|
..
|
|
This file is part of libgpiod.
|
|
|
|
libgpiod python bindings documentation
|
|
|
|
libgpiod Python bindings API
|
|
============================
|
|
|
|
The **libgpiod Python bindings** provide an interface to control and interact
|
|
with GPIO (General-Purpose Input/Output) lines on Linux systems using the
|
|
libgpiod library. The Python bindings allow developers to manage GPIO pins
|
|
easily through Python scripts, enabling tasks such as reading input values,
|
|
setting outputs, monitoring events, and configuring more fine-grained pin
|
|
options.
|
|
|
|
.. note::
|
|
Python bindings require python3 support and libpython development files for
|
|
building from sources.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Contents
|
|
|
|
python_chip
|
|
python_chip_info
|
|
python_exceptions
|
|
python_line
|
|
python_line_info
|
|
python_info_event
|
|
python_edge_event
|
|
python_line_settings
|
|
python_line_request
|
|
python_misc
|
|
|
|
.. note::
|
|
Python bindings can be installed from https://pypi.org/ with pip by running
|
|
``pip install gpiod``.
|