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

Public Member Functions

def __init__ (self, arest, resource, location, name, variable=None, pin=None, unit_of_measurement=None, renderer=None)
 
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)
 
StateType|date|datetime|Decimal native_value (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)
 
str|UndefinedType|None name (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 Attributes

 arest
 
- 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
 

Private Attributes

 _attr_available
 
 _attr_name
 
 _attr_native_unit_of_measurement
 
 _attr_native_value
 
 _renderer
 
 _variable
 

Additional Inherited Members

- 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

Implementation of an aREST sensor for exposed variables.

Definition at line 138 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.arest.sensor.ArestSensor.__init__ (   self,
  arest,
  resource,
  location,
  name,
  variable = None,
  pin = None,
  unit_of_measurement = None,
  renderer = None 
)
Initialize the sensor.

Definition at line 141 of file sensor.py.

Member Function Documentation

◆ update()

None homeassistant.components.arest.sensor.ArestSensor.update (   self)
Get the latest data from aREST API.

Definition at line 164 of file sensor.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.arest.sensor.ArestSensor._attr_available
private

Definition at line 167 of file sensor.py.

◆ _attr_name

homeassistant.components.arest.sensor.ArestSensor._attr_name
private

Definition at line 154 of file sensor.py.

◆ _attr_native_unit_of_measurement

homeassistant.components.arest.sensor.ArestSensor._attr_native_unit_of_measurement
private

Definition at line 156 of file sensor.py.

◆ _attr_native_value

homeassistant.components.arest.sensor.ArestSensor._attr_native_value
private

Definition at line 170 of file sensor.py.

◆ _renderer

homeassistant.components.arest.sensor.ArestSensor._renderer
private

Definition at line 157 of file sensor.py.

◆ _variable

homeassistant.components.arest.sensor.ArestSensor._variable
private

Definition at line 155 of file sensor.py.

◆ arest

homeassistant.components.arest.sensor.ArestSensor.arest

Definition at line 153 of file sensor.py.


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