X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=9fb599ae77d2589ba89b5a3539e8b0977a6238da;hb=090ef127fcc1199642b7a25e28b479f8d94afbbc;hp=969b8ef4c2af049d0dbfdbf5057e960b312a9977;hpb=e302df1d4573ef07df7c44a210a34e429f571814;p=e-mobility-charging-stations-simulator.git
diff --git a/README.md b/README.md
index 969b8ef4..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
@@ -34,10 +35,11 @@ brew install node
## Installation
-Enable corepack if not already done:
+Enable corepack if not already done and install latest pnpm version:
```shell
corepack enable
+corepack prepare pnpm@latest --activate
```
In the repository root, run the following command:
@@ -181,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": {
@@ -211,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 = {
@@ -230,7 +233,7 @@ type AutomaticTransactionGeneratorConfiguration = {
};
```
-Section example:
+##### Example:
```json
"AutomaticTransactionGenerator": {
@@ -247,7 +250,7 @@ Section example:
}
```
-#### Connectors section
+#### Connectors section syntax example
```json
"Connectors": {
@@ -266,7 +269,8 @@ Section example:
...
{
"unit": "A",
- "measurand": "Current.Import"
+ "measurand": "Current.Import",
+ "minimum": "0.5"
},
...
{
@@ -278,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**:
@@ -345,8 +389,8 @@ make SUBMODULES_INIT=true
#### Reservation Profile
-- :x: CancelReservation
-- :x: ReserveNow
+- :white_check_mark: CancelReservation
+- :white_check_mark: ReserveNow
#### Smart Charging Profile
@@ -358,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.
@@ -414,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.
@@ -676,4 +737,4 @@ We as members, contributors, and leaders pledge to make participation in our com
## Licensing
-Copyright 2020-2022 SAP SE or an SAP affiliate company and e-mobility-charging-stations-simulator contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/e-mobility-charging-stations-simulator).
+Copyright 2020-2023 SAP SE or an SAP affiliate company and e-mobility-charging-stations-simulator contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/e-mobility-charging-stations-simulator).