fmartingr/fmartingr.com
1
0
Fork 0
Code Issues 2 Pull requests Projects Releases Packages Wiki Activity Actions
fmartingr.com/content/blog/2020-12-20-self-hosting-my-home-with-home-assistant-part-1/contents.lr
Felipe Martin 706d82bb63
Post published 
Self-hosting my home with Home Assistant (part 1)
2020-12-20 17:46:39 +01:00

316 lines
13 KiB
Markdown
Raw Blame History

title: Self-hosting my home with Home Assistant (part 1)
---
pub_date: 2020-12-20
---
_discoverable: yes
---
body:
Even if I've been a Home Assistant's user for quite some time I have never dedicated myself to have a truly stable and dedicated service at home. I always treated it more like a pet project than anything else, but this is changing now.
I have a fair amount of _Smart Devices_ around the house and just as you come to expect they come from different companies, protocols and sizes. Each day it passes I'm more and more concerned about my privacy and the value of the hardware I do not truly own.
With this in mind I have started **the journey of self-hosting!** Which to put it simply is... every device that is in my home (with a few exceptions that you'll see later) will be controlled by this Home Assistance instance.
<!-- readmore -->
> Note: I wanted to install this on a USB Drive, but apparently that's still not supported for _Home Assistant OS_, so I'm stuck with an SD Card for now. Some time after starting working on this I heard about [`datactl`](https://www.home-assistant.io/blog/2020/12/13/home-assistant-os-release-5/#external-data-disk) but I will setup that sometime later.
## Base Home Assistant OS using an SD Card
For this just stick to the [official documentation](https://www.home-assistant.io/hassio/installation/). Only download the latest release [from github](https://github.com/home-assistant/operating-system/releases) and copy the _img_ card to your SD Card with `dd`, Balena or the tool of choice.
Put the SD Card on your Pi, turn it on and let's get started.
## Base installation
After booting, you will be welcome with a wizard installation. Just follow the basic instructions to generate the main user/account, and the name and location for your home assistant.
Bonus: Use some website [like this](https://www.freemaptools.com/elevation-finder.htm) to get your elevation if you're feeling picky.
After that, you will be greeted by something similar to this:
[![Base install after the wizard](./base-360.png)](./base.png)
## Update the system
Go to your Supervisor tab and check if you have any pending updates.
## Moving to MariaDB
The default database backend is SQLite, and that has it's limitations, so let's move everything to MariaDB before any other configuration.
1. Install the File editor addon from **Supervisor > Add-ons > File editor** and start it.
2. Install the MySQL addon from **Supervisor > Add-ons > MariaDB**
3. Once installed, go to the configuration tab and set a password
4. Under the Info tab start the MariaDB Service and enable the Watchdog service
5. Go to the file editor interface and edit the `configuration.yaml` file.
6. Add the configuration for the [`recorder`](https://www.home-assistant.io/integrations/recorder/) integration:
```yaml
recorder:
db_url: mysql://homeassistant:<password>@core-mariadb/homeassistant?charset=utf8
commit_interval: 5
purge_keep_days: 90
history:
```
In this case I also set data to be stored for 90 days and a 5s delay between disk writes (since I'm using an SD Card and their lifespan is not very long with abundant I/O).
More information on the documentation: [`recorder`](https://www.home-assistant.io/integrations/recorder/), [`history`](https://www.home-assistant.io/integrations/history/)
7. Restart Home Assistant for the changes to take effect under **Configuration > Server Constrols > Restart**.
## Backups
Now another if not the most important of them all, automatic snapshots in case something goes wrong.
Go to **Configuration > Automations > Add automation**, and in top-right hamburger menu press **Edit as YAML**.
This configuration will perform a Weekly Snapshot every Monday at 3.00 AM. It is a sensible default once Home Assistant is running, but if you're going to play with it you may need to consider more frequent backups.
``` yaml
alias: Weekly Snapshot
description: 'Performs a weekly snapshot'
mode: single
trigger:
- platform: time
at: '03:00'
condition:
- condition: time
weekday:
- mon
action:
- service: hassio.snapshot_full
data:
name: 'weekly_{{ now().strftime(''%Y-%m-%d'') }}'
```
Keep in mind that this snapshots are stored on the `/backup` folder on the Home Assistant instance, you need to create a way of moving that **out** of the system. You can use other automation, SCP from another machine or any compatible tool of your choice.
## Setting up accounts and users that will use the system
This used to be more complex a while ago, now you only need to go to **Configuration > People** and add the users you need.
Now you can even add the avatar directly from the interface! Back in the day you required to upload the file and fiddling with YAMLs.
Also, for some options and add-ons to display, you need to enable "Advanced mode" on your user profile page.
![Advanced mode enabled on my user](./advanced_mode-360.png)
## SSH Access
Easily handled by an integration, as almost everything with Home Assistant.
> For this add-on to show up you need to enable Advanced mode as shown in the previous step.
Just install the **Terminal and SSH** addon, add your ssh key under the configuration tab under the `authorized_keys` property, and expose a port for the SSH server on the host. After that Start the service and enable the Watchdog to monitor it in case it fails.
## Enable SSL
Even if my home assistant installation is going to be LAN only (using a VPN to have external access) I always setup SSL in all my services and while there are some options when setting this up with Home Assistant, I went the nginx way since that's what I'm more comfortable with.
Go to **Supervisor > Add-on Store** and install the **NGINX Home Assistant SSL proxy**.
Put your files under `/ssl` connecting to the instance via SSH or using any file editor addon on the store.
Under its **Configuration** tab, set up the domain and path to the certificate and key files.
``` yaml
domain: homeassistant.local
certfile: nginx/homeassistant.local/homeassistant.crt # Relative to /ssl
keyfile: nginx/homeassistant.local/homeassistant.key # Relative to /ssl
```
There are a number of guides out there to generate self-signed certificates. I have my own Certificate Authority that use to sign certificates for my local services, that way I can just trust my own CA and every dependant certificate will work out of the box.
As a note, for this to work with the companion apps on iOS you need to generate the certificates with [pretty specific requisites](https://support.apple.com/en-us/HT210176). Android worked as a charm.
## Getting the Home Assistant Companion
Download the application from your phone's store and after logging in you can setup the sensors to be sent to Home Assistant, this will be linked to your account so you could perform automation with them on the server.
Apart from using the app to control your home devices, the sensors will be useful to generate automation in the future.
Another useful thing to setup here is the local (LAN) address to use when the phone is connected to Wifi at home, using an external hostname when connecting via VPN/RemoteControl.
## The first automation: tell me about updates
I use an script to send notifications to all devices (persons) on the house, with the `title` and `message` parameter:
``` yaml
alias: Send Notifications
sequence:
- service: notify.mobile_app_oneplus6
data:
title: '{{ title }}'
message: '{{ message }}'
# Insert more notifcations into sequence
mode: single
variables:
title: null
message: null
```
And this automation will check when there are any updates and send a notification using the previous script with the version number that just came in:
``` yaml
alias: Update notification
description: "Notify everyone when there's an update available"
trigger:
- platform: state
entity_id: binary_sensor.updater
from: 'off'
to: 'on'
condition: []
action:
- service: script.send_notifications
data:
title: New Home Assistant Release
message: >-
Home Assistant {{ state_attr('binary_sensor.updater', 'newest_version')
}} is now available.
mode: single
```
![Update notification on my phone](./update_notification-360.jpg)
## Add system sensors
I want to control how the Raspberry is doing, so I'm going to enable some system sensors using the [`systemmonitor`](https://www.home-assistant.io/integrations/systemmonitor) sensor.
Edit the `configuration.yaml` file and add the following:
``` yaml
sensor:
- platform: systemmonitor
resources:
- type: disk_use_percent
- type: memory_use_percent
- type: swap_use_percent
- type: load_1m
- type: load_5m
- type: load_15m
- type: processor_use
- type: processor_temperature
- type: last_boot
- type: throughput_network_in
arg: eth0
- type: throughput_network_out
arg: eth0
```
This requires a Home Assistant restart for the changes to take effect.
I also added a custom lovelace dashboard to monitor everything easily, here is the YAML configuration:
``` yaml
views:
- title: Overview
path: overview
icon: 'mdi:eye'
visible:
- user: be3b6f5bc71c49ff9be6830d545cb4e0
badges: []
cards:
- type: grid
cards:
- type: gauge
entity: sensor.processor_use_percent
min: 0
max: 100
name: Processor
severity:
green: 50
yellow: 75
red: 80
- type: gauge
entity: sensor.memory_use_percent
min: 0
max: 100
severity:
green: 50
yellow: 65
red: 75
name: Memory
- type: gauge
entity: sensor.disk_use_percent
min: 0
max: 100
name: Disk usage
severity:
green: 50
yellow: 60
red: 75
- type: gauge
entity: sensor.processor_temperature
min: 0
severity:
green: 45
yellow: 50
red: 55
max: 70
name: Temperature
- type: gauge
entity: sensor.load_5m
min: 0
max: 4
severity:
green: 1
yellow: 2
red: 3
title: System
```
And here's a preview:
![Home Assistant simple system monitor lovelace dashboard](./system_monitor-360.png)
## Adding integrations
At this point if you already have devices on your network your Home Assistant will send you a notification like this:
[![Notification telling that devices where found on network](./notification-360.png)](./notification.png)
So I'm going to setup the base integrations with the server to start controlling some devices.
### Chromecast
> But you said self-hosted! Yeah, yeah... And I want to, but there's no real alternative to the Cast protocol to self host, the speakers with Chromecast devices are just so convenient...
One of the simplest things to set up, just go to your integrations and add it. It will prompt you to select in which rooms each Chromecast device is and that's it.
[![Chromecast configuration](./chromecast-360.png)](./chromecast.png)
### Weather (OpenWeatherMap)
I'm going to use the [`OpenWeatherMap`](https://www.home-assistant.io/integrations/openweathermap/) integration because it provides more sensors than the one setup by default.
You just need to [register to the service](https://openweathermap.org/) and enable the integration under **Configuration > Integrations > OpenWeatherMap**, supply your API key and set the mode to __onecall_hourly__ which will download 3h forecasts each hour, enough for the free tier.
> I had to wait for an hour or so until the API Key was valid for the integration to use, it keep saying **Invalid API Key** until I received a confirmation email for my account.
### Phillips Hue
Linking the Phillips Hue is super easy, you only need to add the Hue integration, select the bridge IP from the dropdown (or input one manually) and press the button on the bridge to confirm.
After selecting in which area the bridge and bulbs are in, you're good to go.
> **BONUS:** Since the comunication is done via LAN with the bridge, the bridge itself doesn't need internet access to work (as I have mine blocked in my firewall). Also in my case this is only temporal since I will move every Zigbee device to a cluster controlled by Home Assistant.
### Tuya (Smart Things)
This is one of the dependencies I have that I'm most eager to get rid off, but for now there are some smart plugs at home that I need to control.
Going to **Configuration > Integrations > Add** the **Tuya** is on the list; you need to enter your username, password and country code for the integration to communicate with the Tuya API, so your devices will require internet connection.
The plan is to try and flash the plugs with Tasmota to free them from the _cloud_ and any new ones I'm getting will be Zigbee compatbile with the hopes on having only Zigbee smart plugs at home.
## Closing
That was easy!
The folks at Home Assistant have been working on this so good that almost everything can be done from the interface now. I see any _normal_ user working with this mostly plug and play from the UI which is amazing in my opinion.
In future post I will dive into my Zigbee configuration, InfluxDB, ESPHome, Alarms ... there's so much to do!
---
_discoverable: no
Reference in a new issue View git blame Copy permalink