-# [charging-stations-simulator](https://github.com/jerome-benoit/charging-stations-simulator)
+# [emobility-charging-stations-simulator](https://github.com/sap/emobility-charging-stations-simulator)
## Summary
- charging stations simulator configuration: [src/assets/config.json](src/assets/config.json);
- charging station configuration templates: [src/assets/station-templates](src/assets/station-templates);
-- charging station configurations: [src/assets/configurations](src/assets/configurations);
-- charging station RFID tags lists in [src/assets](src/assets).
+- charging station configurations: [dist/assets/configurations](dist/assets/configurations);
+- charging station RFID tags lists: [src/assets](src/assets).
The charging stations simulator's configuration parameters must be within the `src/assets/config.json` file. A charging station simulator configuration template file is available at [src/assets/config-template.json](src/assets/config-template.json).
**Configuration files hierarchy and priority**:
-1. charging station configuration: [src/assets/configurations](src/assets/configurations);
+1. charging station configuration: [dist/assets/configurations](dist/assets/configurations);
2. charging station configuration template: [src/assets/station-templates](src/assets/station-templates);
3. charging stations simulator configuration: [src/assets/config.json](src/assets/config.json).
| logLevel | emerg/alert/crit/error/warning/notice/info/debug | info | string | winston logging level |
| logFile | | combined.log | string | log file relative path |
| logErrorFile | | error.log | string | error log file relative path |
-| uiWebSocketServer | | { "enabled": true, "options": { "host: "localhost", "port": 8080 } } | { enabled: boolean; options: ServerOptions; } | UI WebSocket server configuration section |
+| uiServer | | { "enabled": true, "options": { "host: "localhost", "port": 8080 } } | { enabled: boolean; options: ServerOptions; } | UI WebSocket 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) |
| transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction |
| mainVoltageMeterValues | true/false | true | boolean | include charging stations main voltage MeterValues on three phased charging stations |
| phaseLineToLineVoltageMeterValues | true/false | true | boolean | include charging stations line to line voltage MeterValues on three phased charging stations |
+| customValueLimitationMeterValues | true/false | true | boolean | enable limitation on custom fluctuated value in MeterValues |
| Configuration | | | ChargingStationConfiguration | charging stations OCPP parameters configuration section |
| AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration section |
| Connectors | | | Connectors | charging stations connectors configuration section |
### Charging station configuration
-**src/assets/configurations/\<hashId\>.json**:
+**dist/assets/configurations/\<hashId\>.json**:
-The charging station configuration file is automatically generated at startup from the charging station configuration template file and are persistent.
+The charging station configuration file is automatically generated at startup from the charging station configuration template file and is persistent.
The charging station configuration file content can be regenerated partially on matching charging station configuration template file changes. The charging station serial number is kept unchanged.
To start the program, run: `npm start`.
+To start the program with a UI controller, run: `npm start:server`.
+Then, start/stop the simulator by going to `https://<hostname:port>` in a browser. Localhost port will default to 8080. For Cloud Foundry, the port is assigned based on the `process.env.PORT` environment variable.
+
## Docker
In the [docker](./docker) folder:
#### Smart Charging Profile
- :white_check_mark: ClearChargingProfile
-- :white_check_mark: GetCompositeSchedule
+- :x: GetCompositeSchedule
- :white_check_mark: SetChargingProfile
#### Remote Trigger Profile
- _none_
-## License
+## Support, Feedback, Contributing
+
+This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/emobility-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).
+
+## Code of Conduct
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](CODE_OF_CONDUCT.md) at all times.
-This file and all other files in this repository are licensed under the Apache Software License, v.2 and copyrighted under the copyright in [NOTICE](NOTICE) file, except as noted otherwise in the [LICENSE](LICENSE) file or the code source file header.
+## Licensing
-Please note that Docker images can contain other software which may be licensed under different licenses. This LICENSE and NOTICE files are also included in the Docker image. For any usage of built Docker images please make sure to check the licenses of the artifacts contained in the images.
+Copyright 2020-2022 SAP SE or an SAP affiliate company and emobility-charging-stations-simulator contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/emobility-charging-stations-simulator).
repositories / e-mobility-charging-stations-simulator.git / blobdiff