X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=e0cbce54918fa5a3d875285c30669f95adffc86a;hb=a38bc3151612c4fcbd108be125a2e75ef6682810;hp=9b18fed95d7df25bed80c712f6f87f09b9adff22;hpb=32de5a575189d226213641f5ee36004f8454cb50;p=e-mobility-charging-stations-simulator.git diff --git a/README.md b/README.md index 9b18fed9..e0cbce54 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 | @@ -383,71 +384,193 @@ All kind of OCPP parameters are supported in a charging station configuration or ## UI protocol -Protocol to control the simulator via a Websocket protocol +Protocol to control the simulator via a Websocket or HTTP server. + +### HTTP Protocol + +A Postman and [Insomnia](https://insomnia.rest/) requests collection, to learn how to use the HTTP protocol to pilot the simulator, is available in [src/assets](./src/assets/) directory. + +### 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 -### Version 0.0.1 +- Response: + [`uuid`, `PDU`] + `uuid`: String uniquely linking the response to the request + `PDU`: Response data to requested procedure -Set the HTTP header Sec-Websocket-Protocol to `ui0.0.1` +#### Version 0.0.1 -#### Protocol +Set the WebSocket header _Sec-Websocket-Protocol_ to `ui0.0.1`. -Request: -[`uuid`, `ProcedureName`, `PDU`] +##### Procedures -`uuid`: String uniquely representing this request -`ProcedureName`: The procedure to run on the simulator -`PDU (for Protocol Data Unit)`: The parameters (if any) for said procedure +###### Start Simulator -Response: -[`uuid`, `PDU`] +- Request: + `ProcedureName`: 'startSimulator' + `PDU`: {} -`uuid`: String uniquely linking the response to the request -`PDU`: Response data to requested procedure +- Response: + `PDU`: { + `status`: 'success' | 'failure' + } + +###### Stop Simulator -#### Procedures +- Request: + `ProcedureName`: 'stopSimulator' + `PDU`: {} -##### List Charging stations +- Response: + `PDU`: { + `status`: 'success' | 'failure' + } -Request: -`ProcedureName`: 'listChargingStation' -`PDU`: {} +###### List Charging Stations -Response: -`PDU`: { -`status`, -An array of ChargingStationData as described in `ChargingStationWorker.ts` file -} +- Request: + `ProcedureName`: 'listChargingStations' + `PDU`: {} -##### Start Transaction +- Response: + `PDU`: { + `status`: 'success' | 'failure', + `index`: ChargingStationData, + ... + `index`: ChargingStationData + } -Request: -`ProcedureName`: 'startTransaction' -`PDU`: { -`hashId`: the unique identifier of a chargingStation -`connectorId`: the id of the connector (start at 1) -`idTag`: An allowed badge authetification ID -} +###### Start Transaction -Response: -`PDU`: { -`status`, -**null** -} +- Request: + `ProcedureName`: 'startTransaction' + `PDU`: { + `hashIds`: charging station unique identifier strings array (optional, default: all charging stations), + `connectorId`: connector id integer, + `idTag`: RFID tag string + } -##### Stop Transaction +- Response: + `PDU`: { + `status`: 'success' | 'failure', + `hashIdsSucceeded`: charging station unique identifier strings array, + `hashIdsFailed`: charging station unique identifier strings array (optional) + } -Request: -`ProcedureName`: 'stopTransaction' -`PDU`: { -`hashId`: the unique identifier of a chargingStation -`transactionId`: the id of the transaction -} +###### Stop Transaction -Response: -`PDU`: { -`status`, -**null** -} +- Request: + `ProcedureName`: 'stopTransaction' + `PDU`: { + `hashIds`: charging station unique identifier strings array (optional, default: all charging stations), + `transactionId`: transaction id integer + } + +- Response: + `PDU`: { + `status`: 'success' | 'failure', + `hashIdsSucceeded`: charging station unique identifier strings array, + `hashIdsFailed`: charging station unique identifier strings array (optional) + } + +###### Start Charging Station + +- Request: + `ProcedureName`: 'startChargingStation' + `PDU`: { + `hashIds`: charging station unique identifier strings array (optional, default: all charging stations) + } + +- Response: + `PDU`: { + `status`: 'success' | 'failure', + `hashIdsSucceeded`: charging station unique identifier strings array, + `hashIdsFailed`: charging station unique identifier strings array (optional) + } + +###### Stop Charging Station + +- Request: + `ProcedureName`: 'stopChargingStation' + `PDU`: { + `hashIds`: charging station unique identifier strings array (optional, default: all charging stations) + } + +- Response: + `PDU`: { + `status`: 'success' | 'failure', + `hashIdsSucceeded`: charging station unique identifier strings array, + `hashIdsFailed`: charging station unique identifier strings array (optional) + } + +###### Open Connection + +- Request: + `ProcedureName`: 'openConnection' + `PDU`: { + `hashIds`: charging station unique identifier strings array (optional, default: all charging stations) + } + +- Response: + `PDU`: { + `status`: 'success' | 'failure', + `hashIdsSucceeded`: charging station unique identifier strings array, + `hashIdsFailed`: charging station unique identifier strings array (optional) + } + +###### Close Connection + +- Request: + `ProcedureName`: 'closeConnection' + `PDU`: { + `hashIds`: charging station unique identifier strings array (optional, default: all charging stations) + } + +- Response: + `PDU`: { + `status`: 'success' | 'failure', + `hashIdsSucceeded`: charging station unique identifier strings array, + `hashIdsFailed`: charging station unique identifier strings array (optional) + } + +###### 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) + } + +- Response: + `PDU`: { + `status`: 'success' | 'failure', + `hashIdsSucceeded`: charging station unique identifier strings array, + `hashIdsFailed`: charging station unique identifier strings array (optional) + } ## Support, Feedback, Contributing