Home Assistant integration for the Linksys Velop Wi-Fi system.

• Description
• Installation
• Definitions
• Entities Provided
  • Binary Sensors
  • Buttons
  • Device Trackers
  • Event
  • Select
  • Sensors
  • Switches
• Services
• Repairs
• Setup
• Configurable Options
  • Timers
  • Device Trackers
  • UI Devices
  • Events
  • Advanced Options
• Troubleshooting
  • Debug Logging
  • Diagnostics Integration

This custom component has been designed for Home Assistant and enables access to the functions that would be useful (and probably some that aren't) in the Home Assistant environment.

The integration can be installed using HACS. The integrations is not available in the default repositories, so you will need to add the URL of this repository as a custom repository to HACS (see here).

Alternatively you can use the button below.

Mesh: the mesh is the network itself and refers to anything that is not attributed to a single node or device in the network.

Node: a node is a device that helps to form the mesh.

Device: a device is an endpoint that connects to the mesh network. Think of these as the endpoint devices, such as a laptop, phone or tablet.

All device entities are only available if the UI Device is enabled.

Entities are only available if the required capability for that data is available on the Mesh. For example, if the Mesh does not support the storage JNAP actions then the entities detailing storage partitions etc. will not be available.

N.B. There is deliberately no button provided to restart the Primary node by default. Restarting the Primary node will cause all nodes in the Mesh to reboot and I consider this to be quite a destructive action. There is no confirmation in the HASS UI when a button is pressed so there is no time to warn anyone. If you'd like to reboot the Primary you node you must use the service with the is_primary flag provided, or the Mesh: Reboot the Whole Mesh button.

These are selectable and are presented as part of the configuration at both install time and from reconfiguring the integration.

Device trackers should be enabled by default and will be seen as entities of the mesh. This is achieved by adding the MAC address to the known connections for the Mesh device. You will see these in the HASS UI. When the tracker is removed, the MAC is also removed from the Mesh device.

This entity provides access to data for the events selected in the configuration. Available events are: -

The following services are available. Each service is described in metadata so paramters are described in the Home Assistant Services page.

• Control Internet Access for a Device - allow/block access to the Internet for a device.
• Delete Device - delete a device from the Mesh device list.
• Reboot Node - reboot the given node.
• Rename Device - rename the given device in the Mesh device list.
• Set Device Parental Controls - set the times a device is blocked from using the Internet.

All services require that you select the Mesh device that the request should be directed to. Other requirements by the services should be self-explanatory.

* these are considered long-running tasks. When the binary sensors spot these tasks are running an additional timer is set up that polls at intervals to get updates and updates the relevant attributes for that sensor.

^ these are deprecated services. A warning will be displayed in the HASS log when they are used. They are subject to removal at any time.

When setting up the integration you will be asked for the following information.

• Primary node address: must be the node classed as the primary node
• Password: the password you would use to log in to the router. This may not be the same as the password for the application or web UI if you use the Linksys cloud service.

• Scan Interval: the frequency of updates for the sensors, default 60s
• Device Tracker Interval: the frequency of updates for the device trackers, default 10s
• Consider Home Period: the time to wait before considering a device away after it notifies of becoming disconnected, default 180s
• Response Timeout: the number of seconds to wait for a response from an individual request to the API, default 10s

• Available devices: a multi-select list of the devices found on the mesh.

On successful set up the following screen will be seen detailing the Mesh device and the individual nodes found in the mesh.

It is possible to configure the following options for the integration.

• Scan Interval: the frequency of updates for the sensors, default 60s
• Device Tracker Interval: the frequency of updates for the device trackers, default 10s
• Consider Home Period: the time to wait before considering a device away after it notifies of becoming disconnected, default 180s
• Response Timeout: the number of seconds to wait for a response from an individual request to the API, default 10s

• Available devices: a multi-select list of the devices found on the mesh.

A UI device is one which is available on the mesh and you would like to have further information available in Home Assistant. IT could be that you want to create automations based on a device signal strength, parent node or state (without using a device tracker).

• Available devices: a multi-select list of the devices found on the mesh. This list excludes any device which doesn't have a name - typically displayed in the official interfaces as Network Device

The events selected here will be raised with the event entity.

This section is only available if "Advanced Mode" is enabled for the current user. See here.

• Velop image path: the path to the folder location containing the images to use for integration purposes. This is currently used for to set the entity picture for various entities. It relies on the http integration from HASS, details of which can be found here, and more specifically here for the path to place the files in.
• Use a temporary device for select entity details: creates a placeholder device that will be populated with the details of the device selected in the select entity. The select entity will no longer have the details populated to its attributes.
• Allow rebooting the Mesh: creates a button on the Mesh entity that allows rebooting the whole mesh.

This way of logging is most useful if there is an intermitent problem as it will continue logging until it is disabled again.

Debug logging can be enabled in Home Assistant using the logger integration see here.

logger:
  default: warning
  logs:
    custom_components.linksys_velop: debug
    pyvelop: debug

The highlighted area in the image below shows where the link for downloading diagnostics can be found.

Example output: -

• Device
• Configuration Entry and Mesh