commit 8df62ec46c2871e8e2ae3dc0ac7954f91c0b30b6 · pyrox.dev/nixpkgs

nixos/doc/manual/release-notes/rl-2305.section.md

···

       63
       63
        
       

     

       64
       64
        
       - [atuin](https://github.com/ellie/atuin), a sync server for shell history. Available as [services.atuin](#opt-services.atuin.enable).

     

       65
       65
        
       

     

       66
       66
       +
       - [esphome](https://esphome.io), a dashboard to configure ESP8266/ESP32 devices for use with Home Automation systems. Available as [services.esphome](#opt-services.esphome.enable).

     

       67
       67
       +
       

     

       66
       68
        
       - [networkd-dispatcher](https://gitlab.com/craftyguy/networkd-dispatcher), a dispatcher service for systemd-networkd connection status changes. Available as [services.networkd-dispatcher](#opt-services.networkd-dispatcher.enable).

     

       67
       69
        
       

     

       68
       70
        
       - [mmsd](https://gitlab.com/kop316/mmsd), a lower level daemon that transmits and recieves MMSes. Available as [services.mmsd](#opt-services.mmsd.enable).

nixos/modules/module-list.nix

···

       510
       510
        
         ./services/hardware/usbrelayd.nix

     

       511
       511
        
         ./services/hardware/vdr.nix

     

       512
       512
        
         ./services/hardware/keyd.nix

     

       513
       513
       +
         ./services/home-automation/esphome.nix

     

       513
       514
        
         ./services/home-automation/evcc.nix

     

       514
       515
        
         ./services/home-automation/home-assistant.nix

     

       515
       516
        
         ./services/home-automation/zigbee2mqtt.nix

+136

nixos/modules/services/home-automation/esphome.nix

···

       1
       1
       +
       { config, lib, pkgs, ... }:

     

       2
       2
       +
       

     

       3
       3
       +
       let

     

       4
       4
       +
         inherit (lib)

     

       5
       5
       +
           literalExpression

     

       6
       6
       +
           maintainers

     

       7
       7
       +
           mkEnableOption

     

       8
       8
       +
           mkIf

     

       9
       9
       +
           mkOption

     

       10
       10
       +
           mdDoc

     

       11
       11
       +
           types

     

       12
       12
       +
           ;

     

       13
       13
       +
       

     

       14
       14
       +
         cfg = config.services.esphome;

     

       15
       15
       +
       

     

       16
       16
       +
         stateDir = "/var/lib/esphome";

     

       17
       17
       +
       

     

       18
       18
       +
         esphomeParams =

     

       19
       19
       +
           if cfg.enableUnixSocket

     

       20
       20
       +
           then "--socket /run/esphome/esphome.sock"

     

       21
       21
       +
           else "--address ${cfg.address} --port ${toString cfg.port}";

     

       22
       22
       +
       in

     

       23
       23
       +
       {

     

       24
       24
       +
         meta.maintainers = with maintainers; [ oddlama ];

     

       25
       25
       +
       

     

       26
       26
       +
         options.services.esphome = {

     

       27
       27
       +
           enable = mkEnableOption (mdDoc "esphome");

     

       28
       28
       +
       

     

       29
       29
       +
           package = mkOption {

     

       30
       30
       +
             type = types.package;

     

       31
       31
       +
             default = pkgs.esphome;

     

       32
       32
       +
             defaultText = literalExpression "pkgs.esphome";

     

       33
       33
       +
             description = mdDoc "The package to use for the esphome command.";

     

       34
       34
       +
           };

     

       35
       35
       +
       

     

       36
       36
       +
           enableUnixSocket = mkOption {

     

       37
       37
       +
             type = types.bool;

     

       38
       38
       +
             default = false;

     

       39
       39
       +
             description = lib.mdDoc "Listen on a unix socket `/run/esphome/esphome.sock` instead of the TCP port.";

     

       40
       40
       +
           };

     

       41
       41
       +
       

     

       42
       42
       +
           address = mkOption {

     

       43
       43
       +
             type = types.str;

     

       44
       44
       +
             default = "localhost";

     

       45
       45
       +
             description = mdDoc "esphome address";

     

       46
       46
       +
           };

     

       47
       47
       +
       

     

       48
       48
       +
           port = mkOption {

     

       49
       49
       +
             type = types.port;

     

       50
       50
       +
             default = 6052;

     

       51
       51
       +
             description = mdDoc "esphome port";

     

       52
       52
       +
           };

     

       53
       53
       +
       

     

       54
       54
       +
           openFirewall = mkOption {

     

       55
       55
       +
             default = false;

     

       56
       56
       +
             type = types.bool;

     

       57
       57
       +
             description = mdDoc "Whether to open the firewall for the specified port.";

     

       58
       58
       +
           };

     

       59
       59
       +
       

     

       60
       60
       +
           allowedDevices = mkOption {

     

       61
       61
       +
             default = ["char-ttyS" "char-ttyUSB"];

     

       62
       62
       +
             example = ["/dev/serial/by-id/usb-Silicon_Labs_CP2102_USB_to_UART_Bridge_Controller_0001-if00-port0"];

     

       63
       63
       +
             description = lib.mdDoc ''

     

       64
       64
       +
               A list of device nodes to which {command}`esphome` has access to.

     

       65
       65
       +
               Refer to DeviceAllow in systemd.resource-control(5) for more information.

     

       66
       66
       +
               Beware that if a device is referred to by an absolute path instead of a device category,

     

       67
       67
       +
               it will only allow devices that already are plugged in when the service is started.

     

       68
       68
       +
             '';

     

       69
       69
       +
             type = types.listOf types.str;

     

       70
       70
       +
           };

     

       71
       71
       +
         };

     

       72
       72
       +
       

     

       73
       73
       +
         config = mkIf cfg.enable {

     

       74
       74
       +
           networking.firewall.allowedTCPPorts = mkIf (cfg.openFirewall && !cfg.enableUnixSocket) [cfg.port];

     

       75
       75
       +
       

     

       76
       76
       +
           systemd.services.esphome = {

     

       77
       77
       +
             description = "ESPHome dashboard";

     

       78
       78
       +
             after = ["network.target"];

     

       79
       79
       +
             wantedBy = ["multi-user.target"];

     

       80
       80
       +
             path = [cfg.package];

     

       81
       81
       +
       

     

       82
       82
       +
             # platformio fails to determine the home directory when using DynamicUser

     

       83
       83
       +
             environment.PLATFORMIO_CORE_DIR = "${stateDir}/.platformio";

     

       84
       84
       +
       

     

       85
       85
       +
             serviceConfig = {

     

       86
       86
       +
               ExecStart = "${cfg.package}/bin/esphome dashboard ${esphomeParams} ${stateDir}";

     

       87
       87
       +
               DynamicUser = true;

     

       88
       88
       +
               User = "esphome";

     

       89
       89
       +
               Group = "esphome";

     

       90
       90
       +
               WorkingDirectory = stateDir;

     

       91
       91
       +
               StateDirectory = "esphome";

     

       92
       92
       +
               StateDirectoryMode = "0750";

     

       93
       93
       +
               Restart = "on-failure";

     

       94
       94
       +
               RuntimeDirectory = mkIf cfg.enableUnixSocket "esphome";

     

       95
       95
       +
               RuntimeDirectoryMode = "0750";

     

       96
       96
       +
       

     

       97
       97
       +
               # Hardening

     

       98
       98
       +
               CapabilityBoundingSet = "";

     

       99
       99
       +
               LockPersonality = true;

     

       100
       100
       +
               MemoryDenyWriteExecute = true;

     

       101
       101
       +
               DevicePolicy = "closed";

     

       102
       102
       +
               DeviceAllow = map (d: "${d} rw") cfg.allowedDevices;

     

       103
       103
       +
               SupplementaryGroups = ["dialout"];

     

       104
       104
       +
               #NoNewPrivileges = true; # Implied by DynamicUser

     

       105
       105
       +
               PrivateUsers = true;

     

       106
       106
       +
               #PrivateTmp = true; # Implied by DynamicUser

     

       107
       107
       +
               ProtectClock = true;

     

       108
       108
       +
               ProtectControlGroups = true;

     

       109
       109
       +
               ProtectHome = true;

     

       110
       110
       +
               ProtectHostname = true;

     

       111
       111
       +
               ProtectKernelLogs = true;

     

       112
       112
       +
               ProtectKernelModules = true;

     

       113
       113
       +
               ProtectKernelTunables = true;

     

       114
       114
       +
               ProtectProc = "invisible";

     

       115
       115
       +
               ProcSubset = "pid";

     

       116
       116
       +
               ProtectSystem = "strict";

     

       117
       117
       +
               #RemoveIPC = true; # Implied by DynamicUser

     

       118
       118
       +
               RestrictAddressFamilies = [

     

       119
       119
       +
                 "AF_INET"

     

       120
       120
       +
                 "AF_INET6"

     

       121
       121
       +
                 "AF_NETLINK"

     

       122
       122
       +
                 "AF_UNIX"

     

       123
       123
       +
               ];

     

       124
       124
       +
               RestrictNamespaces = false; # Required by platformio for chroot

     

       125
       125
       +
               RestrictRealtime = true;

     

       126
       126
       +
               #RestrictSUIDSGID = true; # Implied by DynamicUser

     

       127
       127
       +
               SystemCallArchitectures = "native";

     

       128
       128
       +
               SystemCallFilter = [

     

       129
       129
       +
                 "@system-service"

     

       130
       130
       +
                 "@mount" # Required by platformio for chroot

     

       131
       131
       +
               ];

     

       132
       132
       +
               UMask = "0077";

     

       133
       133
       +
             };

     

       134
       134
       +
           };

     

       135
       135
       +
         };

     

       136
       136
       +
       }

nixos/tests/all-tests.nix

···

       210
       210
        
         envoy = handleTest ./envoy.nix {};

     

       211
       211
        
         ergo = handleTest ./ergo.nix {};

     

       212
       212
        
         ergochat = handleTest ./ergochat.nix {};

     

       213
       213
       +
         esphome = handleTest ./esphome.nix {};

     

       213
       214
        
         etc = pkgs.callPackage ../modules/system/etc/test.nix { inherit evalMinimalConfig; };

     

       214
       215
        
         activation = pkgs.callPackage ../modules/system/activation/test.nix { };

     

       215
       216
        
         etcd = handleTestOn ["x86_64-linux"] ./etcd.nix {};

+41

nixos/tests/esphome.nix

···

       1
       1
       +
       import ./make-test-python.nix ({ pkgs, lib, ... }:

     

       2
       2
       +
       

     

       3
       3
       +
       let

     

       4
       4
       +
         testPort = 6052;

     

       5
       5
       +
         unixSocket = "/run/esphome/esphome.sock";

     

       6
       6
       +
       in

     

       7
       7
       +
       with lib;

     

       8
       8
       +
       {

     

       9
       9
       +
         name = "esphome";

     

       10
       10
       +
         meta.maintainers = with pkgs.lib.maintainers; [ oddlama ];

     

       11
       11
       +
       

     

       12
       12
       +
         nodes = {

     

       13
       13
       +
           esphomeTcp = { ... }:

     

       14
       14
       +
             {

     

       15
       15
       +
               services.esphome = {

     

       16
       16
       +
                 enable = true;

     

       17
       17
       +
                 port = testPort;

     

       18
       18
       +
                 address = "0.0.0.0";

     

       19
       19
       +
                 openFirewall = true;

     

       20
       20
       +
               };

     

       21
       21
       +
             };

     

       22
       22
       +
       

     

       23
       23
       +
           esphomeUnix = { ... }:

     

       24
       24
       +
             {

     

       25
       25
       +
               services.esphome = {

     

       26
       26
       +
                 enable = true;

     

       27
       27
       +
                 enableUnixSocket = true;

     

       28
       28
       +
               };

     

       29
       29
       +
             };

     

       30
       30
       +
         };

     

       31
       31
       +
       

     

       32
       32
       +
         testScript = ''

     

       33
       33
       +
           esphomeTcp.wait_for_unit("esphome.service")

     

       34
       34
       +
           esphomeTcp.wait_for_open_port(${toString testPort})

     

       35
       35
       +
           esphomeTcp.succeed("curl --fail http://localhost:${toString testPort}/")

     

       36
       36
       +
       

     

       37
       37
       +
           esphomeUnix.wait_for_unit("esphome.service")

     

       38
       38
       +
           esphomeUnix.wait_for_file("${unixSocket}")

     

       39
       39
       +
           esphomeUnix.succeed("curl --fail --unix-socket ${unixSocket} http://localhost/")

     

       40
       40
       +
         '';

     

       41
       41
       +
       })