ControllerABC

Bases: ABC

              flowchart TD
              nrgise.controllers.ControllerABC[ControllerABC]

              

              click nrgise.controllers.ControllerABC href "" "nrgise.controllers.ControllerABC"
            

Defines the base class for all controllers.

nrgise.controllers.ControllerABC.get_action abstractmethod

get_action(state: State) -> Tuple[Dict[str, float], Any]

Returns the action(s) to be taken by the Component(s) implementing ControllableMixin in the EnergySystem. An action defines the amount of kW which Component implementing ControllableMixin should contribute to the energy system in the current time step (positive = contributing power to the energysystem; negative = taking power).

Parameters:

Name	Type	Description	Default
state	State	Current State of the EnergySystem	required

Returns:

Type	Description
Dict[str, float]	Mapping from label of the ControllableMixin to the amount of kW which should be contributed (positive = discharging) in the current time step.
Any	Additional controller information, which is available in simulation results for later analysis.