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

Public Member Functions

None __init__ (self, CommandSensorData data, ConfigType config, Template|None value_template, list[str]|None json_attributes, str|None json_attributes_path, timedelta scan_interval)
 
None async_added_to_hass (self)
 
None async_update (self)
 
dict[str, Any] extra_state_attributes (self)
 
- Public Member Functions inherited from homeassistant.helpers.trigger_template_entity.ManualTriggerSensorEntity
None __init__ (self, HomeAssistant hass, ConfigType config)
 
- Public Member Functions inherited from homeassistant.helpers.trigger_template_entity.TriggerBaseEntity
bool available (self)
 
str|None entity_picture (self)
 
str|None icon (self)
 
str|None name (self)
 
None restore_attributes (self, State last_state)
 
str|None unique_id (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_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
DeviceInfo|None device_info (self)
 
bool enabled (self)
 
EntityCategory|None entity_category (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)
 
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)
 
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)
 
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 Attributes

 data
 
- Public Attributes inherited from homeassistant.helpers.trigger_template_entity.TriggerBaseEntity
 hass
 
- 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 Member Functions

None _async_update (self)
 
None _update_entity_state (self, datetime|None now=None)
 

Private Attributes

 _attr_extra_state_attributes
 
 _attr_native_value
 
 _json_attributes
 
 _json_attributes_path
 
 _process_updates
 
 _scan_interval
 
 _value_template
 

Static Private Attributes

bool _attr_should_poll = False
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.helpers.trigger_template_entity.TriggerBaseEntity
 None
 
- 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

Representation of a sensor that is using shell commands.

Definition at line 84 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.command_line.sensor.CommandSensor.__init__ (   self,
CommandSensorData  data,
ConfigType  config,
Template | None  value_template,
list[str] | None  json_attributes,
str | None  json_attributes_path,
timedelta  scan_interval 
)
Initialize the sensor.

Definition at line 89 of file sensor.py.

Member Function Documentation

◆ _async_update()

None homeassistant.components.command_line.sensor.CommandSensor._async_update (   self)
private
Get the latest data and updates the state.

Definition at line 144 of file sensor.py.

◆ _update_entity_state()

None homeassistant.components.command_line.sensor.CommandSensor._update_entity_state (   self,
datetime | None   now = None 
)
private
Update the state of the entity.

Definition at line 128 of file sensor.py.

◆ async_added_to_hass()

None homeassistant.components.command_line.sensor.CommandSensor.async_added_to_hass (   self)
Call when entity about to be added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 114 of file sensor.py.

◆ async_update()

None homeassistant.components.command_line.sensor.CommandSensor.async_update (   self)
Update the entity.

Only used by the generic entity update service.

Definition at line 198 of file sensor.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.command_line.sensor.CommandSensor.extra_state_attributes (   self)
Return extra state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 110 of file sensor.py.

Member Data Documentation

◆ _attr_extra_state_attributes

homeassistant.components.command_line.sensor.CommandSensor._attr_extra_state_attributes
private

Definition at line 150 of file sensor.py.

◆ _attr_native_value

homeassistant.components.command_line.sensor.CommandSensor._attr_native_value
private

Definition at line 104 of file sensor.py.

◆ _attr_should_poll

bool homeassistant.components.command_line.sensor.CommandSensor._attr_should_poll = False
staticprivate

Definition at line 87 of file sensor.py.

◆ _json_attributes

homeassistant.components.command_line.sensor.CommandSensor._json_attributes
private

Definition at line 102 of file sensor.py.

◆ _json_attributes_path

homeassistant.components.command_line.sensor.CommandSensor._json_attributes_path
private

Definition at line 103 of file sensor.py.

◆ _process_updates

homeassistant.components.command_line.sensor.CommandSensor._process_updates
private

Definition at line 131 of file sensor.py.

◆ _scan_interval

homeassistant.components.command_line.sensor.CommandSensor._scan_interval
private

Definition at line 106 of file sensor.py.

◆ _value_template

homeassistant.components.command_line.sensor.CommandSensor._value_template
private

Definition at line 105 of file sensor.py.

◆ data

homeassistant.components.command_line.sensor.CommandSensor.data

Definition at line 100 of file sensor.py.


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