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

Public Member Functions

None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
str|None icon (self)
 
bool|None is_on (self)
 
- Public Member Functions inherited from homeassistant.components.isy994.entity.ISYNodeEntity
None __init__ (self, Node|Group|Variable|Program node, DeviceInfo|None device_info=None)
 
None async_get_zwave_parameter (self, Any parameter)
 
None async_rename_node (self, str name)
 
None async_send_node_command (self, str command)
 
None async_send_raw_node_command (self, str command, Any|None value=None, str|None unit_of_measurement=None, Any|None parameters=None)
 
None async_set_zwave_parameter (self, Any parameter, Any|None value, int|None size)
 
bool available (self)
 
dict extra_state_attributes (self)
 
- Public Member Functions inherited from homeassistant.components.isy994.entity.ISYEntity
None async_added_to_hass (self)
 
None async_on_control (self, NodeProperty event)
 
None async_on_update (self, NodeProperty event)
 
- 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_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (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|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.components.switch.SwitchEntity
SwitchDeviceClass|None device_class (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None async_toggle (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)
 

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

Detailed Description

Representation of an ISY switch device.

Definition at line 85 of file switch.py.

Member Function Documentation

◆ async_turn_off()

None homeassistant.components.isy994.switch.ISYSwitchEntity.async_turn_off (   self,
**Any  kwargs 
)
Send the turn off command to the ISY switch.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 95 of file switch.py.

◆ async_turn_on()

None homeassistant.components.isy994.switch.ISYSwitchEntity.async_turn_on (   self,
**Any  kwargs 
)
Send the turn on command to the ISY switch.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 100 of file switch.py.

◆ icon()

str | None homeassistant.components.isy994.switch.ISYSwitchEntity.icon (   self)
Get the icon for groups.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 106 of file switch.py.

◆ is_on()

bool | None homeassistant.components.isy994.switch.ISYSwitchEntity.is_on (   self)
Get whether the ISY device is in the on state.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 89 of file switch.py.


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