X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=README.md;h=9fb599ae77d2589ba89b5a3539e8b0977a6238da;hb=9cfa0fcf76afc3d5d2bb552cd2d7764f6635f670;hp=ab751e3cb3af2f2e50c7b8992d2ad4eeaf567120;hpb=1a662d2902d8ba4c41e55febda8a77f52d155a90;p=e-mobility-charging-stations-simulator.git diff --git a/README.md b/README.md index ab751e3c..9fb599ae 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ # [e-mobility charging stations simulator](https://github.com/sap/e-mobility-charging-stations-simulator) +[![CI worklow](https://github.com/SAP/e-mobility-charging-stations-simulator/actions/workflows/ci.yml/badge.svg)](https://github.com/SAP/e-mobility-charging-stations-simulator/actions/workflows/ci.yml) [![REUSE status](https://api.reuse.software/badge/github.com/SAP/e-mobility-charging-stations-simulator)](https://api.reuse.software/info/github.com/SAP/e-mobility-charging-stations-simulator) ## Summary @@ -182,11 +183,12 @@ But the modifications to test have to be done to the files in the build target d | firmwareUpgrade | | {
"versionUpgrade": {
"step": 1
},
"reset": true
} | {
versionUpgrade: {
patternGroup: number;
step: number;
};
reset: boolean;
failureStatus: 'DownloadFailed' \| 'InstallationFailed';
} | Configuration section for simulating firmware upgrade support. | | commandsSupport | | {
"incomingCommands": {},
"outgoingCommands": {}
} | {
incomingCommands: Record;
outgoingCommands?: Record;
} | Configuration section for OCPP commands support. Empty section or subsections means all implemented OCPP commands are supported | | messageTriggerSupport | | {} | Record | Configuration section for OCPP commands trigger support. Empty section means all implemented OCPP trigger commands are supported | -| Configuration | | | ChargingStationConfiguration | charging stations OCPP parameters configuration section | -| AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration section | -| Connectors | | | Connectors | charging stations connectors configuration section | +| Configuration | | | ChargingStationOcppConfiguration | charging stations OCPP parameters configuration section | +| AutomaticTransactionGenerator | | | AutomaticTransactionGeneratorConfiguration | charging stations ATG configuration section | +| Connectors | | | Record | charging stations connectors configuration section | +| Evses | | | Record | charging stations EVSEs configuration section | -#### Configuration section +#### Configuration section syntax example ```json "Configuration": { @@ -212,9 +214,9 @@ But the modifications to test have to be done to the files in the build target d } ``` -#### AutomaticTransactionGenerator section +#### AutomaticTransactionGenerator section syntax example -Section type definition: +##### Type definition: ```ts type AutomaticTransactionGeneratorConfiguration = { @@ -231,7 +233,7 @@ type AutomaticTransactionGeneratorConfiguration = { }; ``` -Section example: +##### Example: ```json "AutomaticTransactionGenerator": { @@ -248,7 +250,7 @@ Section example: } ``` -#### Connectors section +#### Connectors section syntax example ```json "Connectors": { @@ -267,7 +269,8 @@ Section example: ... { "unit": "A", - "measurand": "Current.Import" + "measurand": "Current.Import", + "minimum": "0.5" }, ... { @@ -279,6 +282,46 @@ Section example: }, ``` +#### Evses section syntax example + +```json + "Evses": { + "0": { + "Connectors": { + "0": {} + } + }, + "1": { + "Connectors": { + "1": { + "bootStatus": "Available", + "MeterValues": [ + ... + { + "unit": "W", + "measurand": "Power.Active.Import", + "phase": "L1-N", + "value": "5000", + "fluctuationPercent": "10" + }, + ... + { + "unit": "A", + "measurand": "Current.Import", + "minimum": "0.5" + }, + ... + { + "unit": "Wh" + }, + ... + ] + } + } + } + }, +``` + ### Charging station configuration **dist/assets/configurations/\.json**: @@ -346,8 +389,8 @@ make SUBMODULES_INIT=true #### Reservation Profile -- :x: CancelReservation -- :x: ReserveNow +- :white_check_mark: CancelReservation +- :white_check_mark: ReserveNow #### Smart Charging Profile @@ -359,6 +402,21 @@ make SUBMODULES_INIT=true - :white_check_mark: TriggerMessage +### Version 2.x.x + +#### Provisioning + +- :white_check_mark: BootNotification + +#### Authorization + +- :white_check_mark: ClearCache + +#### Availability + +- :white_check_mark: StatusNotification +- :white_check_mark: Heartbeat + ## 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. @@ -415,6 +473,8 @@ All kind of OCPP parameters are supported in a charging station configuration or - _none_ +### Version 2.x.x + ## UI protocol Protocol to control the simulator via a Websocket or HTTP server.