X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=1ca3701e51143f2d2de67110577d9e9f50553567;hb=778f79241952fefd769c87b195e01e8101964928;hp=eca6d8286ce18fcf8ab1670e8a3fb323c8ff8543;hpb=a02da55fb94060c8066bb885d0e76321e6f03d03;p=e-mobility-charging-stations-simulator.git diff --git a/README.md b/README.md index eca6d828..1ca3701e 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,6 @@ Simple [node.js](https://nodejs.org/) program to simulate a set of charging stations based on the OCPP-J 1.6 protocol. -## Start - -To start the program, run: `npm start`. - ## Configuration syntax All configuration files are in the JSON standard format. @@ -27,14 +23,16 @@ 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 -workerProcess | workerSet/staticPool/dynamicPool | workerSet | string | worker threads process type +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 chargingStationsPerWorker | | 1 | integer | number of charging stations per worker threads for the `workerSet` process type 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 files to keep +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 @@ -55,9 +53,156 @@ chargePointModel | | '' | string | charging stations model chargePointVendor | | '' | string | charging stations vendor chargeBoxSerialNumberPrefix | | '' | string | charging stations serial number prefix firmwareVersion | | '' | string | charging stations firmware version -power | | | number\|number[] | charging stations maximum power value(s) -powerSharedByConnectors | true/false | false | boolean | charging stations power shared by connectors -powerUnits | W/kW | W | string | charging stations power units +power | | | integer\|integer[] | 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 +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 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 +connectionTimeout | | 30 | integer | connection timeout to the OCPP-J server +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 +voltageOut | | AC:230/DC:400 | integer | charging stations voltage out +Configuration | | | ChargingStationConfiguration | charging stations OCPP configuration parameters +AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration +Connectors | | | Connectors | charging stations connectors configuration + +#### Configuration section + +```json + "Configuration": { + "configurationKey": [ + ... + { + "key": "StandardKey", + "readonly": false, + "value": "StandardValue", + "visible": true, + "reboot": false + }, + ... + { + "key": "VendorKey", + "readonly": false, + "value": "VendorValue", + "visible": false, + "reboot": true + }, + ... + ] + } +``` + +#### AutomaticTransactionGenerator section + +```json + "AutomaticTransactionGenerator": { + "enable": false, + "minDuration": 60, + "maxDuration": 80, + "minDelayBetweenTwoTransactions": 15, + "maxDelayBetweenTwoTransactions": 30, + "probabilityOfStart": 1, + "stopAfterHours": 0.3, + "stopOnConnectionFailure": true, + "requireAuthorize": false + } +``` +#### Connectors section + +```json + "Connectors": { + "0": {}, + "1": { + "bootStatus": "Available", + "MeterValues": [ + ... + { + "unit": "A", + "measurand": "Current.Import" + }, + ... + { + "unit": "Wh" + }, + ... + ] + } + }, +``` + +## Start + +To start the program, run: `npm start`. + +## Docker + +In the [docker](./docker) folder: + +```bash +make +``` + +Or without the optional git submodules: + +```bash +make SUBMODULES_INIT=false +``` + +## OCPP-J commands supported + +### Version 1.6 + +### Core Profile + +- :white_check_mark: Authorize +- :white_check_mark: BootNotification +- :white_check_mark: ChangeAvailability +- :white_check_mark: ChangeConfiguration +- :white_check_mark: ClearCache +- :negative_squared_cross_mark: DataTransfer +- :white_check_mark: GetConfiguration +- :white_check_mark: Heartbeat +- :white_check_mark: MeterValues +- :white_check_mark: RemoteStartTransaction +- :white_check_mark: RemoteStopTransaction +- :white_check_mark: Reset +- :white_check_mark: StartTransaction +- :white_check_mark: StatusNotification +- :white_check_mark: StopTransaction +- :white_check_mark: UnlockConnector + +### Firmware Management Profile + +- :negative_squared_cross_mark: GetDiagnostics +- :negative_squared_cross_mark: DiagnosticsStatusNotification +- :negative_squared_cross_mark: FirmwareStatusNotification +- :negative_squared_cross_mark: UpdateFirmware + +### Local Auth List Management Profile + +- :negative_squared_cross_mark: GetLocalListVersion +- :negative_squared_cross_mark: SendLocalList + +### Reservation Profile + +- :negative_squared_cross_mark: CancelReservation +- :negative_squared_cross_mark: ReserveNow + +### Smart Charging Profile + +- :white_check_mark: ClearChargingProfile +- :white_check_mark: GetCompositeSchedule +- :white_check_mark: SetChargingProfile + +### Remote Trigger Profile + +- :negative_squared_cross_mark: TriggerMessage ## License