homeassistant.components.pi_hole.entity.PiHoleEntity Class Reference

Inheritance diagram for homeassistant.components.pi_hole.entity.PiHoleEntity:

Collaboration diagram for homeassistant.components.pi_hole.entity.PiHoleEntity:

Public Member Functions
None	__init__ (self, Hole api, DataUpdateCoordinator[None] coordinator, str name, str server_unique_id)
DeviceInfo	device_info (self)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None	__init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
None	async_update (self)
bool	available (self)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
Callable[[], None]	async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
None	async_config_entry_first_refresh (self)
Generator[Any]	async_contexts (self)
None	async_refresh (self)
None	async_register_shutdown (self)
None	async_request_refresh (self)
None	async_set_update_error (self, Exception err)
None	async_set_updated_data (self, _DataT data)
None	async_shutdown (self)
None	async_update_listeners (self)
timedelta|None	update_interval (self)
None	update_interval (self, timedelta|None value)

Public Attributes
	api
Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
	always_update
	config_entry
	data
	hass
	last_exception
	last_update_success
	logger
	name
	setup_method
	update_interval
	update_method

Private Attributes
	_name
	_server_unique_id

Detailed Description

Representation of a Pi-hole entity.

Definition at line 16 of file entity.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.pi_hole.entity.PiHoleEntity.__init__	(		self,
		Hole	api,
		DataUpdateCoordinator[None]	coordinator,
		str	name,
		str	server_unique_id
	)

Initialize a Pi-hole entity.

Definition at line 19 of file entity.py.

Member Function Documentation

device_info()

DeviceInfo homeassistant.components.pi_hole.entity.PiHoleEntity.device_info

(

self

)

Return the device information of the entity.

Definition at line 33 of file entity.py.

Member Data Documentation

_name

homeassistant.components.pi_hole.entity.PiHoleEntity._name

private

Definition at line 29 of file entity.py.

_server_unique_id

homeassistant.components.pi_hole.entity.PiHoleEntity._server_unique_id

private

Definition at line 30 of file entity.py.

api

homeassistant.components.pi_hole.entity.PiHoleEntity.api

Definition at line 28 of file entity.py.

---

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

• core/homeassistant/components/pi_hole/entity.py