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.
To integrate this into Home Assistant, add the following section to your
# 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.
(boolean)(Optional)If the component should try to map ports.
Default value: false
(boolean)(Optional)If the component should enable the UPNP sensors.
Default value: true
(string)(Optional)The local IP address of the computer running Home Assistant.
Default value: Try to auto-detect IP of host.
(map)(Optional)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.
Default value: Open same port on external router as that HASS runs locally and forwards it.
If Home Assistant is not able to discover UPnP sensors, it may be because the local IP address was not auto-detected correctly. To prevent this, you may add the
local_ip option to your UPnP configuration:
# Example configuration.yaml with UPnP sensors enabled and local_ip set upnp: sensors: true local_ip: 192.168.1.2