homeassistant.components.counter.Counter Class Reference

Inheritance diagram for homeassistant.components.counter.Counter:

Collaboration diagram for homeassistant.components.counter.Counter:

Public Member Functions
None	__init__ (self, ConfigType config)
None	async_added_to_hass (self)
None	async_decrement (self)
None	async_increment (self)
None	async_reset (self)
None	async_set_value (self, int value)
None	async_update_config (self, ConfigType config)
int|None	compute_next_state (self, int|None state)
dict	extra_state_attributes (self)
Self	from_storage (cls, ConfigType config)
Self	from_yaml (cls, ConfigType config)
str|None	icon (self)
str|None	name (self)
int|None	state (self)
str|None	unique_id (self)
Public Member Functions inherited from homeassistant.helpers.restore_state.RestoreEntity
ExtraStoredData|None	async_get_last_extra_data (self)
State|None	async_get_last_state (self)
None	async_internal_added_to_hass (self)
None	async_internal_will_remove_from_hass (self)
ExtraStoredData|None	extra_restore_state_data (self)
Public Member Functions inherited from homeassistant.helpers.entity.Entity
None	__init_subclass__ (cls, **Any kwargs)
str	__repr__ (self)
None	add_to_platform_abort (self)
None	add_to_platform_finish (self)
None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
bool	assumed_state (self)
None	async_device_update (self, bool warning=True)
None	async_on_remove (self, CALLBACK_TYPE func)
None	async_registry_entry_updated (self)
None	async_remove (self, *bool force_remove=False)
None	async_removed_from_registry (self)
None	async_schedule_update_ha_state (self, bool force_refresh=False)
None	async_set_context (self, Context context)
None	async_update_ha_state (self, bool force_refresh=False)
None	async_will_remove_from_hass (self)
None	async_write_ha_state (self)
str|None	attribution (self)
bool	available (self)
dict[str, Any]|None	capability_attributes (self)
str|None	device_class (self)
DeviceInfo|None	device_info (self)
bool	enabled (self)
EntityCategory|None	entity_category (self)
str|None	entity_picture (self)
bool	entity_registry_enabled_default (self)
bool	entity_registry_visible_default (self)
bool	force_update (self)
HassJobType	get_hassjob_type (self, str function_name)
er.EntityOptionsType|None	get_initial_entity_options (self)
bool	has_entity_name (self)
None	schedule_update_ha_state (self, bool force_refresh=False)
bool	should_poll (self)
dict[str, Any]|None	state_attributes (self)
str|None	suggested_object_id (self)
int|None	supported_features (self)
str|None	translation_key (self)
Mapping[str, str]	translation_placeholders (self)
str|None	unit_of_measurement (self)
bool	use_device_name (self)
Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None	__init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
Any	__new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)

Static Public Attributes
	bool
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Private Attributes
	_config
	_state

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry

Detailed Description

Representation of a counter.

Definition at line 157 of file __init__.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.counter.Counter.__init__	(		self,
		ConfigType	config
	)

Initialize a counter.

Definition at line 163 of file __init__.py.

Member Function Documentation

async_added_to_hass()

None homeassistant.components.counter.Counter.async_added_to_hass

(

self

)

Call when entity about to be added to Home Assistant.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 226 of file __init__.py.

async_decrement()

None homeassistant.components.counter.Counter.async_decrement

(

self

)

Decrement the counter.

Definition at line 238 of file __init__.py.

async_increment()

None homeassistant.components.counter.Counter.async_increment

(

self

)

Increment a counter.

Definition at line 244 of file __init__.py.

async_reset()

None homeassistant.components.counter.Counter.async_reset

(

self

)

Reset a counter.

Definition at line 250 of file __init__.py.

async_set_value()

None homeassistant.components.counter.Counter.async_set_value	(		self,
		int	value
	)

Set counter to value.

Definition at line 256 of file __init__.py.

async_update_config()

None homeassistant.components.counter.Counter.async_update_config	(		self,
		ConfigType	config
	)

Change the counter's settings WS CRUD.

Definition at line 276 of file __init__.py.

compute_next_state()

int | None homeassistant.components.counter.Counter.compute_next_state	(		self,
		int | None	state
	)

Keep the state within the range of min/max values.

Definition at line 217 of file __init__.py.

extra_state_attributes()

dict homeassistant.components.counter.Counter.extra_state_attributes

(

self

)

Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 199 of file __init__.py.

from_storage()

Self homeassistant.components.counter.Counter.from_storage	(		cls,
		ConfigType	config
	)

Create counter instance from storage.

Definition at line 169 of file __init__.py.

from_yaml()

Self homeassistant.components.counter.Counter.from_yaml	(		cls,
		ConfigType	config
	)

Create counter instance from yaml config.

Definition at line 176 of file __init__.py.

icon()

str | None homeassistant.components.counter.Counter.icon

(

self

)

Return the icon to be used for this entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 189 of file __init__.py.

name()

str | None homeassistant.components.counter.Counter.name

(

self

)

Return name of the counter.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 184 of file __init__.py.

state()

int | None homeassistant.components.counter.Counter.state

(

self

)

Return the current value of the counter.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 194 of file __init__.py.

unique_id()

str | None homeassistant.components.counter.Counter.unique_id

(

self

)

Return unique id of the entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 213 of file __init__.py.

Member Data Documentation

_config

homeassistant.components.counter.Counter._config

private

Definition at line 278 of file __init__.py.

_state

homeassistant.components.counter.Counter._state

private

Definition at line 235 of file __init__.py.

bool

homeassistant.components.counter.Counter.bool

static

Definition at line 160 of file __init__.py.

---

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

• core/homeassistant/components/counter/__init__.py