akkudoktoreos.core.emplan

Energy management plan.

The energy management plan is leaned on to the S2 standard.

This module provides data models and enums for energy resource management following the S2 standard, supporting various control types including Power Envelope Based Control, Power Profile Based Control, Operation Mode Based Control, Fill Rate Based Control, and Demand Driven Based Control.

Classes

BaseInstruction(*[, id, abnormal_condition])	Base class for S2 control instructions.
Commodity(*values)	Enumeration of energy commodities supported in the system.
CommodityQuantity(*values)	Enumeration of specific commodity quantities and measurement types.
ControlType(*values)	Enumeration of different control types supported by the system.
Currency(*values)	Enumeration of currency codes following ISO 4217 standard.
DDBCActuatorDefinition(*, id[, diagnostic_label])	Definition of an Actuator for Demand Driven Based Control (DDBC).
DDBCActuatorDescription(*, id[, ...])	Description of an Actuator for Demand Driven Based Control (DDBC).
DDBCActuatorStatus(*[, type, ...])	Current status of a DDBC Actuator.
DDBCAverageDemandRateForecast(*, start_time, ...)	Complete demand rate forecast for DDBC.
DDBCAverageDemandRateForecastElement(*, duration)	Element of a demand rate forecast for DDBC.
DDBCInstruction(*[, id, abnormal_condition, ...])	Instruction for Demand Driven Based Control (DDBC).
DDBCOperationMode(*, id[, diagnostic_label, ...])	Operation Mode for Demand Driven Based Control (DDBC).
DDBCSystemDescription(*, valid_from, ...)	Complete system description for Demand Driven Based Control (DDBC).
EnergyManagementPlan(*, id, generated_at[, ...])	A coordinated energy management plan composed of device control instructions.
EnergyMeasurement(*[, type, last_reset])	Captures a set of energy meter readouts taken at a specific point in time.
FRBCActuatorDefinition(*, id[, diagnostic_label])	Definition of an Actuator for Fill Rate Based Control (FRBC).
FRBCActuatorDescription(*, id[, ...])	Description of an Actuator for Fill Rate Based Control (FRBC).
FRBCActuatorStatus(*[, type, ...])	Current status of an FRBC Actuator.
FRBCEnergyStatus(*[, type, import_total, ...])	Energy status of an FRBC storage.
FRBCFillLevelTargetProfile(*, start_time, ...)	Complete fill level target profile for an FRBC Storage.
FRBCFillLevelTargetProfileElement(*, ...)	Element of a fill level target profile for an FRBC Storage.
FRBCInstruction(*[, id, abnormal_condition, ...])	Instruction for Fill Rate Based Control (FRBC).
FRBCLeakageBehaviour(*, valid_from, elements)	Complete leakage behavior model for an FRBC Storage.
FRBCLeakageBehaviourElement(*, ...)	Element of the leakage behavior for an FRBC Storage.
FRBCOperationMode(*, id[, diagnostic_label])	Operation Mode for Fill Rate Based Control (FRBC).
FRBCOperationModeElement(*, ...[, running_costs])	Element of an FRBC Operation Mode with properties dependent on fill level.
FRBCStorageDefinition(*[, diagnostic_label, ...])	Definition of a Storage for Fill Rate Based Control (FRBC).
FRBCStorageDescription(*[, ...])	Description of a Storage for Fill Rate Based Control (FRBC).
FRBCStorageStatus(*[, type])	Current status of an FRBC Storage.
FRBCSystemDescription(*, valid_from, ...)	Complete system description for Fill Rate Based Control (FRBC).
FRBCTimerStatus(*[, type])	Current status of an FRBC Timer.
FRBCUsageForecast(*, start_time, elements)	Complete usage forecast for an FRBC Storage.
FRBCUsageForecastElement(*, duration[, ...])	Element of a usage forecast for an FRBC Storage.
InstructionStatus(*values)	Enumeration of possible instruction status values.
InstructionStatusUpdate(*, instruction_id, ...)	Represents an update to the status of a control instruction.
NumberRange(*, start_of_range, end_of_range)	Defines a generic numeric range with start and end values.
OMBCInstruction(*[, id, abnormal_condition, ...])	Instruction for Operation Mode Based Control (OMBC).
OMBCOperationMode(*, id[, diagnostic_label, ...])	Operation Mode for Operation Mode Based Control (OMBC).
OMBCStatus(*[, type, ...])	Reports the current operational status of an Operation Mode Based Control system.
OMBCSystemDefinition(*, valid_from, ...)	Provides a comprehensive definition of an Operation Mode Based Control system.
OMBCSystemDescription(*, valid_from, ...)	Provides a comprehensive description of an Operation Mode Based Control system.
OMBCTimerStatus(*[, type])	Current status of an OMBC Timer.
PEBCAllowedLimitRange(*, commodity_quantity, ...)	Defines the permissible range for power envelope limits in PEBC.
PEBCEnergyConstraints(*, id, valid_from, ...)	Defines energy constraints over a time period for Power Envelope Based Control.
PEBCInstruction(*[, id, abnormal_condition, ...])	Represents a control instruction for Power Envelope Based Control.
PEBCPowerConstraints(*, id, valid_from[, ...])	Defines the constraints for power envelope control during a specific time period.
PEBCPowerEnvelope(*, id, commodity_quantity, ...)	Defines a complete power envelope constraint for a specific commodity quantity.
PEBCPowerEnvelopeConsequenceType(*values)	Enumeration of consequences when power is limited for Power Envelope Based Control.
PEBCPowerEnvelopeElement(*, duration, ...)	Defines a segment of a power envelope for a specific duration.
PEBCPowerEnvelopeLimitType(*values)	Enumeration of power envelope limit types for Power Envelope Based Control.
PPBCEndInterruptionInstruction(*[, id, ...])	Represents an instruction to resume execution of a previously interrupted power sequence.
PPBCPowerProfileDefinition(*, id, ...)	Defines a complete power profile for Power Profile Based Control.
PPBCPowerProfileStatus(*[, type])	Reports the current status of a power profile execution.
PPBCPowerSequence(*, id, elements, ...[, ...])	Defines a specific power sequence pattern with timing and interruptibility properties.
PPBCPowerSequenceContainer(*, id, ...)	Groups alternative power sequences for a specific phase of operation.
PPBCPowerSequenceContainerStatus(*, ...[, ...])	Reports the status of a specific power sequence container execution.
PPBCPowerSequenceElement(*, duration, ...)	Defines a segment of a power sequence with specific duration and power values.
PPBCPowerSequenceStatus(*values)	Enumeration of status values for Power Profile Based Control sequences.
PPBCScheduleInstruction(*[, id, ...])	Represents an instruction to schedule execution of a specific power sequence.
PPBCStartInterruptionInstruction(*[, id, ...])	Represents an instruction to interrupt execution of a running power sequence.
PowerForecast(*, start_time, elements)	Represents a power forecast profile consisting of one or more forecast elements.
PowerForecastElement(*, duration, power_values)	Represents a segment of a power forecast covering a specific time duration.
PowerForecastValue(*[, value_upper_limit, ...])	Represents a forecasted power value with statistical confidence intervals.
PowerMeasurement(*[, type])	Captures a set of power measurements taken at a specific point in time.
PowerRange(*, start_of_range, end_of_range, ...)	Defines a range of acceptable power values for a specific commodity quantity.
PowerValue(*, commodity_quantity, value)	Represents a specific power value measurement with its associated commodity quantity.
ReceptionStatus(*, status[, diagnostic_label])	Represents the status of a data reception operation with optional diagnostic information.
ReceptionStatusValues(*values)	Enumeration of status values for data reception.
ResourceManagerDetails(*, resource_id[, ...])	Provides comprehensive details about a ResourceManager's capabilities and identity.
Role(*, role, commodity)	Defines an energy system role related to a specific commodity.
RoleType(*values)	Enumeration of energy resource roles in the system.
Timer(*, id[, diagnostic_label])	Defines a timing constraint for transitions between operation modes.
Transition(*, id, from_, to, start_timers, ...)	Defines a permitted transition between operation modes with associated constraints and costs.