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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.services.ebusd;
in
{
meta.maintainers = with maintainers; [ nathan-gs ];
options.services.ebusd = {
enable = mkEnableOption "ebusd, a daemon for communication with eBUS heating systems";
package = mkPackageOptionMD pkgs "ebusd" { };
device = mkOption {
type = types.str;
default = "";
example = "IP:PORT";
description = ''
Use DEV as eBUS device [/dev/ttyUSB0].
This can be either:
enh:DEVICE or enh:IP:PORT for enhanced device (only adapter v3 and newer),
ens:DEVICE for enhanced high speed serial device (only adapter v3 and newer with firmware since 20220731),
DEVICE for serial device (normal speed, for all other serial adapters like adapter v2 as well as adapter v3 in non-enhanced mode), or
[udp:]IP:PORT for network device.
Source: <https://github.com/john30/ebusd/wiki/2.-Run#device-options>
'';
};
port = mkOption {
default = 8888;
type = types.port;
description = ''
The port on which to listen on
'';
};
readonly = mkOption {
type = types.bool;
default = false;
description = ''
Only read from device, never write to it
'';
};
configpath = mkOption {
type = types.str;
default = "https://cfg.ebusd.eu/";
description = ''
Directory to read CSV config files from. This can be a local folder or a URL.
'';
};
scanconfig = mkOption {
type = types.str;
default = "full";
description = ''
Pick CSV config files matching initial scan ("none" or empty for no initial scan message, "full" for full scan, or a single hex address to scan, default is to send a broadcast ident message).
If combined with --checkconfig, you can add scan message data as arguments for checking a particular scan configuration, e.g. "FF08070400/0AB5454850303003277201". For further details on this option,
see [Automatic configuration](https://github.com/john30/ebusd/wiki/4.7.-Automatic-configuration).
'';
};
logs = let
# "all" must come first so it can be overridden by more specific areas
areas = [ "all" "main" "network" "bus" "update" "other" ];
levels = [ "none" "error" "notice" "info" "debug" ];
in listToAttrs (map (area: nameValuePair area (mkOption {
type = types.enum levels;
default = "notice";
example = "debug";
description = ''
Only write log for matching `AREA`s (${concatStringsSep "|" areas}) below or equal to `LEVEL` (${concatStringsSep "|" levels})
'';
})) areas);
mqtt = {
enable = mkEnableOption "support for MQTT";
host = mkOption {
type = types.str;
default = "localhost";
description = ''
Connect to MQTT broker on HOST.
'';
};
port = mkOption {
default = 1883;
type = types.port;
description = ''
The port on which to connect to MQTT
'';
};
home-assistant = mkOption {
type = types.bool;
default = false;
description = ''
Adds the Home Assistant topics to MQTT, read more at [MQTT Integration](https://github.com/john30/ebusd/wiki/MQTT-integration)
'';
};
retain = mkEnableOption "set the retain flag on all topics instead of only selected global ones";
user = mkOption {
type = types.str;
description = ''
The MQTT user to use
'';
};
password = mkOption {
type = types.str;
description = ''
The MQTT password.
'';
};
};
extraArguments = mkOption {
type = types.listOf types.str;
default = [];
description = ''
Extra arguments to the ebus daemon
'';
};
};
config = let
usesDev = hasPrefix "/" cfg.device;
in mkIf cfg.enable {
systemd.services.ebusd = {
description = "EBUSd Service";
wantedBy = [ "multi-user.target" ];
after = [ "network.target" ];
serviceConfig = {
ExecStart = let
args = cli.toGNUCommandLineShell { } (foldr (a: b: a // b) { } [
{
inherit (cfg) device port configpath scanconfig readonly;
foreground = true;
updatecheck = "off";
log = mapAttrsToList (name: value: "${name}:${value}") cfg.logs;
mqttretain = cfg.mqtt.retain;
}
(optionalAttrs cfg.mqtt.enable {
mqtthost = cfg.mqtt.host;
mqttport = cfg.mqtt.port;
mqttuser = cfg.mqtt.user;
mqttpass = cfg.mqtt.password;
})
(optionalAttrs cfg.mqtt.home-assistant {
mqttint = "${cfg.package}/etc/ebusd/mqtt-hassio.cfg";
mqttjson = true;
})
]);
in "${cfg.package}/bin/ebusd ${args} ${escapeShellArgs cfg.extraArguments}";
DynamicUser = true;
Restart = "on-failure";
# Hardening
CapabilityBoundingSet = "";
DeviceAllow = optionals usesDev [ cfg.device ];
DevicePolicy = "closed";
LockPersonality = true;
MemoryDenyWriteExecute = false;
NoNewPrivileges = true;
PrivateDevices = usesDev;
PrivateUsers = true;
PrivateTmp = true;
ProtectClock = true;
ProtectControlGroups = true;
ProtectHome = true;
ProtectHostname = true;
ProtectKernelLogs = true;
ProtectKernelModules = true;
ProtectKernelTunables = true;
ProtectProc = "invisible";
ProcSubset = "pid";
ProtectSystem = "strict";
RemoveIPC = true;
RestrictAddressFamilies = [
"AF_INET"
"AF_INET6"
];
RestrictNamespaces = true;
RestrictRealtime = true;
RestrictSUIDSGID = true;
SupplementaryGroups = [ "dialout" ];
SystemCallArchitectures = "native";
SystemCallFilter = [
"@system-service @pkey"
"~@privileged @resources"
];
UMask = "0077";
};
};
};
}
|
