homeassistant.components.goodwe.sensor.InverterSensor Class Reference

Inheritance diagram for homeassistant.components.goodwe.sensor.InverterSensor:

Collaboration diagram for homeassistant.components.goodwe.sensor.InverterSensor:

Public Member Functions
None	__init__ (self, GoodweUpdateCoordinator coordinator, DeviceInfo device_info, Inverter inverter, Sensor sensor)
None	async_added_to_hass (self)
def	async_reset (self, now)
None	async_will_remove_from_hass (self)
bool	available (self)
StateType|date|datetime|Decimal	native_value (self)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None	__init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
None	async_update (self)
Public Member Functions inherited from homeassistant.components.goodwe.coordinator.GoodweUpdateCoordinator
None	__init__ (self, HomeAssistant hass, ConfigEntry entry, Inverter inverter)
None	reset_sensor (self, str sensor)
Any	sensor_value (self, str sensor)
Any	total_sensor_value (self, str sensor)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
Callable[[], None]	async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
None	async_config_entry_first_refresh (self)
Generator[Any]	async_contexts (self)
None	async_refresh (self)
None	async_register_shutdown (self)
None	async_request_refresh (self)
None	async_set_update_error (self, Exception err)
None	async_set_updated_data (self, _DataT data)
None	async_shutdown (self)
None	async_update_listeners (self)
timedelta|None	update_interval (self)
None	update_interval (self, timedelta|None value)
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)
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, str]	translation_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
	entity_description
Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
	always_update
	config_entry
	data
	hass
	last_exception
	last_update_success
	logger
	name
	setup_method
	update_interval
	update_method
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_device_class
	_attr_device_info
	_attr_entity_category
	_attr_icon
	_attr_name
	_attr_native_unit_of_measurement
	_attr_unique_id
	_sensor
	_stop_reset

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

Entity representing individual inverter sensor.

Definition at line 187 of file sensor.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.goodwe.sensor.InverterSensor.__init__	(		self,
		GoodweUpdateCoordinator	coordinator,
		DeviceInfo	device_info,
		Inverter	inverter,
		Sensor	sensor
	)

Initialize an inverter sensor.

Definition at line 192 of file sensor.py.

Member Function Documentation

async_added_to_hass()

None homeassistant.components.goodwe.sensor.InverterSensor.async_added_to_hass

(

self

)

Schedule reset task at midnight.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 257 of file sensor.py.

async_reset()

def homeassistant.components.goodwe.sensor.InverterSensor.async_reset	(		self,
			now
	)

Reset the value back to 0 at midnight.

Some sensors values like daily produced energy are kept available,
even when the inverter is in sleep mode and no longer responds to request.
In contrast to "total" sensors, these "daily" sensors need to be reset to 0 on midnight.

Definition at line 239 of file sensor.py.

async_will_remove_from_hass()

None homeassistant.components.goodwe.sensor.InverterSensor.async_will_remove_from_hass

(

self

)

Remove reset task at midnight.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 268 of file sensor.py.

available()

bool homeassistant.components.goodwe.sensor.InverterSensor.available

(

self

)

Return if entity is available.

We delegate the behavior to entity description lambda, since
some sensors (like energy produced today) should report themselves
as available even when the (non-battery) pv inverter is off-line during night
and most of the sensors are actually unavailable.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 228 of file sensor.py.

native_value()

StateType | date | datetime | Decimal homeassistant.components.goodwe.sensor.InverterSensor.native_value

(

self

)

Return the value reported by the sensor.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 223 of file sensor.py.

Member Data Documentation

_attr_device_class

homeassistant.components.goodwe.sensor.InverterSensor._attr_device_class

private

Definition at line 218 of file sensor.py.

_attr_device_info

homeassistant.components.goodwe.sensor.InverterSensor._attr_device_info

private

Definition at line 203 of file sensor.py.

_attr_entity_category

homeassistant.components.goodwe.sensor.InverterSensor._attr_entity_category

private

Definition at line 204 of file sensor.py.

_attr_icon

homeassistant.components.goodwe.sensor.InverterSensor._attr_icon

private

Definition at line 215 of file sensor.py.

_attr_name

homeassistant.components.goodwe.sensor.InverterSensor._attr_name

private

Definition at line 201 of file sensor.py.

_attr_native_unit_of_measurement

homeassistant.components.goodwe.sensor.InverterSensor._attr_native_unit_of_measurement

private

Definition at line 214 of file sensor.py.

_attr_unique_id

homeassistant.components.goodwe.sensor.InverterSensor._attr_unique_id

private

Definition at line 202 of file sensor.py.

_sensor

homeassistant.components.goodwe.sensor.InverterSensor._sensor

private

Definition at line 219 of file sensor.py.

_stop_reset

homeassistant.components.goodwe.sensor.InverterSensor._stop_reset

private

Definition at line 253 of file sensor.py.

entity_description

homeassistant.components.goodwe.sensor.InverterSensor.entity_description

Definition at line 208 of file sensor.py.

---

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

• core/homeassistant/components/goodwe/sensor.py