Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.mqtt_room.sensor.MQTTRoomSensor Class Reference
Inheritance diagram for homeassistant.components.mqtt_room.sensor.MQTTRoomSensor:
[legend]
Collaboration diagram for homeassistant.components.mqtt_room.sensor.MQTTRoomSensor:
[legend]

Public Member Functions

None __init__ (self, str|None name, str state_topic, str device_id, int timeout, int consider_home, str|None unique_id)
 
None async_added_to_hass (self)
 
def extra_state_attributes (self)
 
def name (self)
 
def native_value (self)
 
None update (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)
 
str|None native_unit_of_measurement (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_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)
 
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, strtranslation_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 Attributes

 _attr_unique_id
 
 _consider_home
 
 _device_id
 
 _distance
 
 _name
 
 _state
 
 _state_topic
 
 _timeout
 
 _updated
 

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 room sensor that is updated via MQTT.

Definition at line 104 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.mqtt_room.sensor.MQTTRoomSensor.__init__ (   self,
str | None  name,
str  state_topic,
str  device_id,
int  timeout,
int  consider_home,
str | None  unique_id 
)
Initialize the sensor.

Definition at line 107 of file sensor.py.

Member Function Documentation

◆ async_added_to_hass()

None homeassistant.components.mqtt_room.sensor.MQTTRoomSensor.async_added_to_hass (   self)
Subscribe to MQTT events.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 130 of file sensor.py.

◆ extra_state_attributes()

def homeassistant.components.mqtt_room.sensor.MQTTRoomSensor.extra_state_attributes (   self)
Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 176 of file sensor.py.

◆ name()

def homeassistant.components.mqtt_room.sensor.MQTTRoomSensor.name (   self)
Return the name of the sensor.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 171 of file sensor.py.

◆ native_value()

def homeassistant.components.mqtt_room.sensor.MQTTRoomSensor.native_value (   self)
Return the current room of the entity.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 181 of file sensor.py.

◆ update()

None homeassistant.components.mqtt_room.sensor.MQTTRoomSensor.update (   self)
Update the state for absent devices.

Definition at line 185 of file sensor.py.

Member Data Documentation

◆ _attr_unique_id

homeassistant.components.mqtt_room.sensor.MQTTRoomSensor._attr_unique_id
private

Definition at line 117 of file sensor.py.

◆ _consider_home

homeassistant.components.mqtt_room.sensor.MQTTRoomSensor._consider_home
private

Definition at line 124 of file sensor.py.

◆ _device_id

homeassistant.components.mqtt_room.sensor.MQTTRoomSensor._device_id
private

Definition at line 122 of file sensor.py.

◆ _distance

homeassistant.components.mqtt_room.sensor.MQTTRoomSensor._distance
private

Definition at line 127 of file sensor.py.

◆ _name

homeassistant.components.mqtt_room.sensor.MQTTRoomSensor._name
private

Definition at line 120 of file sensor.py.

◆ _state

homeassistant.components.mqtt_room.sensor.MQTTRoomSensor._state
private

Definition at line 119 of file sensor.py.

◆ _state_topic

homeassistant.components.mqtt_room.sensor.MQTTRoomSensor._state_topic
private

Definition at line 121 of file sensor.py.

◆ _timeout

homeassistant.components.mqtt_room.sensor.MQTTRoomSensor._timeout
private

Definition at line 123 of file sensor.py.

◆ _updated

homeassistant.components.mqtt_room.sensor.MQTTRoomSensor._updated
private

Definition at line 128 of file sensor.py.


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