Energy Management Module System¶

Architecture¶

The EMS uses a factory pattern where each module is a Python class extending EnergyManagementModule. New modules are registered in the factory and auto-discovered.

classDiagram
    class EnergyManagementModule {
        +get_capabilities() list
        +get_config_schema() dict
        +validate_config(config) bool
        +calculate_setpoints(forecasts, start, end)
        +on_activate()
        +on_deactivate()
        +get_status() dict
    }
    class OSTECSimpleModule {
        +calculate_setpoints(forecasts, start, end)
        +get_capabilities() list
        +get_config_schema() dict
    }
    class GDBNBeFlexibleModule {
        +receive_setpoints()
        +receive_offers()
    }
    EnergyManagementModule <|-- OSTECSimpleModule
    EnergyManagementModule <|-- GDBNBeFlexibleModule

Adding a New Module¶

A new module requires only one Python file. It:

1. Extends EnergyManagementModule
2. Implements get_capabilities(), get_config_schema(), calculate_setpoints()
3. Is placed in the modules/ directory and auto-registered by the factory

No database schema changes are needed. Module-specific config goes in the config_data JSONB field.

Available Modules¶

Module Maturity Levels¶