X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=9dce3f0adb22ea576316427f32dfaaf2d6cc50f7;hb=125ec3b6560ba032327557f0827620192a8aaca3;hp=41a74805378c54dd92b7e43bc130416f5386b2f5;hpb=c27c3eeea356b0692bef2327bb59aa99f9cbad8d;p=e-mobility-charging-stations-simulator.git diff --git a/README.md b/README.md index 41a74805..9dce3f0a 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,27 @@ -# charging-stations-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 +``` + ## Configuration syntax All configuration files are in the JSON standard format. @@ -38,7 +56,18 @@ logFile | | combined.log | string | log file relative path logErrorFile | | error.log | string | error log file relative path performanceStorage | | { "enabled": false, "type": "jsonfile", "file:///performanceMeasurements.json" } | { enabled: string; type: string; URI: string; } where type can be 'jsonfile', 'mysql', 'mariadb', 'sqlite' 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 @@ -220,7 +249,7 @@ make SUBMODULES_INIT=false #### Remote Trigger Profile -- :x: TriggerMessage +- :white_check_mark: TriggerMessage ## OCPP-J standard parameters supported