File: dbus.rst

package info (click to toggle)
libgpiod 2.2.1-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,108 kB
  • sloc: ansic: 26,612; sh: 7,554; cpp: 4,944; python: 2,426; makefile: 811; xml: 49
file content (37 lines) | stat: -rw-r--r-- 1,469 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
..
   SPDX-License-Identifier: CC-BY-SA-4.0
   SPDX-FileCopyrightText: 2025 Bartosz Golaszewski <bartosz.golaszewski@linaro.org>

..
   This file is part of libgpiod.

   GPIO D-Bus API, daemon and command-line client documentation

D-Bus interface
===============

A commonly requested feature for the GPIO character device was state persistence
after releasing the lines (as a kernel feature) or providing a central authority
(in user-space) that would be in charge of keeping the lines requested and in a
certain state (similarily to how the sysfs ABI works). **GPIO D-Bus API** has
been provided to address this requirement. We define an interface covering the
majority of the GPIO chardev's functionality and implement it from both the
server and client sides in the form of the **gpio-manager** daemon and the
**gpiocli** command-line utility for talking to the manager. It enables
relatively efficient, asynchronous control of GPIO lines, offering methods for
configuring, monitoring, and manipulating GPIOs.

.. note::
   DBus support can be built by passing ``--enable-dbus`` to configure. The
   daemon is bundled with a systemd unit file and an example configuration file
   for the ``io.gpiod1`` interface that allows all users to access basic
   information about the GPIOs in the system but only root to request lines or
   change their values.

.. toctree::
   :maxdepth: 1
   :caption: Contents

   dbus_api
   gpio-manager<gpio-manager>
   gpiocli_top