commit f30192ae6ffb25cf74cfcfbc5beae3fa9b386bf4 · pyrox.dev/nixpkgs

+38 -2

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

···

       63
       63
        
           # Respect overrides that already exist in the passed package and

     

       64
       64
        
           # concat it with values passed via the module.

     

       65
       65
        
           extraComponents = oldArgs.extraComponents or [] ++ extraComponents;

     

       66
       66
       -
           extraPackages = ps: (oldArgs.extraPackages or (_: []) ps) ++ (cfg.extraPackages ps);

     

       66
       66
       +
           extraPackages = ps: (oldArgs.extraPackages or (_: []) ps)

     

       67
       67
       +
             ++ (cfg.extraPackages ps)

     

       68
       68
       +
             ++ (lib.concatMap (component: component.propagatedBuildInputs or []) cfg.customComponents);

     

       67
       69
        
         }));

     

       68
       70
        
       

     

       69
       71
        
         # Create a directory that holds all lovelace modules

     
···

       149
       151
        
       

     

       150
       152
        
               A popular example is `python3Packages.psycopg2`

     

       151
       153
        
               for PostgreSQL support in the recorder component.

     

       154
       154
       +
             '';

     

       155
       155
       +
           };

     

       156
       156
       +
       

     

       157
       157
       +
           customComponents = mkOption {

     

       158
       158
       +
             type = types.listOf types.package;

     

       159
       159
       +
             default = [];

     

       160
       160
       +
             example = literalExpression ''

     

       161
       161
       +
               with pkgs.home-assistant-custom-components; [

     

       162
       162
       +
                 prometheus-sensor

     

       163
       163
       +
               ];

     

       164
       164
       +
             '';

     

       165
       165
       +
             description = lib.mdDoc ''

     

       166
       166
       +
               List of custom component packages to install.

     

       167
       167
       +
       

     

       168
       168
       +
               Available components can be found below `pkgs.home-assistant-custom-components`.

     

       152
       169
        
             '';

     

       153
       170
        
           };

     

       154
       171
        
       

     
···

       449
       466
        
               '' else ''

     

       450
       467
        
                 rm -f "${cfg.configDir}/www/nixos-lovelace-modules"

     

       451
       468
        
               '';

     

       469
       469
       +
               copyCustomComponents = ''

     

       470
       470
       +
                 mkdir -p "${cfg.configDir}/custom_components"

     

       471
       471
       +
       

     

       472
       472
       +
                 # remove components symlinked in from below the /nix/store

     

       473
       473
       +
                 components="$(find "${cfg.configDir}/custom_components" -maxdepth 1 -type l)"

     

       474
       474
       +
                 for component in "$components"; do

     

       475
       475
       +
                   if [[ "$(readlink "$component")" =~ ^${escapeShellArg builtins.storeDir} ]]; then

     

       476
       476
       +
                     rm "$component"

     

       477
       477
       +
                   fi

     

       478
       478
       +
                 done

     

       479
       479
       +
       

     

       480
       480
       +
                 # recreate symlinks for desired components

     

       481
       481
       +
                 declare -a components=(${escapeShellArgs cfg.customComponents})

     

       482
       482
       +
                 for component in "''${components[@]}"; do

     

       483
       483
       +
                   path="$(dirname $(find "$component" -name "manifest.json"))"

     

       484
       484
       +
                   ln -fns "$path" "${cfg.configDir}/custom_components/"

     

       485
       485
       +
                 done

     

       486
       486
       +
               '';

     

       452
       487
        
             in

     

       453
       488
        
               (optionalString (cfg.config != null) copyConfig) +

     

       454
       489
        
               (optionalString (cfg.lovelaceConfig != null) copyLovelaceConfig) +

     

       455
       455
       -
               copyCustomLovelaceModules

     

       490
       490
       +
               copyCustomLovelaceModules +

     

       491
       491
       +
               copyCustomComponents

     

       456
       492
        
             ;

     

       457
       493
        
             environment.PYTHONPATH = package.pythonPath;

     

       458
       494
        
             serviceConfig = let

+57

pkgs/servers/home-assistant/custom-components/README.md

···

       1
       1
       +
       # Packaging guidelines

     

       2
       2
       +
       

     

       3
       3
       +
       ## buildHomeAssistantComponent

     

       4
       4
       +
       

     

       5
       5
       +
       Custom components should be packaged using the

     

       6
       6
       +
        `buildHomeAssistantComponent` function, that is provided at top-level.

     

       7
       7
       +
       It builds upon `buildPythonPackage` but uses a custom install and check

     

       8
       8
       +
       phase.

     

       9
       9
       +
       

     

       10
       10
       +
       Python runtime dependencies can be directly consumed as unqualified

     

       11
       11
       +
       function arguments. Pass them into `propagatedBuildInputs`, for them to

     

       12
       12
       +
       be available to Home Assistant.

     

       13
       13
       +
       

     

       14
       14
       +
       Out-of-tree components need to use python packages from

     

       15
       15
       +
       `home-assistant.python.pkgs` as to not introduce conflicting package

     

       16
       16
       +
       versions into the Python environment.

     

       17
       17
       +
       

     

       18
       18
       +
       

     

       19
       19
       +
       **Example Boilerplate:**

     

       20
       20
       +
       

     

       21
       21
       +
       ```nix

     

       22
       22
       +
       { lib

     

       23
       23
       +
       , buildHomeAssistantcomponent

     

       24
       24
       +
       , fetchFromGitHub

     

       25
       25
       +
       }:

     

       26
       26
       +
       

     

       27
       27
       +
       buildHomeAssistantComponent {

     

       28
       28
       +
         # pname, version

     

       29
       29
       +
       

     

       30
       30
       +
         src = fetchFromGithub {

     

       31
       31
       +
           # owner, repo, rev, hash

     

       32
       32
       +
         };

     

       33
       33
       +
       

     

       34
       34
       +
         propagatedBuildInputs = [

     

       35
       35
       +
           # python requirements, as specified in manifest.json

     

       36
       36
       +
         ];

     

       37
       37
       +
       

     

       38
       38
       +
         meta = with lib; {

     

       39
       39
       +
           # changelog, description, homepage, license, maintainers

     

       40
       40
       +
         }

     

       41
       41
       +
       }

     

       42
       42
       +
       

     

       43
       43
       +
       ## Package name normalization

     

       44
       44
       +
       

     

       45
       45
       +
       Apply the same normalization rules as defined for python packages in

     

       46
       46
       +
       [PEP503](https://peps.python.org/pep-0503/#normalized-names).

     

       47
       47
       +
       The name should be lowercased and dots, underlines or multiple

     

       48
       48
       +
       dashes should all be replaced by a single dash.

     

       49
       49
       +
       

     

       50
       50
       +
       ## Manifest check

     

       51
       51
       +
       

     

       52
       52
       +
       The `buildHomeAssistantComponent` builder uses a hook to check whether

     

       53
       53
       +
       the dependencies specified in the `manifest.json` are present and

     

       54
       54
       +
       inside the specified version range.

     

       55
       55
       +
       

     

       56
       56
       +
       There shouldn't be a need to disable this hook, but you can set

     

       57
       57
       +
       `dontCheckManifest` to `true` in the derivation to achieve that.