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

Public Member Functions

None __init__ (self, HKDevice conn, ConfigType info, Characteristic char, HomeKitSensorEntityDescription description)
 
list[strget_characteristic_types (self)
 
str name (self)
 
str|int|float native_value (self)
 
- Public Member Functions inherited from homeassistant.components.homekit_controller.entity.CharacteristicEntity
None __init__ (self, HKDevice accessory, ConfigType devinfo, Characteristic char)
 
str old_unique_id (self)
 
- Public Member Functions inherited from homeassistant.components.homekit_controller.entity.HomeKitEntity
None __init__ (self, HKDevice accessory, ConfigType devinfo)
 
None async_added_to_hass (self)
 
None async_put_characteristics (self, dict[str, Any] characteristics)
 
None async_setup (self)
 
None async_update (self)
 
None async_will_remove_from_hass (self)
 
bool available (self)
 
str|None default_name (self)
 
DeviceInfo device_info (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_write_ha_state (self)
 
str|None attribution (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, 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)
 
- 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 Attributes

 entity_description
 
- Public Attributes inherited from homeassistant.components.homekit_controller.entity.HomeKitEntity
 accessory
 
 accessory_info
 
 all_characteristics
 
 all_iids
 
 pollable_characteristics
 
 service
 
 watchable_characteristics
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Public Attributes inherited from homeassistant.components.sensor.SensorEntity
 entity_category
 
 registry_entry
 
 unit_of_measurement
 

Private Attributes

 _attr_options
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 
- Static Public Attributes inherited from homeassistant.components.sensor.SensorEntity
 Decimal
 
 None
 
 UndefinedType
 

Detailed Description

A simple sensor for a single characteristic.

This may be an additional secondary entity that is part of another service. An
example is a switch that has an energy sensor.

These *have* to have a different unique_id to the normal sensors as there could
be multiple entities per HomeKit service (this was not previously the case).

Definition at line 536 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.homekit_controller.sensor.SimpleSensor.__init__ (   self,
HKDevice  conn,
ConfigType  info,
Characteristic  char,
HomeKitSensorEntityDescription  description 
)
Initialise a secondary HomeKit characteristic sensor.

Definition at line 548 of file sensor.py.

Member Function Documentation

◆ get_characteristic_types()

list[str] homeassistant.components.homekit_controller.sensor.SimpleSensor.get_characteristic_types (   self)
Define the homekit characteristics the entity is tracking.

Reimplemented from homeassistant.components.homekit_controller.entity.HomeKitEntity.

Definition at line 561 of file sensor.py.

◆ name()

str homeassistant.components.homekit_controller.sensor.SimpleSensor.name (   self)
Return the name of the device if any.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 566 of file sensor.py.

◆ native_value()

str | int | float homeassistant.components.homekit_controller.sensor.SimpleSensor.native_value (   self)
Return the current sensor value.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 573 of file sensor.py.

Member Data Documentation

◆ _attr_options

homeassistant.components.homekit_controller.sensor.SimpleSensor._attr_options
private

Definition at line 558 of file sensor.py.

◆ entity_description

homeassistant.components.homekit_controller.sensor.SimpleSensor.entity_description

Definition at line 556 of file sensor.py.


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