Home Assistant: Difference between revisions

Home Assistant maintains their own operating system and provides [[QEMU]] (qcow2) and [[Virtualbox]] (vdi) compatible [https://www.home-assistant.io/installation/linux#install-home-assistant-operating-system images]. NixOS supports virtualization solutions like [[libvirt]] and [[Incus]], both of which wrap QEMU to host a virtual machine.

== NixOS Module ==

 

 

 

Using a custom configuration has the drawback, that we cannot automatically recognize and install component dependencies, and it is not clear that we will continue to support these kinds of setups going forward. If you are using such a setup, please speak up in the Home-Automation room on Matrix (<code><nowiki>#homeautomation:nixos.org</nowiki></code>).

Set up your home-assistant by configuring the <code>services.home-assistant.config</code> attribute set as if it were your home-assistant YAML configuration. The module parses the root and platforms level to automatically discover integrations used and will add their dependencies to your home-assistant package.

 

<syntaxHighlight lang=nix>

       "esphome"

</syntaxHighlight>

If not using a reverse-proxy, and you just want unencrypted access on a local network don't forget to update your firewall configuration to expose the port home-assistant is running on.

<syntaxHighlight lang=nix>

   networking.firewall.allowedTCPPorts = [ <other ports> 8123 ];

</syntaxHighlight>

===== First start =====

On your first start you may see multiple <code><nowiki>ModuleNotFoundError</nowiki></code> in Home Assistants journal log. These are dependencies required to set up devices Home Assistant already found on the network.

The appropriate component to load can be looked up in the <code><nowiki>component-packages.nix</nowiki></code> file, that gets auto-generated as part of the packaging process.

When a component has no YAML configuration its dependencies can in theory be installed by mentioning the component name in <code><nowiki>services.home-assistant.config.wled = {};</nowiki></code>. This is deprecated, since Home Assistant will usually complain about the config having been migrated into the graphical user interface.

==== Making additional python packages available ====

=== Reusing existing YAML configuration ===

 

The module also supports passing it an existing configuration, however that comes with certain drawbacks. For example we cannot automatically detect the components, that your configuration requires. In that scenario you will need to resolve dependencies manually using the packages <code>extraComponents</code> parameter. Also you will be unable to reuse configuration values between parts of your NixOS configuration. A barebones setup to get you started may look like this:

 

 

 

= Running a recent version using an overlay =  

Home Assistant is a fast-paced open source project, that currently features one major release every month, and a handful of minor ones in between. Firmwares and API endpoints tend to change from time to  time, so Home Assistant and its bindings need to keep up to keep things work. The version we provide at the branch off is just a snapshot in time, and does not receive any updates, because there would just be too many dependencies to backport. But with NixOS it is still possible to use the version in nixpkgs/unstable by creating an overlay and using the module from nixos-unstable.

 

 

<syntaxHighlight lang=nix>

     package = (pkgs.home-assistant.override {

      extraPackages = py: with py; [ psycopg2 ];

    });

</syntaxHighlight>

== Combine declarative and UI defined automations ==

You can also declaratively define your automations while still being able to define them in Home Assistant UI. Automations defined in UI are stored in <code>/var/lib/hass/automations.yaml</code>. If you are not planning on using UI defined automations, then you can define them under  <code>services.home-assistant.config.automation</code>, otherwise split them into <code>services.home-assistant.config."automation manual"</code> and <code>services.home-assistant.config."automation ui"</code>, like so:

   services.home-assistant.config =

        action = {

}

</syntaxHighlight>

 

== Combine declarative and UI defined scenes ==

Same as with automations, scenes can also be configured both declaratively and from within the UI:

services.home-assistant.config."scene manual" = [

  # declarative scenes go here

];

services.home-assistant.config."scene ui" = "!include scenes.yaml";

== More Declarative Nix Configuration Examples ==

           trigger = {

             platform = "state";

           condition = {

           action = {

             service = "light.turn_off";

           trigger = {

             platform = "state";

           condition = [

           action = [

               service = "notify.notify";

               service = "siren.turn_on";

           trigger = {

             platform = "numeric_state";

           action = {

             service = "notify.notify";

           trigger = {

             platform = "state";

           action = {

             service = "notify.notify";

           trigger = {

             platform = "time";

           action = {

             service = "climate.set_temperature";

* [https://github.com/Mic92/dotfiles/tree/master/nixos/eve/modules/home-assistant Mic92's config]

A nix-shell expression for this is available [https://github.com/nix-community/nix-environments here].