homeassistant.components.smarttub.entity.SmartTubEntity Class Reference

Inheritance diagram for homeassistant.components.smarttub.entity.SmartTubEntity:

Collaboration diagram for homeassistant.components.smarttub.entity.SmartTubEntity:

Public Member Functions
None	__init__ (self, DataUpdateCoordinator coordinator, smarttub.Spa spa, entity_name)
smarttub.SpaState	spa_status (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 Attributes
	spa

Private Attributes
	_attr_device_info
	_attr_name
	_attr_unique_id

Detailed Description

Base class for SmartTub entities.

Definition at line 15 of file entity.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.smarttub.entity.SmartTubEntity.__init__	(		self,
		DataUpdateCoordinator	coordinator,
		smarttub.Spa	spa,
			entity_name
	)

Initialize the entity.

Given a spa id and a short name for the entity, we provide basic device
info, name, unique id, etc. for all derived entities.

Definition at line 18 of file entity.py.

Member Function Documentation

spa_status()

smarttub.SpaState homeassistant.components.smarttub.entity.SmartTubEntity.spa_status

(

self

)

Retrieve the result of Spa.get_status().

Definition at line 39 of file entity.py.

Member Data Documentation

_attr_device_info

homeassistant.components.smarttub.entity.SmartTubEntity._attr_device_info

private

Definition at line 30 of file entity.py.

_attr_name

homeassistant.components.smarttub.entity.SmartTubEntity._attr_name

private

Definition at line 36 of file entity.py.

_attr_unique_id

homeassistant.components.smarttub.entity.SmartTubEntity._attr_unique_id

private

Definition at line 29 of file entity.py.

spa

homeassistant.components.smarttub.entity.SmartTubEntity.spa

Definition at line 28 of file entity.py.

---

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

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