Desktop Companion for Home Assistant

This is an unofficial Desktop Companion App for Home Assistant written in Go.

The companion is running as a background process and sends local hardware information to your Home Assistant instance. Additionally, you can send notifications from Home Assistant to your Computer and display them using notify-send.

Currently, Linux is the only supported operating system (tested on Ubuntu 20.04 / KDE Neon)

Supported sensors

CPU temperature
CPU usage
Load average
Memory usage
Uptime
Power stats
Online check
Audio volume
Webcam process count
Custom scripts

Installation

You can download a compiled binary from the releases page or alternatively use the provided deb or rpm packages.

Just download the _binary file for your architecture and copy it to ~/.local/bin/hacompanion (or any other path on your system).

Arch Linux users have the option to install the binary as an AUR package. Eg:

yay -Sy hacompanion

You can now start the companion with the hacompanion command. But before doing so, you have to set up the configuration:

Configuration and Setup

Make sure you have the Mobile App integration enabled in Home Assistant (it is on by default).
Download a copy of the configuration file. Save it to ~/.config/hacompanion.toml.
In Home Assistant, generate a token by visting your profile page, then click on Generate Token at the end of the page.
Update your ~/.config/hacompanion.toml file's [homeassistant] section with the generated token.
Set the display name of your device (device_name) and the URL of your Home Assistant instance (host).
To receive notifications on a specific IP address you may need to change the push_url and listen settings under [notifications] to point respectively to your local IP address and the listen port. Without any value hacompanion will use your default NIC and listen on port 8080.
Configure all sensors in the configuration file as you see fit.
Run the companion by executing hacompanion (use the -config=/path/to/config flag to pass the path to a custom configuration file, ~/.config/hacompanion.toml is used by default).
You should now see your new sensors under Settings -> Integrations -> Mobile App -> Your Device.

Run the companion on system boot

If your system is using Systemd, you can use the following unit file to run the companion on system boot:

mkdir -p ${XDG_CONFIG_HOME:-$HOME/.config}/systemd/user
${EDITOR:-vi} "${XDG_CONFIG_HOME:-$HOME/.config}/systemd/user/hacompanion.service"

[Unit]
Description=Home Assistant Desktop Companion
Documentation=https://github.com/tobias-kuendig/hacompanion
# Uncomment the line below if you are using NetworkManager to ensure hacompanion
# only starts after your host is online
# After=NetworkManager-wait-online.service

[Service]
# Load ~/.config/hacompanion/env where you can for example set
# HASS_TOKEN, HASS_DEVICE_NAME etc.
EnvironmentFile=%E/hacompanion/env
# Make sure to set the absolute path to hacompanion correctly below
ExecStart=%h/.local/bin/hacompanion -config=%E/hacompanion.toml
Restart=on-failure
RestartSec=5
Type=simple

[Install]
WantedBy=default.target

Start the companion by running:

systemctl --user daemon-reload
systemctl --user enable --now hacompanion
# check status with:
# systemctl --user status hacompanion
# and logs with:
# journalctl --user -xlf -u hacompanion

Custom scripts

You can add any number of custom scripts in your configuration file.

The companion will call these scripts and send the output to Home Assistant. It does not matter what language the script is written in, as long as it can be executed from the command line.

The output of your script has to be as follows:

my_state_value
icon:mdi:home-assistant
custom_attribute_1:value 1
custom_attribute_2:value 2

The above would be translated to the following json payload:

{
  "icon": "mdi:home-assistant",
  "state": "my_state_value",
  "attributes": {
    "custom_attribute_1": "value 1",
    "custom_attribute_2": "value 2"
  }
}

The state (first line) is required. If icon is not set then the icon defined in the config file will be used. Attributes are optional.

Example script

The following bash script reports the current time to Home Assistant.

It can be registered like this:

[script.custom_time]
path = "/path/to/script.sh"
name = "The current time"
icon = "mdi:clock-outline"
type = "sensor"

The script content:

#!/bin/bash
date "+%H:%M"             # First line, state of the sensor
echo formatted:$(date)    # Custom "formatted" Attribute
echo unix:$(date "+%s")   # Custom "unix" Attribute

The output:

16:34
formatted:Sa 15 Mai 2021 16:34:40 CEST
unix:1621089280

Receiving notifications

The companion can receive notifications from Home Assistant and display them using notify-send. To test the integration, start the companion and execute the following service in Home Assistant:

service: notify.mobile_app_your_device # change this!
data:
  title: "Message Title"
  message: "Message Body"
  data:
    expire: 4000 # display for 4 seconds
    urgency: normal

Automation ideas

Feel free to share your automation ideas in the Discussions section of this repo.

tobias-kuendig / hacompanion

readme