Variables
string	BYTES_RECEIVED = "bytes_received"

string	BYTES_SENT = "bytes_sent"

string	CONFIG_ENTRY_FORCE_POLL = "force_poll"

string	CONFIG_ENTRY_HOST = "host"

string	CONFIG_ENTRY_LOCATION = "location"

string	CONFIG_ENTRY_MAC_ADDRESS = "mac_address"

string	CONFIG_ENTRY_ORIGINAL_UDN = "original_udn"

string	CONFIG_ENTRY_ST = "st"

string	CONFIG_ENTRY_UDN = "udn"

string	DATA_PACKETS = "packets"

string	DATA_RATE_PACKETS_PER_SECOND = f"{DATA_PACKETS}/{UnitOfTime.SECONDS}"

bool	DEFAULT_CONFIG_ENTRY_FORCE_POLL = False

	DEFAULT_SCAN_INTERVAL = timedelta(seconds=30).total_seconds()

string	DOMAIN = "upnp"

string	DOMAIN_DISCOVERIES = "discoveries"

string	IDENTIFIER_HOST = "upnp_host"

string	IDENTIFIER_SERIAL_NUMBER = "upnp_serial_number"

string	KIBIBYTES_PER_SEC_RECEIVED = "kibibytes_per_sec_received"

string	KIBIBYTES_PER_SEC_SENT = "kibibytes_per_sec_sent"

	LOGGER = logging.getLogger(__package__)

string	PACKETS_PER_SEC_RECEIVED = "packets_per_sec_received"

string	PACKETS_PER_SEC_SENT = "packets_per_sec_sent"

string	PACKETS_RECEIVED = "packets_received"

string	PACKETS_SENT = "packets_sent"

string	PORT_MAPPING_NUMBER_OF_ENTRIES_IPV4 = "port_mapping_number_of_entries"

string	ROUTER_IP = "ip"

string	ROUTER_UPTIME = "uptime"

string	ST_IGD_V1 = "urn:schemas-upnp-org:device:InternetGatewayDevice:1"

string	ST_IGD_V2 = "urn:schemas-upnp-org:device:InternetGatewayDevice:2"

string	TIMESTAMP = "timestamp"

string	WAN_STATUS = "wan_status"

Detailed Description

Constants for the IGD component.

Variable Documentation

◆ BYTES_RECEIVED

string homeassistant.components.upnp.const.BYTES_RECEIVED = "bytes_received"

Definition at line 12 of file const.py.

◆ BYTES_SENT

string homeassistant.components.upnp.const.BYTES_SENT = "bytes_sent"

Definition at line 13 of file const.py.

◆ CONFIG_ENTRY_FORCE_POLL

string homeassistant.components.upnp.const.CONFIG_ENTRY_FORCE_POLL = "force_poll"

Definition at line 27 of file const.py.

◆ CONFIG_ENTRY_HOST

string homeassistant.components.upnp.const.CONFIG_ENTRY_HOST = "host"

Definition at line 33 of file const.py.

◆ CONFIG_ENTRY_LOCATION

string homeassistant.components.upnp.const.CONFIG_ENTRY_LOCATION = "location"

Definition at line 32 of file const.py.

◆ CONFIG_ENTRY_MAC_ADDRESS

string homeassistant.components.upnp.const.CONFIG_ENTRY_MAC_ADDRESS = "mac_address"

Definition at line 31 of file const.py.

◆ CONFIG_ENTRY_ORIGINAL_UDN

string homeassistant.components.upnp.const.CONFIG_ENTRY_ORIGINAL_UDN = "original_udn"

Definition at line 30 of file const.py.

◆ CONFIG_ENTRY_ST

string homeassistant.components.upnp.const.CONFIG_ENTRY_ST = "st"

Definition at line 28 of file const.py.

◆ CONFIG_ENTRY_UDN

string homeassistant.components.upnp.const.CONFIG_ENTRY_UDN = "udn"

Definition at line 29 of file const.py.

◆ DATA_PACKETS

string homeassistant.components.upnp.const.DATA_PACKETS = "packets"

Definition at line 21 of file const.py.

◆ DATA_RATE_PACKETS_PER_SECOND

string homeassistant.components.upnp.const.DATA_RATE_PACKETS_PER_SECOND = f"{DATA_PACKETS}/{UnitOfTime.SECONDS}"

Definition at line 22 of file const.py.

◆ DEFAULT_CONFIG_ENTRY_FORCE_POLL

bool homeassistant.components.upnp.const.DEFAULT_CONFIG_ENTRY_FORCE_POLL = False

Definition at line 37 of file const.py.

◆ DEFAULT_SCAN_INTERVAL

homeassistant.components.upnp.const.DEFAULT_SCAN_INTERVAL = timedelta(seconds=30).total_seconds()

Definition at line 36 of file const.py.

◆ DOMAIN

string homeassistant.components.upnp.const.DOMAIN = "upnp"

Definition at line 10 of file const.py.

◆ DOMAIN_DISCOVERIES

string homeassistant.components.upnp.const.DOMAIN_DISCOVERIES = "discoveries"

Definition at line 11 of file const.py.

◆ IDENTIFIER_HOST

string homeassistant.components.upnp.const.IDENTIFIER_HOST = "upnp_host"

Definition at line 34 of file const.py.

◆ IDENTIFIER_SERIAL_NUMBER

string homeassistant.components.upnp.const.IDENTIFIER_SERIAL_NUMBER = "upnp_serial_number"

Definition at line 35 of file const.py.

◆ KIBIBYTES_PER_SEC_RECEIVED

string homeassistant.components.upnp.const.KIBIBYTES_PER_SEC_RECEIVED = "kibibytes_per_sec_received"

Definition at line 16 of file const.py.

◆ KIBIBYTES_PER_SEC_SENT

string homeassistant.components.upnp.const.KIBIBYTES_PER_SEC_SENT = "kibibytes_per_sec_sent"

Definition at line 17 of file const.py.

◆ LOGGER

homeassistant.components.upnp.const.LOGGER = logging.getLogger(__package__)

Definition at line 8 of file const.py.

◆ PACKETS_PER_SEC_RECEIVED

string homeassistant.components.upnp.const.PACKETS_PER_SEC_RECEIVED = "packets_per_sec_received"

Definition at line 18 of file const.py.

◆ PACKETS_PER_SEC_SENT

string homeassistant.components.upnp.const.PACKETS_PER_SEC_SENT = "packets_per_sec_sent"

Definition at line 19 of file const.py.

◆ PACKETS_RECEIVED

string homeassistant.components.upnp.const.PACKETS_RECEIVED = "packets_received"

Definition at line 14 of file const.py.

◆ PACKETS_SENT

string homeassistant.components.upnp.const.PACKETS_SENT = "packets_sent"

Definition at line 15 of file const.py.

◆ PORT_MAPPING_NUMBER_OF_ENTRIES_IPV4

string homeassistant.components.upnp.const.PORT_MAPPING_NUMBER_OF_ENTRIES_IPV4 = "port_mapping_number_of_entries"

Definition at line 24 of file const.py.

◆ ROUTER_IP

string homeassistant.components.upnp.const.ROUTER_IP = "ip"

Definition at line 25 of file const.py.

◆ ROUTER_UPTIME

string homeassistant.components.upnp.const.ROUTER_UPTIME = "uptime"

Definition at line 26 of file const.py.

◆ ST_IGD_V1

string homeassistant.components.upnp.const.ST_IGD_V1 = "urn:schemas-upnp-org:device:InternetGatewayDevice:1"

Definition at line 38 of file const.py.

◆ ST_IGD_V2

string homeassistant.components.upnp.const.ST_IGD_V2 = "urn:schemas-upnp-org:device:InternetGatewayDevice:2"

Definition at line 39 of file const.py.

◆ TIMESTAMP

string homeassistant.components.upnp.const.TIMESTAMP = "timestamp"

Definition at line 20 of file const.py.

◆ WAN_STATUS

string homeassistant.components.upnp.const.WAN_STATUS = "wan_status"

Definition at line 23 of file const.py.

Home Assistant Unofficial Reference 2024.12.1

Variables