homeassistant-vyos-router

VyOS Rounter is a custom integration for Homeassistant which provides Presence detection as device_tracker functionality for VyOS Router. This integration uses direct HTTP-API from VyOS Router.

To use this integration you need to enable HTTP-API on your VyOS Router.

Installation

First enable HTTP-API on your VyOS Router.

HACS

Add this repository to your HACS installation, then install.

Manual

Download stable release contents from custom_components/vyos, then copy to your home assistant at /config/custom_components/vyos.

Once the integration is installed be sure to restart hass and hard-refresh the UI in the browser (ctrl-F5) if it doesn't appear in the list.

Usage

After VyOS Router is installed, you can add your device from Home Assistant UI.

To connect to the device you need to provide the following data:

• url this include https:// protocol and port number :port, for instance https://192.168.1.1:11123
• api_key the key that you set from VyOS doc MY-HTTPS-API-PLAINTEXT-KEY
• version_dhcp_server config version of dhcp-server, on vyos-1.4 or lower that doesn't use kea dhcp server, this value is typcally 7. If you're running vyos-1.5 and above with kea, you can use any number higher than 7. If you wish to know your exact number, you could use this command cat /config/config.boot | grep -Eo 'dhcp-server@[0-9]*'
• verify_ssl whether to use an SSL connection
• tracker_interfaces this is optional, you can use comma , to specify multiple interface, for example eth0,eth1,wlan0. If you leave it empty, it'll use all interfaces.
• detection_time How long before considered away or at home in seconds.

After configured the integration, the device entities will be disabled by default. Find the required mac addresses using the disabled entity list, then activate them as needed.

Support

Issues and Pull requests

If you have discovered a problem with the integration or simply want to request a new feature, please create a new issue.

You may also submit pull requests to the repository.