homeassistant.components.omnilogic.switch.OmniLogicSwitch Class Reference

Inheritance diagram for homeassistant.components.omnilogic.switch.OmniLogicSwitch:

Collaboration diagram for homeassistant.components.omnilogic.switch.OmniLogicSwitch:

Public Member Functions
None	__init__ (self, OmniLogicUpdateCoordinator coordinator, str kind, str name, str icon, tuple item_id, str state_key)
def	is_on (self)
Public Member Functions inherited from homeassistant.components.omnilogic.entity.OmniLogicEntity
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)
Public Member Functions inherited from homeassistant.components.switch.SwitchEntity
SwitchDeviceClass|None	device_class (self)
Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None	async_toggle (self, **Any kwargs)
None	async_turn_off (self, **Any kwargs)
None	async_turn_on (self, **Any kwargs)
Literal["on", "off"]|None	state (self)
None	toggle (self, **Any kwargs)
None	turn_off (self, **Any kwargs)
None	turn_on (self, **Any kwargs)
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_added_to_hass (self)
None	async_device_update (self, bool warning=True)
None	async_internal_added_to_hass (self)
None	async_internal_will_remove_from_hass (self)
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)
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)
Mapping[str, Any]|None	extra_state_attributes (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)
str|None	icon (self)
str|UndefinedType|None	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	unique_id (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)

Private Attributes
	_last_action
	_state
	_state_delay
	_state_key

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
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry
Static Public Attributes inherited from homeassistant.helpers.entity.ToggleEntity
	None
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Detailed Description

Define an Omnilogic Base Switch entity to be extended.

Definition at line 71 of file switch.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.omnilogic.switch.OmniLogicSwitch.__init__	(		self,
		OmniLogicUpdateCoordinator	coordinator,
		str	kind,
		str	name,
		str	icon,
		tuple	item_id,
		str	state_key
	)

Initialize Entities.

Reimplemented in homeassistant.components.omnilogic.switch.OmniLogicPumpControl.

Definition at line 74 of file switch.py.

Member Function Documentation

is_on()

def homeassistant.components.omnilogic.switch.OmniLogicSwitch.is_on

(

self

)

Return the on/off state of the switch.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 98 of file switch.py.

Member Data Documentation

_last_action

homeassistant.components.omnilogic.switch.OmniLogicSwitch._last_action

private

Definition at line 94 of file switch.py.

_state

homeassistant.components.omnilogic.switch.OmniLogicSwitch._state

private

Definition at line 93 of file switch.py.

_state_delay

homeassistant.components.omnilogic.switch.OmniLogicSwitch._state_delay

private

Definition at line 95 of file switch.py.

_state_key

homeassistant.components.omnilogic.switch.OmniLogicSwitch._state_key

private

Definition at line 92 of file switch.py.

---

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

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