X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=336ac71d4db7c99f038fde63da59e2d9b830236d;hb=4cf856f0ff988b709da7b9185913266146e82add;hp=378c83c8c0a8f1b183d7f2a9fca83d607640b9f4;hpb=37e868f20a2862b24b65963016706e63e0b96b7d;p=e-mobility-charging-stations-simulator.git diff --git a/README.md b/README.md index 378c83c8..336ac71d 100644 --- 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: @@ -49,7 +50,7 @@ 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). @@ -76,7 +77,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**: @@ -103,7 +104,7 @@ But the modifications to test have to be done to the files in the build target d | logStatisticsInterval | | 60 | integer | seconds between charging stations statistics output in the logs | | 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 log files rotation | +| 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: 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 | @@ -142,7 +143,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 | @@ -266,7 +267,8 @@ Section example: ... { "unit": "A", - "measurand": "Current.Import" + "measurand": "Current.Import", + "minimum": "0.5" }, ... { @@ -676,4 +678,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).