Finished 2D Railway[Metro] System Real-world Emulator read me file an…

…d update the design document.
Omnind · Jul 25, 2023 · 2012291 · 2012291
1 parent aae8661
commit 2012291
Show file tree

Hide file tree

Showing 6 changed files with 75 additions and 1 deletion.
diff --git a/doc/designDoc.pptx b/doc/designDoc.pptx
diff --git a/doc/img/metroEmulator/collisionAvoid.png b/doc/img/metroEmulator/collisionAvoid.png
diff --git a/doc/img/metroEmulator/loadScenario.png b/doc/img/metroEmulator/loadScenario.png
diff --git a/doc/img/metroEmulator/trainPwrCtrl.png b/doc/img/metroEmulator/trainPwrCtrl.png
diff --git a/doc/metroEmuUI_readme.md b/doc/metroEmuUI_readme.md
@@ -8,7 +8,12 @@
 
 ### Introduction 
 
-2D Railway System Real-world Emulator User Interface
+The 2D Railway[Metro] System Real-world Emulator is part of the Railway IT/OT System security test platform. It is a OT system visualizer to simulate different kind of railway operation scenarios.  You can refer the system topology diagram to check its function in the system by below link:
+
+-  [Railway IT/OT System security test platform system structure diagram](img/networkCommDesign.png)
+- [Railway IT/OT System security test platform network topology diagram](img/networkDesign.png)
+
+**2D Railway System Real-world Emulator User Interface:**
 
 ![](video/connectionHub5.gif)
 
@@ -103,6 +108,54 @@ Network interface requirement:
 
 
 
+------
+
+### Program Usage
+
+
+
+##### Edit Configuration File 
+
+Open config file `metroConfig.txt`,  if you want to run this program individually, set the test mode flag `TEST_MD` to True. If you want to connect to other modules such as the PLCs, please set the flag to False.
+
+
+
+##### Program Execution 
+
+After follow the instruction in the file `metroConfig.txt` to setup all the parameters, you can run the program: 
+
+```
+python MetroEmuRun.py
+```
+
+or double click the file `runMetroEmuUI_win.bat`
+
+
+
+##### Interface Usage
+
+Please to refer to the [2D Railway[Metro] System Real-world Emulator User Manual]() to check the detail usage for all the functions. Below are some of the usage functions: 
+
+**Function 1**: Change Train power or reset train position: 
+
+ ![](img/metroEmulator/trainPwrCtrl.png)
+
+**Function 2:**  ON/OFF the train collision auto-avoidance : 
+
+![](img/metroEmulator/collisionAvoid.png)
+
+**Function 3 :** Load Pre-saved scenario in the system
+
+![](img/metroEmulator/loadScenario.png)
+
+
+
+------
+
+#### Problem and Solution
+
+Refer to `doc/ProblemAndSolution.md`
+
 
 
 ------

diff --git a/src/metroEmuUI/readme.md b/src/metroEmuUI/readme.md
@@ -0,0 +1,21 @@
+# 2D Railway[Metro] System Real-world Emulator
+
+### Introduction 
+
+**Please refer to the 2D Railway[Metro] System Real-world Emulator Readme file in the document fold with the below section: ** 
+
+- Introduction
+- Program design 
+- Program Setup steps
+- Execute the program
+- Problem and solution
+
+**Click below link to jump to the  readme file:** 
+
+[ 2D Railway[Metro] System Real-world Emulator Readme file ](../../doc/metroEmuUI_readme.md)
+
+
+
+------
+
+> last edit by LiuYuancheng ([email protected]) by 25/07/2023 if you have any problem, please send me a message.