Home-Assistant
/
home-assistant.io
mirror of https://github.com/home-assistant/home-assistant.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_integrations/upnp.markdown

1.4 KiB
Raw Permalink Blame History

title description ha_category ha_release ha_iot_class ha_config_flow ha_codeowners ha_domain ha_ssdp ha_platforms
UPnP/IGD Internet Gateway Device (IGD) Protocol for Home Assistant.
Network
Binary Sensor
Sensor
0.18 Local Polling true
@StevenLooman
@ehendrix23
upnp true
binary_sensor
sensor

The upnp integration enables you to collect network statistics from your router such as bytes in/out and packets in/out, uptime, WAN IP address, and WAN connectivity status. 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:

  • Binary Sensor - If router is connected to the WAN.
  • Sensor - Allows to get the network statistics from your router such as bytes in/out and packets in/out, uptime, status, and IP. Sensor for uptime will only be there if supported by the router.

Please note that UPnP or NAT-PMP needs to be enabled on your router for this integration to work.

{% include integrations/config_flow.md %}

Manual configuration

Alternatively, you can use YAML by adding the following section to your configuration.yaml file:

# Example configuration.yaml entry
upnp: