build(simulator): features for reserve-now and cancel-reservation support added

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

diff --git a/README.md b/README.md
index 336ac71d4db7c99f038fde63da59e2d9b830236d..9fb599ae77d2589ba89b5a3539e8b0977a6238da 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,6 +2,7 @@
 
 # [e-mobility charging stations simulator](https://github.com/sap/e-mobility-charging-stations-simulator)
 
+[![CI worklow](https://github.com/SAP/e-mobility-charging-stations-simulator/actions/workflows/ci.yml/badge.svg)](https://github.com/SAP/e-mobility-charging-stations-simulator/actions/workflows/ci.yml)
 [![REUSE status](https://api.reuse.software/badge/github.com/SAP/e-mobility-charging-stations-simulator)](https://api.reuse.software/info/github.com/SAP/e-mobility-charging-stations-simulator)
 
 ## Summary
@@ -182,11 +183,12 @@ 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": {
@@ -212,9 +214,9 @@ 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:
+##### Type definition:
 
 ```ts
 type AutomaticTransactionGeneratorConfiguration = {
@@ -231,7 +233,7 @@ type AutomaticTransactionGeneratorConfiguration = {
 };
 ```
 
-Section example:
+##### Example:
 
 ```json
   "AutomaticTransactionGenerator": {
@@ -248,7 +250,7 @@ Section example:
   }
 ```
 
-#### Connectors section
+#### Connectors section syntax example
 
 ```json
   "Connectors": {
@@ -280,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**:
@@ -347,8 +389,8 @@ make SUBMODULES_INIT=true
 
 #### Reservation Profile
 
-- :x: CancelReservation
-- :x: ReserveNow
+- :white_check_mark: CancelReservation
+- :white_check_mark: ReserveNow
 
 #### Smart Charging Profile
 
@@ -360,6 +402,21 @@ make SUBMODULES_INIT=true
 
 - :white_check_mark: TriggerMessage
 
+### Version 2.x.x
+
+#### Provisioning
+
+- :white_check_mark: BootNotification
+
+#### Authorization
+
+- :white_check_mark: ClearCache
+
+#### Availability
+
+- :white_check_mark: StatusNotification
+- :white_check_mark: Heartbeat
+
 ## OCPP-J standard parameters supported
 
 All kind of OCPP parameters are supported in a charging station configuration or a charging station configuration template file. The list here mention the standard ones also handled automatically in the simulator.
@@ -416,6 +473,8 @@ All kind of OCPP parameters are supported in a charging station configuration or
 
 - _none_
 
+### Version 2.x.x
+
 ## UI protocol
 
 Protocol to control the simulator via a Websocket or HTTP server.