Merge pull request #777 from ie3-institute/sp/#776-ext-sim-next-tick

External simulation: Providing information about next tick of MobSim
ie3-institute · Aug 15, 2024 · 53ef1af · 53ef1af
2 parents 4973d89 + d4308df
commit 53ef1af
Show file tree

Hide file tree

Showing 30 changed files with 677 additions and 1,482 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -71,6 +71,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Merged `HpModelTestData` with `HpTestData` to `HpInputTestData` [#872](https://github.com/ie3-institute/simona/issues/872)
 - Harmonised both methods that check the inner temperature of thermal house against the boundaries [#880](https://github.com/ie3-institute/simona/issues/880)
 - Convert all `eval-rst` instances in rtd to myst syntax [#901](https://github.com/ie3-institute/simona/issues/901)
+- External simulation should provide information about next tick of MobSim [#776](https://github.com/ie3-institute/simona/issues/776)
 
 ### Fixed
 - Removed a repeated line in the documentation of vn_simona config [#658](https://github.com/ie3-institute/simona/issues/658)

diff --git a/build.gradle b/build.gradle
@@ -89,7 +89,7 @@ dependencies {
     exclude group: 'edu.ie3'
   }
 
-  implementation('com.github.ie3-institute:simonaAPI:0.4.0') {
+  implementation('com.github.ie3-institute:simonaAPI:0.5.0') {
     exclude group: 'org.apache.logging.log4j'
     exclude group: 'org.slf4j'
     /* Exclude our own nested dependencies */

diff --git a/docs/uml/main/ExtEvSimulationClasses.puml b/docs/uml/main/ExtEvSimulationClasses.puml
@@ -27,7 +27,7 @@ package ev-simulation {
 package simona-api {
     ' MIDDLE PART
     class ExtEvData {
-        ~ LinkedBlockingQueue<ExtEvResponseMessage> receiveTriggerQueue
+        ~ LinkedBlockingQueue<EvDataResponseMessageToExt> receiveTriggerQueue
         - ActorRef dataService
         - ActorRef extSimAdapter
         + List<UUID> requestAvailablePublicEvCs()
@@ -119,33 +119,33 @@ package simona-api {
     EvModelImpl --|> EvModel
 
 
-    interface ExtEvMessage
+    interface EvDataMessageFromExt
     class EvMovementsMessage {
         - Map<UUID, List<EvMovement>> movements
     }
     class RequestEvcsFreeLots
-    RequestEvcsFreeLots --|> ExtEvMessage
-    EvMovementsMessage --|> ExtEvMessage
+    RequestEvcsFreeLots --|> EvDataMessageFromExt
+    EvMovementsMessage --|> EvDataMessageFromExt
     RequestEvcsFreeLots -[hidden]> EvMovementsMessage
 
-    interface ExtEvResponseMessage
+    interface EvDataResponseMessageToExt
     class AllDepartedEvsRepsonse {
         - Map<UUID, List<EvMovement>> movements
     }
     class ProvideEvcsFreeLots
-    ProvideEvcsFreeLots --|> ExtEvResponseMessage
-    AllDepartedEvsRepsonse --|> ExtEvResponseMessage
-    ExtEvData -> ExtEvMessage
-    ExtEvData -> ExtEvResponseMessage
+    ProvideEvcsFreeLots --|> EvDataResponseMessageToExt
+    AllDepartedEvsRepsonse --|> EvDataResponseMessageToExt
+    ExtEvData -> EvDataMessageFromExt
+    ExtEvData -> EvDataResponseMessageToExt
     EvMovement -[hidden]-> RequestEvcsFreeLots
-    ExtEvMessage -[hidden]> ExtEvResponseMessage
+    EvDataMessageFromExt -[hidden]> EvDataResponseMessageToExt
     EvMovementsMessage -[hidden]> ProvideEvcsFreeLots
     ProvideEvcsFreeLots -[hidden]> AllDepartedEvsRepsonse
 
     class ScheduleDataServiceMessage {
         - ExtEvDataService dataService
     }
-    ExtEvResponseMessage -[hidden]> ScheduleDataServiceMessage
+    EvDataResponseMessageToExt -[hidden]> ScheduleDataServiceMessage
     ExtEvData -> ScheduleDataServiceMessage
 
 
@@ -158,10 +158,10 @@ package simona-api {
     ExtLink --|> ExtLinkInterface
 
     interface ExtTrigger
-    class ActivityStartTrigger {
+    class ActivationMessage {
         - Long tick
     }
-    ActivityStartTrigger --|> ExtTrigger
+    ActivationMessage --|> ExtTrigger
 
     interface ExtTriggerResponse
     class CompletionMessage {
@@ -188,7 +188,7 @@ package simona {
 
     class SimonaSim
 
-    class SimScheduler
+    class Scheduler
 
     class SimonaStandaloneSetup
 
@@ -198,12 +198,12 @@ package simona {
 
     class ExtEvDataService
 
-    SimScheduler -- SimonaSim
+    Scheduler -- SimonaSim
     SimonaSim *- SimonaStandaloneSetup
     SimonaStandaloneSetup *- ExtSimLoader
 
-    ExtSimAdapter -- SimScheduler
-    ExtEvDataService -- SimScheduler
+    ExtSimAdapter -- Scheduler
+    ExtEvDataService -- Scheduler
 
     SecondaryData <|-- EvMovementData
 

diff --git a/docs/uml/protocol/ExtEvSimulationSequence.puml b/docs/uml/protocol/ExtEvSimulationSequence.puml
@@ -2,97 +2,201 @@
 
 !theme plain
 
+participant Scheduler
+participant ExtSimAdapter
+participant ExtSimulation
+participant ExtEvDataService
+participant EvcsAgent1
+participant EvcsAgent2
+
 ==Init==
-SimScheduler -> ExtSimAdapter: <font color=red>!</font> <font color=green>ActivityStartTrigger(-1L)</font>
+Scheduler -> EvcsAgent1: <font color=red>!</font> Activation(-1)
+activate EvcsAgent1
+
+EvcsAgent1 -> ExtEvDataService: <font color=red>!</font> RegisterForEvDataMessage
+deactivate EvcsAgent1
+
+Scheduler -> EvcsAgent2: <font color=red>!</font> Activation(-1)
+activate EvcsAgent2
+
+EvcsAgent2 -> ExtEvDataService: <font color=red>!</font> RegisterForEvDataMessage
+deactivate EvcsAgent2
+
+Scheduler -> ExtSimAdapter: <font color=red>!</font> <font color=green>Activation(-1)</font>
 activate ExtSimAdapter
 
-ExtSimAdapter -> ExtSimulation: queue(ActivityStartTrigger(-1L))
+ExtSimAdapter -> ExtSimulation: queue(ActivationMessage(-1))
 deactivate ExtSimAdapter
 activate ExtSimulation
+
 ... Initialize external mobility simulation ...
+ExtSimulation -> ExtEvDataService: ProvideArrivingEvs(_, t1)
 
-ExtSimulation -> ExtSimAdapter: <font color=red>!</font> CompletionMessage(newTriggers)
-deactivate ExtSimulation
+ExtSimulation -> ExtSimAdapter: <font color=red>!</font> ScheduleDataServiceMessage(\n\tdataServiceRef\n)
 activate ExtSimAdapter
 
-ExtSimAdapter -> SimScheduler: <font color=red>!</font> <font color=green>CompletionMessage(newTriggers)</font>
+ExtSimAdapter -> Scheduler: <font color=red>!</font> ScheduleActivation(\n\t_, dataServiceRef)
 deactivate ExtSimAdapter
+activate Scheduler
+
+Scheduler -> ExtEvDataService: <font color=red>!</font> Activation(t1)
+deactivate Scheduler
+activate ExtEvDataService
 
-==Sim==
-SimScheduler -> ExtSimAdapter: <font color=red>!</font> <font color=green>ActivityStartTrigger(tick)</font>
+ExtSimulation -> ExtSimAdapter: <font color=red>!</font> CompletionMessage(newTriggers)
+deactivate ExtSimulation
 activate ExtSimAdapter
 
-ExtSimAdapter -> ExtSimulation: queue(ActivityStartTrigger(tick))
+ExtSimAdapter -> Scheduler: <font color=red>!</font> <font color=green>Completion(newTriggers)</font>
 deactivate ExtSimAdapter
 
-activate ExtSimulation
-ExtSimulation -> ExtEvDataService: <font color=red>!</font> RequestEvcsFreeLots
-ExtSimulation -> ExtSimAdapter: <font color=red>!</font> ScheduleDataServiceMessage(\n\tdataServiceRef\n)
-
-activate ExtSimAdapter
-ExtSimAdapter -> SimScheduler: <font color=red>!</font> ScheduleTriggerMessage(\n\t_, dataServiceRef)
-deactivate ExtSimAdapter
+ExtEvDataService -> EvcsAgent1: <font color=red>!</font> RegistrationSuccessfulMessage(t1)
+activate EvcsAgent1
 
-activate SimScheduler
-SimScheduler -> ExtEvDataService: <font color=red>!</font> ActivityStartTrigger(tick)
-deactivate SimScheduler
+EvcsAgent1 -> Scheduler: <font color=red>!</font> Completion(t1)
+deactivate EvcsAgent1
 
-activate ExtEvDataService
-ExtEvDataService -> EvcsAgent1: <font color=red>!</font> EvFreeLotsRequest(tick)
-activate EvcsAgent1
-ExtEvDataService -> EvcsAgent2: <font color=red>!</font> EvFreeLotsRequest(tick)
+ExtEvDataService -> EvcsAgent2: <font color=red>!</font> RegistrationSuccessfulMessage(t1)
 activate EvcsAgent2
 
-ExtEvDataService -> SimScheduler: <font color=red>!</font> CompletionMessage(None)
-
-EvcsAgent2 -> ExtEvDataService: <font color=red>!</font> FreeLotsResponse(_, _)
+EvcsAgent2 -> Scheduler: <font color=red>!</font> Completion(t1)
 deactivate EvcsAgent2
-EvcsAgent1 -> ExtEvDataService: <font color=red>!</font> FreeLotsResponse(_, _)
-deactivate EvcsAgent1
-ExtEvDataService -> ExtSimulation: queue(ProvideEvcsFreeLots(_))
+
+ExtEvDataService -> Scheduler: <font color=red>!</font> Completion(None)
 deactivate ExtEvDataService
 
-... Running external mobility simulation,\n determining EV positions ...
-ExtSimulation -> ExtEvDataService: <font color=red>!</font> EvMovementsMessage(_)
-ExtSimulation -> ExtSimAdapter: <font color=red>!</font> ScheduleDataServiceMessage(\n\tdataServiceRef\n)
+==Simulation==
+Scheduler -> EvcsAgent1: <font color=red>!</font> Activation(t1)
+Scheduler -> EvcsAgent2: <font color=red>!</font> Activation(t1)
 
+Scheduler -> ExtSimAdapter: <font color=red>!</font> <font color=green>Activation(t1)</font>
 activate ExtSimAdapter
-ExtSimAdapter -> SimScheduler: <font color=red>!</font> ScheduleTriggerMessage(\n\t_, dataServiceRef)
+
+ExtSimAdapter -> ExtSimulation: queue(ActivationMessage(t1))
 deactivate ExtSimAdapter
+activate ExtSimulation
 
-activate SimScheduler
-SimScheduler -> ExtEvDataService: <font color=red>!</font> ActivityStartTrigger(tick)
-deactivate SimScheduler
+group Request free lots
+    ExtSimulation -> ExtEvDataService: <font color=red>!</font> RequestEvcsFreeLots
 
-activate ExtEvDataService
-ExtEvDataService -> EvcsAgent1: <font color=red>!</font> ProvideEvDataMessage(\n\ttick, _)
-ExtEvDataService -> EvcsAgent2: <font color=red>!</font> ProvideEvDataMessage(\n\ttick, _)
-ExtEvDataService -> SimScheduler: <font color=red>!</font> CompletionMessage(evcsTriggers)
-deactivate ExtEvDataService
+    ExtSimulation -> ExtSimAdapter: <font color=red>!</font> ScheduleDataServiceMessage(\n\tdataServiceRef\n)
+    activate ExtSimAdapter
 
-activate SimScheduler
-SimScheduler -> EvcsAgent1: <font color=red>!</font> ActivityStartTrigger(tick)
-activate EvcsAgent1
-SimScheduler -> EvcsAgent2: <font color=red>!</font> ActivityStartTrigger(tick)
-deactivate SimScheduler
+    ExtSimAdapter -> Scheduler: <font color=red>!</font> ScheduleActivation(\n\t_, dataServiceRef)
+    deactivate ExtSimAdapter
+    activate Scheduler
 
-activate EvcsAgent2
-EvcsAgent1 -> SimScheduler: <font color=red>!</font> CompletionMessage(None)
-deactivate EvcsAgent1
+    Scheduler -> ExtEvDataService: <font color=red>!</font> Activation(t1)
+    deactivate Scheduler
+    activate ExtEvDataService
 
-EvcsAgent2 -> ExtEvDataService: <font color=red>!</font> DepartedEvsResponse(_, _)
-activate ExtEvDataService
-EvcsAgent2 -> SimScheduler: <font color=red>!</font> CompletionMessage(None)
-deactivate EvcsAgent2
+    ExtEvDataService -> EvcsAgent1: <font color=red>!</font> EvFreeLotsRequest(t1)
+    activate EvcsAgent1
 
-ExtEvDataService -> ExtSimulation: queue(AllDepartedEvsResponse(_))
-deactivate ExtEvDataService
+    ExtEvDataService -> EvcsAgent2: <font color=red>!</font> EvFreeLotsRequest(t1)
+    activate EvcsAgent2
 
-ExtSimulation -> ExtSimAdapter: <font color=red>!</font> CompletionMessage(newTriggers)
-deactivate ExtSimulation
+    ExtEvDataService -> Scheduler: <font color=red>!</font> Completion(None)
+
+    EvcsAgent2 -> ExtEvDataService: <font color=red>!</font> FreeLotsResponse(_, _)
+    deactivate EvcsAgent2
+
+    EvcsAgent1 -> ExtEvDataService: <font color=red>!</font> FreeLotsResponse(_, _)
+    deactivate EvcsAgent1
+
+    ExtEvDataService -> ExtSimulation: queue(ProvideEvcsFreeLots(_))
+    deactivate ExtEvDataService
+end
+
+group Request current prices (dummy implementation)
+    ExtSimulation -> ExtEvDataService: <font color=red>!</font> RequestCurrentPrices
+
+    ExtSimulation -> ExtSimAdapter: <font color=red>!</font> ScheduleDataServiceMessage(\n\tdataServiceRef\n)
+    activate ExtSimAdapter
+
+    ExtSimAdapter -> Scheduler: <font color=red>!</font> ScheduleActivation(\n\t_, dataServiceRef)
+    deactivate ExtSimAdapter
+    activate Scheduler
+
+    Scheduler -> ExtEvDataService: <font color=red>!</font> Activation(t1)
+    deactivate Scheduler
+    activate ExtEvDataService
+
+    ExtEvDataService -> ExtSimulation: queue(ProvideCurrentPrices(_))
+
+    ExtEvDataService -> Scheduler: <font color=red>!</font> Completion(None)
+
+    deactivate ExtEvDataService
+end
+
+group Request departing EVs
+    ExtSimulation -> ExtEvDataService: <font color=red>!</font> RequestDepartingEvs
+
+    ExtSimulation -> ExtSimAdapter: <font color=red>!</font> ScheduleDataServiceMessage(\n\tdataServiceRef\n)
+    activate ExtSimAdapter
+
+    ExtSimAdapter -> Scheduler: <font color=red>!</font> ScheduleActivation(\n\t_, dataServiceRef)
+    deactivate ExtSimAdapter
+    activate Scheduler
+
+    Scheduler -> ExtEvDataService: <font color=red>!</font> Activation(t1)
+    deactivate Scheduler
+    activate ExtEvDataService
 
+    ExtEvDataService -> EvcsAgent1: <font color=red>!</font> DepartingEvsRequest(t1)
+    activate EvcsAgent1
+
+    ExtEvDataService -> EvcsAgent2: <font color=red>!</font> DepartingEvsRequest(t1)
+    activate EvcsAgent2
+
+    ExtEvDataService -> Scheduler: <font color=red>!</font> Completion(None)
+
+    EvcsAgent2 -> ExtEvDataService: <font color=red>!</font> DepartingEvsResponse(_, _)
+    deactivate EvcsAgent2
+
+    EvcsAgent1 -> ExtEvDataService: <font color=red>!</font> DepartingEvsResponse(_, _)
+    deactivate EvcsAgent1
+
+    ExtEvDataService -> ExtSimulation: queue(ProvideDepartingEvs(_))
+    deactivate ExtEvDataService
+end
+
+... Running external mobility simulation,\n determining EV positions ...
+
+group Provide arriving EVs
+    ExtSimulation -> ExtEvDataService: <font color=red>!</font> ProvideArrivingEvs(_)
+    ExtSimulation -> ExtSimAdapter: <font color=red>!</font> ScheduleDataServiceMessage(\n\tdataServiceRef\n)
+    activate ExtSimAdapter
+
+    ExtSimAdapter -> Scheduler: <font color=red>!</font> ScheduleActivation(\n\t_, dataServiceRef)
+    deactivate ExtSimAdapter
+    activate Scheduler
+
+    Scheduler -> ExtEvDataService: <font color=red>!</font> Activation(t1)
+    deactivate Scheduler
+    activate ExtEvDataService
+
+    ExtEvDataService -> EvcsAgent1: <font color=red>!</font> ProvideEvDataMessage(evs, t2)
+    activate EvcsAgent1
+
+    ExtEvDataService -> EvcsAgent2: <font color=red>!</font> ProvideEvDataMessage(evs, t2)
+    activate EvcsAgent2
+
+    ExtEvDataService -> Scheduler: <font color=red>!</font> Completion(None)
+    deactivate ExtEvDataService
+
+    EvcsAgent1 -> Scheduler: <font color=red>!</font> Completion(t2)
+    deactivate EvcsAgent1
+
+    EvcsAgent2 -> Scheduler: <font color=red>!</font> Completion(t2)
+    deactivate EvcsAgent2
+end
+
+ExtSimulation -> ExtSimAdapter: <font color=red>!</font> CompletionMessage(t2)
+deactivate ExtSimulation
 activate ExtSimAdapter
-ExtSimAdapter -> SimScheduler: <font color=red>!</font> <font color=green>CompletionMessage(newTriggers)</font>
+
+ExtSimAdapter -> Scheduler: <font color=red>!</font> <font color=green>Completion(t2)</font>
 deactivate ExtSimAdapter
 
 @enduml
diff --git a/src/main/scala/edu/ie3/simona/agent/grid/GridAgentController.scala b/src/main/scala/edu/ie3/simona/agent/grid/GridAgentController.scala
@@ -14,7 +14,7 @@ import edu.ie3.simona.agent.EnvironmentRefs
 import edu.ie3.simona.agent.em.EmAgent
 import edu.ie3.simona.agent.participant.ParticipantAgent.ParticipantMessage
 import edu.ie3.simona.agent.participant.data.secondary.SecondaryDataService.{
-  ActorEvMovementsService,
+  ActorExtEvDataService,
   ActorWeatherService,
 }
 import edu.ie3.simona.agent.participant.evcs.EvcsAgent
@@ -666,7 +666,7 @@ class GridAgentController(
             modelConfiguration,
             primaryServiceProxy,
             Iterable(
-              ActorEvMovementsService(
+              ActorExtEvDataService(
                 evMovementsService
               )
             ),