From afa0da8ed0a7f4817001799752dbd80422047772 Mon Sep 17 00:00:00 2001 From: ehendrix23 Date: Tue, 17 Aug 2021 12:36:40 -0600 Subject: [PATCH] Add documentation for new upnp binary sensor (#18926) --- source/_integrations/upnp.markdown | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/source/_integrations/upnp.markdown b/source/_integrations/upnp.markdown index 713062a7189..18b19fd4963 100644 --- a/source/_integrations/upnp.markdown +++ b/source/_integrations/upnp.markdown @@ -3,6 +3,7 @@ title: UPnP/IGD description: Internet Gateway Device (IGD) Protocol for Home Assistant. ha_category: - Network + - Binary Sensor - Sensor ha_release: 0.18 ha_iot_class: Local Polling @@ -12,13 +13,15 @@ ha_codeowners: ha_domain: upnp ha_ssdp: true ha_platforms: + - binary_sensor - sensor --- -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](https://en.wikipedia.org/wiki/Universal_Plug_and_Play)/[Internet Gateway Device (IGD) Protocol](https://en.wikipedia.org/wiki/Internet_Gateway_Device_Protocol) if enabled on your router. +The `upnp` integration enables you to collect network statistics from your router such as bytes in/out and packets in/out and WAN connectivity status. This information is provided by the [UPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play)/[Internet Gateway Device (IGD) Protocol](https://en.wikipedia.org/wiki/Internet_Gateway_Device_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. Please note that UPnP or NAT-PMP needs to be enabled on your router for this integration to work.