Add upnp sensor for IP, Status, and Uptime (#18979)

This commit is contained in:
ehendrix23 2021-09-22 11:19:34 -06:00 committed by GitHub
parent 8885762c8d
commit 9ccaa4a3aa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -10,6 +10,7 @@ ha_iot_class: Local Polling
ha_config_flow: true
ha_codeowners:
- '@StevenLooman'
- '@ehendrix23'
ha_domain: upnp
ha_ssdp: true
ha_platforms:
@ -17,12 +18,12 @@ ha_platforms:
- sensor
---
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.
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](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.
- **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.