2.4 KiB
layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release, ha_iot_class, redirect_from
| layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | ha_release | ha_iot_class | redirect_from | |||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| page | UPnP | Internet Gateway Device (IGD) Protocol for Home Assistant. | 2016-04-10 19:16 | true | false | true | true | upnp.png |
|
0.18 | Local Polling |
|
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/Internet Gateway Device (IGD) Protocol if enabled on your router.
The IGD can automatically create 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.
There is currently support for the following device types within Home Assistant:
- 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 component to work.
{% linkable_title Configuration %}
To integrate this into Home Assistant, add the following section to your configuration.yaml file:
# Example configuration.yaml entry with custom external portal
upnp:
port_mapping: true
ports:
hass: 8000
8080: 8080
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 %} port_mapping: description: If the component should try to map ports. required: false type: boolean default: false sensors: description: If the component should enable the UPNP sensors. required: false type: boolean default: true local_ip: description: The local IP address of the computer running Home Assistant. required: false type: string default: Try to auto-detect IP of host. ports: 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. {% endconfiguration %}