X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=f59641624e92b696cfbb72730f4ea5531efd34b3;hb=86102a27a41ff89422d375ff847c23b293e5773a;hp=52fa721e89b8b31726dc73ce2d481720f2a1ebec;hpb=ed6c2bb716260dc6f4f53d897b1c9f74519e75b3;p=e-mobility-charging-stations-simulator.git diff --git a/README.md b/README.md index 52fa721e..f5964162 100644 --- a/README.md +++ b/README.md @@ -395,7 +395,7 @@ Request: `uuid`: String uniquely representing this request `ProcedureName`: The procedure to run on the simulator -`PDU`: The parameters (if any) for said procedure +`PDU`: The parameters for said procedure Response: [`uuid`, `PDU`] @@ -409,7 +409,29 @@ Set the HTTP header _Sec-Websocket-Protocol_ to `ui0.0.1` #### Procedures -##### List Charging stations +##### Start Simulator + +Request: +`ProcedureName`: 'startSimulator' +`PDU`: {} + +Response: +`PDU`: { +`status` +} + +##### Stop Simulator + +Request: +`ProcedureName`: 'stopSimulator' +`PDU`: {} + +Response: +`PDU`: { +`status` +} + +##### List Charging Stations Request: `ProcedureName`: 'listChargingStations' @@ -430,7 +452,7 @@ Request: `PDU`: { `hashId`: the unique identifier of a charging station `connectorId`: the id of the connector -`idTag`: An allowed badge authetification ID +`idTag`: the RFID tag } Response: @@ -478,6 +500,32 @@ Response: `status` } +##### Open Connection + +Request: +`ProcedureName`: 'openConnection' +`PDU`: { +`hashId`: the unique identifier of a charging station +} + +Response: +`PDU`: { +`status` +} + +##### Close Connection + +Request: +`ProcedureName`: 'closeConnection' +`PDU`: { +`hashId`: the unique identifier of a charging station +} + +Response: +`PDU`: { +`status` +} + ## Support, Feedback, Contributing This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/e-mobility-charging-stations-simulator/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).