X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=9fb599ae77d2589ba89b5a3539e8b0977a6238da;hb=090ef127fcc1199642b7a25e28b479f8d94afbbc;hp=99451a43ccd8a0545c1dd95a17e2a5bc6a8ea8e5;hpb=1d495af5cbd31e339e8a34096adf137fe9b6eb9b;p=e-mobility-charging-stations-simulator.git
diff --git a/README.md b/README.md
index 99451a43..9fb599ae 100644
--- 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
@@ -10,14 +11,14 @@ Simple [node.js](https://nodejs.org/) software to simulate and scale a set of ch
## Prerequisites
-Install the [node.js](https://nodejs.org/) LTS runtime environment:
+Install the [node.js](https://nodejs.org/) current LTS or superior version runtime environment:
### Windows
- [Chocolatey](https://chocolatey.org/):
```powershell
-choco install -y nodejs-lts
+choco install -y nodejs
```
### MacOSX
@@ -25,7 +26,7 @@ choco install -y nodejs-lts
- [Homebrew](https://brew.sh/):
```shell
-brew install node@16
+brew install node
```
### GNU/Linux
@@ -34,22 +35,29 @@ brew install node@16
## Installation
+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:
```shell
-npm install
+pnpm install
```
## Initial configuration
Copy the configuration template file [src/assets/config-template.json](src/assets/config-template.json) to [src/assets/config.json](src/assets/config.json).
-Copy the authorization RFID tags template file [src/assets/authorization-tags-template.json](src/assets/authorization-tags-template.json) to [src/assets/authorization-tags.json](src/assets/authorization-tags.json).
+Copy the RFID tags template file [src/assets/idtags-template.json](src/assets/idtags-template.json) to [src/assets/idtags.json](src/assets/idtags.json).
Tweak them to your needs by following the section [configuration files syntax](README.md#configuration-files-syntax).
## Start
-To start the program, run: `npm start`.
+To start the program, run: `pnpm start`.
## Start Web UI
@@ -70,7 +78,7 @@ The charging stations simulator's configuration parameters must be within the `s
All charging station configuration templates are in the directory [src/assets/station-templates](src/assets/station-templates).
-A list of RFID tags must be defined for the automatic transaction generator with a default location and name: `src/assets/authorization-tags.json`. A template file is available at [src/assets/authorization-tags-template.json](src/assets/authorization-tags-template.json).
+A list of RFID tags must be defined for the automatic transaction generator in a file with a default location and name: `src/assets/idtags.json`. A template file is available at [src/assets/idtags-template.json](src/assets/idtags-template.json).
**Configuration files hierarchy and priority**:
@@ -98,8 +106,8 @@ But the modifications to test have to be done to the files in the build target d
| logConsole | true/false | false | boolean | output logs on the console |
| logFormat | | simple | string | [winston](https://github.com/winstonjs/winston) log format |
| logRotate | true/false | true | boolean | enable daily log files rotation |
-| logMaxFiles | x/"xd" where x is an integer | undefined | integer \| string | maximum number of log files |
-| logMaxSize | x/"xk"/"xm"/"xg" where x is a number | undefined | number \| string | maximum size of log files in bytes, or units of kb, mb, and gb |
+| logMaxFiles | x/"xd" where x is an integer | undefined | integer \| string | maximum number of log files: https://github.com/winstonjs/winston-daily-rotate-file#options |
+| logMaxSize | x/"xk"/"xm"/"xg" where x is a number | undefined | number \| string | maximum size of log files in bytes, or units of kb, mb, and gb: https://github.com/winstonjs/winston-daily-rotate-file#options |
| logLevel | emerg/alert/crit/error/warning/notice/info/debug | info | string | [winston](https://github.com/winstonjs/winston) logging level |
| logFile | | combined.log | string | log file relative path |
| logErrorFile | | error.log | string | error log file relative path |
@@ -136,7 +144,7 @@ But the modifications to test have to be done to the files in the build target d
| 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](dist/assets/configurations) |
| stationInfoPersistentConfiguration | true/false | true | boolean | enable persistent station information and specifications storage by charging stations 'hashId'. The persistency is ensured by the charging stations configuration files in [dist/assets/configurations](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 | | undefined | string | RFID tags list file relative to src/assets path |
+| idTagsFile | | undefined | string | RFID tags list file relative to src/assets path |
| baseName | | undefined | string | base name to build charging stations id |
| nameSuffix | | undefined | string | name suffix to build charging stations id |
| fixedName | true/false | false | boolean | use the baseName as the charging stations unique name |
@@ -175,11 +183,12 @@ But the modifications to test have to be done to the files in the build target d
| firmwareUpgrade | | {
"versionUpgrade": {
"step": 1
},
"reset": true
} | {
versionUpgrade: {
patternGroup: number;
step: number;
};
reset: boolean;
failureStatus: 'DownloadFailed' \| 'InstallationFailed';
} | Configuration section for simulating firmware upgrade support. |
| commandsSupport | | {
"incomingCommands": {},
"outgoingCommands": {}
} | {
incomingCommands: Record;
outgoingCommands?: Record;
} | Configuration section for OCPP commands support. Empty section or subsections means all implemented OCPP commands are supported |
| messageTriggerSupport | | {} | Record | 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 | charging stations connectors configuration section |
+| Evses | | | Record | charging stations EVSEs configuration section |
-#### Configuration section
+#### Configuration section syntax example
```json
"Configuration": {
@@ -205,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 = {
@@ -224,7 +233,7 @@ type AutomaticTransactionGeneratorConfiguration = {
};
```
-Section example:
+##### Example:
```json
"AutomaticTransactionGenerator": {
@@ -241,7 +250,7 @@ Section example:
}
```
-#### Connectors section
+#### Connectors section syntax example
```json
"Connectors": {
@@ -260,7 +269,8 @@ Section example:
...
{
"unit": "A",
- "measurand": "Current.Import"
+ "measurand": "Current.Import",
+ "minimum": "0.5"
},
...
{
@@ -272,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/\.json**:
@@ -339,8 +389,8 @@ make SUBMODULES_INIT=true
#### Reservation Profile
-- :x: CancelReservation
-- :x: ReserveNow
+- :white_check_mark: CancelReservation
+- :white_check_mark: ReserveNow
#### Smart Charging Profile
@@ -352,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.
@@ -408,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.
@@ -670,4 +737,4 @@ We as members, contributors, and leaders pledge to make participation in our com
## Licensing
-Copyright 2020-2022 SAP SE or an SAP affiliate company and e-mobility-charging-stations-simulator contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/e-mobility-charging-stations-simulator).
+Copyright 2020-2023 SAP SE or an SAP affiliate company and e-mobility-charging-stations-simulator contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/e-mobility-charging-stations-simulator).