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

Public Member Functions

def __init__ (self, name, unit, amp, mean, period, phase, fwhm, seed, relative_to_epoch)
 
None async_update (self)
 
def extra_state_attributes (self)
 
def name (self)
 
def native_unit_of_measurement (self)
 
def native_value (self)
 
def signal_calc (self)
 
def time_delta (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)
 
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)
 
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

 _amp
 
 _fwhm
 
 _mean
 
 _name
 
 _period
 
 _phase
 
 _random
 
 _relative_to_epoch
 
 _seed
 
 _start_time
 
 _state
 
 _unit
 

Static Private Attributes

string _attr_icon = "mdi:chart-line"
 

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

Class for simulated sensor.

Definition at line 98 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.simulated.sensor.SimulatedSensor.__init__ (   self,
  name,
  unit,
  amp,
  mean,
  period,
  phase,
  fwhm,
  seed,
  relative_to_epoch 
)
Init the class.

Definition at line 103 of file sensor.py.

Member Function Documentation

◆ async_update()

None homeassistant.components.simulated.sensor.SimulatedSensor.async_update (   self)
Update the sensor.

Definition at line 145 of file sensor.py.

◆ extra_state_attributes()

def homeassistant.components.simulated.sensor.SimulatedSensor.extra_state_attributes (   self)
Return other details about the sensor state.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 165 of file sensor.py.

◆ name()

def homeassistant.components.simulated.sensor.SimulatedSensor.name (   self)
Return the name of the sensor.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 150 of file sensor.py.

◆ native_unit_of_measurement()

def homeassistant.components.simulated.sensor.SimulatedSensor.native_unit_of_measurement (   self)
Return the unit this state is expressed in.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 160 of file sensor.py.

◆ native_value()

def homeassistant.components.simulated.sensor.SimulatedSensor.native_value (   self)
Return the state of the sensor.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 155 of file sensor.py.

◆ signal_calc()

def homeassistant.components.simulated.sensor.SimulatedSensor.signal_calc (   self)
Calculate the signal.

Definition at line 130 of file sensor.py.

◆ time_delta()

def homeassistant.components.simulated.sensor.SimulatedSensor.time_delta (   self)
Return the time delta.

Definition at line 124 of file sensor.py.

Member Data Documentation

◆ _amp

homeassistant.components.simulated.sensor.SimulatedSensor._amp
private

Definition at line 109 of file sensor.py.

◆ _attr_icon

string homeassistant.components.simulated.sensor.SimulatedSensor._attr_icon = "mdi:chart-line"
staticprivate

Definition at line 101 of file sensor.py.

◆ _fwhm

homeassistant.components.simulated.sensor.SimulatedSensor._fwhm
private

Definition at line 113 of file sensor.py.

◆ _mean

homeassistant.components.simulated.sensor.SimulatedSensor._mean
private

Definition at line 110 of file sensor.py.

◆ _name

homeassistant.components.simulated.sensor.SimulatedSensor._name
private

Definition at line 107 of file sensor.py.

◆ _period

homeassistant.components.simulated.sensor.SimulatedSensor._period
private

Definition at line 111 of file sensor.py.

◆ _phase

homeassistant.components.simulated.sensor.SimulatedSensor._phase
private

Definition at line 112 of file sensor.py.

◆ _random

homeassistant.components.simulated.sensor.SimulatedSensor._random
private

Definition at line 115 of file sensor.py.

◆ _relative_to_epoch

homeassistant.components.simulated.sensor.SimulatedSensor._relative_to_epoch
private

Definition at line 121 of file sensor.py.

◆ _seed

homeassistant.components.simulated.sensor.SimulatedSensor._seed
private

Definition at line 114 of file sensor.py.

◆ _start_time

homeassistant.components.simulated.sensor.SimulatedSensor._start_time
private

Definition at line 116 of file sensor.py.

◆ _state

homeassistant.components.simulated.sensor.SimulatedSensor._state
private

Definition at line 122 of file sensor.py.

◆ _unit

homeassistant.components.simulated.sensor.SimulatedSensor._unit
private

Definition at line 108 of file sensor.py.


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