Document modules

Evgeny PisemskySat Dec 28 19:40:50+0300 2024

8cac53c

Document modules

README

55
#+title: guix-homeassistant
66
#+subtitle: Home Assistant platform for GNU Guix
77
8+
* Setup
9+
810
This is a guix channel that provides package and service definitions
911
for the Home Assistant platform. To use it, add the following record:
1012

2123
2224
to your guix channel configuration file, save it, and run =guix pull=.
2325
26+
* Modules
27+
28+
The =(homeassistant-package)= module contains definitions of the
29+
=homeassistant= package (quite outdated to match python version in
30+
guix) and its dependencies (enough for default configuration). This
31+
module is overall messy with mostly disabled tests and unhandled
32+
synopses/descriptions to get a working package as soon as possible.
33+
34+
The =(homeassistant-service)= module provides definitions of the
35+
=homeassistant-service-type= and the =homeassistant-configuration= -
36+
the latter can be optionally passed as a value of the former to
37+
override default configuration which is set by the following fields:
38+
39+
- =package= (default: =homeassistant=) ::
40+
  The homeassistant package to use.
41+
42+
- =yaml-file= (default: =(plain-file "configuration.yaml" "default_config:\n")=) ::
43+
  The configuration yaml file as a file-like object.
44+
45+
* Usage
46+
47+
#+begin_example
48+
(service homeassistant-service-type
49+
         (homeassistant-configuration
50+
          (yaml-file (plain-file "configuration.yaml"
51+
                                 "default_config:
52+
http:
53+
  server_port: 8765
54+
"))))
55+
#+end_example
56+
2457
# Local Variables:
2558
# mode: org
2659
# End: