README.md: Spell fixes
authorJérôme Benoit <jerome.benoit@sap.com>
Thu, 17 Mar 2022 15:23:59 +0000 (16:23 +0100)
committerJérôme Benoit <jerome.benoit@sap.com>
Thu, 17 Mar 2022 15:23:59 +0000 (16:23 +0100)
Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
README.md

index a264c708822d8d23b92e79d4a713dfecc2cc25e5..1985cfd2712c362d6ccc6c2aa6e03bf7b5fa5531 100644 (file)
--- a/README.md
+++ b/README.md
@@ -32,10 +32,10 @@ All configuration files are in the JSON standard format.
 
 **Configuration files list**:
 
-- charging station simulator configuration: [src/assets/config.json](src/assets/config.json);
+- 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 list in [src/assets](src/assets).
+- charging station RFID tags lists in [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).
 
@@ -47,17 +47,17 @@ A list of RFID tags must be defined for the automatic transaction generator with
 
 1. charging station configuration: [src/assets/configurations](src/assets/configurations);
 2. charging station configuration template: [src/assets/station-templates](src/assets/station-templates);
-3. charging station simulator configuration: [src/assets/config.json](src/assets/config.json).
+3. charging stations simulator configuration: [src/assets/config.json](src/assets/config.json).
 
 The charging stations simulator have an automatic configuration files reload feature at change for:
 
-- charging station simulator configuration;
+- charging stations simulator configuration;
 - charging station configuration templates;
-- charging station authorization RFID tags list.
+- charging station authorization RFID tags lists.
 
 But the modifications to test have to be done to the files in the build result directory [dist/assets](dist/assets). Once the modifications are finished, they have to be reported or copied to the matching files in the build source directory [src/assets](src/assets) to ensure they will be taken into account at next build.
 
-### Charging station simulator configuration
+### Charging stations simulator configuration
 
 **src/assets/config.json**:
 
@@ -99,52 +99,52 @@ But the modifications to test have to be done to the files in the build result d
 
 **src/assets/station-templates/\<name\>.json**:
 
-| Key                               | Value(s)   | Default Value   | Value type                        | Description                                                                                                                                                                   |
-| --------------------------------- | ---------- | --------------- | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| supervisionUrls                   |            | ''              | string \| string[]                | string or array of connection URIs to OCPP-J servers                                                                                                                          |
-| supervisionUser                   |            | ''              | string                            | basic HTTP authentication user to OCPP-J server                                                                                                                               |
-| supervisionPassword               |            | ''              | string                            | basic HTTP authentication password to OCPP-J server                                                                                                                           |
-| supervisionUrlOcppConfiguration   | true/false | false           | boolean                           | allow supervision URL configuration via a vendor OCPP parameter key                                                                                                           |
-| supervisionUrlOcppKey             |            | 'ConnectionUrl' | string                            | the vendor string that will be used as a vendor OCPP parameter key to set the supervision URL                                                                                 |
-| ocppVersion                       | 1.6        | 1.6             | string                            | OCPP version                                                                                                                                                                  |
-| ocppProtocol                      | json       | json            | string                            | OCPP protocol                                                                                                                                                                 |
-| ocppStrictCompliance              | true/false | false           | boolean                           | strict adherence to the OCPP version and protocol specifications                                                                                                              |
-| ocppPersistentConfiguration       | true/false | true            | boolean                           | enable persistent OCPP parameters storage by charging station 'hashId'. The persistency is ensured by the charging stations configuration files in dist/assets/configurations |
-| wsOptions                         |            | {}              | ClientOptions & ClientRequestArgs | [ws](https://github.com/websockets/ws) and node.js [http](https://nodejs.org/api/http.html) clients options intersection                                                      |
-| authorizationFile                 |            | ''              | string                            | RFID tags list file relative to src/assets path                                                                                                                               |
-| baseName                          |            | ''              | string                            | base name to build charging stations name                                                                                                                                     |
-| nameSuffix                        |            | ''              | string                            | name suffix to build charging stations name                                                                                                                                   |
-| fixedName                         | true/false | false           | boolean                           | use the baseName as the charging stations unique name                                                                                                                         |
-| chargePointModel                  |            | ''              | string                            | charging stations model                                                                                                                                                       |
-| chargePointVendor                 |            | ''              | string                            | charging stations vendor                                                                                                                                                      |
-| chargePointSerialNumberPrefix     |            | ''              | string                            | charge point serial number prefix                                                                                                                                             |
-| chargeBoxSerialNumberPrefix       |            | ''              | string                            | charge box serial number prefix (deprecated in OCPP 1.6)                                                                                                                      |
-| firmwareVersion                   |            | ''              | string                            | charging stations firmware version                                                                                                                                            |
-| power                             |            |                 | float \| float[]                  | charging stations maximum power value(s)                                                                                                                                      |
-| powerSharedByConnectors           | true/false | false           | boolean                           | charging stations power shared by its connectors                                                                                                                              |
-| powerUnit                         | W/kW       | W               | string                            | charging stations power unit                                                                                                                                                  |
-| currentOutType                    | AC/DC      | AC              | string                            | charging stations current out type                                                                                                                                            |
-| voltageOut                        |            | AC:230/DC:400   | integer                           | charging stations voltage out                                                                                                                                                 |
-| numberOfPhases                    | 0/1/3      | AC:3/DC:0       | integer                           | charging stations number of phase(s)                                                                                                                                          |
-| numberOfConnectors                |            |                 | integer \| integer[]              | charging stations number of connector(s)                                                                                                                                      |
-| useConnectorId0                   | true/false | true            | boolean                           | use connector id 0 definition from the charging station configuration template                                                                                                |
-| randomConnectors                  | true/false | false           | boolean                           | randomize runtime connector id affectation from the connector id definition in charging station configuration template                                                        |
-| resetTime                         |            | 60              | integer                           | seconds to wait before the charging stations come back at reset                                                                                                               |
-| autoRegister                      | true/false | false           | boolean                           | set the charging station as registered at boot notification for testing purpose                                                                                               |
-| 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                                                                                                                                   |
-| 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                                                                                                                                    |
-| outOfOrderEndMeterValues          | true/false | false           | boolean                           | send Transaction.End MeterValues out of order. Need to relax OCPP specifications strict compliance ('ocppStrictCompliance' parameter)                                         |
-| meteringPerTransaction            | true/false | true            | boolean                           | enable metering history on a per transaction basis                                                                                                                            |
-| transactionDataMeterValues        | true/false | false           | boolean                           | enable transaction data MeterValues at stop transaction                                                                                                                       |
-| mainVoltageMeterValues            | true/false | true            | boolean                           | include charging station main voltage MeterValues on three phased charging stations                                                                                           |
-| phaseLineToLineVoltageMeterValues | true/false | true            | boolean                           | include charging station line to line voltage MeterValues on three phased charging stations                                                                                   |
-| Configuration                     |            |                 | ChargingStationConfiguration      | charging stations OCPP parameters configuration section                                                                                                                       |
-| AutomaticTransactionGenerator     |            |                 | AutomaticTransactionGenerator     | charging stations ATG configuration section                                                                                                                                   |
-| Connectors                        |            |                 | Connectors                        | charging stations connectors configuration section                                                                                                                            |
+| Key                               | Value(s)   | Default Value   | Value type                        | Description                                                                                                                                                                    |
+| --------------------------------- | ---------- | --------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| supervisionUrls                   |            | ''              | string \| string[]                | string or array of connection URIs to OCPP-J servers                                                                                                                           |
+| supervisionUser                   |            | ''              | string                            | basic HTTP authentication user to OCPP-J server                                                                                                                                |
+| supervisionPassword               |            | ''              | string                            | basic HTTP authentication password to OCPP-J server                                                                                                                            |
+| supervisionUrlOcppConfiguration   | true/false | false           | boolean                           | allow supervision URL configuration via a vendor OCPP parameter key                                                                                                            |
+| supervisionUrlOcppKey             |            | 'ConnectionUrl' | string                            | the vendor string that will be used as a vendor OCPP parameter key to set the supervision URL                                                                                  |
+| ocppVersion                       | 1.6        | 1.6             | string                            | OCPP version                                                                                                                                                                   |
+| ocppProtocol                      | json       | json            | string                            | OCPP protocol                                                                                                                                                                  |
+| ocppStrictCompliance              | true/false | false           | boolean                           | strict adherence to the OCPP version and protocol specifications                                                                                                               |
+| ocppPersistentConfiguration       | true/false | true            | boolean                           | enable persistent OCPP parameters storage by charging stations 'hashId'. The persistency is ensured by the charging stations configuration files in dist/assets/configurations |
+| wsOptions                         |            | {}              | ClientOptions & ClientRequestArgs | [ws](https://github.com/websockets/ws) and node.js [http](https://nodejs.org/api/http.html) clients options intersection                                                       |
+| authorizationFile                 |            | ''              | string                            | RFID tags list file relative to src/assets path                                                                                                                                |
+| baseName                          |            | ''              | string                            | base name to build charging stations id                                                                                                                                        |
+| nameSuffix                        |            | ''              | string                            | name suffix to build charging stations id                                                                                                                                      |
+| fixedName                         | true/false | false           | boolean                           | use the baseName as the charging stations unique name                                                                                                                          |
+| chargePointModel                  |            | ''              | string                            | charging stations model                                                                                                                                                        |
+| chargePointVendor                 |            | ''              | string                            | charging stations vendor                                                                                                                                                       |
+| chargePointSerialNumberPrefix     |            | ''              | string                            | charge point serial number prefix                                                                                                                                              |
+| chargeBoxSerialNumberPrefix       |            | ''              | string                            | charge box serial number prefix (deprecated in OCPP 1.6)                                                                                                                       |
+| firmwareVersion                   |            | ''              | string                            | charging stations firmware version                                                                                                                                             |
+| power                             |            |                 | float \| float[]                  | charging stations maximum power value(s)                                                                                                                                       |
+| powerSharedByConnectors           | true/false | false           | boolean                           | charging stations power shared by its connectors                                                                                                                               |
+| powerUnit                         | W/kW       | W               | string                            | charging stations power unit                                                                                                                                                   |
+| currentOutType                    | AC/DC      | AC              | string                            | charging stations current out type                                                                                                                                             |
+| voltageOut                        |            | AC:230/DC:400   | integer                           | charging stations voltage out                                                                                                                                                  |
+| numberOfPhases                    | 0/1/3      | AC:3/DC:0       | integer                           | charging stations number of phase(s)                                                                                                                                           |
+| numberOfConnectors                |            |                 | integer \| integer[]              | charging stations number of connector(s)                                                                                                                                       |
+| useConnectorId0                   | true/false | true            | boolean                           | use connector id 0 definition from the charging station configuration template                                                                                                 |
+| randomConnectors                  | true/false | false           | boolean                           | randomize runtime connector id affectation from the connector id definition in charging station configuration template                                                         |
+| resetTime                         |            | 60              | integer                           | seconds to wait before the charging stations come back at reset                                                                                                                |
+| autoRegister                      | true/false | false           | boolean                           | set charging stations as registered at boot notification for testing purpose                                                                                                   |
+| 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                                                                                                                                    |
+| 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                                                                                                                                     |
+| outOfOrderEndMeterValues          | true/false | false           | boolean                           | send Transaction.End MeterValues out of order. Need to relax OCPP specifications strict compliance ('ocppStrictCompliance' parameter)                                          |
+| meteringPerTransaction            | true/false | true            | boolean                           | enable metering history on a per transaction basis                                                                                                                             |
+| 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                                                                                   |
+| Configuration                     |            |                 | ChargingStationConfiguration      | charging stations OCPP parameters configuration section                                                                                                                        |
+| AutomaticTransactionGenerator     |            |                 | AutomaticTransactionGenerator     | charging stations ATG configuration section                                                                                                                                    |
+| Connectors                        |            |                 | Connectors                        | charging stations connectors configuration section                                                                                                                             |
 
 #### Configuration section
 
@@ -223,7 +223,7 @@ But the modifications to test have to be done to the files in the build result d
 
 **src/assets/configurations/\<hashId\>.json**:
 
-The charging station configuration file is automatically generated at start from the charging station configuration template file.
+The charging station configuration file is automatically generated at startup from the charging station configuration template file.
 
 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.