Inheritance diagram for homeassistant.components.rest.switch.RestSwitch:

Collaboration diagram for homeassistant.components.rest.switch.RestSwitch:

Public Member Functions
None	__init__ (self, HomeAssistant hass, ConfigType config, ConfigType trigger_entity_config)

None	async_added_to_hass (self)

None	async_turn_off (self, **Any kwargs)

None	async_turn_on (self, **Any kwargs)

None	async_update (self)

httpx.Response	get_device_state (self, HomeAssistant hass)

httpx.Response	set_device_state (self, Any body)

Public Member Functions inherited from homeassistant.helpers.trigger_template_entity.ManualTriggerEntity
None	__init__ (self, HomeAssistant hass, ConfigType config)

Public Member Functions inherited from homeassistant.helpers.trigger_template_entity.TriggerBaseEntity
bool	available (self)

str\|None	entity_picture (self)

dict[str, Any]\|None	extra_state_attributes (self)

str\|None	icon (self)

str\|None	name (self)

None	restore_attributes (self, State last_state)

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)

dict[str, Any]\|None	capability_attributes (self)

DeviceInfo\|None	device_info (self)

bool	enabled (self)

EntityCategory\|None	entity_category (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)

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

	_auth

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.trigger_template_entity.TriggerBaseEntity
	hass

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.trigger_template_entity.TriggerBaseEntity
	None

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 switch that can be toggled using REST.

Definition at line 124 of file switch.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.rest.switch.RestSwitch.__init__	(		self,
		HomeAssistant	hass,
		ConfigType	config,
		ConfigType	trigger_entity_config
	)

Initialize the REST switch.

Definition at line 127 of file switch.py.

Member Function Documentation

◆ async_added_to_hass()

None homeassistant.components.rest.switch.RestSwitch.async_added_to_hass ( self )

Handle adding to Home Assistant.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 154 of file switch.py.

◆ async_turn_off()

None homeassistant.components.rest.switch.RestSwitch.async_turn_off	(		self,
		**Any	kwargs
	)

Turn the device off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 175 of file switch.py.

◆ async_turn_on()

None homeassistant.components.rest.switch.RestSwitch.async_turn_on	(		self,
		**Any	kwargs
	)

Turn the device on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 159 of file switch.py.

◆ async_update()

None homeassistant.components.rest.switch.RestSwitch.async_update ( self )

Get the current state, catching errors.

Definition at line 207 of file switch.py.

◆ get_device_state()

httpx.Response homeassistant.components.rest.switch.RestSwitch.get_device_state	(		self,
		HomeAssistant	hass
	)

Get the latest data from REST API and update the state.

Definition at line 221 of file switch.py.

◆ set_device_state()

httpx.Response homeassistant.components.rest.switch.RestSwitch.set_device_state	(		self,
		Any	body
	)

Send a state update to the device.

Definition at line 190 of file switch.py.

Member Data Documentation

◆ _attr_is_on

homeassistant.components.rest.switch.RestSwitch._attr_is_on

private

Definition at line 167 of file switch.py.

◆ _auth

homeassistant.components.rest.switch.RestSwitch._auth