homeassistant.components.pilight.sensor.PilightSensor Class Reference

Inheritance diagram for homeassistant.components.pilight.sensor.PilightSensor:

Collaboration diagram for homeassistant.components.pilight.sensor.PilightSensor:

Public Member Functions
def	__init__ (self, hass, name, variable, payload, unit_of_measurement)
def	name (self)
def	native_unit_of_measurement (self)
def	native_value (self)
Public Member Functions inherited from homeassistant.components.sensor.SensorEntity
None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
None	async_internal_added_to_hass (self)
None	async_registry_entry_updated (self)
dict[str, Any]|None	capability_attributes (self)
SensorDeviceClass|None	device_class (self)
er.EntityOptionsType|None	get_initial_entity_options (self)
datetime|None	last_reset (self)
list[str]|None	options (self)
Any	state (self)
dict[str, Any]|None	state_attributes (self)
SensorStateClass|str|None	state_class (self)
int|None	suggested_display_precision (self)
str|None	suggested_unit_of_measurement (self)
str|None	unit_of_measurement (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)
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_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)
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)
bool	has_entity_name (self)
str|None	icon (self)
None	schedule_update_ha_state (self, bool force_refresh=False)
bool	should_poll (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)
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
	_hass
	_name
	_payload
	_state
	_unit_of_measurement
	_variable

Static Private Attributes
bool	_attr_should_poll = False

Additional Inherited Members
Public Attributes inherited from homeassistant.components.sensor.SensorEntity
	entity_category
	registry_entry
	unit_of_measurement
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.sensor.SensorEntity
	Decimal
	None
	UndefinedType
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Detailed Description

Representation of a sensor that can be updated using Pilight.

Definition at line 56 of file sensor.py.

Constructor & Destructor Documentation

__init__()

def homeassistant.components.pilight.sensor.PilightSensor.__init__	(		self,
			hass,
			name,
			variable,
			payload,
			unit_of_measurement
	)

Initialize the sensor.

Definition at line 61 of file sensor.py.

Member Function Documentation

_handle_code()

def homeassistant.components.pilight.sensor.PilightSensor._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 87 of file sensor.py.

name()

def homeassistant.components.pilight.sensor.PilightSensor.name

(

self

)

Return the name of the sensor.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 73 of file sensor.py.

native_unit_of_measurement()

def homeassistant.components.pilight.sensor.PilightSensor.native_unit_of_measurement

(

self

)

Return the unit this state is expressed in.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 78 of file sensor.py.

native_value()

def homeassistant.components.pilight.sensor.PilightSensor.native_value

(

self

)

Return the state of the entity.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 83 of file sensor.py.

Member Data Documentation

_attr_should_poll

bool homeassistant.components.pilight.sensor.PilightSensor._attr_should_poll = False

staticprivate

Definition at line 59 of file sensor.py.

_hass

homeassistant.components.pilight.sensor.PilightSensor._hass

private

Definition at line 64 of file sensor.py.

_name

homeassistant.components.pilight.sensor.PilightSensor._name

private

Definition at line 65 of file sensor.py.

_payload

homeassistant.components.pilight.sensor.PilightSensor._payload

private

Definition at line 67 of file sensor.py.

_state

homeassistant.components.pilight.sensor.PilightSensor._state

private

Definition at line 63 of file sensor.py.

_unit_of_measurement

homeassistant.components.pilight.sensor.PilightSensor._unit_of_measurement

private

Definition at line 68 of file sensor.py.

_variable

homeassistant.components.pilight.sensor.PilightSensor._variable

private

Definition at line 66 of file sensor.py.

---

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

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