Package for a completely event-driven device/user presence tracker for Home Assistant on an OpenWRT/LEDE access point.
I wanted to use this in a mixed device tracker environment in a fashion that treats the devices detected by this script separately from other devices. In order to do this, these scripts now can use 'device mode', which maps a MAC address to a device name in the devices file.
To enable this mode:
- Edit your
/usr/lib/hass/devicesfile - Set the config setting
use_device_idto1 - Reload the daemon:
/etc/init.d/hass reload
I tested with this specific OpenWRT version:
OpenWrt 18.06.1 r7258-5eb055306f / LuCI openwrt-18.06 branch (git-18.228.31946-f64b152)
Listens on hostapd wifi association events and then initiates appropriate service calls to the configured Home Assistant instance. On AP-STA-CONNECTED or AP-STA-POLL-OK the device is marked as seen with a timeout set by the timeout_conn config option. If an AP-STA-DISCONNECTED event is received, it is marked as seen with a timeout of timeout_disc.
Since restarting your access points removes any scripts connected via hostapd_cli -a, this package includes a daemon which monitors ubus for added APs so restarting/reconfiguring your radios doesn't kill the service.
A docker image is provided for convenience of generating an OpenWRT package without having to set up the build environment. Simply run docker-compose run pkgbuild. If successful, the created package will be located in build/bin/packages/<ARCH>/packages/. If your UID is not 1000, you may need to chmod 777 build/bin.
Simply opkg install hass once it is added to the OpenWRT repositories. Until then, download a package from releases and opkg install <downloaded_file>.
Once the package is installed, you can modify /etc/config/hass to your liking and start/enable the service via service hass start and service hass enable. If you would like to use HTTPS, simply start your host string with the https:// protocol specifier.
Due to auth changes in Home Assistant 0.78 there are now two authentication methods, the new and preferred option being a long-lived access token that can be generated from the web UI. The deprecated API password method continues to work as long you have an API password set. If both are configured, token auth will be preferred.
If Home Assistant or the OpenWRT access point is restarted frequently or unreliable in other ways, you should reduce the very long default timeout for connected devices, since a disconnect event may be missed. However, since association events for connected devices can happen as infrequently as every 2-4 hours, you might want to then add a cronjob which synchronizes the state to Home Assistant at least twice as often as your timeout for connected devices timeout_conn. A good value for this might be a timeout of 1 hour and a sync every 30 minutes. The cronjob should look like:
#!/bin/sh
source /lib/functions.sh
config_load hass
source /usr/lib/hass/functions.sh
sync_state
This ensures that missed disconnect events do not spuriously keep the device present for more than an hour. This will be implemented by default in a future version or via an OpenWRT DeviceScanner in Home Assistant.