homeassistant.components.pilight.binary_sensor.PilightTriggerSensor Class Reference

Inheritance diagram for homeassistant.components.pilight.binary_sensor.PilightTriggerSensor:

Collaboration diagram for homeassistant.components.pilight.binary_sensor.PilightTriggerSensor:

Public Member Functions
def	__init__ (self, hass, name, variable, payload, on_value, off_value, rst_dly_sec=30)
def	is_on (self)
def	name (self)
Public Member Functions inherited from homeassistant.components.binary_sensor.BinarySensorEntity
None	async_internal_added_to_hass (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_added_to_hass (self)
None	async_device_update (self, bool warning=True)
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)
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)
def	_reset_state (self, call)

Private Attributes
	_delay_after
	_hass
	_name
	_off_value
	_on_value
	_payload
	_reset_delay_sec
	_state
	_variable

Additional Inherited Members
Public Attributes inherited from homeassistant.components.binary_sensor.BinarySensorEntity
	entity_category
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry
Static Public Attributes inherited from homeassistant.components.binary_sensor.BinarySensorEntity
	None
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Detailed Description

Representation of a binary sensor that can be updated using Pilight.

Definition at line 135 of file binary_sensor.py.

Constructor & Destructor Documentation

__init__()

def homeassistant.components.pilight.binary_sensor.PilightTriggerSensor.__init__	(		self,
			hass,
			name,
			variable,
			payload,
			on_value,
			off_value,
			rst_dly_sec = 30
	)

Initialize the sensor.

Definition at line 138 of file binary_sensor.py.

Member Function Documentation

_handle_code()

def homeassistant.components.pilight.binary_sensor.PilightTriggerSensor._handle_code (   self,   call  )

private

Handle received code by the pilight-daemon.

If the code matches the defined payload
of this sensor the sensor state is changed accordingly.

Definition at line 170 of file binary_sensor.py.

_reset_state()

def homeassistant.components.pilight.binary_sensor.PilightTriggerSensor._reset_state (   self,   call  )

private

Definition at line 165 of file binary_sensor.py.

is_on()

def homeassistant.components.pilight.binary_sensor.PilightTriggerSensor.is_on

(

self

)

Return True if the binary sensor is on.

Definition at line 161 of file binary_sensor.py.

name()

def homeassistant.components.pilight.binary_sensor.PilightTriggerSensor.name

(

self

)

Return the name of the sensor.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 156 of file binary_sensor.py.

Member Data Documentation

_delay_after

homeassistant.components.pilight.binary_sensor.PilightTriggerSensor._delay_after

private

Definition at line 150 of file binary_sensor.py.

_hass

homeassistant.components.pilight.binary_sensor.PilightTriggerSensor._hass

private

Definition at line 143 of file binary_sensor.py.

_name

homeassistant.components.pilight.binary_sensor.PilightTriggerSensor._name

private

Definition at line 144 of file binary_sensor.py.

_off_value

homeassistant.components.pilight.binary_sensor.PilightTriggerSensor._off_value

private

Definition at line 148 of file binary_sensor.py.

_on_value

homeassistant.components.pilight.binary_sensor.PilightTriggerSensor._on_value

private

Definition at line 147 of file binary_sensor.py.

_payload

homeassistant.components.pilight.binary_sensor.PilightTriggerSensor._payload

private

Definition at line 146 of file binary_sensor.py.

_reset_delay_sec

homeassistant.components.pilight.binary_sensor.PilightTriggerSensor._reset_delay_sec

private

Definition at line 149 of file binary_sensor.py.

_state

homeassistant.components.pilight.binary_sensor.PilightTriggerSensor._state

private

Definition at line 142 of file binary_sensor.py.

_variable

homeassistant.components.pilight.binary_sensor.PilightTriggerSensor._variable

private

Definition at line 145 of file binary_sensor.py.

---

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

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