X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=63d48d98eae81e37333574abf1dc07e2438b286b;hb=cb886184464ed30ee14f538581e511710131b6ef;hp=746bb9e04f7be7d6d74861389a7dfe2a10df20a6;hpb=60ad3d178c0121ed48a346461dcd71047e44e8be;p=e-mobility-charging-stations-simulator.git diff --git a/README.md b/README.md index 746bb9e0..63d48d98 100644 --- a/README.md +++ b/README.md @@ -49,8 +49,9 @@ Tweak them to your needs by following the section [configuration files syntax](R To start the program, run: `npm start`. -To start the program with a UI controller, run: `npm run start:server`. -Then, start/stop the simulator by going to `https://` in a browser. Localhost port will default to 8080. For Cloud Foundry, the port is assigned based on the `process.env.PORT` environment variable. +## Start Web UI + +See Web UI [README.md](src/ui/web/README.md) for more information. ## Configuration files syntax @@ -100,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,
"options": {
"host: "localhost",
"port": 8080
}
} | {
enabled: boolean;
options: ServerOptions;
} | UI WebSocket server configuration section | +| uiServer | | {
"enabled": true,
"type": "ws",
"options": {
"host: "localhost",
"port": 8080
}
} | {
enabled: boolean;
type: ApplicationProtocol;
options: ServerOptions;
} | 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) | @@ -158,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 | @@ -381,6 +382,152 @@ All kind of OCPP parameters are supported in a charging station configuration or - _none_ +## UI protocol + +Protocol to control the simulator via a Websocket or HTTP server. + +### WebSocket Protocol + +PDU stands for Protocol Data Unit. + +- Request: + [`uuid`, `ProcedureName`, `PDU`] + `uuid`: String uniquely representing this request + `ProcedureName`: The procedure to run on the simulator + `PDU`: The parameters for said procedure + +- Response: + [`uuid`, `PDU`] + `uuid`: String uniquely linking the response to the request + `PDU`: Response data to requested procedure + +### Version 0.0.1 + +Set the WebSocket header _Sec-Websocket-Protocol_ to `ui0.0.1`. + +#### Procedures + +##### Start Simulator + +- Request: + `ProcedureName`: 'startSimulator' + `PDU`: {} + +- Response: + `PDU`: { + `status` + } + +##### Stop Simulator + +- Request: + `ProcedureName`: 'stopSimulator' + `PDU`: {} + +- Response: + `PDU`: { + `status` + } + +##### List Charging Stations + +- Request: + `ProcedureName`: 'listChargingStations' + `PDU`: {} + +- Response: + `PDU`: { + `status`, + `index`: ChargingStationData, + ... + `index`: ChargingStationData + } + +##### Start Transaction + +- 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` + } + +##### Stop Transaction + +- Request: + `ProcedureName`: 'stopTransaction' + `PDU`: { + `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array, + `transactionId`: transaction id integer + } + +- Response: + `PDU`: { + `status` + } + +##### Start Charging Station + +- Request: + `ProcedureName`: 'startChargingStation' + `PDU`: { + `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array + } + +- Response: + `PDU`: { + `status` + } + +##### Stop Charging Station + +- Request: + `ProcedureName`: 'stopChargingStation' + `PDU`: { + `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array + } + +- Response: + `PDU`: { + `status` + } + +##### 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` + } + +### HTTP Protocol + +A Postman or [Insomnia](https://insomnia.rest/) collection, to learn how to use the HTTP protocol to pilot the simulator, is available. + ## 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).