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

Public Member Functions

None __init__ (self, greeneye.monitor.Monitor monitor, int number, str name, str counted_quantity, str time_unit, float counted_quantity_per_pulse)
 
dict[str, Any] extra_state_attributes (self)
 
float|None native_value (self)
 
- Public Member Functions inherited from homeassistant.components.greeneye_monitor.sensor.GEMSensor
None __init__ (self, greeneye.monitor.Monitor monitor, str name, str sensor_type, UnderlyingSensorType sensor, int number)
 
None async_added_to_hass (self)
 
None async_will_remove_from_hass (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_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)
 
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 Member Functions

int _seconds_per_time_unit (self)
 

Private Attributes

 _attr_native_unit_of_measurement
 
 _counted_quantity_per_pulse
 
 _time_unit
 

Static Private Attributes

 _attr_icon = COUNTER_ICON
 

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

Entity showing rate of change in one pulse counter of the monitor.

Definition at line 194 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.greeneye_monitor.sensor.PulseCounter.__init__ (   self,
greeneye.monitor.Monitor  monitor,
int  number,
str  name,
str  counted_quantity,
str  time_unit,
float  counted_quantity_per_pulse 
)
Construct the entity.

Definition at line 199 of file sensor.py.

Member Function Documentation

◆ _seconds_per_time_unit()

int homeassistant.components.greeneye_monitor.sensor.PulseCounter._seconds_per_time_unit (   self)
private
Return the number of seconds in the given display time unit.

Definition at line 230 of file sensor.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.greeneye_monitor.sensor.PulseCounter.extra_state_attributes (   self)
Return total pulses in the data dictionary.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 246 of file sensor.py.

◆ native_value()

float | None homeassistant.components.greeneye_monitor.sensor.PulseCounter.native_value (   self)
Return the current rate of change for the given pulse counter.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 218 of file sensor.py.

Member Data Documentation

◆ _attr_icon

homeassistant.components.greeneye_monitor.sensor.PulseCounter._attr_icon = COUNTER_ICON
staticprivate

Definition at line 197 of file sensor.py.

◆ _attr_native_unit_of_measurement

homeassistant.components.greeneye_monitor.sensor.PulseCounter._attr_native_unit_of_measurement
private

Definition at line 215 of file sensor.py.

◆ _counted_quantity_per_pulse

homeassistant.components.greeneye_monitor.sensor.PulseCounter._counted_quantity_per_pulse
private

Definition at line 213 of file sensor.py.

◆ _time_unit

homeassistant.components.greeneye_monitor.sensor.PulseCounter._time_unit
private

Definition at line 214 of file sensor.py.


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