GH action: Use the right repo token
[e-mobility-charging-stations-simulator.git] / README.md
CommitLineData
7dde0b73
JB
1# ev-simulator
2
3## Summary
4
1eabf6a9 5Simple [node.js](https://nodejs.org/) program to simulate a set of charging stations based on the OCPP-J 1.6 protocol.
7dde0b73 6
2c28fc83
JB
7## Configuration syntax
8
9All configuration files are in the JSON standard format.
10
11The 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).
12
13All charging station templates are in the directory [src/assets/station-templates](src/assets/station-templates).
14
15A 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).
16
17### Global configuration
18
b1d6e944 19**src/assets/config.json**:
2c28fc83
JB
20
21Key | Value(s) | Default Value | Value type | Description
22--- | -------| --------------| ---------- | ------------
23supervisionURLs | | [] | string[] | array of connection URIs to OCPP-J servers
24distributeStationsToTenantsEqually | true/false | true | boolean | distribute charging stations uniformly to the OCPP-J servers
25statisticsDisplayInterval | | 60 | integer | seconds between charging stations statistics output in the logs
326ab6fd
JB
26workerProcess | workerSet/staticPool/dynamicPool | workerSet | string | worker threads process type
27workerStartDelay | | 500 | integer | milliseconds to wait at charging station worker threads startup
2c28fc83
JB
28workerPoolMinSize | | 4 | integer | worker threads pool minimum number of threads
29workerPoolMaxSize | | 16 | integer | worker threads pool maximum number of threads
9efbac5b 30workerPoolStrategy | 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
2c28fc83
JB
31chargingStationsPerWorker | | 1 | integer | number of charging stations per worker threads for the `workerSet` process type
32logConsole | true/false | false | boolean | output logs on the console
33logFormat | | simple | string | winston log format
34logRotate | true/false | true | boolean | enable daily log files rotation
0302da79 35logMaxFiles | | 7 | integer | maximum number of log files to keep
2c28fc83
JB
36logLevel | emerg/alert/crit/error/warning/notice/info/debug | info | string | winston logging level
37logFile | | combined.log | string | log file relative path
38logErrorFile | | error.log | string | error log file relative path
a02da55f 39stationTemplateURLs | | {}[] | { file: string; numberOfStations: number; }[] | array of charging template file URIs
2c28fc83
JB
40
41### Charging station template
2e6e52f3 42
2c28fc83
JB
43Key | Value(s) | Default Value | Value type | Description
44--- | -------| --------------| ---------- | ------------
a02da55f 45supervisionURL | | '' | string | connection URI to OCPP-J server
15042c5f
JB
46supervisionUser | | '' | string | basic HTTP authentication user to OCPP-J server
47supervisionPassword | | '' | string | basic HTTP authentication password to OCPP-J server
a02da55f
JB
48ocppVersion | 1.6 | 1.6 | string | OCPP version
49ocppProtocol | json | json | string | OCPP protocol
2c28fc83 50authorizationFile | | '' | string | RFID tags list file relative to src/assets path
a02da55f
JB
51baseName | | '' | string | base name to build charging stations name
52nameSuffix | | '' | string | name suffix to build charging stations name
53fixedName | true/false | false | boolean | use the baseName as the charging stations unique name
54chargePointModel | | '' | string | charging stations model
55chargePointVendor | | '' | string | charging stations vendor
56chargeBoxSerialNumberPrefix | | '' | string | charging stations serial number prefix
57firmwareVersion | | '' | string | charging stations firmware version
4a1857a2 58power | | | float\|float[] | charging stations maximum power value(s)
c6f76013 59powerSharedByConnectors | true/false | false | boolean | charging stations power shared by its connectors
ef16e252 60powerUnit | W/kW | W | string | charging stations power unit
7decf1b6 61currentOutType | AC/DC | AC | string | charging stations current out type
6ed92bc1 62voltageOut | | AC:230/DC:400 | integer | charging stations voltage out
c706280d 63numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s)
7decf1b6
JB
64numberOfConnectors | | | integer\|integer[] | charging stations number of connector(s)
65useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the template
11b056bb 66randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in template
7decf1b6 67resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset
47e22477 68autoRegister | true/false | false | boolean | set the charging station as registered at boot notification for testing purpose
7decf1b6
JB
69autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server
70reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server
0b13b85d 71registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries
6ed92bc1 72enableStatistics | true/false | true | boolean | enable charging stations statistics
a7fc8211 73mayAuthorizeAtRemoteStart | true/false | true | boolean | always send authorize at remote start transaction when AuthorizeRemoteTxRequests is enabled
6ed92bc1
JB
74beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues
75outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order
a7fc8211 76meteringPerTransaction | true/false | true | boolean | enable metering history on a per transaction basis
fd0c36fa 77transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction
9ccca265 78mainVoltageMeterValues | true/false | true | boolean | include charging station main voltage MeterValues on three phased charging stations
6b10669b 79phaseLineToLineVoltageMeterValues | true/false | true | boolean | include charging station line to line voltage MeterValues on three phased charging stations
c94a349a
JB
80Configuration | | | ChargingStationConfiguration | charging stations OCPP configuration parameters
81AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration
82Connectors | | | Connectors | charging stations connectors configuration
83
84#### Configuration section
85
86```json
0302da79 87 "Configuration": {
c94a349a
JB
88 "configurationKey": [
89 ...
90 {
91 "key": "StandardKey",
92 "readonly": false,
93 "value": "StandardValue",
94 "visible": true,
95 "reboot": false
96 },
97 ...
98 {
99 "key": "VendorKey",
100 "readonly": false,
101 "value": "VendorValue",
102 "visible": false,
103 "reboot": true
104 },
105 ...
106 ]
107 }
108```
109
110#### AutomaticTransactionGenerator section
111
112```json
0302da79 113 "AutomaticTransactionGenerator": {
c94a349a
JB
114 "enable": false,
115 "minDuration": 60,
116 "maxDuration": 80,
117 "minDelayBetweenTwoTransactions": 15,
118 "maxDelayBetweenTwoTransactions": 30,
119 "probabilityOfStart": 1,
120 "stopAfterHours": 0.3,
121 "stopOnConnectionFailure": true,
e644918b 122 "requireAuthorize": true
c94a349a
JB
123 }
124```
125#### Connectors section
126
127```json
0302da79 128 "Connectors": {
c94a349a
JB
129 "0": {},
130 "1": {
131 "bootStatus": "Available",
132 "MeterValues": [
9bd87386
JB
133 ...
134 {
135 "unit": "W",
136 "measurand": "Power.Active.Import",
137 "phase": "L1-N",
138 "value": "5000",
139 "fluctuationPercent": "10"
140 },
c94a349a
JB
141 ...
142 {
143 "unit": "A",
144 "measurand": "Current.Import"
145 },
146 ...
147 {
148 "unit": "Wh"
149 },
150 ...
151 ]
152 }
153 },
154```
155
6f0ec20e
JB
156## Start
157
158To start the program, run: `npm start`.
159
160## Docker
161
162In the [docker](./docker) folder:
163
164```bash
165make
166```
167
168Or without the optional git submodules:
169
170```bash
171make SUBMODULES_INIT=false
172```
173
174## OCPP-J commands supported
c94a349a
JB
175
176### Version 1.6
177
c56d42f1 178#### Core Profile
6f0ec20e 179
778f7924
JB
180- :white_check_mark: Authorize
181- :white_check_mark: BootNotification
182- :white_check_mark: ChangeAvailability
183- :white_check_mark: ChangeConfiguration
184- :white_check_mark: ClearCache
9e1b12e4 185- :x: DataTransfer
778f7924
JB
186- :white_check_mark: GetConfiguration
187- :white_check_mark: Heartbeat
188- :white_check_mark: MeterValues
189- :white_check_mark: RemoteStartTransaction
190- :white_check_mark: RemoteStopTransaction
191- :white_check_mark: Reset
192- :white_check_mark: StartTransaction
193- :white_check_mark: StatusNotification
194- :white_check_mark: StopTransaction
195- :white_check_mark: UnlockConnector
6f0ec20e 196
c56d42f1 197#### Firmware Management Profile
6f0ec20e 198
9e1b12e4
JB
199- :x: GetDiagnostics
200- :x: DiagnosticsStatusNotification
201- :x: FirmwareStatusNotification
202- :x: UpdateFirmware
6f0ec20e 203
c56d42f1 204#### Local Auth List Management Profile
6f0ec20e 205
9e1b12e4
JB
206- :x: GetLocalListVersion
207- :x: SendLocalList
6f0ec20e 208
c56d42f1 209#### Reservation Profile
6f0ec20e 210
9e1b12e4
JB
211- :x: CancelReservation
212- :x: ReserveNow
6f0ec20e 213
c56d42f1 214#### Smart Charging Profile
6f0ec20e 215
778f7924
JB
216- :white_check_mark: ClearChargingProfile
217- :white_check_mark: GetCompositeSchedule
218- :white_check_mark: SetChargingProfile
6f0ec20e 219
c56d42f1 220#### Remote Trigger Profile
6f0ec20e 221
9e1b12e4 222- :x: TriggerMessage
7dde0b73 223
7e1dc878
JB
224## OCPP-J standard parameters supported
225
adf16e64 226All kind of OCPP parameters are supported in a charging station template. The list here mention the standard ones also handled automatically in the simulator.
7e1dc878
JB
227
228### Version 1.6
229
c56d42f1 230#### Core Profile
7e1dc878
JB
231
232- :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
233- :x: ClockAlignedDataInterval (type: integer) (units: seconds)
291cb255 234- :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
7e1dc878
JB
235- :x: GetConfigurationMaxKeys (type: integer) (units: -)
236- :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
237- :x: LocalAuthorizeOffline (type: boolean) (units: -)
238- :x: LocalPreAuthorize (type: boolean) (units: -)
239- :x: MeterValuesAlignedData (type: CSL) (units: -)
240- :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
241- :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
242- :white_check_mark: NumberOfConnectors (type: integer) (units: -)
243- :x: ResetRetries (type: integer) (units: times)
244- :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
245- :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
246- :x: StopTransactionOnInvalidId (type: boolean) (units: -)
247- :x: StopTxnAlignedData (type: CSL) (units: -)
248- :x: StopTxnSampledData (type: CSL) (units: -)
36f6a92e 249- :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
7e1dc878
JB
250- :x: TransactionMessageAttempts (type: integer) (units: times)
251- :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
252- :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
36f6a92e 253- :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
7e1dc878 254
c56d42f1 255#### Firmware Management Profile
7e1dc878
JB
256
257- *none*
258
c56d42f1 259#### Local Auth List Management Profile
7e1dc878 260
36f6a92e 261- :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
7e1dc878
JB
262- :x: LocalAuthListMaxLength (type: integer) (units: -)
263- :x: SendLocalListMaxLength (type: integer) (units: -)
264
c56d42f1 265#### Reservation Profile
7e1dc878
JB
266
267- *none*
268
c56d42f1 269#### Smart Charging Profile
7e1dc878
JB
270
271- :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
272- :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
273- :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
274- :x: MaxChargingProfilesInstalled (type: integer) (units: -)
275
c56d42f1 276#### Remote Trigger Profile
7e1dc878
JB
277
278- *none*
279
7dde0b73
JB
280## License
281
25c7bbb9 282This 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
283
284Please 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.