X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=9f1156e75fe46147311288736462254b850599e6;hb=2dcfe98ec940932372855643f996b87c27f4b7fa;hp=a4a39038791167ee24d76008d0d04f738d3e1a68;hpb=9bd87386d65158edef865cafd0daabff91822b87;p=e-mobility-charging-stations-simulator.git diff --git a/README.md b/README.md index a4a39038..9f1156e7 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,97 @@ -# ev-simulator +# [charging-stations-simulator](https://github.com/jerome-benoit/charging-stations-simulator) ## Summary Simple [node.js](https://nodejs.org/) program to simulate a set of charging stations based on the OCPP-J 1.6 protocol. +## Prerequisites + +### Windows + +* [Chocolatey](https://chocolatey.org/): + +```powershell +choco install -y nodejs-lts +``` + +### MacOSX + +* [Homebrew](https://brew.sh/): + +```shell +brew install node@14 +``` + +### GNU/Linux: + +* [NodeSource](https://github.com/nodesource/distributions) Node.js Binary Distributions for version 14.X + ## Configuration syntax All configuration files are in the JSON standard format. -The program's global configuration parameters must be within the src/assets/config.json file. A configuration template file is available at [src/assets/config-template.json](src/assets/config-template.json). +The charging stations simulator's main configuration parameters must be within the `src/assets/config.json` file. A configuration template file is available at [src/assets/config-template.json](src/assets/config-template.json). All charging station 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 the 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 with the 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). + +The charging stations simulator have an automatic configuration files reload feature at change for: +* main configuration; +* charging station templates; +* authorization RFID tags. -### Global configuration +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. + +### Main configuration **src/assets/config.json**: Key | Value(s) | Default Value | Value type | Description --- | -------| --------------| ---------- | ------------ -supervisionURLs | | [] | string[] | array of connection URIs to OCPP-J servers -distributeStationsToTenantsEqually | true/false | true | boolean | distribute charging stations uniformly to the OCPP-J servers -statisticsDisplayInterval | | 60 | integer | seconds between charging stations statistics output in the logs +supervisionUrls | | [] | string \| string[] | string or array of global connection URIs to OCPP-J servers +supervisionUrlDistribution | round-robin/random/sequential | round-robin | boolean | supervision urls distribution policy to simulated charging stations workerProcess | workerSet/staticPool/dynamicPool | workerSet | string | worker threads process type workerStartDelay | | 500 | integer | milliseconds to wait at charging station worker threads startup workerPoolMinSize | | 4 | integer | worker threads pool minimum number of threads workerPoolMaxSize | | 16 | integer | worker threads pool maximum number of threads -workerPoolStrategy | ROUND_ROBIN/LESS_RECENTLY_USED/... | [poolifier](https://github.com/pioardi/poolifier) default: ROUND_ROBBIN | string | worker threads pool [poolifier](https://github.com/pioardi/poolifier) worker choice strategy +workerPoolStrategy | ROUND_ROBIN/LESS_RECENTLY_USED/... | [poolifier](https://github.com/poolifier/poolifier) default: ROUND_ROBBIN | string | worker threads pool [poolifier](https://github.com/poolifier/poolifier) worker choice strategy chargingStationsPerWorker | | 1 | integer | number of charging stations per worker threads for the `workerSet` process type +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 log format logRotate | true/false | true | boolean | enable daily log files rotation logMaxFiles | | 7 | integer | maximum number of log files to keep logLevel | emerg/alert/crit/error/warning/notice/info/debug | info | string | winston logging level logFile | | combined.log | string | log file relative path -logErrorFile | | error.log | string | error log file relative path -stationTemplateURLs | | {}[] | { file: string; numberOfStations: number; }[] | array of charging template file URIs - +logErrorFile | | error.log | string | error log file relative path +uiWebSocketServer | | { "enabled": true, "options": { "host: "localhost", "port": 8080 } } | { enabled: boolean; options: ServerOptions; } | UI WebSocket server configuration section +performanceStorage | | { "enabled": false, "type": "jsonfile", "file:///performanceRecords.json" } | { enabled: boolean; type: string; URI: string; } where type can be 'jsonfile' or 'mongodb' | performance storage configuration section +stationTemplateUrls | | {}[] | { file: string; numberOfStations: number; }[] | array of charging station templates URIs configuration section (template file name and number of stations) + +#### Worker process model: + +- **workerSet**: + Worker set executing each a static number (chargingStationsPerWorker) of simulated charging stations from the total + +- **staticPool**: + Statically sized worker pool executing a static total number of simulated charging stations + +- **dynamicPool**: + Dynamically sized worker pool executing a static total number of simulated charging stations + ### Charging station template Key | Value(s) | Default Value | Value type | Description --- | -------| --------------| ---------- | ------------ -supervisionURL | | '' | string | connection URI to OCPP-J server +supervisionUrls | | '' | string \| string[] | string or array of connection URIs to OCPP-J servers. It has priority over the global configuration parameter +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 +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 @@ -63,19 +110,21 @@ numberOfConnectors | | | integer\|integer[] | charging stations number of connec useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the template randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in 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 -meteringPerTransaction | true/false | true | boolean | disable metering on a per transaction basis +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 -phaseLineToLineVoltage | true/false | true | boolean | include charging station line to line voltage MeterValues on three phased charging stations -Configuration | | | ChargingStationConfiguration | charging stations OCPP configuration parameters -AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration -Connectors | | | Connectors | charging stations connectors configuration +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 #### Configuration section @@ -161,10 +210,10 @@ In the [docker](./docker) folder: make ``` -Or without the optional git submodules: +Or with the optional git submodules: ```bash -make SUBMODULES_INIT=false +make SUBMODULES_INIT=true ``` ## OCPP-J commands supported @@ -192,8 +241,8 @@ make SUBMODULES_INIT=false #### Firmware Management Profile -- :x: GetDiagnostics -- :x: DiagnosticsStatusNotification +- :white_check_mark: GetDiagnostics +- :white_check_mark: DiagnosticsStatusNotification - :x: FirmwareStatusNotification - :x: UpdateFirmware @@ -215,7 +264,7 @@ make SUBMODULES_INIT=false #### Remote Trigger Profile -- :x: TriggerMessage +- :white_check_mark: TriggerMessage ## OCPP-J standard parameters supported @@ -275,6 +324,6 @@ All kind of OCPP parameters are supported in a charging station template. The li ## License -This file and all other files in this repository are licensed under the Apache Software License, v.2 and copyrighted under the copyright in [NOTICE](NOTICE) file, except as noted otherwise in the [LICENSE](LICENSE) file. +This file and all other files in this repository are licensed under the Apache Software License, v.2 and copyrighted under the copyright in [NOTICE](NOTICE) file, except as noted otherwise in the [LICENSE](LICENSE) file or the code source file header. Please note that Docker images can contain other software which may be licensed under different licenses. This LICENSE and NOTICE files are also included in the Docker image. For any usage of built Docker images please make sure to check the licenses of the artifacts contained in the images.