[e-mobility-charging-stations-simulator.git] / README.md

# [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@16
```

### GNU/Linux:

- [NodeSource](https://github.com/nodesource/distributions) Node.js Binary Distributions for version 16.X

## Configuration syntax

All configuration files are in the JSON standard format.

**Configuration files list**:

- charging station simulator configuration: [src/assets/config.json](src/assets/config.json);
- charging station configuration templates: [src/assets/station-templates](src/assets/station-templates);
- charging station configurations: [src/assets/configurations](src/assets/configurations);
- charging station RFID tags list in [src/assets](src/assets).

The charging stations simulator's configuration parameters must be within the `src/assets/config.json` file. A charging station simulator configuration template file is available at [src/assets/config-template.json](src/assets/config-template.json).

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).

**Configuration files hierarchy and priority**:

1. charging station configuration: [src/assets/configurations](src/assets/configurations);
2. charging station configuration template: [src/assets/station-templates](src/assets/station-templates);
3. charging station simulator configuration: [src/assets/config.json](src/assets/config.json).

The charging stations simulator have an automatic configuration files reload feature at change for:

- charging station simulator configuration;
- charging station configuration templates;
- charging station authorization RFID tags list.

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.

### Charging station simulator configuration

**src/assets/config.json**:

| Key                        | Value(s)                                         | Default Value                                                               | Value type                                                                                 | Description                                                                                                                                             |
| -------------------------- | ------------------------------------------------ | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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 worker threads startup (only for workerSet threads process type)                                                                |
| elementStartDelay          |                                                  | 0                                                                           | integer                                                                                    | milliseconds to wait at charging station 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/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                                                                                                                            |
| 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 configuration templates URIs configuration section (charging station configuration 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 configuration template

**src/assets/station-templates/<name>.json**:

| Key                               | Value(s)   | Default Value   | Value type                        | Description                                                                                                                                                  |
| --------------------------------- | ---------- | --------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| supervisionUrls                   |            | ''              | string \| string[]                | string or array of connection URIs to OCPP-J servers                                                                                                         |
| 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                                                                                                                                                |
| ocppStrictCompliance              | true/false | false           | boolean                           | strict adherence to the OCPP version and protocol specifications                                                                                             |
| ocppPersistentConfiguration       | true/false | true            | boolean                           | enable persistent OCPP parameters storage by charging station 'hashId'. The persistency is ensured by JSON configuration files in 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                 |            | ''              | 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                                                                                                                                     |
| chargePointSerialNumberPrefix     |            | ''              | string                            | charge point serial number prefix                                                                                                                            |
| chargeBoxSerialNumberPrefix       |            | ''              | string                            | charge box serial number prefix (deprecated in OCPP 1.6)                                                                                                     |
| 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 charging station configuration template                                                                               |
| randomConnectors                  | true/false | false           | boolean                           | randomize runtime connector id affectation from the connector id definition in charging station configuration 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. Need to relax OCPP specifications strict compliance ('ocppStrictCompliance' parameter)                        |
| 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 parameters configuration section                                                                                                      |
| AutomaticTransactionGenerator     |            |                 | AutomaticTransactionGenerator     | charging stations ATG configuration section                                                                                                                  |
| Connectors                        |            |                 | Connectors                        | charging stations connectors configuration section                                                                                                           |

#### 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"
        },
        ...
      ]
    }
  },
```

### Charging station configuration

**src/assets/configurations/<hashId>.json**:

The charging station configuration file is automatically generated at start from the charging station configuration template file.

The charging station configuration file content can be regenerated partially on matching charging station configuration template file changes. The charging station serial number is kept unchanged.

#### stationInfo section

The syntax is similar to charging station configuration template with some added fields like the charging station id (name) and the 'Configuration' section removed.

#### configurationKey section

The syntax is similar to the charging station configuration template 'Configuration' section.

## Start

To start the program, run: `npm start`.

## Docker

In the [docker](./docker) folder:

```bash
make
```

Or with the optional git submodules:

```bash
make SUBMODULES_INIT=true
```

## 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

- :white_check_mark: GetDiagnostics
- :white_check_mark: 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

- :white_check_mark: TriggerMessage

## OCPP-J standard parameters supported

All kind of OCPP parameters are supported in a charging station configuration or a charging station configuration template file. 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

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.
Commit	Line	Data
ae8ee665	1	# [charging-stations-simulator](https://github.com/jerome-benoit/charging-stations-simulator)
7dde0b73 JB	2
	3	## Summary
	4
1eabf6a9	5	Simple [node.js](https://nodejs.org/) program to simulate a set of charging stations based on the OCPP-J 1.6 protocol.
7dde0b73	6
696ce53a JB	7	## Prerequisites
	8
	9	### Windows
	10
e7aeea18	11	- [Chocolatey](https://chocolatey.org/):
696ce53a JB	12
	13	```powershell
	14	choco install -y nodejs-lts
	15	```
	16
	17	### MacOSX
	18
e7aeea18	19	- [Homebrew](https://brew.sh/):
696ce53a JB	20
696ce53a JB	21	```shell
8f3d04b0	22	brew install node@16
696ce53a JB	23	```
696ce53a JB	24
e7aeea18	25	### GNU/Linux:
511780c3	26
11d8f3e9	27	- [NodeSource](https://github.com/nodesource/distributions) Node.js Binary Distributions for version 16.X
511780c3	28
2c28fc83 JB	29	## Configuration syntax
2c28fc83 JB	30
e7aeea18	31	All configuration files are in the JSON standard format.
2c28fc83	32
1816f743	33	Configuration files list:
2c28fc83	34
1816f743 JB	35	- charging station simulator configuration: [src/assets/config.json](src/assets/config.json);
	36	- charging station configuration templates: [src/assets/station-templates](src/assets/station-templates);
	37	- charging station configurations: [src/assets/configurations](src/assets/configurations);
	38	- charging station RFID tags list in [src/assets](src/assets).
2c28fc83	39
1816f743 JB	40	The charging stations simulator's configuration parameters must be within the `src/assets/config.json` file. A charging station simulator configuration template file is available at [src/assets/config-template.json](src/assets/config-template.json).
	41
	42	All charging station configuration templates are in the directory [src/assets/station-templates](src/assets/station-templates).
	43
	44	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).
	45
	46	Configuration files hierarchy and priority:
	47
	48	1. charging station configuration: [src/assets/configurations](src/assets/configurations);
	49	2. charging station configuration template: [src/assets/station-templates](src/assets/station-templates);
	50	3. charging station simulator configuration: [src/assets/config.json](src/assets/config.json).
511780c3	51
e7aeea18	52	The charging stations simulator have an automatic configuration files reload feature at change for:
511780c3	53
1816f743 JB	54	- charging station simulator configuration;
	55	- charging station configuration templates;
	56	- charging station authorization RFID tags list.
2c28fc83	57
e7aeea18 JB	58	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.
e7aeea18 JB	59
1816f743	60	### Charging station simulator configuration
2c28fc83	61
b1d6e944	62	src/assets/config.json:
2c28fc83	63
1816f743 JB	64	\| Key \| Value(s) \| Default Value \| Value type \| Description \|
	65	\| -------------------------- \| ------------------------------------------------ \| --------------------------------------------------------------------------- \| ------------------------------------------------------------------------------------------ \| ------------------------------------------------------------------------------------------------------------------------------------------------------- \|
	66	\| supervisionUrls \| \| [] \| string \\| string[] \| string or array of global connection URIs to OCPP-J servers \|
	67	\| supervisionUrlDistribution \| round-robin/random/sequential \| round-robin \| boolean \| supervision urls distribution policy to simulated charging stations \|
	68	\| workerProcess \| workerSet/staticPool/dynamicPool \| workerSet \| string \| worker threads process type \|
	69	\| workerStartDelay \| \| 500 \| integer \| milliseconds to wait at worker threads startup (only for workerSet threads process type) \|
	70	\| elementStartDelay \| \| 0 \| integer \| milliseconds to wait at charging station startup \|
	71	\| workerPoolMinSize \| \| 4 \| integer \| worker threads pool minimum number of threads \|
	72	\| workerPoolMaxSize \| \| 16 \| integer \| worker threads pool maximum number of threads \|
	73	\| 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 \|
	74	\| chargingStationsPerWorker \| \| 1 \| integer \| number of charging stations per worker threads for the `workerSet` process type \|
	75	\| logStatisticsInterval \| \| 60 \| integer \| seconds between charging stations statistics output in the logs \|
	76	\| logConsole \| true/false \| false \| boolean \| output logs on the console \|
	77	\| logFormat \| \| simple \| string \| winston log format \|
	78	\| logRotate \| true/false \| true \| boolean \| enable daily log files rotation \|
	79	\| logMaxFiles \| \| 7 \| integer \| maximum number of log files to keep \|
	80	\| logLevel \| emerg/alert/crit/error/warning/notice/info/debug \| info \| string \| winston logging level \|
	81	\| logFile \| \| combined.log \| string \| log file relative path \|
	82	\| logErrorFile \| \| error.log \| string \| error log file relative path \|
	83	\| uiWebSocketServer \| \| { "enabled": true, "options": { "host: "localhost", "port": 8080 } } \| { enabled: boolean; options: ServerOptions; } \| UI WebSocket server configuration section \|
	84	\| 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 \|
	85	\| stationTemplateUrls \| \| {}[] \| { file: string; numberOfStations: number; }[] \| array of charging station configuration templates URIs configuration section (charging station configuration template file name and number of stations) \|
e7aeea18 JB	86
e7aeea18 JB	87	#### Worker process model:
a6b3c6c3 JB	88
	89	- workerSet:
	90	Worker set executing each a static number (chargingStationsPerWorker) of simulated charging stations from the total
	91
	92	- staticPool:
e7aeea18	93	Statically sized worker pool executing a static total number of simulated charging stations
a6b3c6c3 JB	94
a6b3c6c3 JB	95	- dynamicPool:
e7aeea18	96	Dynamically sized worker pool executing a static total number of simulated charging stations
a6b3c6c3	97
1816f743 JB	98	### Charging station configuration template
	99
	100	src/assets/station-templates/<name>.json:
	101
	102	\| Key \| Value(s) \| Default Value \| Value type \| Description \|
	103	\| --------------------------------- \| ---------- \| --------------- \| --------------------------------- \| ------------------------------------------------------------------------------------------------------------------------------------------------------------ \|
	104	\| supervisionUrls \| \| '' \| string \\| string[] \| string or array of connection URIs to OCPP-J servers \|
	105	\| supervisionUser \| \| '' \| string \| basic HTTP authentication user to OCPP-J server \|
	106	\| supervisionPassword \| \| '' \| string \| basic HTTP authentication password to OCPP-J server \|
	107	\| supervisionUrlOcppConfiguration \| true/false \| false \| boolean \| allow supervision URL configuration via a vendor OCPP parameter key \|
	108	\| supervisionUrlOcppKey \| \| 'ConnectionUrl' \| string \| the vendor string that will be used as a vendor OCPP parameter key to set the supervision URL \|
	109	\| ocppVersion \| 1.6 \| 1.6 \| string \| OCPP version \|
	110	\| ocppProtocol \| json \| json \| string \| OCPP protocol \|
	111	\| ocppStrictCompliance \| true/false \| false \| boolean \| strict adherence to the OCPP version and protocol specifications \|
	112	\| ocppPersistentConfiguration \| true/false \| true \| boolean \| enable persistent OCPP parameters storage by charging station 'hashId'. The persistency is ensured by JSON configuration files in dist/assets/configurations \|
	113	\| wsOptions \| \| {} \| ClientOptions & ClientRequestArgs \| [ws](https://github.com/websockets/ws) and node.js [http](https://nodejs.org/api/http.html) clients options intersection \|
	114	\| authorizationFile \| \| '' \| string \| RFID tags list file relative to src/assets path \|
	115	\| baseName \| \| '' \| string \| base name to build charging stations name \|
	116	\| nameSuffix \| \| '' \| string \| name suffix to build charging stations name \|
	117	\| fixedName \| true/false \| false \| boolean \| use the baseName as the charging stations unique name \|
	118	\| chargePointModel \| \| '' \| string \| charging stations model \|
	119	\| chargePointVendor \| \| '' \| string \| charging stations vendor \|
	120	\| chargePointSerialNumberPrefix \| \| '' \| string \| charge point serial number prefix \|
	121	\| chargeBoxSerialNumberPrefix \| \| '' \| string \| charge box serial number prefix (deprecated in OCPP 1.6) \|
	122	\| firmwareVersion \| \| '' \| string \| charging stations firmware version \|
	123	\| power \| \| \| float \\| float[] \| charging stations maximum power value(s) \|
	124	\| powerSharedByConnectors \| true/false \| false \| boolean \| charging stations power shared by its connectors \|
	125	\| powerUnit \| W/kW \| W \| string \| charging stations power unit \|
	126	\| currentOutType \| AC/DC \| AC \| string \| charging stations current out type \|
	127	\| voltageOut \| \| AC:230/DC:400 \| integer \| charging stations voltage out \|
	128	\| numberOfPhases \| 0/1/3 \| AC:3/DC:0 \| integer \| charging stations number of phase(s) \|
	129	\| numberOfConnectors \| \| \| integer \\| integer[] \| charging stations number of connector(s) \|
	130	\| useConnectorId0 \| true/false \| true \| boolean \| use connector id 0 definition from the charging station configuration template \|
	131	\| randomConnectors \| true/false \| false \| boolean \| randomize runtime connector id affectation from the connector id definition in charging station configuration template \|
	132	\| resetTime \| \| 60 \| integer \| seconds to wait before the charging stations come back at reset \|
	133	\| autoRegister \| true/false \| false \| boolean \| set the charging station as registered at boot notification for testing purpose \|
	134	\| autoReconnectMaxRetries \| \| -1 (unlimited) \| integer \| connection retries to the OCPP-J server \|
	135	\| reconnectExponentialDelay \| true/false \| false \| boolean \| connection delay retry to the OCPP-J server \|
	136	\| registrationMaxRetries \| \| -1 (unlimited) \| integer \| charging stations boot notification retries \|
	137	\| enableStatistics \| true/false \| true \| boolean \| enable charging stations statistics \|
	138	\| mayAuthorizeAtRemoteStart \| true/false \| true \| boolean \| always send authorize at remote start transaction when AuthorizeRemoteTxRequests is enabled \|
	139	\| beginEndMeterValues \| true/false \| false \| boolean \| enable Transaction.{Begin,End} MeterValues \|
	140	\| outOfOrderEndMeterValues \| true/false \| false \| boolean \| send Transaction.End MeterValues out of order. Need to relax OCPP specifications strict compliance ('ocppStrictCompliance' parameter) \|
	141	\| meteringPerTransaction \| true/false \| true \| boolean \| enable metering history on a per transaction basis \|
	142	\| transactionDataMeterValues \| true/false \| false \| boolean \| enable transaction data MeterValues at stop transaction \|
	143	\| mainVoltageMeterValues \| true/false \| true \| boolean \| include charging station main voltage MeterValues on three phased charging stations \|
	144	\| phaseLineToLineVoltageMeterValues \| true/false \| true \| boolean \| include charging station line to line voltage MeterValues on three phased charging stations \|
	145	\| Configuration \| \| \| ChargingStationConfiguration \| charging stations OCPP parameters configuration section \|
	146	\| AutomaticTransactionGenerator \| \| \| AutomaticTransactionGenerator \| charging stations ATG configuration section \|
	147	\| Connectors \| \| \| Connectors \| charging stations connectors configuration section \|
c94a349a JB	148
	149	#### Configuration section
	150
	151	```json
0302da79	152	"Configuration": {
c94a349a JB	153	"configurationKey": [
	154	...
	155	{
	156	"key": "StandardKey",
	157	"readonly": false,
	158	"value": "StandardValue",
	159	"visible": true,
	160	"reboot": false
	161	},
	162	...
	163	{
	164	"key": "VendorKey",
	165	"readonly": false,
	166	"value": "VendorValue",
	167	"visible": false,
	168	"reboot": true
	169	},
	170	...
	171	]
	172	}
	173	```
	174
	175	#### AutomaticTransactionGenerator section
	176
	177	```json
0302da79	178	"AutomaticTransactionGenerator": {
c94a349a JB	179	"enable": false,
	180	"minDuration": 60,
	181	"maxDuration": 80,
	182	"minDelayBetweenTwoTransactions": 15,
	183	"maxDelayBetweenTwoTransactions": 30,
	184	"probabilityOfStart": 1,
	185	"stopAfterHours": 0.3,
	186	"stopOnConnectionFailure": true,
e644918b	187	"requireAuthorize": true
c94a349a JB	188	}
c94a349a JB	189	```
e7aeea18	190
c94a349a JB	191	#### Connectors section
	192
	193	```json
0302da79	194	"Connectors": {
c94a349a JB	195	"0": {},
	196	"1": {
	197	"bootStatus": "Available",
	198	"MeterValues": [
9bd87386 JB	199	...
	200	{
	201	"unit": "W",
	202	"measurand": "Power.Active.Import",
	203	"phase": "L1-N",
	204	"value": "5000",
	205	"fluctuationPercent": "10"
	206	},
c94a349a JB	207	...
	208	{
	209	"unit": "A",
	210	"measurand": "Current.Import"
	211	},
	212	...
	213	{
	214	"unit": "Wh"
	215	},
	216	...
	217	]
	218	}
	219	},
	220	```
	221
1816f743 JB	222	### Charging station configuration
	223
	224	src/assets/configurations/<hashId>.json:
	225
	226	The charging station configuration file is automatically generated at start from the charging station configuration template file.
	227
	228	The charging station configuration file content can be regenerated partially on matching charging station configuration template file changes. The charging station serial number is kept unchanged.
	229
	230	#### stationInfo section
	231
	232	The syntax is similar to charging station configuration template with some added fields like the charging station id (name) and the 'Configuration' section removed.
	233
	234	#### configurationKey section
	235
	236	The syntax is similar to the charging station configuration template 'Configuration' section.
	237
6f0ec20e JB	238	## Start
	239
	240	To start the program, run: `npm start`.
	241
	242	## Docker
	243
	244	In the [docker](./docker) folder:
	245
	246	```bash
	247	make
	248	```
	249
bfcad885	250	Or with the optional git submodules:
6f0ec20e JB	251
6f0ec20e JB	252	```bash
bfcad885	253	make SUBMODULES_INIT=true
6f0ec20e JB	254	```
	255
	256	## OCPP-J commands supported
c94a349a JB	257
	258	### Version 1.6
	259
c56d42f1	260	#### Core Profile
6f0ec20e	261
778f7924 JB	262	- :white_check_mark: Authorize
	263	- :white_check_mark: BootNotification
	264	- :white_check_mark: ChangeAvailability
	265	- :white_check_mark: ChangeConfiguration
	266	- :white_check_mark: ClearCache
9e1b12e4	267	- :x: DataTransfer
778f7924 JB	268	- :white_check_mark: GetConfiguration
	269	- :white_check_mark: Heartbeat
	270	- :white_check_mark: MeterValues
	271	- :white_check_mark: RemoteStartTransaction
	272	- :white_check_mark: RemoteStopTransaction
	273	- :white_check_mark: Reset
	274	- :white_check_mark: StartTransaction
	275	- :white_check_mark: StatusNotification
	276	- :white_check_mark: StopTransaction
	277	- :white_check_mark: UnlockConnector
6f0ec20e	278
c56d42f1	279	#### Firmware Management Profile
6f0ec20e	280
b652b0c3	281	- :white_check_mark: GetDiagnostics
d50343bd	282	- :white_check_mark: DiagnosticsStatusNotification
9e1b12e4 JB	283	- :x: FirmwareStatusNotification
9e1b12e4 JB	284	- :x: UpdateFirmware
6f0ec20e	285
c56d42f1	286	#### Local Auth List Management Profile
6f0ec20e	287
9e1b12e4 JB	288	- :x: GetLocalListVersion
9e1b12e4 JB	289	- :x: SendLocalList
6f0ec20e	290
c56d42f1	291	#### Reservation Profile
6f0ec20e	292
9e1b12e4 JB	293	- :x: CancelReservation
9e1b12e4 JB	294	- :x: ReserveNow
6f0ec20e	295
c56d42f1	296	#### Smart Charging Profile
6f0ec20e	297
778f7924 JB	298	- :white_check_mark: ClearChargingProfile
	299	- :white_check_mark: GetCompositeSchedule
	300	- :white_check_mark: SetChargingProfile
6f0ec20e	301
c56d42f1	302	#### Remote Trigger Profile
6f0ec20e	303
802cfa13	304	- :white_check_mark: TriggerMessage
7dde0b73	305
7e1dc878 JB	306	## OCPP-J standard parameters supported
7e1dc878 JB	307
1816f743	308	All kind of OCPP parameters are supported in a charging station configuration or a charging station configuration template file. The list here mention the standard ones also handled automatically in the simulator.
7e1dc878 JB	309
	310	### Version 1.6
	311
c56d42f1	312	#### Core Profile
7e1dc878 JB	313
	314	- :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
	315	- :x: ClockAlignedDataInterval (type: integer) (units: seconds)
291cb255	316	- :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
7e1dc878 JB	317	- :x: GetConfigurationMaxKeys (type: integer) (units: -)
	318	- :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
	319	- :x: LocalAuthorizeOffline (type: boolean) (units: -)
	320	- :x: LocalPreAuthorize (type: boolean) (units: -)
	321	- :x: MeterValuesAlignedData (type: CSL) (units: -)
	322	- :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
	323	- :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
	324	- :white_check_mark: NumberOfConnectors (type: integer) (units: -)
	325	- :x: ResetRetries (type: integer) (units: times)
	326	- :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
	327	- :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
	328	- :x: StopTransactionOnInvalidId (type: boolean) (units: -)
	329	- :x: StopTxnAlignedData (type: CSL) (units: -)
	330	- :x: StopTxnSampledData (type: CSL) (units: -)
36f6a92e	331	- :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
7e1dc878 JB	332	- :x: TransactionMessageAttempts (type: integer) (units: times)
	333	- :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
	334	- :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
36f6a92e	335	- :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
7e1dc878	336
c56d42f1	337	#### Firmware Management Profile
7e1dc878	338
e7aeea18	339	- _none_
7e1dc878	340
c56d42f1	341	#### Local Auth List Management Profile
7e1dc878	342
36f6a92e	343	- :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
7e1dc878 JB	344	- :x: LocalAuthListMaxLength (type: integer) (units: -)
	345	- :x: SendLocalListMaxLength (type: integer) (units: -)
	346
c56d42f1	347	#### Reservation Profile
7e1dc878	348
e7aeea18	349	- _none_
7e1dc878	350
c56d42f1	351	#### Smart Charging Profile
7e1dc878 JB	352
	353	- :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
	354	- :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
	355	- :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
	356	- :x: MaxChargingProfilesInstalled (type: integer) (units: -)
	357
c56d42f1	358	#### Remote Trigger Profile
7e1dc878	359
e7aeea18	360	- _none_
7e1dc878	361
7dde0b73 JB	362	## License
7dde0b73 JB	363
25c7bbb9	364	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.
7dde0b73 JB	365
7dde0b73 JB	366	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.