homeassistant.components.nibe_heatpump.entity.CoilEntity Class Reference

Inheritance diagram for homeassistant.components.nibe_heatpump.entity.CoilEntity:

Collaboration diagram for homeassistant.components.nibe_heatpump.entity.CoilEntity:

Public Member Functions
None	__init__ (self, CoilCoordinator coordinator, Coil coil, str entity_format)
bool	available (self)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None	__init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
None	async_update (self)
Public Member Functions inherited from homeassistant.components.nibe_heatpump.coordinator.CoilCoordinator
None	__init__ (self, HomeAssistant hass, HeatPump heatpump, Connection connection)
CoilData	async_read_coil (self, Coil coil)
def	async_shutdown (self)
None	async_write_coil (self, Coil coil, float|str value)
list[Coil]	coils (self)
DeviceInfo	device_info (self)
float|None	get_coil_float (self, Coil coil)
int|str|float|date|None	get_coil_value (self, Coil coil)
Series	series (self)
str	unique_id (self)
Public Member Functions inherited from homeassistant.components.nibe_heatpump.coordinator.ContextCoordinator
Callable[[], None]	async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
None	async_update_context_listeners (self, Iterable[_ContextTypeT] contexts)
dict[_ContextTypeT, list[CALLBACK_TYPE]]	context_callbacks (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)
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_update_listeners (self)
timedelta|None	update_interval (self)
None	update_interval (self, timedelta|None value)

Public Attributes
	entity_id
Public Attributes inherited from homeassistant.components.nibe_heatpump.coordinator.CoilCoordinator
	connection
	data
	heatpump
	task
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 Member Functions
def	_async_read_coil (self, CoilData data)
def	_async_write_coil (self, float|str value)
None	_handle_coordinator_update (self)

Private Attributes
	_attr_device_info
	_attr_name
	_attr_unique_id
	_coil

Static Private Attributes
bool	_attr_entity_registry_enabled_default = False
bool	_attr_has_entity_name = True

Detailed Description

Base for coil based entities.

Definition at line 13 of file entity.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.nibe_heatpump.entity.CoilEntity.__init__	(		self,
		CoilCoordinator	coordinator,
		Coil	coil,
		str	entity_format
	)

Initialize base entity.

Definition at line 19 of file entity.py.

Member Function Documentation

_async_read_coil()

def homeassistant.components.nibe_heatpump.entity.CoilEntity._async_read_coil (   self, CoilData  data  )

private

Update state of entity based on coil data.

Reimplemented in homeassistant.components.nibe_heatpump.switch.Switch, homeassistant.components.nibe_heatpump.sensor.Sensor, homeassistant.components.nibe_heatpump.select.Select, homeassistant.components.nibe_heatpump.number.Number, and homeassistant.components.nibe_heatpump.binary_sensor.BinarySensor.

Definition at line 39 of file entity.py.

_async_write_coil()

def homeassistant.components.nibe_heatpump.entity.CoilEntity._async_write_coil (   self, float | str  value  )

private

Write coil and update state.

Definition at line 42 of file entity.py.

_handle_coordinator_update()

None homeassistant.components.nibe_heatpump.entity.CoilEntity._handle_coordinator_update (   self )

private

Definition at line 46 of file entity.py.

available()

bool homeassistant.components.nibe_heatpump.entity.CoilEntity.available

(

self

)

Return if entity is available.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 33 of file entity.py.

Member Data Documentation

_attr_device_info

homeassistant.components.nibe_heatpump.entity.CoilEntity._attr_device_info

private

Definition at line 29 of file entity.py.

_attr_entity_registry_enabled_default

bool homeassistant.components.nibe_heatpump.entity.CoilEntity._attr_entity_registry_enabled_default = False

staticprivate

Definition at line 17 of file entity.py.

_attr_has_entity_name

bool homeassistant.components.nibe_heatpump.entity.CoilEntity._attr_has_entity_name = True

staticprivate

Definition at line 16 of file entity.py.

_attr_name

homeassistant.components.nibe_heatpump.entity.CoilEntity._attr_name

private

Definition at line 27 of file entity.py.

_attr_unique_id

homeassistant.components.nibe_heatpump.entity.CoilEntity._attr_unique_id

private

Definition at line 28 of file entity.py.

_coil

homeassistant.components.nibe_heatpump.entity.CoilEntity._coil

private

Definition at line 30 of file entity.py.

entity_id

homeassistant.components.nibe_heatpump.entity.CoilEntity.entity_id

Definition at line 24 of file entity.py.

---

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

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