Enums & Constants¶
RoleType¶
Platform and community roles.
class RoleType(str, Enum):
SUPER_USER = "SUPER_USER" # Platform-wide; only role that can create communities
ADMIN = "ADMIN" # Full management of an assigned community
MEMBER = "MEMBER" # Read-only access to own data + community aggregates (requires verified email)
CommunityType¶
class CommunityType(str, Enum):
PROD = "PROD" # Real licensed REC in production
DEMO = "DEMO" # Demo/showcase community
SIMULATION = "SIMULATION" # Simulation / planning mode
MeterType¶
class MeterType(str, Enum):
CPE = "CPE" # DSO meter — primary market & settlement measurement point
Internal = "Internal" # Resource-dedicated meter behind a CPE
Aggregator = "Aggregator" # Virtual aggregator meter
InstallationType¶
Type of energy installation behind a meter.
class InstallationType(str, Enum):
IAC = "IAC" # Self-consumption installation (prosumer: generation + consumption)
IC = "IC" # Consumption-only installation
IPR = "IPR" # Production/generation-only installation
IA = "IA" # Storage installation
ResourceType¶
class ResourceType(str, Enum):
IU = "IU" # Utilization Installation — generic prosumer (consume + generate)
IC = "IC" # Consumption Installation — consume only
SCPU = "SCPU" # Self-Consumption Production Unit — generate only (PV)
STORAGE = "STORAGE" # Battery storage system
EV = "EV" # Electric vehicle charger
EWH = "EWH" # Electric water heater
ContractType¶
class ContractType(str, Enum):
FIXED = "FIXED" # Fixed tariff contract
INDEXED = "INDEXED" # OMIE-indexed contract
INDEXED_SIMPLIFIED = "INDEXED_SIMPLIFIED" # Simplified indexed contract
MethodAllocCoeff¶
Energy allocation coefficient method.
class MethodAllocCoeffType(str, Enum):
PROPORTIONAL = "PROPORTIONAL" # Proportional to consumption share
FIXED = "FIXED" # Pre-defined fixed coefficients
DYNAMIC = "DYNAMIC" # Dynamically updated coefficients
TransactionType¶
class TransactionType(str, Enum):
INTRA_CPE = "INTRA_CPE" # Both resources behind the same DSO meter (no RESP tariff)
PUBLIC_CPE = "PUBLIC_CPE" # Resources behind different DSO meters (RESP tariff applies)
GranularityType¶
Used in load and energy data query endpoints.
class GranularityType(str, Enum):
MIN15 = "MIN15" # 15-minute intervals (raw data / ISP resolution)
HOURLY = "HOURLY" # Hourly aggregation
DAILY = "DAILY" # Daily aggregation
WEEKLY = "WEEKLY" # Weekly aggregation
MONTHLY = "MONTHLY" # Monthly aggregation
SetpointType¶
Types of energy setpoints produced by EMS modules.
class SetpointType(str, Enum):
PRODUCTION = "PRODUCTION"
CONSUMPTION = "CONSUMPTION"
STORAGE_CHARGE = "STORAGE_CHARGE"
STORAGE_DISCHARGE = "STORAGE_DISCHARGE"
EV_CHARGE = "EV_CHARGE"
EWH_HEATING = "EWH_HEATING"
ModuleCategory¶
class ModuleCategory(str, Enum):
OPTIMIZATION = "OPTIMIZATION"
MARKET_INTEGRATION = "MARKET_INTEGRATION"
FLEXIBILITY = "FLEXIBILITY"
ModuleMaturity¶
class ModuleMaturity(str, Enum):
PRODUCTION = "PRODUCTION"
BETA = "BETA"
DEVELOPMENT = "DEVELOPMENT"