akkudoktoreos.devices.generic.HomeAppliance

class akkudoktoreos.devices.generic.HomeAppliance(parameters: HomeApplianceParameters | None = None)

Bases: DeviceBase

__init__(parameters: HomeApplianceParameters | None = None)

Methods

__init__([parameters])
get_latest_starting_point()	Returns the latest possible start time at which the device can still run completely.
get_load_curve()	Returns the current load curve.
get_load_for_hour(hour)	Returns the load for a specific hour.
post_setup()
reset_load_curve()	Resets the load curve.
set_starting_time(start_hour[, ...])	Sets the start time of the device and generates the corresponding load curve.
setup(parameters)

Attributes

config	Convenience method/ attribute to retrieve the EOS configuration data.
devices	Convenience method/ attribute to retrieve the EOS devices simulation data.
ems	Convenience method/ attribute to retrieve the EOS energy management system.
end_datetime	Compute the end datetime based on the start_datetime and hours.
prediction	Convenience method/ attribute to retrieve the EOS prediction data.
total_hours	Compute the hours from start_datetime to end_datetime.

__init__(parameters: HomeApplianceParameters | None = None)

set_starting_time(start_hour: int, global_start_hour: int = 0) → None

Sets the start time of the device and generates the corresponding load curve.

Parameters:

start_hour – The hour at which the device should start.

reset_load_curve() → None

Resets the load curve.

get_load_curve() → ndarray

Returns the current load curve.

get_load_for_hour(hour: int) → float

Returns the load for a specific hour.

Parameters:

hour – The hour for which the load is queried.

Returns:

The load in watts for the specified hour.

get_latest_starting_point() → int

Returns the latest possible start time at which the device can still run completely.

property config: Any

Convenience method/ attribute to retrieve the EOS configuration data.

Returns:

The configuration.

Return type:

ConfigEOS

property devices: Any

Convenience method/ attribute to retrieve the EOS devices simulation data.

Returns:

The devices simulation.

Return type:

Devices

property ems: Any

Convenience method/ attribute to retrieve the EOS energy management system.

Returns:

The energy management system.

Return type:

EnergyManagementSystem

property end_datetime: DateTime | None

Compute the end datetime based on the start_datetime and hours.

Ajusts the calculated end time if DST transitions occur within the prediction window.

Returns:

The calculated end datetime, or None if inputs are missing.

Return type:

Optional[DateTime]

post_setup() → None

property prediction: Any

Convenience method/ attribute to retrieve the EOS prediction data.

Returns:

The prediction.

Return type:

Prediction

setup(parameters: DeviceParameters) → None

property total_hours: int | None

Compute the hours from start_datetime to end_datetime.

Returns:

The duration hours, or None if either datetime is unavailable.

Return type:

Optional[pendulum.period]