From: Jérôme Benoit <jerome.benoit@sap.com>
Date: Thu, 7 Mar 2024 11:12:28 +0000 (+0100)
Subject: docs: document UI protocol simulator state RPC command
X-Git-Tag: v1.3.0~36
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=a997fb633645882785e12ea3362d428233476e7c;p=e-mobility-charging-stations-simulator.git

docs: document UI protocol simulator state RPC command

Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
---

diff --git a/README.md b/README.md
index 750ad8e2..675ac231 100644
--- 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: