homeassistant.components.omnilogic.entity.OmniLogicEntity Class Reference

Inheritance diagram for homeassistant.components.omnilogic.entity.OmniLogicEntity:

Collaboration diagram for homeassistant.components.omnilogic.entity.OmniLogicEntity:

Public Member Functions
None	__init__ (self, OmniLogicUpdateCoordinator coordinator, str kind, str name, tuple item_id, str icon)
DeviceInfo	device_info (self)
def	extra_state_attributes (self)
def	icon (self)
str	name (self)
str	unique_id (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.components.omnilogic.coordinator.OmniLogicUpdateCoordinator
None	__init__ (self, HomeAssistant hass, OmniLogic api, str name, ConfigEntry config_entry, int polling_interval)
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)

Private Attributes
	_backyard_name
	_icon
	_item_id
	_kind
	_msp_system_id
	_name
	_unique_id

Additional Inherited Members
Public Attributes inherited from homeassistant.components.omnilogic.coordinator.OmniLogicUpdateCoordinator
	api
	config_entry
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

Detailed Description

Defines the base OmniLogic entity.

Definition at line 12 of file entity.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.omnilogic.entity.OmniLogicEntity.__init__	(		self,
		OmniLogicUpdateCoordinator	coordinator,
		str	kind,
		str	name,
		tuple	item_id,
		str	icon
	)

Initialize the OmniLogic Entity.

Definition at line 15 of file entity.py.

Member Function Documentation

device_info()

DeviceInfo homeassistant.components.omnilogic.entity.OmniLogicEntity.device_info

(

self

)

Define the device as back yard/MSP System.

Definition at line 86 of file entity.py.

extra_state_attributes()

def homeassistant.components.omnilogic.entity.OmniLogicEntity.extra_state_attributes

(

self

)

Return the attributes.

Definition at line 81 of file entity.py.

icon()

def homeassistant.components.omnilogic.entity.OmniLogicEntity.icon

(

self

)

Return the icon for the entity.

Definition at line 76 of file entity.py.

name()

str homeassistant.components.omnilogic.entity.OmniLogicEntity.name

(

self

)

Return the name of the entity.

Definition at line 71 of file entity.py.

unique_id()

str homeassistant.components.omnilogic.entity.OmniLogicEntity.unique_id

(

self

)

Return a unique, Home Assistant friendly identifier for this entity.

Definition at line 66 of file entity.py.

Member Data Documentation

_backyard_name

homeassistant.components.omnilogic.entity.OmniLogicEntity._backyard_name

private

Definition at line 63 of file entity.py.

_icon

homeassistant.components.omnilogic.entity.OmniLogicEntity._icon

private

Definition at line 60 of file entity.py.

_item_id

homeassistant.components.omnilogic.entity.OmniLogicEntity._item_id

private

Definition at line 59 of file entity.py.

_kind

homeassistant.components.omnilogic.entity.OmniLogicEntity._kind

private

Definition at line 56 of file entity.py.

_msp_system_id

homeassistant.components.omnilogic.entity.OmniLogicEntity._msp_system_id

private

Definition at line 62 of file entity.py.

_name

homeassistant.components.omnilogic.entity.OmniLogicEntity._name

private

Definition at line 57 of file entity.py.

_unique_id

homeassistant.components.omnilogic.entity.OmniLogicEntity._unique_id

private

Definition at line 58 of file entity.py.

---

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

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