Home Assistant

OpenWrt (luci)

This is a presence detection scanner for OpenWrt using luci.

Before this scanner can be used you have to install the luci RPC package on OpenWrt:

# opkg install luci-mod-rpc

To use this device tracker in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
device_tracker:
  - platform: luci
    host: ROUTER_IP_ADDRESS
    username: YOUR_ADMIN_USERNAME
    password: YOUR_ADMIN_PASSWORD

Configuration Variables

Looking for your configuration file?
host string Required

The hostname or IP address of your router, e.g., 192.168.1.1.

username string Required

The username of a user with administrative privileges, usually admin.

password string Required

The password for your given admin account.

ssl boolean (Optional, default: false)

If your router enforces SSL connections, set to true.

verify_ssl boolean (Optional, default: true)

If SSL/TLS verification for HTTPS resources needs to be turned off (for self-signed certs, etc.)

See the device tracker integration page for instructions how to configure the people to be tracked.

This device tracker provides a number of additional attributes for each tracked device (if it is at home): flags, ip, device, and host. The first three attributes are taken from the ARP table returned by the luci RPC. The host attribute is taken from the platform configuration and can be used to distinguish in which router a device is logged in, if you are using multiple OpenWrt routers.

Some installations have a small bug. The timeout for luci RPC calls is not set and this makes the call fail. If you want to locally fix your OpenWrt installation, you can apply the change manually to /usr/lib/lua/luci/controller/rpc.lua, or simply set a fixed timeout. The default is 3600.