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

Public Member Functions

None __init__ (self, str|None serialnumber, pysaj.Sensor pysaj_sensor, str|None inverter_name=None)
 
def async_update_values (self, unknown_state=False)
 
date date_updated (self)
 
def native_value (self)
 
bool per_day_basis (self)
 
bool per_total_basis (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_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)
 

Private Attributes

 _attr_device_class
 
 _attr_name
 
 _attr_native_unit_of_measurement
 
 _attr_state_class
 
 _attr_unique_id
 
 _inverter_name
 
 _sensor
 
 _serialnumber
 
 _state
 

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 SAJ sensor.

Definition at line 180 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.saj.sensor.SAJsensor.__init__ (   self,
str | None  serialnumber,
pysaj.Sensor  pysaj_sensor,
str | None   inverter_name = None 
)
Initialize the SAJ sensor.

Definition at line 185 of file sensor.py.

Member Function Documentation

◆ async_update_values()

def homeassistant.components.saj.sensor.SAJsensor.async_update_values (   self,
  unknown_state = False 
)
Update this sensor.

Definition at line 240 of file sensor.py.

◆ date_updated()

date homeassistant.components.saj.sensor.SAJsensor.date_updated (   self)
Return the date when the sensor was last updated.

Definition at line 235 of file sensor.py.

◆ native_value()

def homeassistant.components.saj.sensor.SAJsensor.native_value (   self)
Return the state of the sensor.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 220 of file sensor.py.

◆ per_day_basis()

bool homeassistant.components.saj.sensor.SAJsensor.per_day_basis (   self)
Return if the sensors value is on daily basis or not.

Definition at line 225 of file sensor.py.

◆ per_total_basis()

bool homeassistant.components.saj.sensor.SAJsensor.per_total_basis (   self)
Return if the sensors value is cumulative or not.

Definition at line 230 of file sensor.py.

Member Data Documentation

◆ _attr_device_class

homeassistant.components.saj.sensor.SAJsensor._attr_device_class
private

Definition at line 210 of file sensor.py.

◆ _attr_name

homeassistant.components.saj.sensor.SAJsensor._attr_name
private

Definition at line 206 of file sensor.py.

◆ _attr_native_unit_of_measurement

homeassistant.components.saj.sensor.SAJsensor._attr_native_unit_of_measurement
private

Definition at line 204 of file sensor.py.

◆ _attr_should_poll

bool homeassistant.components.saj.sensor.SAJsensor._attr_should_poll = False
staticprivate

Definition at line 183 of file sensor.py.

◆ _attr_state_class

homeassistant.components.saj.sensor.SAJsensor._attr_state_class
private

Definition at line 198 of file sensor.py.

◆ _attr_unique_id

homeassistant.components.saj.sensor.SAJsensor._attr_unique_id
private

Definition at line 202 of file sensor.py.

◆ _inverter_name

homeassistant.components.saj.sensor.SAJsensor._inverter_name
private

Definition at line 193 of file sensor.py.

◆ _sensor

homeassistant.components.saj.sensor.SAJsensor._sensor
private

Definition at line 192 of file sensor.py.

◆ _serialnumber

homeassistant.components.saj.sensor.SAJsensor._serialnumber
private

Definition at line 194 of file sensor.py.

◆ _state

homeassistant.components.saj.sensor.SAJsensor._state
private

Definition at line 195 of file sensor.py.


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