164 lines
4.1 KiB
Nix
164 lines
4.1 KiB
Nix
{ config
|
|
, lib
|
|
, pkgs
|
|
, ...
|
|
}:
|
|
|
|
let
|
|
cfg = config.services.wyoming.openwakeword;
|
|
|
|
inherit (lib)
|
|
concatStringsSep
|
|
concatMapStringsSep
|
|
escapeShellArgs
|
|
mkOption
|
|
mdDoc
|
|
mkEnableOption
|
|
mkIf
|
|
mkPackageOption
|
|
mkRemovedOptionModule
|
|
types
|
|
;
|
|
|
|
inherit (builtins)
|
|
toString
|
|
;
|
|
|
|
in
|
|
|
|
{
|
|
imports = [
|
|
(mkRemovedOptionModule [ "services" "wyoming" "openwakeword" "models" ] "Configuring models has been removed, they are now dynamically discovered and loaded at runtime")
|
|
];
|
|
|
|
meta.buildDocsInSandbox = false;
|
|
|
|
options.services.wyoming.openwakeword = with types; {
|
|
enable = mkEnableOption (mdDoc "Wyoming openWakeWord server");
|
|
|
|
package = mkPackageOption pkgs "wyoming-openwakeword" { };
|
|
|
|
uri = mkOption {
|
|
type = strMatching "^(tcp|unix)://.*$";
|
|
default = "tcp://0.0.0.0:10400";
|
|
example = "tcp://192.0.2.1:5000";
|
|
description = mdDoc ''
|
|
URI to bind the wyoming server to.
|
|
'';
|
|
};
|
|
|
|
customModelsDirectories = mkOption {
|
|
type = listOf types.path;
|
|
default = [];
|
|
description = lib.mdDoc ''
|
|
Paths to directories with custom wake word models (*.tflite model files).
|
|
'';
|
|
};
|
|
|
|
preloadModels = mkOption {
|
|
type = listOf str;
|
|
default = [
|
|
"ok_nabu"
|
|
];
|
|
example = [
|
|
# wyoming_openwakeword/models/*.tflite
|
|
"alexa"
|
|
"hey_jarvis"
|
|
"hey_mycroft"
|
|
"hey_rhasspy"
|
|
"ok_nabu"
|
|
];
|
|
description = mdDoc ''
|
|
List of wake word models to preload after startup.
|
|
'';
|
|
};
|
|
|
|
threshold = mkOption {
|
|
type = float;
|
|
default = 0.5;
|
|
description = mdDoc ''
|
|
Activation threshold (0-1), where higher means fewer activations.
|
|
|
|
See trigger level for the relationship between activations and
|
|
wake word detections.
|
|
'';
|
|
apply = toString;
|
|
};
|
|
|
|
triggerLevel = mkOption {
|
|
type = int;
|
|
default = 1;
|
|
description = mdDoc ''
|
|
Number of activations before a detection is registered.
|
|
|
|
A higher trigger level means fewer detections.
|
|
'';
|
|
apply = toString;
|
|
};
|
|
|
|
extraArgs = mkOption {
|
|
type = listOf str;
|
|
default = [ ];
|
|
description = mdDoc ''
|
|
Extra arguments to pass to the server commandline.
|
|
'';
|
|
apply = escapeShellArgs;
|
|
};
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
systemd.services."wyoming-openwakeword" = {
|
|
description = "Wyoming openWakeWord server";
|
|
after = [
|
|
"network-online.target"
|
|
];
|
|
wantedBy = [
|
|
"multi-user.target"
|
|
];
|
|
serviceConfig = {
|
|
DynamicUser = true;
|
|
User = "wyoming-openwakeword";
|
|
# https://github.com/home-assistant/addons/blob/master/openwakeword/rootfs/etc/s6-overlay/s6-rc.d/openwakeword/run
|
|
ExecStart = concatStringsSep " " [
|
|
"${cfg.package}/bin/wyoming-openwakeword"
|
|
"--uri ${cfg.uri}"
|
|
(concatMapStringsSep " " (model: "--preload-model ${model}") cfg.preloadModels)
|
|
(concatMapStringsSep " " (dir: "--custom-model-dir ${toString dir}") cfg.customModelsDirectories)
|
|
"--threshold ${cfg.threshold}"
|
|
"--trigger-level ${cfg.triggerLevel}"
|
|
"${cfg.extraArgs}"
|
|
];
|
|
CapabilityBoundingSet = "";
|
|
DeviceAllow = "";
|
|
DevicePolicy = "closed";
|
|
LockPersonality = true;
|
|
MemoryDenyWriteExecute = true;
|
|
PrivateDevices = true;
|
|
PrivateUsers = true;
|
|
ProtectHome = true;
|
|
ProtectHostname = true;
|
|
ProtectKernelLogs = true;
|
|
ProtectKernelModules = true;
|
|
ProtectKernelTunables = true;
|
|
ProtectControlGroups = true;
|
|
ProtectProc = "invisible";
|
|
ProcSubset = "all"; # reads /proc/cpuinfo
|
|
RestrictAddressFamilies = [
|
|
"AF_INET"
|
|
"AF_INET6"
|
|
"AF_UNIX"
|
|
];
|
|
RestrictNamespaces = true;
|
|
RestrictRealtime = true;
|
|
RuntimeDirectory = "wyoming-openwakeword";
|
|
SystemCallArchitectures = "native";
|
|
SystemCallFilter = [
|
|
"@system-service"
|
|
"~@privileged"
|
|
];
|
|
UMask = "0077";
|
|
};
|
|
};
|
|
};
|
|
}
|