Update dependencies

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

diff --git a/README.md b/README.md
index 9e9b07761341ad38a29626c7e282d5c402105bce..7873b31f337766396cb931f7a3f5bbbe52f09e37 100644 (file)
--- a/README.md
+++ b/README.md
@@ -34,8 +34,8 @@ All configuration files are in the JSON standard format.
 
 - charging stations simulator configuration: [src/assets/config.json](src/assets/config.json);
 - charging station configuration templates: [src/assets/station-templates](src/assets/station-templates);
-- charging station configurations: [src/assets/configurations](src/assets/configurations);
-- charging station RFID tags lists in [src/assets](src/assets).
+- charging station configurations: [dist/assets/configurations](dist/assets/configurations);
+- charging station RFID tags lists: [src/assets](src/assets).
 
 The charging stations simulator's configuration parameters must be within the `src/assets/config.json` file. A charging station simulator configuration template file is available at [src/assets/config-template.json](src/assets/config-template.json).
 
@@ -45,7 +45,7 @@ A list of RFID tags must be defined for the automatic transaction generator with
 
 **Configuration files hierarchy and priority**:
 
-1. charging station configuration: [src/assets/configurations](src/assets/configurations);
+1. charging station configuration: [dist/assets/configurations](dist/assets/configurations);
 2. charging station configuration template: [src/assets/station-templates](src/assets/station-templates);
 3. charging stations simulator configuration: [src/assets/config.json](src/assets/config.json).
 
@@ -134,6 +134,8 @@ But the modifications to test have to be done to the files in the build result d
 | autoReconnectMaxRetries           |            | -1 (unlimited)  | integer                           | connection retries to the OCPP-J server                                                                                                                                        |
 | reconnectExponentialDelay         | true/false | false           | boolean                           | connection delay retry to the OCPP-J server                                                                                                                                    |
 | registrationMaxRetries            |            | -1 (unlimited)  | integer                           | charging stations boot notification retries                                                                                                                                    |
+| amperageLimitationOcppKey         |            | undefined       | string                            | charging stations OCPP parameter key used to set the amperage limit, per phase for each connector on AC and global for DC                                                      |
+| amperageLimitationUnit            | A/cA/dA/mA | A               | string                            | charging stations amperage limit unit                                                                                                                                          |
 | enableStatistics                  | true/false | true            | boolean                           | enable charging stations statistics                                                                                                                                            |
 | mayAuthorizeAtRemoteStart         | true/false | true            | boolean                           | always send authorize at remote start transaction when AuthorizeRemoteTxRequests is enabled                                                                                    |
 | beginEndMeterValues               | true/false | false           | boolean                           | enable Transaction.{Begin,End} MeterValues                                                                                                                                     |
@@ -142,6 +144,7 @@ But the modifications to test have to be done to the files in the build result d
 | transactionDataMeterValues        | true/false | false           | boolean                           | enable transaction data MeterValues at stop transaction                                                                                                                        |
 | mainVoltageMeterValues            | true/false | true            | boolean                           | include charging stations main voltage MeterValues on three phased charging stations                                                                                           |
 | phaseLineToLineVoltageMeterValues | true/false | true            | boolean                           | include charging stations line to line voltage MeterValues on three phased charging stations                                                                                   |
+| customValueLimitationMeterValues  | true/false | true            | boolean                           | enable limitation on custom fluctuated value in MeterValues                                                                                                                    |
 | Configuration                     |            |                 | ChargingStationConfiguration      | charging stations OCPP parameters configuration section                                                                                                                        |
 | AutomaticTransactionGenerator     |            |                 | AutomaticTransactionGenerator     | charging stations ATG configuration section                                                                                                                                    |
 | Connectors                        |            |                 | Connectors                        | charging stations connectors configuration section                                                                                                                             |
@@ -221,9 +224,9 @@ But the modifications to test have to be done to the files in the build result d
 
 ### Charging station configuration
 
-**src/assets/configurations/\<hashId\>.json**:
+**dist/assets/configurations/\<hashId\>.json**:
 
-The charging station configuration file is automatically generated at startup from the charging station configuration template file.
+The charging station configuration file is automatically generated at startup from the charging station configuration template file and is persistent.
 
 The charging station configuration file content can be regenerated partially on matching charging station configuration template file changes. The charging station serial number is kept unchanged.
 
@@ -239,6 +242,9 @@ The syntax is similar to the charging station configuration template 'Configurat
 
 To start the program, run: `npm start`.
 
+To start the program with a UI controller, run: `npm start:server`.
+Then, start/stop the simulator by going to `https://<hostname:port>` in a browser. Localhost port will default to 8080. For Cloud Foundry, the port is assigned based on the `process.env.PORT` environment variable.
+
 ## Docker
 
 In the [docker](./docker) folder:
@@ -296,7 +302,7 @@ make SUBMODULES_INIT=true
 #### Smart Charging Profile
 
 - :white_check_mark: ClearChargingProfile
-- :white_check_mark: GetCompositeSchedule
+- :x: GetCompositeSchedule
 - :white_check_mark: SetChargingProfile
 
 #### Remote Trigger Profile