Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.screenlogic.entity.ScreenLogicSwitchingEntity Class Reference
Inheritance diagram for homeassistant.components.screenlogic.entity.ScreenLogicSwitchingEntity:
[legend]
Collaboration diagram for homeassistant.components.screenlogic.entity.ScreenLogicSwitchingEntity:
[legend]

Public Member Functions

None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
bool is_on (self)
 
- Public Member Functions inherited from homeassistant.components.screenlogic.entity.ScreenLogicEntity
None __init__ (self, ScreenlogicDataUpdateCoordinator coordinator, ScreenLogicEntityDescription entity_description)
 
dict entity_data (self)
 
ScreenLogicGateway gateway (self)
 
str|None mac (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.screenlogic.coordinator.ScreenlogicDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, *ConfigEntry config_entry, ScreenLogicGateway gateway)
 
- 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)
 

Private Member Functions

None _async_set_state (self, ON_OFF state)
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.screenlogic.entity.ScreenLogicEntity
 entity_description
 
- Public Attributes inherited from homeassistant.components.screenlogic.coordinator.ScreenlogicDataUpdateCoordinator
 config_entry
 
 gateway
 
- 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
 

Detailed Description

Base class for all switchable entities.

Definition at line 145 of file entity.py.

Member Function Documentation

◆ _async_set_state()

None homeassistant.components.screenlogic.entity.ScreenLogicSwitchingEntity._async_set_state (   self,
ON_OFF  state 
)
private

◆ async_turn_off()

None homeassistant.components.screenlogic.entity.ScreenLogicSwitchingEntity.async_turn_off (   self,
**Any  kwargs 
)
Send the OFF command.

Definition at line 157 of file entity.py.

◆ async_turn_on()

None homeassistant.components.screenlogic.entity.ScreenLogicSwitchingEntity.async_turn_on (   self,
**Any  kwargs 
)
Send the ON command.

Definition at line 153 of file entity.py.

◆ is_on()

bool homeassistant.components.screenlogic.entity.ScreenLogicSwitchingEntity.is_on (   self)
Get whether the switch is in on state.

Definition at line 149 of file entity.py.


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