X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=bcdefa604e29ee0a38d46877dddbb152a17e48d6;hb=47e224777669f935f45d443b6da948e7977fd9b7;hp=2695cb80aa7d75ce82b788daf294cf7abfa7e110;hpb=2c28fc83794a74ee53d4d60e88e11b49949db9a2;p=e-mobility-charging-stations-simulator.git diff --git a/README.md b/README.md index 2695cb80..bcdefa60 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,7 @@ ## Summary -Simple node program to simulate a set of charging stations based on the OCPP-J 1.6 protocol. - -## Start - -To start the program, run: `npm start`. +Simple [node.js](https://nodejs.org/) program to simulate a set of charging stations based on the OCPP-J 1.6 protocol. ## Configuration syntax @@ -20,30 +16,264 @@ A list of RFID tags must be defined for the automatic transaction generator with ### Global configuration -_src/assets/config.json_ +**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 -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 +stationTemplateURLs | | {}[] | { file: string; numberOfStations: number; }[] | array of charging template file URIs ### Charging station template Key | Value(s) | Default Value | Value type | Description --- | -------| --------------| ---------- | ------------ +supervisionURL | | '' | string | connection URI to OCPP-J server +ocppVersion | 1.6 | 1.6 | string | OCPP version +ocppProtocol | json | json | string | OCPP protocol 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 +fixedName | true/false | false | boolean | use the baseName as the charging stations unique name +chargePointModel | | '' | string | charging stations model +chargePointVendor | | '' | string | charging stations vendor +chargeBoxSerialNumberPrefix | | '' | string | charging stations serial number prefix +firmwareVersion | | '' | string | charging stations firmware version +power | | | float\|float[] | 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 +voltageOut | | AC:230/DC:400 | integer | charging stations voltage out +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 +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 | 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 +phaseLineToLineVoltageMeterValues | 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 + +#### 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": true + } +``` +#### Connectors section + +```json + "Connectors": { + "0": {}, + "1": { + "bootStatus": "Available", + "MeterValues": [ + ... + { + "unit": "W", + "measurand": "Power.Active.Import", + "phase": "L1-N", + "value": "5000", + "fluctuationPercent": "10" + }, + ... + { + "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 +- :x: 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 + +- :x: GetDiagnostics +- :x: DiagnosticsStatusNotification +- :x: FirmwareStatusNotification +- :x: UpdateFirmware + +#### Local Auth List Management Profile + +- :x: GetLocalListVersion +- :x: SendLocalList + +#### Reservation Profile + +- :x: CancelReservation +- :x: ReserveNow + +#### Smart Charging Profile + +- :white_check_mark: ClearChargingProfile +- :white_check_mark: GetCompositeSchedule +- :white_check_mark: SetChargingProfile + +#### Remote Trigger Profile + +- :x: TriggerMessage + +## OCPP-J standard parameters supported + +All kind of OCPP parameters are supported in a charging station template. The list here mention the standard ones also handled automatically in the simulator. + +### Version 1.6 + +#### Core Profile + +- :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -) +- :x: ClockAlignedDataInterval (type: integer) (units: seconds) +- :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds) +- :x: GetConfigurationMaxKeys (type: integer) (units: -) +- :white_check_mark: HeartbeatInterval (type: integer) (units: seconds) +- :x: LocalAuthorizeOffline (type: boolean) (units: -) +- :x: LocalPreAuthorize (type: boolean) (units: -) +- :x: MeterValuesAlignedData (type: CSL) (units: -) +- :white_check_mark: MeterValuesSampledData (type: CSL) (units: -) +- :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds) +- :white_check_mark: NumberOfConnectors (type: integer) (units: -) +- :x: ResetRetries (type: integer) (units: times) +- :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -) +- :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -) +- :x: StopTransactionOnInvalidId (type: boolean) (units: -) +- :x: StopTxnAlignedData (type: CSL) (units: -) +- :x: StopTxnSampledData (type: CSL) (units: -) +- :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -) +- :x: TransactionMessageAttempts (type: integer) (units: times) +- :x: TransactionMessageRetryInterval (type: integer) (units: seconds) +- :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -) +- :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds) + +#### Firmware Management Profile + +- *none* + +#### Local Auth List Management Profile + +- :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -) +- :x: LocalAuthListMaxLength (type: integer) (units: -) +- :x: SendLocalListMaxLength (type: integer) (units: -) + +#### Reservation Profile + +- *none* + +#### Smart Charging Profile + +- :x: ChargeProfileMaxStackLevel (type: integer) (units: -) +- :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -) +- :x: ChargingScheduleMaxPeriods (type: integer) (units: -) +- :x: MaxChargingProfilesInstalled (type: integer) (units: -) + +#### Remote Trigger Profile + +- *none* ## License