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

Public Member Functions

None __init__ (self, HomeAssistant hass, ModbusHub hub, dict config)
 
None async_added_to_hass (self)
 
None async_turn (self, int command)
 
None async_turn_off (self, **Any kwargs)
 
None async_update (self, datetime|None now=None)
 
- Public Member Functions inherited from homeassistant.components.modbus.entity.BasePlatform
None __init__ (self, HomeAssistant hass, ModbusHub hub, dict[str, Any] entry)
 
None async_base_added_to_hass (self)
 
None async_hold (self, bool update=True)
 
None async_run (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)
 
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, 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)
 
- Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None async_toggle (self, **Any kwargs)
 
None async_turn_on (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.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 Attributes

 command_on
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Attributes

 _attr_available
 
 _attr_is_on
 
 _call_active
 
 _command_off
 
 _state_off
 
 _state_on
 
 _verify_active
 
 _verify_address
 
 _verify_delay
 
 _verify_type
 
 _write_type
 

Additional Inherited Members

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

Detailed Description

Base class representing a Modbus switch.

Definition at line 258 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.modbus.entity.BaseSwitch.__init__ (   self,
HomeAssistant  hass,
ModbusHub  hub,
dict  config 
)
Initialize the switch.

Definition at line 261 of file entity.py.

Member Function Documentation

◆ async_added_to_hass()

None homeassistant.components.modbus.entity.BaseSwitch.async_added_to_hass (   self)
Handle entity which will be added.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 307 of file entity.py.

◆ async_turn()

None homeassistant.components.modbus.entity.BaseSwitch.async_turn (   self,
int  command 
)
Evaluate switch result.

Definition at line 316 of file entity.py.

◆ async_turn_off()

None homeassistant.components.modbus.entity.BaseSwitch.async_turn_off (   self,
**Any  kwargs 
)
Set switch off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 337 of file entity.py.

◆ async_update()

None homeassistant.components.modbus.entity.BaseSwitch.async_update (   self,
datetime | None   now = None 
)
Update the entity state.

Reimplemented from homeassistant.components.modbus.entity.BasePlatform.

Definition at line 341 of file entity.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.modbus.entity.BaseSwitch._attr_available
private

Definition at line 322 of file entity.py.

◆ _attr_is_on

homeassistant.components.modbus.entity.BaseSwitch._attr_is_on
private

Definition at line 265 of file entity.py.

◆ _call_active

homeassistant.components.modbus.entity.BaseSwitch._call_active
private

Definition at line 353 of file entity.py.

◆ _command_off

homeassistant.components.modbus.entity.BaseSwitch._command_off
private

Definition at line 288 of file entity.py.

◆ _state_off

homeassistant.components.modbus.entity.BaseSwitch._state_off
private

Definition at line 301 of file entity.py.

◆ _state_on

homeassistant.components.modbus.entity.BaseSwitch._state_on
private

Definition at line 300 of file entity.py.

◆ _verify_active

homeassistant.components.modbus.entity.BaseSwitch._verify_active
private

Definition at line 292 of file entity.py.

◆ _verify_address

homeassistant.components.modbus.entity.BaseSwitch._verify_address
private

Definition at line 294 of file entity.py.

◆ _verify_delay

homeassistant.components.modbus.entity.BaseSwitch._verify_delay
private

Definition at line 293 of file entity.py.

◆ _verify_type

homeassistant.components.modbus.entity.BaseSwitch._verify_type
private

Definition at line 297 of file entity.py.

◆ _write_type

homeassistant.components.modbus.entity.BaseSwitch._write_type
private

Definition at line 286 of file entity.py.

◆ command_on

homeassistant.components.modbus.entity.BaseSwitch.command_on

Definition at line 287 of file entity.py.


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