cogd/manuals/cogd.skb

cogd.skb

1
;;; SPDX-FileCopyrightText: 2025 Evgeny Pisemsky <mail@pisemsky.site>
2
;;;
3
;;; SPDX-License-Identifier: GPL-3.0-or-later
4
5
(document :title "Channel of guix definitions"
6
          :author (list (author :name "Evgeny Pisemsky"
7
                                :email (mailto "mail@pisemsky.site")))
8
          :info-dir-entry "Channel of guix definitions"
9
          :info-dir-category "System administration"
10
  (chapter :title [Modules]
11
    (section :title [Services]
12
      (subsection :title [USB relay daemon]
13
        (p [USB relay daemon allows controlling locally connected USB HID relays remotely via MQTT protocol.])
14
        (description
15
         (item :key (list [Variable: ,(code [usbrelayd-service-type])])
16
               (p [This is the service type for the USB relay daemon.  Its value is a ,(code [usbrelayd-configuration]) (see below).]))
17
         (item :key (list [Data Type: ,(code [usbrelayd-configuration])])
18
               (p [This is the configuration for the USB relay daemon, with the following fields:])
19
               (description
20
                (item :key (list [,(code [package]) (default: ,(code [python-usbrelay]))])
21
                      (p [The package containing the USB relay daemon.]))
22
                (item :key (list [,(code [mqtt-broker]) (default: ,(code ["localhost"]))])
23
                      (p [The hostname or IP address of the MQTT broker.]))
24
                (item :key (list [,(code [mqtt-client]) (default: ,(code ["usbrelayd"]))])
25
                      (p [The client name used when connecting to the broker.])))))))))
26