homeassistant.components.supla.entity.SuplaEntity Class Reference

Inheritance diagram for homeassistant.components.supla.entity.SuplaEntity:

Collaboration diagram for homeassistant.components.supla.entity.SuplaEntity:

Public Member Functions
def	__init__ (self, config, server, coordinator)
def	async_action (self, action, **add_pars)
bool	available (self)
def	channel_data (self)
str|None	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)

Public Attributes
	channel_id
	server
	server_name

Detailed Description

Base class of a SUPLA Channel (an equivalent of HA's Entity).

Definition at line 12 of file entity.py.

Constructor & Destructor Documentation

__init__()

def homeassistant.components.supla.entity.SuplaEntity.__init__	(		self,
			config,
			server,
			coordinator
	)

Init from config, hookup[ server and coordinator.

Definition at line 15 of file entity.py.

Member Function Documentation

async_action()

def homeassistant.components.supla.entity.SuplaEntity.async_action	(		self,
			action,
		**	add_pars
	)

Run server action.

Actions are currently hardcoded in components.
SUPLA's API enables autodiscovery

Definition at line 48 of file entity.py.

available()

bool homeassistant.components.supla.entity.SuplaEntity.available

(

self

)

Return True if entity is available.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 40 of file entity.py.

channel_data()

def homeassistant.components.supla.entity.SuplaEntity.channel_data

(

self

)

Return channel data taken from coordinator.

Definition at line 23 of file entity.py.

name()

str | None homeassistant.components.supla.entity.SuplaEntity.name

(

self

)

Return the name of the device.

Definition at line 35 of file entity.py.

unique_id()

str homeassistant.components.supla.entity.SuplaEntity.unique_id

(

self

)

Return a unique ID.

Definition at line 28 of file entity.py.

Member Data Documentation

channel_id

homeassistant.components.supla.entity.SuplaEntity.channel_id

Definition at line 19 of file entity.py.

server

homeassistant.components.supla.entity.SuplaEntity.server

Definition at line 20 of file entity.py.

server_name

homeassistant.components.supla.entity.SuplaEntity.server_name

Definition at line 18 of file entity.py.

---

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

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