SSDP

Section [SSDP]

Added in version 1.0.0.dev11.

SSDP.Location: str

Linked to ssdp.SSDPConfig.ssdp_location

Specifies the target location of the UPnP webserver (will automatically point to the current host if not specified). By default the target location will consist of:

LOCATION := http://<HOST>:<LOCAL_PORT>/<UUID>/<dd_path>

whereby the UUID is taken either from the UPnP configuration (UPnP.UUID) or used from the search request. The target device description path is also taken from the UPnP configuration (UPnP.DDUri).

SSDP.Server: str = "OS/1.0 UPnP/1.0 Dementor/1.0"

Linked to ssdp.SSDPConfig.ssdp_server

Specifies the server type (Server header) that will be returned in SSDP M-SEARCH responses.

SSDP.MaxAge: int = 1800

Linked to ssdp.SSDPConfig.ssdp_max_age

Defines the duration a response to a multicast search should be valid.

SSDP.ExtraHeaders: List[str]

Linked to ssdp.SSDPConfig.ssdp_extra_headers

Specifies additional headers to include in all server responses. Each entry must be a fully qualified SSDP header line without CRLF at the end.

SSDP.Ignore: list[str | dict]

Specifies a list of hosts or UDNs to be blacklisted. For additional context, see Globals.Ignore. When this attribute is defined, it overrides the global blacklist configuration. If not explicitly set, this attribute has no effect. For a comprehensive explanation of how the blacklist is applied, refer to BlacklistConfigMixin.

SSDP.AnswerTo: list[str | dict]

Defines a list of hosts or UDNs to which responses should be sent. See Globals.AnswerTo for more information. When specified, this attribute takes precedence over the global whitelist. If omitted, the global configuration remains in effect. For detailed behavior and usage, refer to WhitelistConfigMixin.

Default Configuration

SSDP configuration section (default values)
 1[SSDP]
 2Server = "OS/1.0 UPnP/1.0 Dementor/1.0"
 3MaxAge = 1800
 4ExtraHeaders = [
 5    # The BOOTID.UPNP.ORG header field represents the boot instance of
 6    # the device expressed according to a monotonically increasing value
 7    "BOOTID.UPNP.ORG: 1",
 8    # The CONFIGID.UPNP.ORG field value shall be a non-negative, 31-bit integer that shall
 9    # represent the configuration number of a root device
10    "CONFIGID.UPNP.ORG: 1337",
11    'OPT: "http://schemas.upnp.org/upnp/1/0/"; ns=01',
12    "01-NLS: 1",
13]