Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.litejet.switch.LiteJetSwitch Class Reference
Inheritance diagram for homeassistant.components.litejet.switch.LiteJetSwitch:
[legend]
Collaboration diagram for homeassistant.components.litejet.switch.LiteJetSwitch:
[legend]

Public Member Functions

None __init__ (self, str entry_id, LiteJet system, int i, str name)
 
None async_added_to_hass (self)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
None async_will_remove_from_hass (self)
 
dict[str, Any] extra_state_attributes (self)
 
- 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)
 
bool|None is_on (self)
 
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_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_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)
 
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, strtranslation_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 Member Functions

None _on_connected_changed (self, bool connected, str reason)
 
None _on_switch_pressed (self)
 
None _on_switch_released (self)
 

Private Attributes

 _attr_available
 
 _attr_device_info
 
 _attr_is_on
 
 _attr_name
 
 _attr_unique_id
 
 _index
 
 _lj
 

Static Private Attributes

 _attr_device_class = SwitchDeviceClass.SWITCH
 
bool _attr_entity_registry_enabled_default = False
 
bool _attr_has_entity_name = True
 
bool _attr_should_poll = False
 

Additional Inherited Members

- 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

Representation of a single LiteJet switch.

Definition at line 36 of file switch.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.litejet.switch.LiteJetSwitch.__init__ (   self,
str  entry_id,
LiteJet  system,
int  i,
str  name 
)
Initialize a LiteJet switch.

Definition at line 44 of file switch.py.

Member Function Documentation

◆ _on_connected_changed()

None homeassistant.components.litejet.switch.LiteJetSwitch._on_connected_changed (   self,
bool  connected,
str  reason 
)
private

Definition at line 81 of file switch.py.

◆ _on_switch_pressed()

None homeassistant.components.litejet.switch.LiteJetSwitch._on_switch_pressed (   self)
private

Definition at line 73 of file switch.py.

◆ _on_switch_released()

None homeassistant.components.litejet.switch.LiteJetSwitch._on_switch_released (   self)
private

Definition at line 77 of file switch.py.

◆ async_added_to_hass()

None homeassistant.components.litejet.switch.LiteJetSwitch.async_added_to_hass (   self)
Run when this Entity has been added to HA.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 61 of file switch.py.

◆ async_turn_off()

None homeassistant.components.litejet.switch.LiteJetSwitch.async_turn_off (   self,
**Any  kwargs 
)
Release the switch.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 97 of file switch.py.

◆ async_turn_on()

None homeassistant.components.litejet.switch.LiteJetSwitch.async_turn_on (   self,
**Any  kwargs 
)
Press the switch.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 90 of file switch.py.

◆ async_will_remove_from_hass()

None homeassistant.components.litejet.switch.LiteJetSwitch.async_will_remove_from_hass (   self)
Entity being removed from hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 67 of file switch.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.litejet.switch.LiteJetSwitch.extra_state_attributes (   self)
Return the device-specific state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 86 of file switch.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.litejet.switch.LiteJetSwitch._attr_available
private

Definition at line 82 of file switch.py.

◆ _attr_device_class

homeassistant.components.litejet.switch.LiteJetSwitch._attr_device_class = SwitchDeviceClass.SWITCH
staticprivate

Definition at line 42 of file switch.py.

◆ _attr_device_info

homeassistant.components.litejet.switch.LiteJetSwitch._attr_device_info
private

Definition at line 54 of file switch.py.

◆ _attr_entity_registry_enabled_default

bool homeassistant.components.litejet.switch.LiteJetSwitch._attr_entity_registry_enabled_default = False
staticprivate

Definition at line 41 of file switch.py.

◆ _attr_has_entity_name

bool homeassistant.components.litejet.switch.LiteJetSwitch._attr_has_entity_name = True
staticprivate

Definition at line 40 of file switch.py.

◆ _attr_is_on

homeassistant.components.litejet.switch.LiteJetSwitch._attr_is_on
private

Definition at line 48 of file switch.py.

◆ _attr_name

homeassistant.components.litejet.switch.LiteJetSwitch._attr_name
private

Definition at line 50 of file switch.py.

◆ _attr_should_poll

bool homeassistant.components.litejet.switch.LiteJetSwitch._attr_should_poll = False
staticprivate

Definition at line 39 of file switch.py.

◆ _attr_unique_id

homeassistant.components.litejet.switch.LiteJetSwitch._attr_unique_id
private

Definition at line 49 of file switch.py.

◆ _index

homeassistant.components.litejet.switch.LiteJetSwitch._index
private

Definition at line 47 of file switch.py.

◆ _lj

homeassistant.components.litejet.switch.LiteJetSwitch._lj
private

Definition at line 46 of file switch.py.


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