FreeNAS statistics and messages in Home Assistant

Following on from the previous guide on how to enable remote starting and shutting down of a FreeNAS I’ll be showing you how to view your FreeNAS statistics and messages in Home Assistant. For this guide I’m once again going to be using the FreeNAS API. The FreeNAS dashboard has evolved into a nice little visual hub for viewing important data but as I have Home Assistant open on my desktop a lot more often than the FreeNAS web interface I wanted to import and display that data in my UI. The sensor I’ll be setting up in this guide will give me a report of the following:

  • The name of my volume
  • The current status of my volume
  • The used percentage of my volume
  • Whether the volume is decrypted

Once you’ve understood the basics you’ll be able to add any of the values available through the FreeNAS API. Based on these values you can also set up notifications such as a push notification if you’re volume were to become unhealthy.

Setting up the FreeNAS sensor in Home Assistant

As I’m not executing any commands, such as shutting the system down, this setup will be using sensors and not rest_command. Any of the following variables can be enabled in using the RESTful integration (just add or remove them under the json_attributes):

  • status: The current status of the Volume
  • vol_guid: The volume’s Globally Unique Identifier
  • name: The volume’s name
  • used_pct: The percentage of used storage
  • used_si: The amount of storage currently used
  • is_decrypted: Whether the volume is decrypted or not
  • avail_si: Available storage
  • total_si: The volume’s total storage

To get this API call to work, I’ve once again referenced the username and password in my secret.yaml file. For more on that topic you can check out my previous guide here.

 sensor:
  - platform: rest
    name: freenas_report_full
    json_attributes:
      - name
      - status
      - used_pct
      - is_decrypted
    resource: http://IP -OF-YOUR-FREENAS/api/v1.0/storage/volume/VOLUME-NAME/?format=json
    value_template: '{{ value_json.status }}'
    username: !secret freenas_user
    password: !secret freenas_password
    authentication: basic
    headers:
      Content-Type: application/json

This code will create a new entity with the desired attributes. But, as you might find out, this isn’t very practical. With this entity you won’t be able to embed individual information in your Lovelace UI and you can’t easily use the values in automations. What I did was create a template sensor for each individual value.

Template sensors

Percent used

 sensor:
  - platform: template
    sensors:
      freenas_percent_used:
        friendly_name: Percent used
        value_template: '{{ states.sensor.freenas_report_full.attributes["used_pct"].title() }}'
        entity_id: sensor.freenas_report_full

Volume status

 sensor:
  - platform: template
    sensors:
      freenas_status:
        friendly_name: Status
        value_template: '{{ states.sensor.freenas_report_full.attributes["status"].title() }}'
        entity_id: sensor.freenas_report_full

FreeNAS version (full)

 sensor:
  - platform: rest
    name: fn_version_full
    scan_interval: 3600
    json_attributes: 
      - fullversion
      - name
      - version
    resource: http://192.168.1.10/api/v1.0/system/version/?format=json
    value_template: '{{ value_json.fullversion }}'
    username: !secret fn_user
    password: !secret fn_password
    authentication: basic
    headers:
      Content-Type: application/json

FreeNAS version (just version number)

 sensor:
  - platform: template
    sensors:
      fn_version:
        friendly_name: Version
        value_template: '{{ states.sensor.fn_version_full.state.split(" ")[0] }}'
        entity_id: sensor.fn_version_full

Final steps

And there we have. Our FreeNAS statistics and information on the system can now be displayed inside Home Assistant and used for automations, scripts, and notification.

Controlling a FreeNAS using Home Assistant

Update 13 December 2019: Changed mac_address to mac

Besides my application server running Proxmox VE I have a NAS (Network Attached Storage) containing plenty of media, backups of my photography, and many delicious recipes. My NAS is currently running the FreeNAS operating system and despite it’s many faults, I’ll be sticking to that OS for the foreseeable future. My NAS is far from perfect. In fact, it’s borderline embarrassing. I bought the cheapest case I could find and fitted the absolute minimum of hardware. It isn’t particularly quiet and nothing is dampened so during writes this thing gets loud. Seeing as it sits right next to where I sleep there’s no way of leaving it turned on 24/7. This is where Home Assistant enters the fray. I needed a way of remotely turning my FreeNAS on and off as it sits in a shelf that isn’t easy to reach. And this is what the endresult looks like in my Lovelace UI:

The FreeNAS switch in my Home Assistant

For this to work I’m using the FreeNAS API to trigger a system shutdown from Home Assistant. Turning on the FreeNAS is way easier thanks to Wake on LAN (WOL) integration in Home Assistant. Let me start by showing you how to use the WOL switch to turn on your FreeNAS instantly.

Turning on a FreeNAS using Home Assistant

If you’re considering implementing this I’m going to assume you are technically well versed and understand the basics of Home Assistant and FreeNAS. For the WOL switch to work you need to know the IP (though this is technically only optional) and MAC of your FreeNAS. To find out your MAC simply enter the command ifconfig in your FreeNAS’ shell and look for hwaddr. The IP is solely used for Home Assistant to figure out if your FreeNAS is turned on or not. So if you’re going to use the switch in the UI I’d recommend adding the IP.

 switch:
  - platform: wake_on_lan
    name: FreeNAS
    host: YOUR-FREENAS-IP
    mac: "XX:XX:XX:XX:XX:XX"

Turning off a FreeNAS using Home Assistant

Turning off a FreeNAS using Home Assistant is slightly more complex. There’s no reverse WOL or anything similar and no universal way of handling shutdowns so instead I’ve opted to use the FreeNAS API. To make the API call simply create a REST command containing the following details:

 rest_command:
  freenas_shutdown:
    url: http://IP-OF-YOUR-FREENAS/api/v1.0/system/shutdown/
    method: post
    username: !secret freenas_user
    password: !secret freenas_password
    headers:
      content-Type: application/json

As you might have noticed, I’ve used the secret file to store my credentials. I had to use root to get this API call to work. There might be a nicer and safer way of doing this. To do this simply open the secrets.yaml on your Home Assistant server and enter the following on a new line:

freenas_user: YOUR-ROOT-USER
freenas_password: YOUR-PASSWORD

Tying it all together in one switch

Now that the FreeNAS RESTful Command is complete it can be added to the switch created in the first step. To do so, simply add the turn_off variable at the end of the switch as seen below:

switch:
 platform: wake_on_lan
 name: FreeNAS
 host: YOUR-FREENAS-IP
 mac_address: "XX:XX:XX:XX:XX:XX"
 turn_off:
   service: rest_command.freenas_shutdown 

And there you have it, FreeNAS can now be controlled by Home Assistant. This switch can be used in automations using switch.turn_on, switch.toggle, and switch.turn_off and can be placed in the UI.

Update Google Assistant on Every Home Assistant Reboot

In the third Beginner’s Guide I showed you how to enable the Homegraph API to allow the Google Assistant to sync devices with Home Assistant. Today I’ll be showing you a few lines of code that will sync the two platforms every time you reboot your Home Assistant. As a tinkerer’s tool, you will be rebooting very often, so it’s quite handy to use this automation. Just add these lines (no adjustments needed) to your automations.yaml:

- alias: 'Update Google Assistant on start of Home Assistant'
  trigger:
    platform: homeassistant
    event: start
  action:
    service: google_assistant.request_sync

That’s all.

The Home Assistant Beginner’s Guide Part 3: Integrating Home Assistant with the Google Assistant/Google Home

Let’s clear up a few misconceptions: When talking about Google Home (GH) I mean the hardware, the physical speaker that sits in your home, and Google Assistant (GA) is the software that runs on top of that hardware. Many, including Google, use the two synonymously. However this integration will not just connect your smart speaker with Home Assistant. The Google Assistant runs on just about anything and it’s reach is increasing with almost daily. Anything from your phone to watches to security cameras and washing machines run the Google Assistant. It’s just that Google Home was the first device that brought Google Assistant into our homes.

Be warned before you start this guide: This is by far the most complex thing we’ve done so far. There’s a fair bit of coding involved and we’ll be working with more than one different tool. With that said, I’ll try to explain things in the simplest way possible. After all, this is a Beginner’s Guide!

What will be done and what to expect

In this guide we’ll be going through the steps on how to integrate your Home Assistant with the Google Assistant (and thus your Google Home). By the end of this guide you’ll be able to ask your Google Assistant to turn the lights on with a specific colour and manage most of your devices that have been added to your Home Assistant.

Requirements

There are two main requirements for the Google Assistant and Home Assistant:

  • The obvious one: You need a smartphone that is compatible with the Google. This can be an iOS or Android device. You do not need a Google Home device for this integration to work, it just makes things more convenient.
  • The less obvious, but soon will become apparent, one: Your Home Assistant has to open to the internet. You can find out how to do that in my Beginner’s Guide Part 2.
  • This has already been pointed out in the first Beginner’s Guide but I’ll mention it again: Using an advanced text editor, such as Sublime Text will make editing files so much easier.
  • This guide was written for Windows users. I don’t have any Apple devices and as such couldn’t test any of the steps.

gactions CLI

Downloading the gactions CLI

First up, you’re going to want to download the gactions CLI. This is the command line interface used to test and update your integration. Download the correct version for your OS (in most cases this will be x86_64) and copy the file into a new and empty folder. In the same folder create a text file and rename it project.json (make sure you have File name extensions in explorer enabled, otherwise you will end up with a file called project.json.txt). Open the file with Sublime Text. Update and copy the following code into it (use the URL you previously created with Duck DNS):

{
  "actions": [{
    "name": "actions.devices",
    "deviceControl": {
    },
    "fulfillment": {
      "conversationName": "automation"
    }
  }],
  "conversations": {
    "automation":
    {
      "name": "automation",
      "url": "https://[YOUR HOME ASSISTANT URL]/api/google_assistant"
    }
  }
}

Actions on Google

Go to the Actions on Google developer console and create a new project. Enter a suitable project name (I went for Home Assistant, how imaginative) and your country. Click on create project. You’ll be greeted with a new window containing many complicated sounding words. Don’t worry, I don’t understand any of it either. We’re only interested in the Actions SDK. Click on Build. Copy the code ($ gactions update…) and paste it into an empty notepad, we’re going to need that.

In the notepad, replace PACKAGE_NAME with project.json and replace the $ with ./ if you’re running Windows. This is what you’re code should look like on a windows machine:

./gactions update --action_package project.json --PROJECT_NAME

Open the folder we created for the gactions CLI in the File Explorer, hold down shift and right-click anywhere inside the folder. You should see Open PowerShell window here in the right-click menu somewhere. Click on that. Copy and paste the code from your notepad and paste it into the PowerShell window using CRTL+V. Hit the Enter/Return key on your keyboard to run the code.

Opening PowerShell from a folder

After running the code you will be prompted to visit a URL. Copy and paste that URL into a browser and allow Assistant CLI to view and manage your Actions on Google. You will receive a long string of code in return for the permission. Copy that code and paste it into the PowerShell window. After a short time a message containing a URL will be returned. Copy the URL in the message.

Open the copied URL in a browser and fill in the required App information. Once again, it isn’t really important what you add but I always like to keep it relevant. Once Google is happy with the information you’ve given, click save. Don’t worry about entering private information, this Action will never be publicly released.

 

Click on the back arrow and select Account linking. Click Edit. Fill in information (has to be added but isn’t important). Click on Add in the following prompt. Select the following:

Grant type: Implicit

For the Client ID we’re going to create a long, randomly generated and secure string. Use something like the Random Password Generator for this and make sure to select the maximum length. Save this string in a notepad, we’re going to need it later (I recommend you add the description Client ID too)! The Authorization URL is your Home Assistant URL with ]/api/google_assistant/auth added to it:

https://YOUR_HOME_ASSISTANT_URL.duckdns.org/api/google_assistant/auth

Adding the Home Assistant URL to Actions on Google

Add two scopes: One being name, the other one email. Following that, enter some random gibberish in the testing instructions and click save.

Adding scopes to Actions on Google

Finally, with all the information entered, click on TEST DRAFT.

Testing the draft Action on Google

With everything sorted out, click on the settings cog in the top-left corner and open the Project settings. Here you’ll find your Project ID. Copy it into your notepad (again, give it a description).

Getting the Project ID

Homegraph API

This is an optional step but is highly recommended. The Homegraph API will allow you to ask your Google Assistant to “sync my devices”. That command will sync your Home Assistant devices with the Google Assistant each time you add a new one or change an existing one. To enable the Homegraph API, follow these steps:

  1. Go to the Google Cloud Platform.
  2. Select your project and click on ENABLE.
  3. Once enabled click on MANAGE and select Credentials in the left hand menu. Click on Create credentials and select API key.
  4. A new API key will appear in the list. Copy this key into your notepad.

Home Assistant configuration

Keep your notepad handy and open up the configuration.yaml. You’re going to have to create yet another random string for your access_token. Add and edit the following code with your data:

google_assistant:
  project_id: ACTIONS_ON_GOOGLE_PROJECT_NAME
  client_id: CLIENT_ID_CREATED_DURING_SETUP
  access_token: RANDOM_STRING
  agent_user_id: EMAIL_ENTERED_DURING_SETUP
  api_key: HOMEGRAPH_API_KEY_CREATED_DURING_SETUP
  exposed_domains:
    - switch
    - light
    - group

Restart your Home Assistant from the Web UI and wait for it to restart.

Google Home app

Open the Google Home app on your smartphone and navigate to Home control (you’ll find it in the menu). Click on the big + button to add new devices (in this case the home assistant). The project we have just created will located at the very top of the list and will prefixed by [test]. Add the device and all of your devices set up in Home Assistant will show up!

The Home Assistant Beginner’s Guide Part 2: Web Access

Setting a custom URL for Home Assistant using Duck DNS

Now that we’ve got our Home Assistant set up using Hass.io, it’s time to move on to more interesting matters. If you’re anything like me, the first thing you might want to do is control your Home Assistant using a Google Home speaker or the Google Assistant on your phone. And while we’re at it, wouldn’t it also be nice to be able to access the Home Assistant when you’re not at home? Luckily for you, that’s exactly what we’re going to be doing today!

The following steps might want to be avoided by anyone with privacy concerns. Following this guide will open up your Home Assistant to the big, bad internet. It’s more important than ever to set a password for your Home Assistant before going any further (you can find out how to do that in part 1 of the Beginner’s Guide). In this guide I’ll be showing you how to open your Home Assistant to the internet, configure a custom URL (using Duck DNS) with encryption (using Let’s Encrypt) and what ports you have to open on your Router.

Getting an custom Home Assistant URL with Duck DNS

To get things started, sign up to Duck DNS. Duck DNS is a free dynamic DNS. To put things simply, this service will translate your router’s public IP into an easily remembered URL. You could just enter your router’s public IP into your browser to access Home Assistant but there is one main drawback. The main reason you can’t just use the router’s IP is because it changes. Duck DNS will regularly check your the IP and update the settings so you’ll always have access to your Home Assistant.

Adding a new domain to Duck DNS

Once you’ve signed up to Duck DNS you can add a new domain. Just enter your desired URL into the field following http and click on ‘add domain’. In the top half of the window you’ll also see some information like your account and account type. Keep this window open because we’ll need the token later on.

Setting up Duck DNS for Home Assistant

Next it’s back to the Home Assistant. Access it by entering the device’s IP followed by :8123 (how to find your device’s IP) or

hassio.local:8123

into your browser of choice. Access the add-on store (it’s located under Hass.io in the menu and look for the add-on Duck DNS. Install the Duck DNS add-on and enter the add-ons settings by clicking on its card. The default settings are shown in the screenshot below:

Duck DNS setting in Home Assistant

Remember that token we saw on the Duck DNS website? It’s time to copy that and enter it into your Duck DNS settings. Enter the token and domain you registered so you’re settings look like the following (fields that have to be edited have been highlighted in bold):

{
  "lets_encrypt": {
    "accept_terms": true,
    "certfile": "fullchain.pem",
    "keyfile": "privkey.pem"
},
  "token": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  "domains": [
    "YOURDOMAIN.duckdns.org"
],
  "seconds": 300
}

Finished Duck DNS settings in Home Assistant

Home Assistant configuration

Unfortunately the Duck DNS add-on can’t take care of quite everything and there are a few lines of code we’re going to have to add to the Home Assistant’s configuration.yaml file. Open the file using your favourite editor and enter the following:

http:
  api_password: YOUR PASSWORD
  base_url: YOUR DUCK DNS URL
  ssl_certificate: /ssl/fullchain.pem
  ssl_key: /ssl/privkey.pem

As you can see in my screenshot, I’ve not included the api_password and base_url in my configuration.yaml file and have instead added these to the secrets.yaml file (more about that here).

Adjusting the configuration.yaml

Port forwarding your Home Assistant

The final step is telling your router what device to look for, when entering the URL into your browser. This is achieved by port forwarding. This step will be a bit different for everyone, because all router interfaces look a bit different. Somewhere in the settings you’ll find the option port forwarding and you’re going to want to enter the following:

Entry port: Single port / 443
Protocol: TCP
Device: hassio
Destination port: Single port / 8123

Finishing up

The final step will be to check your configuration in the Home Assistant interface and restart it. You should now be able to access the Home Assistant using the costum .duckdns.org domain you’ve chosen!