X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=855e13db05ec966089f4753206419719b27e12a2;hb=dbd54e98c369aa3032a76a066c9ff9828ef5a742;hp=edc08c6c9c10633cd328832580b567de359f789f;hpb=1f7fa4de53a1b28324f362402f61b81b28d75c2c;p=e-mobility-charging-stations-simulator.git diff --git a/README.md b/README.md index edc08c6c..855e13db 100644 --- a/README.md +++ b/README.md @@ -159,8 +159,8 @@ But the modifications to test have to be done to the files in the build target d | amperageLimitationOcppKey | | undefined | string | charging stations OCPP parameter key used to set the amperage limit, per phase for each connector on AC and global for DC | | amperageLimitationUnit | A/cA/dA/mA | A | string | charging stations amperage limit unit | | enableStatistics | true/false | true | boolean | enable charging stations statistics | -| mayAuthorizeAtRemoteStart | true/false | true | boolean | always send authorize at remote start transaction when AuthorizeRemoteTxRequests is enabled | -| payloadSchemaValidation | true/false | true | boolean | validate OCPP commands PDU against OCA JSON schemas | +| mustAuthorizeAtRemoteStart | true/false | true | boolean | always send authorize at remote start transaction when AuthorizeRemoteTxRequests is enabled | +| payloadSchemaValidation | true/false | true | boolean | validate OCPP commands PDU against [OCA](https://www.openchargealliance.org/) JSON schemas | | beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues | | outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order. Need to relax OCPP specifications strict compliance ('ocppStrictCompliance' parameter) | | meteringPerTransaction | true/false | true | boolean | enable metering history on a per transaction basis | @@ -384,147 +384,149 @@ All kind of OCPP parameters are supported in a charging station configuration or ## UI protocol -Protocol to control the simulator via a Websocket +Protocol to control the simulator via a Websocket or HTTP server. -### Protocol +### HTTP Protocol -PDU stands for Protocol Data Unit +A Postman and [Insomnia](https://insomnia.rest/) collection, to learn how to use the HTTP protocol to pilot the simulator, is available in [src/assets](./src/assets/) directory. -Request: -[`uuid`, `ProcedureName`, `PDU`] +### WebSocket Protocol -`uuid`: String uniquely representing this request -`ProcedureName`: The procedure to run on the simulator -`PDU`: The parameters for said procedure +PDU stands for Protocol Data Unit. -Response: -[`uuid`, `PDU`] +- Request: + [`uuid`, `ProcedureName`, `PDU`] + `uuid`: String uniquely representing this request + `ProcedureName`: The procedure to run on the simulator + `PDU`: The parameters for said procedure -`uuid`: String uniquely linking the response to the request -`PDU`: Response data to requested procedure +- Response: + [`uuid`, `PDU`] + `uuid`: String uniquely linking the response to the request + `PDU`: Response data to requested procedure -### Version 0.0.1 +#### Version 0.0.1 -Set the HTTP 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' -`PDU`: {} +- Request: + `ProcedureName`: 'startSimulator' + `PDU`: {} -Response: -`PDU`: { -`status` -} +- Response: + `PDU`: { + `status` + } + +###### Stop Simulator + +- Request: + `ProcedureName`: 'stopSimulator' + `PDU`: {} + +- Response: + `PDU`: { + `status` + } -##### Stop Simulator +###### List Charging Stations -Request: -`ProcedureName`: 'stopSimulator' -`PDU`: {} +- Request: + `ProcedureName`: 'listChargingStations' + `PDU`: {} -Response: -`PDU`: { -`status` -} +- Response: + `PDU`: { + `status`, + `index`: ChargingStationData, + ... + `index`: ChargingStationData + } + +###### Start Transaction -##### List Charging Stations +- Request: + `ProcedureName`: 'startTransaction' + `PDU`: { + `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array, + `connectorId`: connector id integer, + `idTag`: RFID tag string + } + +- Response: + `PDU`: { + `status` + } -Request: -`ProcedureName`: 'listChargingStations' -`PDU`: {} +###### Stop Transaction -Response: -`PDU`: { -`status`, -`index`: ChargingStationData, -... -`index`: ChargingStationData -} +- Request: + `ProcedureName`: 'stopTransaction' + `PDU`: { + `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array, + `transactionId`: transaction id integer + } -##### Start Transaction +- Response: + `PDU`: { + `status` + } -Request: -`ProcedureName`: 'startTransaction' -`PDU`: { -`hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array, -`connectorId`: connector id integer, -`idTag`: RFID tag string -} +###### Start Charging Station -Response: -`PDU`: { -`status` -} +- Request: + `ProcedureName`: 'startChargingStation' + `PDU`: { + `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array + } -##### Stop Transaction +- Response: + `PDU`: { + `status` + } -Request: -`ProcedureName`: 'stopTransaction' -`PDU`: { -`hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array, -`transactionId`: transaction id integer -} +###### Stop Charging Station -Response: -`PDU`: { -`status` -} +- Request: + `ProcedureName`: 'stopChargingStation' + `PDU`: { + `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array + } -##### Start Charging Station +- Response: + `PDU`: { + `status` + } -Request: -`ProcedureName`: 'startChargingStation' -`PDU`: { -`hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array -} +###### Open Connection -Response: -`PDU`: { -`status` -} +- Request: + `ProcedureName`: 'openConnection' + `PDU`: { + `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array + } -##### Stop Charging Station +- Response: + `PDU`: { + `status` + } -Request: -`ProcedureName`: 'stopChargingStation' -`PDU`: { -`hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array -} +###### Close Connection -Response: -`PDU`: { -`status` -} +- Request: + `ProcedureName`: 'closeConnection' + `PDU`: { + `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array + } -##### Open Connection - -Request: -`ProcedureName`: 'openConnection' -`PDU`: { -`hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array -} - -Response: -`PDU`: { -`status` -} - -##### Close Connection - -Request: -`ProcedureName`: 'closeConnection' -`PDU`: { -`hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array -} - -Response: -`PDU`: { -`status` -} +- Response: + `PDU`: { + `status` + } ## Support, Feedback, Contributing