homeassistant.components.ihc.switch.IHCSwitch Class Reference

Inheritance diagram for homeassistant.components.ihc.switch.IHCSwitch:

Collaboration diagram for homeassistant.components.ihc.switch.IHCSwitch:

Public Member Functions
None	__init__ (self, IHCController ihc_controller, str controller_id, str name, int ihc_id, int ihc_off_id, int ihc_on_id, product=None)
None	async_turn_off (self, **Any kwargs)
None	async_turn_on (self, **Any kwargs)
def	on_ihc_change (self, ihc_id, value)
Public Member Functions inherited from homeassistant.components.ihc.entity.IHCEntity
None	__init__ (self, IHCController ihc_controller, str controller_id, str name, int ihc_id, product=None)
def	async_added_to_hass (self)
def	extra_state_attributes (self)
def	name (self)
def	unique_id (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_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)
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)
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	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)
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)

Private Attributes
	_attr_is_on
	_ihc_off_id
	_ihc_on_id

Additional Inherited Members
Public Attributes inherited from homeassistant.components.ihc.entity.IHCEntity
	controller_id
	device_id
	device_model
	device_name
	ihc_controller
	ihc_id
	ihc_name
	ihc_note
	ihc_position
	suggested_area
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 IHC switch.

Definition at line 46 of file switch.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.ihc.switch.IHCSwitch.__init__	(		self,
		IHCController	ihc_controller,
		str	controller_id,
		str	name,
		int	ihc_id,
		int	ihc_off_id,
		int	ihc_on_id,
			product = None
	)

Initialize the IHC switch.

Definition at line 49 of file switch.py.

Member Function Documentation

async_turn_off()

None homeassistant.components.ihc.switch.IHCSwitch.async_turn_off	(		self,
		**Any	kwargs
	)

Turn the device off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 71 of file switch.py.

async_turn_on()

None homeassistant.components.ihc.switch.IHCSwitch.async_turn_on	(		self,
		**Any	kwargs
	)

Turn the switch on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 64 of file switch.py.

on_ihc_change()

def homeassistant.components.ihc.switch.IHCSwitch.on_ihc_change	(		self,
			ihc_id,
			value
	)

Handle IHC resource change.

Reimplemented from homeassistant.components.ihc.entity.IHCEntity.

Definition at line 78 of file switch.py.

Member Data Documentation

_attr_is_on

homeassistant.components.ihc.switch.IHCSwitch._attr_is_on

private

Definition at line 80 of file switch.py.

_ihc_off_id

homeassistant.components.ihc.switch.IHCSwitch._ihc_off_id

private

Definition at line 61 of file switch.py.

_ihc_on_id

homeassistant.components.ihc.switch.IHCSwitch._ihc_on_id

private

Definition at line 62 of file switch.py.

---

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

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