Document simulator configuration for Web UI usage.

Reference: #333

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

diff --git a/package-lock.json b/package-lock.json
index b16981141e689e222c8e3bc17033a3f0e29722f0..b7dbb4990484019a6715ecb3555bdb0c5876b75f 100644 (file)
--- a/package-lock.json
+++ b/package-lock.json
@@ -63,9 +63,9 @@
         "mocha": "^10.2.0",
         "mochawesome": "^7.1.3",
         "prettier": "^2.8.1",
-        "release-it": "^15.5.1",
+        "release-it": "^15.6.0",
         "robohydra": "^0.6.9",
-        "rollup": "^3.8.1",
+        "rollup": "^3.9.0",
         "rollup-plugin-analyzer": "^4.0.0",
         "rollup-plugin-copy": "^3.4.0",
         "rollup-plugin-delete": "^2.0.0",
@@ -13148,9 +13148,9 @@
       "dev": true
     },
     "node_modules/release-it": {
-      "version": "15.5.1",
-      "resolved": "https://registry.npmjs.org/release-it/-/release-it-15.5.1.tgz",
-      "integrity": "sha512-1X1oyqay/amJh/V+xkSU9zN6LqGmLQJ0Q40+FaHE6+Pu6QCmgX9HbrpHxvF0HZeXkB5cdhHjmYsPbHnUQLRnYg==",
+      "version": "15.6.0",
+      "resolved": "https://registry.npmjs.org/release-it/-/release-it-15.6.0.tgz",
+      "integrity": "sha512-NXewgzO8QV1LOFjn2K7/dgE1Y1cG+2JiLOU/x9X/Lq9UdFn2hTH1r9SSrufCxG+y/Rp+oN8liYTsNptKrj92kg==",
       "dev": true,
       "dependencies": {
         "@iarna/toml": "2.2.5",
@@ -13159,7 +13159,6 @@
         "chalk": "5.1.2",
         "cosmiconfig": "8.0.0",
         "execa": "6.1.0",
-        "form-data": "4.0.0",
         "git-url-parse": "13.1.0",
         "globby": "13.1.2",
         "got": "12.5.3",
@@ -14335,9 +14334,9 @@
       }
     },
     "node_modules/rollup": {
-      "version": "3.8.1",
-      "resolved": "https://registry.npmjs.org/rollup/-/rollup-3.8.1.tgz",
-      "integrity": "sha512-4yh9eMW7byOroYcN8DlF9P/2jCpu6txVIHjEqquQVSx7DI0RgyCCN3tjrcy4ra6yVtV336aLBB3v2AarYAxePQ==",
+      "version": "3.9.0",
+      "resolved": "https://registry.npmjs.org/rollup/-/rollup-3.9.0.tgz",
+      "integrity": "sha512-nGGylpmblyjTpF4lEUPgmOw6OVxRvnI6Iuuh6Lz4O/X66cVOX1XJSsqP1YamxQ+mPuFE7qJxLFDSCk8rNv5dDw==",
       "dev": true,
       "bin": {
         "rollup": "dist/bin/rollup"
@@ -27763,9 +27762,9 @@
       "dev": true
     },
     "release-it": {
-      "version": "15.5.1",
-      "resolved": "https://registry.npmjs.org/release-it/-/release-it-15.5.1.tgz",
-      "integrity": "sha512-1X1oyqay/amJh/V+xkSU9zN6LqGmLQJ0Q40+FaHE6+Pu6QCmgX9HbrpHxvF0HZeXkB5cdhHjmYsPbHnUQLRnYg==",
+      "version": "15.6.0",
+      "resolved": "https://registry.npmjs.org/release-it/-/release-it-15.6.0.tgz",
+      "integrity": "sha512-NXewgzO8QV1LOFjn2K7/dgE1Y1cG+2JiLOU/x9X/Lq9UdFn2hTH1r9SSrufCxG+y/Rp+oN8liYTsNptKrj92kg==",
       "dev": true,
       "requires": {
         "@iarna/toml": "2.2.5",
@@ -27774,7 +27773,6 @@
         "chalk": "5.1.2",
         "cosmiconfig": "8.0.0",
         "execa": "6.1.0",
-        "form-data": "4.0.0",
         "git-url-parse": "13.1.0",
         "globby": "13.1.2",
         "got": "12.5.3",
@@ -28574,9 +28572,9 @@
       }
     },
     "rollup": {
-      "version": "3.8.1",
-      "resolved": "https://registry.npmjs.org/rollup/-/rollup-3.8.1.tgz",
-      "integrity": "sha512-4yh9eMW7byOroYcN8DlF9P/2jCpu6txVIHjEqquQVSx7DI0RgyCCN3tjrcy4ra6yVtV336aLBB3v2AarYAxePQ==",
+      "version": "3.9.0",
+      "resolved": "https://registry.npmjs.org/rollup/-/rollup-3.9.0.tgz",
+      "integrity": "sha512-nGGylpmblyjTpF4lEUPgmOw6OVxRvnI6Iuuh6Lz4O/X66cVOX1XJSsqP1YamxQ+mPuFE7qJxLFDSCk8rNv5dDw==",
       "dev": true,
       "requires": {
         "fsevents": "~2.3.2"

diff --git a/package.json b/package.json
index 6e537a6d7237266237ab8620ea071bf674f72496..86f6fe4985dd45a74a5064846d0acd487b00bf9b 100644 (file)
--- a/package.json
+++ b/package.json
@@ -130,9 +130,9 @@
     "mocha": "^10.2.0",
     "mochawesome": "^7.1.3",
     "prettier": "^2.8.1",
-    "release-it": "^15.5.1",
+    "release-it": "^15.6.0",
     "robohydra": "^0.6.9",
-    "rollup": "^3.8.1",
+    "rollup": "^3.9.0",
     "rollup-plugin-analyzer": "^4.0.0",
     "rollup-plugin-copy": "^3.4.0",
     "rollup-plugin-delete": "^2.0.0",

diff --git a/ui/web/README.md b/ui/web/README.md
index b14f6e4e3dc9de8889436a07e6cd92c61fe717a6..5b7f5d6f3d8bdfe8a703ba70721e77f44d0597cf 100644 (file)
--- a/ui/web/README.md
+++ b/ui/web/README.md
@@ -6,6 +6,23 @@
 npm install
 ```
 
+The simulator UI server must be enabled, use WebSocket and disable authentication. The simulator main configuration file should have a `uiServer` section like this:
+
+```json
+  "uiServer": {
+    "enabled": true,
+    "type": "ws",
+    "authentication": {
+      "enabled": false,
+      "type": "basic-auth",
+      "username": "admin",
+      "password": "admin"
+    }
+  },
+```
+
+See [here](../README.md#charging-stations-simulator-configuration) for more details.
+
 ### Run
 
 For both solution you can then follow the link displayed in the terminal at the end of compilation