1.6 KiB
title, description, ha_category, ha_release, ha_iot_class, ha_config_flow, ha_codeowners, ha_domain
| title | description | ha_category | ha_release | ha_iot_class | ha_config_flow | ha_codeowners | ha_domain | |||
|---|---|---|---|---|---|---|---|---|---|---|
| UPnP | Internet Gateway Device (IGD) Protocol for Home Assistant. |
|
0.18 | Local Polling | true |
|
upnp |
The upnp integration enables you to collect network statistics from your router such as bytes in/out and packets in/out. This information is provided by the UPnP/Internet Gateway Device (IGD) Protocol if enabled on your router.
There is currently support for the following device types within Home Assistant:
- Sensor - Allows to get the network statistics from your router such as bytes in/out and packets in/out.
Please note that UPnP or NAT-PMP needs to be enabled on your router for this integration to work.
Configuration
To integrate this into Home Assistant, add the following section to your configuration.yaml file:
# Example configuration.yaml entry
upnp:
{% configuration %} local_ip: description: The local IP address of the computer running Home Assistant. required: false type: string default: Try to auto-detect IP of host. {% endconfiguration %}
Troubleshooting
If Home Assistant is not able to discover the UPnP device, it may be because the local IP address of the computer running Home Assistant was not auto-detected correctly. To prevent this, you may add the local_ip option to your UPnP configuration:
# Example configuration.yaml with local_ip set
upnp:
local_ip: 192.168.1.2