docs: document evses template configuration section

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

diff --git a/README.md b/README.md
index 49f799b9eede1da60c67d14fb2c2b1bc918ed696..9e514fed2af1ec08c821528ebdd85b977be83c3c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -34,10 +34,11 @@ brew install node
 
 ## Installation
 
-Enable corepack if not already done:
+Enable corepack if not already done and install latest pnpm version:
 
 ```shell
 corepack enable
+corepack prepare pnpm@latest --activate
 ```
 
 In the repository root, run the following command:
@@ -181,11 +182,13 @@ But the modifications to test have to be done to the files in the build target d
 | firmwareUpgrade                    |               | {<br />"versionUpgrade": {<br />"step": 1<br />},<br />"reset": true<br />}                                                         | {<br />versionUpgrade: {<br />patternGroup: number;<br />step: number;<br />};<br />reset: boolean;<br />failureStatus: 'DownloadFailed' \| 'InstallationFailed';<br />} | Configuration section for simulating firmware upgrade support.                                                                                                                                                                      |
 | commandsSupport                    |               | {<br />"incomingCommands": {},<br />"outgoingCommands": {}<br />}                                                                   | {<br /> incomingCommands: Record<IncomingRequestCommand, boolean>;<br />outgoingCommands?: Record<RequestCommand, boolean>;<br />}                                       | Configuration section for OCPP commands support. Empty section or subsections means all implemented OCPP commands are supported                                                                                                     |
 | messageTriggerSupport              |               | {}                                                                                                                                  | Record<MessageTrigger, boolean>                                                                                                                                          | Configuration section for OCPP commands trigger support. Empty section means all implemented OCPP trigger commands are supported                                                                                                    |
-| Configuration                      |               |                                                                                                                                     | ChargingStationConfiguration                                                                                                                                             | charging stations OCPP parameters configuration section                                                                                                                                                                             |
-| AutomaticTransactionGenerator      |               |                                                                                                                                     | AutomaticTransactionGenerator                                                                                                                                            | charging stations ATG configuration section                                                                                                                                                                                         |
-| Connectors                         |               |                                                                                                                                     | Connectors                                                                                                                                                               | charging stations connectors configuration section                                                                                                                                                                                  |
+| Configuration                      |               |                                                                                                                                     | ChargingStationOcppConfiguration                                                                                                                                         | charging stations OCPP parameters configuration section                                                                                                                                                                             |
+| AutomaticTransactionGenerator      |               |                                                                                                                                     | AutomaticTransactionGeneratorConfiguration                                                                                                                               | charging stations ATG configuration section                                                                                                                                                                                         |
+| Connectors                         |               |                                                                                                                                     | Record<string, ConnectorStatus>                                                                                                                                          | charging stations connectors configuration section                                                                                                                                                                                  |
+| Evses                              |               |                                                                                                                                     | Record<string, EvseTemplate>                                                                                                                                             | charging stations EVSEs configuration section                                                                                                                                                                                       |
+|                                    |
 
-#### Configuration section
+#### Configuration section syntax example
 
 ```json
   "Configuration": {
@@ -211,7 +214,7 @@ But the modifications to test have to be done to the files in the build target d
   }
 ```
 
-#### AutomaticTransactionGenerator section
+#### AutomaticTransactionGenerator section syntax example
 
 Section type definition:
 
@@ -247,7 +250,7 @@ Section example:
   }
 ```
 
-#### Connectors section
+#### Connectors section syntax example
 
 ```json
   "Connectors": {
@@ -266,7 +269,8 @@ Section example:
         ...
         {
           "unit": "A",
-          "measurand": "Current.Import"
+          "measurand": "Current.Import",
+          "minimum": "0.5"
         },
         ...
         {
@@ -278,6 +282,46 @@ Section example:
   },
 ```
 
+#### Evses section syntax example
+
+```json
+  "Evses": {
+    "0": {
+      "Connectors": {
+        "0": {}
+      }
+    },
+    "1": {
+      "Connectors": {
+        "1": {
+          "bootStatus": "Available",
+          "MeterValues": [
+            ...
+            {
+              "unit": "W",
+              "measurand": "Power.Active.Import",
+              "phase": "L1-N",
+              "value": "5000",
+              "fluctuationPercent": "10"
+            },
+            ...
+            {
+              "unit": "A",
+              "measurand": "Current.Import",
+              "minimum": "0.5"
+            },
+            ...
+            {
+              "unit": "Wh"
+            },
+            ...
+          ]
+        }
+      }
+    }
+  },
+```
+
 ### Charging station configuration
 
 **dist/assets/configurations/\<hashId\>.json**: