Document modules
README
5 | 5 | #+title: guix-homeassistant | |
6 | 6 | #+subtitle: Home Assistant platform for GNU Guix | |
7 | 7 | ||
8 | + | * Setup | |
9 | + | ||
8 | 10 | This is a guix channel that provides package and service definitions | |
9 | 11 | for the Home Assistant platform. To use it, add the following record: | |
10 | 12 | ||
… | |||
21 | 23 | ||
22 | 24 | to your guix channel configuration file, save it, and run =guix pull=. | |
23 | 25 | ||
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 | + | ||
24 | 57 | # Local Variables: | |
25 | 58 | # mode: org | |
26 | 59 | # End: |