Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.upnp.device.Device Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass, IgdDevice igd_device, bool force_poll)
 
str __str__ (self)
 
dict[str, str|datetime|int|float|None] async_get_data (self, list[str]|None entity_description_keys)
 
str|None async_get_mac_address (self)
 
None async_set_force_poll (self, bool force_poll)
 
None async_subscribe_services (self)
 
None async_unsubscribe_services (self)
 
str device_type (self)
 
str device_url (self)
 
bool force_poll (self)
 
str|None host (self)
 
str manufacturer (self)
 
str model_name (self)
 
str name (self)
 
str|None serial_number (self)
 
str udn (self)
 
str unique_id (self)
 
str usn (self)
 

Public Attributes

 hass
 

Private Attributes

 _force_poll
 
 _igd_device
 

Detailed Description

Home Assistant representation of a UPnP/IGD device.

Definition at line 112 of file device.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.upnp.device.Device.__init__ (   self,
HomeAssistant  hass,
IgdDevice  igd_device,
bool   force_poll 
)
Initialize UPnP/IGD device.

Definition at line 115 of file device.py.

Member Function Documentation

◆ __str__()

str homeassistant.components.upnp.device.Device.__str__ (   self)
Get string representation.

Definition at line 186 of file device.py.

◆ async_get_data()

dict[str, str | datetime | int | float | None] homeassistant.components.upnp.device.Device.async_get_data (   self,
list[str] | None   entity_description_keys 
)
Get all data from device.

Definition at line 222 of file device.py.

◆ async_get_mac_address()

str | None homeassistant.components.upnp.device.Device.async_get_mac_address (   self)
Get mac address.

Definition at line 128 of file device.py.

◆ async_set_force_poll()

None homeassistant.components.upnp.device.Device.async_set_force_poll (   self,
bool  force_poll 
)
Set force_poll, and (un)subscribe if needed.

Definition at line 195 of file device.py.

◆ async_subscribe_services()

None homeassistant.components.upnp.device.Device.async_subscribe_services (   self)
Subscribe to services.

Definition at line 205 of file device.py.

◆ async_unsubscribe_services()

None homeassistant.components.upnp.device.Device.async_unsubscribe_services (   self)
Unsubscribe from services.

Definition at line 215 of file device.py.

◆ device_type()

str homeassistant.components.upnp.device.Device.device_type (   self)
Get the device type.

Definition at line 156 of file device.py.

◆ device_url()

str homeassistant.components.upnp.device.Device.device_url (   self)
Get the device_url of the device.

Definition at line 177 of file device.py.

◆ force_poll()

bool homeassistant.components.upnp.device.Device.force_poll (   self)
Get force_poll.

Definition at line 191 of file device.py.

◆ host()

str | None homeassistant.components.upnp.device.Device.host (   self)
Get the hostname.

Definition at line 171 of file device.py.

◆ manufacturer()

str homeassistant.components.upnp.device.Device.manufacturer (   self)
Get the manufacturer.

Definition at line 146 of file device.py.

◆ model_name()

str homeassistant.components.upnp.device.Device.model_name (   self)
Get the model name.

Definition at line 151 of file device.py.

◆ name()

str homeassistant.components.upnp.device.Device.name (   self)
Get the name.

Definition at line 141 of file device.py.

◆ serial_number()

str | None homeassistant.components.upnp.device.Device.serial_number (   self)
Get the serial number.

Definition at line 182 of file device.py.

◆ udn()

str homeassistant.components.upnp.device.Device.udn (   self)
Get the UDN.

Definition at line 136 of file device.py.

◆ unique_id()

str homeassistant.components.upnp.device.Device.unique_id (   self)
Get the unique id.

Definition at line 166 of file device.py.

◆ usn()

str homeassistant.components.upnp.device.Device.usn (   self)
Get the USN.

Definition at line 161 of file device.py.

Member Data Documentation

◆ _force_poll

homeassistant.components.upnp.device.Device._force_poll
private

Definition at line 121 of file device.py.

◆ _igd_device

homeassistant.components.upnp.device.Device._igd_device
private

Definition at line 120 of file device.py.

◆ hass

homeassistant.components.upnp.device.Device.hass

Definition at line 119 of file device.py.


The documentation for this class was generated from the following file: