d398a6ced2
- CitrineOS core extracted (CSMS OCPP 2.0.1) - OpenOCPP extracted (firmware OCPP 1.6J/2.0.1) - ShapeShifter library installed (pip install -e) - ShapeShifter specification extracted - EVerest extracted TODO updated with progress
87 lines
2.9 KiB
Python
87 lines
2.9 KiB
Python
from abc import ABC, abstractmethod
|
|
|
|
from ..client import ShapeshifterCroAgrClient, ShapeshifterCroDsoClient
|
|
from ..uftp import (
|
|
AgrPortfolioQuery,
|
|
AgrPortfolioUpdate,
|
|
DsoPortfolioQuery,
|
|
DsoPortfolioUpdate,
|
|
TestMessage,
|
|
TestMessageResponse,
|
|
UsefRole,
|
|
)
|
|
from .base_service import ShapeshifterService
|
|
|
|
|
|
class ShapeshifterCroService(ShapeshifterService, ABC):
|
|
"""
|
|
Service that represent the Common Reference Operator in the UFTP communication.
|
|
|
|
It can receive requests from the Aggregator and from the DSO.
|
|
"""
|
|
|
|
sender_role = UsefRole.CRO
|
|
acceptable_messages = [
|
|
DsoPortfolioQuery,
|
|
DsoPortfolioUpdate,
|
|
AgrPortfolioQuery,
|
|
AgrPortfolioUpdate,
|
|
TestMessage,
|
|
TestMessageResponse,
|
|
]
|
|
|
|
# ------------------------------------------------------------ #
|
|
# Methods related to Agr Portfolio Query messages #
|
|
# ------------------------------------------------------------ #
|
|
|
|
@abstractmethod
|
|
def process_agr_portfolio_query(self, message: AgrPortfolioQuery):
|
|
"""
|
|
The AGRPortfolioQuery is used by the AGR to retrieve
|
|
additional information on the connections.
|
|
"""
|
|
|
|
@abstractmethod
|
|
def process_agr_portfolio_update(self, message: AgrPortfolioUpdate):
|
|
"""
|
|
The AGRPortfolioUpdate is used by the AGR to indicate on which
|
|
Connections it represents prosumers.
|
|
"""
|
|
|
|
@abstractmethod
|
|
def process_dso_portfolio_query(self, message: DsoPortfolioQuery):
|
|
"""
|
|
DSOPortfolioQuery is used by DSOs to discover which AGRs represent
|
|
connections on its registered congestion point(s).
|
|
|
|
You should end this method by sending a
|
|
DsoPortfolioQueryResponse back to the DSO::
|
|
|
|
with self.get_dso_client(message.sender_domain) as client:
|
|
client.send_portfolio_query_response
|
|
"""
|
|
|
|
@abstractmethod
|
|
def process_dso_portfolio_update(self, message: DsoPortfolioUpdate):
|
|
"""
|
|
The DSOPortfolioUpdate is used by the DSO to indicate on which
|
|
congestion points it wants to engage in flexibility trading.
|
|
"""
|
|
|
|
# ------------------------------------------------------------ #
|
|
# Convenience methods for getting a client to the designated #
|
|
# participant. #
|
|
# ------------------------------------------------------------ #
|
|
|
|
def agr_client(self, recipient_domain, version="3.1.0") -> ShapeshifterCroAgrClient:
|
|
"""
|
|
Retrieve a client object for sending messages to the AGR.
|
|
"""
|
|
return self._get_client(recipient_domain, "AGR", version)
|
|
|
|
def dso_client(self, recipient_domain, version="3.1.0") -> ShapeshifterCroDsoClient:
|
|
"""
|
|
Retrieve a client object for sending messages to the DSO.
|
|
"""
|
|
return self._get_client(recipient_domain, "DSO", version)
|