jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-22 00:36:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updates after upnp-component rewrite. (#6324)

Browse Source 
* Remove unsupported option

* More clear instructions

* Changes after review
This commit is contained in:
Steven Looman 2018-10-04 20:56:34 +02:00 committed by Franck Nijhof
parent 8076e1e1ea
commit 2f467a0db6
1 changed files with 4 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
source/_components/upnp.markdown
View File

@ -12,7 +12,7 @@ ha_category: Network
ha_release: 0.18
---
The `upnp` component enables you to collect network statistics from your router such as bytes in/out and packets in/out. This information is provided by the Internet Gateway Device (IGD) Protocol if enabled on your router.
The `upnp` component 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 IGD automatically creates port forwarding mappings on your router for Home Assistant, exposing your installation to the internet. The mapping will never automatically expire. Upon stopping Home Assistant, the mapping will be removed from your router.
@ -25,16 +25,17 @@ To integrate this into Home Assistant, add the following section to your `config
```yaml
# Example configuration.yaml entry with custom external portal
upnp:
port_mapping: true
ports:
hass: 8000
8080: 8080
```
If you which to have the statistics without having port mapping done through IGD, add the option **port_mapping**.
With the default settings only the sensors are added for statistics. If you wish to have port mapping done through IGD, add the option **port_mapping** and **ports**.
{% configuration binary_sensor.template %}
ports:
description: Map of ports to map from internal to external. Pass 'hass' as internal port to use the port Home Assistant runs on.
description: Map of ports to map from internal to external. Pass 'hass' as internal port to use the port Home Assistant runs on. Note that you have to enable port_mapping if you wish to map ports.
required: false
type: map
default: open same port on external router as that HASS runs locally and forwards it.
@ -43,11 +44,6 @@ If you which to have the statistics without having port mapping done through IGD
required: false
type: boolean
default: false
units:
description: Define the units used for the UPNP sensor. Possible values are Bytes, KBytes, MBytes, GBytes.
required: false
type: string
default: Mbytes
local_ip:
description: The local IP address of the computer running Home Assistant.
required: false