X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=d80538029b6f6b891bf643c13bab95e32c89b9a9;hb=fec8f1ba23a7545090fa8f47710959213153292e;hp=c61910c98d40c4de9d7377b93784f53e8f64657d;hpb=03ebf4c1db6ba11903b42e56692ed3d8538ba1d3;p=e-mobility-charging-stations-simulator.git
diff --git a/README.md b/README.md
index c61910c9..d8053802 100644
--- a/README.md
+++ b/README.md
@@ -101,7 +101,7 @@ But the modifications to test have to be done to the files in the build target d
| logFile | | combined.log | string | log file relative path |
| logErrorFile | | error.log | string | error log file relative path |
| worker | | {
"processType": "workerSet",
"startDelay": 500,
"elementStartDelay": 0,
"elementsPerWorker": 1,
"poolMinSize": 4,
"poolMaxSize": 16,
"poolStrategy": "ROUND_ROBBIN"
} | {
processType: WorkerProcessType;
startDelay: number;
elementStartDelay: number;
elementsPerWorker: number;
poolMinSize: number;
poolMaxSize: number;
poolStrategy: WorkerChoiceStrategy;
} | Worker configuration section:
- processType: worker threads process type (workerSet/staticPool/dynamicPool)
- startDelay: milliseconds to wait at worker threads startup (only for workerSet threads process type)
- elementStartDelay: milliseconds to wait at charging station startup
- elementsPerWorker: number of charging stations per worker threads for the `workerSet` process type
- poolMinSize: worker threads pool minimum number of threads- poolMaxSize: worker threads pool maximum number of threads
- poolStrategy: worker threads pool [poolifier](https://github.com/poolifier/poolifier) worker choice strategy |
-| uiServer | | {
"enabled": true,
"type": "ws",
"options": {
"host: "localhost",
"port": 8080
}
} | {
enabled: boolean;
type: ApplicationProtocol;
options: ServerOptions;
} | UI server configuration section |
+| uiServer | | {
"enabled": true,
"type": "ws",
"options": {
"host: "localhost",
"port": 8080
}
} | {
enabled: boolean;
type: ApplicationProtocol;
options: ServerOptions;
authentication: {
enabled: boolean;
type: AuthenticationType;
username: string;
password: string;
}
} | UI 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) |
@@ -386,9 +386,13 @@ All kind of OCPP parameters are supported in a charging station configuration or
Protocol to control the simulator via a Websocket or HTTP server.
-### WebSocket Protocol
+### HTTP Protocol
+
+To learn how to use the HTTP protocol to pilot the simulator, an [Insomnia](https://insomnia.rest/) requests collection is available in [src/assets](./src/assets/) directory.
+
+### Websocket Protocol
-PDU stands for Protocol Data Unit.
+SRPC protocol over Websocket. PDU stands for 'Protocol Data Unit'.
- Request:
[`uuid`, `ProcedureName`, `PDU`]
@@ -399,15 +403,15 @@ PDU stands for Protocol Data Unit.
- Response:
[`uuid`, `PDU`]
`uuid`: String uniquely linking the response to the request
- `PDU`: Response data to requested procedure
+ `PDU`: Response parameters to requested procedure
-### Version 0.0.1
+#### Version 0.0.1
-Set the WebSocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
+Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
-#### Procedures
+##### Procedures
-##### Start Simulator
+###### Start Simulator
- Request:
`ProcedureName`: 'startSimulator'
@@ -415,10 +419,10 @@ Set the WebSocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
- Response:
`PDU`: {
- `status`
+ `status`: 'success' | 'failure'
}
-##### Stop Simulator
+###### Stop Simulator
- Request:
`ProcedureName`: 'stopSimulator'
@@ -426,10 +430,10 @@ Set the WebSocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
- Response:
`PDU`: {
- `status`
+ `status`: 'success' | 'failure'
}
-##### List Charging Stations
+###### List Charging Stations
- Request:
`ProcedureName`: 'listChargingStations'
@@ -437,96 +441,134 @@ Set the WebSocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
- Response:
`PDU`: {
- `status`,
- `index`: ChargingStationData,
- ...
- `index`: ChargingStationData
+ `status`: 'success' | 'failure',
+ `chargingStations`: ChargingStationData[]
}
-##### Start Transaction
+###### Start Transaction
- Request:
`ProcedureName`: 'startTransaction'
`PDU`: {
- `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array,
+ `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
`connectorId`: connector id integer,
`idTag`: RFID tag string
}
- Response:
`PDU`: {
- `status`
+ `status`: 'success' | 'failure',
+ `hashIdsSucceeded`: charging station unique identifier strings array,
+ `hashIdsFailed`: charging station unique identifier strings array (optional)
}
-##### Stop Transaction
+###### Stop Transaction
- Request:
`ProcedureName`: 'stopTransaction'
`PDU`: {
- `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array,
+ `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
`transactionId`: transaction id integer
}
- Response:
`PDU`: {
- `status`
+ `status`: 'success' | 'failure',
+ `hashIdsSucceeded`: charging station unique identifier strings array,
+ `hashIdsFailed`: charging station unique identifier strings array (optional)
}
-##### Start Charging Station
+###### Start Charging Station
- Request:
`ProcedureName`: 'startChargingStation'
`PDU`: {
- `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array
+ `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
}
- Response:
`PDU`: {
- `status`
+ `status`: 'success' | 'failure',
+ `hashIdsSucceeded`: charging station unique identifier strings array,
+ `hashIdsFailed`: charging station unique identifier strings array (optional)
}
-##### Stop Charging Station
+###### Stop Charging Station
- Request:
`ProcedureName`: 'stopChargingStation'
`PDU`: {
- `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array
+ `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
}
- Response:
`PDU`: {
- `status`
+ `status`: 'success' | 'failure',
+ `hashIdsSucceeded`: charging station unique identifier strings array,
+ `hashIdsFailed`: charging station unique identifier strings array (optional)
}
-##### Open Connection
+###### Open Connection
- Request:
`ProcedureName`: 'openConnection'
`PDU`: {
- `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array
+ `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
}
- Response:
`PDU`: {
- `status`
+ `status`: 'success' | 'failure',
+ `hashIdsSucceeded`: charging station unique identifier strings array,
+ `hashIdsFailed`: charging station unique identifier strings array (optional)
}
-##### Close Connection
+###### Close Connection
- Request:
`ProcedureName`: 'closeConnection'
`PDU`: {
- `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array
+ `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
}
- Response:
`PDU`: {
- `status`
+ `status`: 'success' | 'failure',
+ `hashIdsSucceeded`: charging station unique identifier strings array,
+ `hashIdsFailed`: charging station unique identifier strings array (optional)
}
-### HTTP Protocol
+###### Start Automatic Transaction Generator
+
+- Request:
+ `ProcedureName`: 'startAutomaticTransactionGenerator'
+ `PDU`: {
+ `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
+ `connectorIds`: connector id integer array (optional, default: all connectors)
+ }
+
+- Response:
+ `PDU`: {
+ `status`: 'success' | 'failure',
+ `hashIdsSucceeded`: charging station unique identifier strings array,
+ `hashIdsFailed`: charging station unique identifier strings array (optional)
+ }
+
+###### Stop Automatic Transaction Generator
+
+- Request:
+ `ProcedureName`: 'stopAutomaticTransactionGenerator'
+ `PDU`: {
+ `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
+ `connectorIds`: connector id integer array (optional, default: all connectors)
+ }
-A Postman or Advanced REST client collection to learn how to use the HTTP protocol to pilot the simulator is available.
+- Response:
+ `PDU`: {
+ `status`: 'success' | 'failure',
+ `hashIdsSucceeded`: charging station unique identifier strings array,
+ `hashIdsFailed`: charging station unique identifier strings array (optional)
+ }
## Support, Feedback, Contributing