homeassistant.components.geniushub.switch.GeniusSwitch Class Reference

Inheritance diagram for homeassistant.components.geniushub.switch.GeniusSwitch:

Collaboration diagram for homeassistant.components.geniushub.switch.GeniusSwitch:

Public Member Functions
None	async_turn_off (self, **Any kwargs)
None	async_turn_on (self, **Any kwargs)
def	device_class (self)
bool	is_on (self)
Public Member Functions inherited from homeassistant.components.geniushub.entity.GeniusZone
None	__init__ (self, broker, zone)
dict[str, Any]	extra_state_attributes (self)
str	name (self)
Public Member Functions inherited from homeassistant.components.geniushub.entity.GeniusEntity
None	__init__ (self)
None	async_added_to_hass (self)
str|None	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.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 a Genius Hub switch.

Definition at line 56 of file switch.py.

Member Function Documentation

async_turn_off()

None homeassistant.components.geniushub.switch.GeniusSwitch.async_turn_off	(		self,
		**Any	kwargs
	)

Send the zone to Timer mode.

The zone is deemed 'off' in this mode, although the plugs may actually be on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 75 of file switch.py.

async_turn_on()

None homeassistant.components.geniushub.switch.GeniusSwitch.async_turn_on	(		self,
		**Any	kwargs
	)

Set the zone to override/on ({'setpoint': true}) for x seconds.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 82 of file switch.py.

device_class()

def homeassistant.components.geniushub.switch.GeniusSwitch.device_class

(

self

)

Return the class of this device, from component DEVICE_CLASSES.

Reimplemented from homeassistant.components.switch.SwitchEntity.

Definition at line 60 of file switch.py.

is_on()

bool homeassistant.components.geniushub.switch.GeniusSwitch.is_on

(

self

)

Return the current state of the on/off zone.

The zone is considered 'on' if the mode is either 'override' or 'timer'.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 65 of file switch.py.

---

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

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