docs: document UI protocol simulator state RPC command

[e-mobility-charging-stations-simulator.git] / README.md

diff --git a/README.md b/README.md
index 750ad8e2968c5017a1101f864706cf357441ff4b..675ac231a06d09bfab90935a42175a7df9ed244d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -531,6 +531,22 @@ Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
 
 ##### Procedures
 
+###### Simulator State
+
+- Request:  
+  `ProcedureName`: 'simulatorState'  
+  `PDU`: {}
+
+- Response:  
+  `PDU`: {  
+   `status`: 'success' | 'failure'  
+   `state`: {  
+   `version`: string  
+   `started`: boolean  
+   `templateStatistics`: Record<string, TemplateStatistics>  
+   }  
+  }
+
 ###### Start Simulator
 
 - Request: