homeassistant.components.pilight.entity.PilightBaseDevice Class Reference

Inheritance diagram for homeassistant.components.pilight.entity.PilightBaseDevice:

Collaboration diagram for homeassistant.components.pilight.entity.PilightBaseDevice:

Public Member Functions
def	__init__ (self, hass, name, config)
def	assumed_state (self)
def	async_added_to_hass (self)
def	is_on (self)
def	name (self)
def	set_state (self, turn_on, send_code=True, dimlevel=None)
def	turn_off (self, **kwargs)
def	turn_on (self, **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 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)
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)
None	schedule_update_ha_state (self, bool force_refresh=False)
bool	should_poll (self)
StateType	state (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	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)

Private Member Functions
def	_handle_code (self, call)

Private Attributes
	_brightness
	_code_off
	_code_off_receive
	_code_on
	_code_on_receive
	_hass
	_is_on
	_name

Static Private Attributes
bool	_attr_should_poll = False

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

Detailed Description

Base class for pilight switches and lights.

Definition at line 57 of file entity.py.

Constructor & Destructor Documentation

__init__()

def homeassistant.components.pilight.entity.PilightBaseDevice.__init__	(		self,
			hass,
			name,
			config
	)

Initialize a device.

Reimplemented in homeassistant.components.pilight.light.PilightLight.

Definition at line 62 of file entity.py.

Member Function Documentation

_handle_code()

def homeassistant.components.pilight.entity.PilightBaseDevice._handle_code (   self,   call  )

private

Check if received code by the pilight-daemon.

If the code matches the receive on/off codes of this switch the switch
state is changed accordingly.

Definition at line 111 of file entity.py.

assumed_state()

def homeassistant.components.pilight.entity.PilightBaseDevice.assumed_state

(

self

)

Return True if unable to access real state of the entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 102 of file entity.py.

async_added_to_hass()

def homeassistant.components.pilight.entity.PilightBaseDevice.async_added_to_hass

(

self

)

Call when entity about to be added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 89 of file entity.py.

is_on()

def homeassistant.components.pilight.entity.PilightBaseDevice.is_on

(

self

)

Return true if switch is on.

Definition at line 107 of file entity.py.

name()

def homeassistant.components.pilight.entity.PilightBaseDevice.name

(

self

)

Get the name of the switch.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 97 of file entity.py.

set_state()

def homeassistant.components.pilight.entity.PilightBaseDevice.set_state	(		self,
			turn_on,
			send_code = True,
			dimlevel = None
	)

Set the state of the switch.

This sets the state of the switch. If send_code is set to True, then
it will call the pilight.send service to actually send the codes
to the pilight daemon.

Definition at line 132 of file entity.py.

turn_off()

def homeassistant.components.pilight.entity.PilightBaseDevice.turn_off	(		self,
		**	kwargs
	)

Turn the switch on by calling pilight.send service with off code.

Definition at line 158 of file entity.py.

turn_on()

def homeassistant.components.pilight.entity.PilightBaseDevice.turn_on	(		self,
		**	kwargs
	)

Turn the switch on by calling pilight.send service with on code.

Definition at line 154 of file entity.py.

Member Data Documentation

_attr_should_poll

bool homeassistant.components.pilight.entity.PilightBaseDevice._attr_should_poll = False

staticprivate

Definition at line 60 of file entity.py.

_brightness

homeassistant.components.pilight.entity.PilightBaseDevice._brightness

private

Definition at line 87 of file entity.py.

_code_off

homeassistant.components.pilight.entity.PilightBaseDevice._code_off

private

Definition at line 68 of file entity.py.

_code_off_receive

homeassistant.components.pilight.entity.PilightBaseDevice._code_off_receive

private

Definition at line 74 of file entity.py.

_code_on

homeassistant.components.pilight.entity.PilightBaseDevice._code_on

private

Definition at line 67 of file entity.py.

_code_on_receive

homeassistant.components.pilight.entity.PilightBaseDevice._code_on_receive

private

Definition at line 73 of file entity.py.

_hass

homeassistant.components.pilight.entity.PilightBaseDevice._hass

private

Definition at line 64 of file entity.py.

_is_on

homeassistant.components.pilight.entity.PilightBaseDevice._is_on

private

Definition at line 66 of file entity.py.

_name

homeassistant.components.pilight.entity.PilightBaseDevice._name

private

Definition at line 65 of file entity.py.

---

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

• core/homeassistant/components/pilight/entity.py