Skip to content

Commit 61a959d

Browse files
committed
Improved
thanks for the comments / review
1 parent 028f822 commit 61a959d

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

source/_components/upnp.markdown

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,22 @@ ha_release: 0.18
1414

1515
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.
1616

17-
The IGD can also automatically create port forwarding mappings on your router for Home Assistant. By default it port forwards the tcp port being used by Home Assistant (default 8123), this can be changed with the optional external_port parameter.
17+
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.
1818

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

2121
To integrate this into Home Assistant, add the following section to your `configuration.yaml` file:
2222

2323
```yaml
24-
# Example configuration.yaml entry
24+
# Example configuration.yaml entry with custom external portal
2525
upnp:
2626
external_port: 80
2727
```
2828
29-
A port mapping will be created using the IP address and port that Home Assistant is running on. The mapping will never automatically expire. Upon stopping Home Assistant, the mapping will be removed from your router.
29+
If you which to have the statistics without having port mapping done through IGD, add the option **port_mapping**.
3030
31-
If you which to have the statistics without having port mapping done through IGD, add the option:
32-
```yaml
33-
# Example configuration.yaml entry with port mapping disabled
34-
upnp:
35-
port_mapping: false
36-
```
31+
Configuration variables:
32+
33+
- **external_port** (*Optional*): Expose Home Assistant to the internet over this TCP port. Defaults to Home Assistant configured port.
34+
- **port_mapping** (*Optional*): Disables port mapping maintains the network statistics sensors)
35+
- **unit** (*Optional*): UPnP sensors unit. Valid units are 'Bytes', 'KBytes', 'MBytes' and 'GBytes'.

0 commit comments

Comments
 (0)