X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=5b1c9fe50c21802a00cc51c57dd80cf73adbd30b;hb=8053c842c7b96f5d62f4daa7dbd5054ba7468e05;hp=1fb3a7077332fe780f54656f38a10ff7c722f70e;hpb=e7cb1b684b42ad70d2deb39ad9edd066ba1c0176;p=e-mobility-charging-stations-simulator.git
diff --git a/README.md b/README.md
index 1fb3a707..5b1c9fe5 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,8 @@
# [e-mobility charging stations simulator](https://github.com/sap/e-mobility-charging-stations-simulator)
-[](https://img.shields.io/github/commit-activity/m/SAP/e-mobility-charging-stations-simulator/main)
+[](https://github.com/SAP/e-mobility-charging-stations-simulator/graphs/traffic)
+[](https://github.com/SAP/e-mobility-charging-stations-simulator/graphs/commit-activity)
[](https://github.com/SAP/e-mobility-charging-stations-simulator/actions/workflows/ci.yml)
[](https://api.reuse.software/info/github.com/SAP/e-mobility-charging-stations-simulator)
@@ -104,7 +105,7 @@ But the modifications to test have to be done to the files in the build target d
| supervisionUrls | | [] | string \| string[] | string or strings array containing global connection URIs to OCPP-J servers |
| supervisionUrlDistribution | round-robin/random/charging-station-affinity | charging-station-affinity | string | supervision urls distribution policy to simulated charging stations |
| log | | {
"enabled": true,
"file": "logs/combined.log",
"errorFile": "logs/error.log",
"statisticsInterval": 60,
"level": "info",
"console": false,
"format": "simple",
"rotate": true
} | {
enabled: boolean;
file: string;
errorFile: string;
statisticsInterval: number;
level: string;
console: boolean;
format: string;
rotate: boolean;
maxFiles: string \| number;
maxSize: string \| number;
} | Log configuration section:
- _enabled_: enable logging
- _file_: log file relative path
- _errorFile_: error log file relative path
- _statisticsInterval_: seconds between charging stations statistics output in the logs
- _level_: emerg/alert/crit/error/warning/notice/info/debug [winston](https://github.com/winstonjs/winston) logging level- _console_: output logs on the console
- _format_: [winston](https://github.com/winstonjs/winston) log format
- _rotate_: enable daily log files rotation
- _maxFiles_: maximum number of log files: https://github.com/winstonjs/winston-daily-rotate-file#options
- _maxSize_: maximum size of log files in bytes, or units of kb, mb, and gb: https://github.com/winstonjs/winston-daily-rotate-file#options |
-| worker | | {
"processType": "workerSet",
"startDelay": 500,
"elementStartDelay": 0,
"elementsPerWorker": 'auto',
"poolMinSize": 4,
"poolMaxSize": 16,
"poolStrategy": "ROUND_ROBIN"
} | {
processType: WorkerProcessType;
startDelay: number;
elementStartDelay: number;
elementsPerWorker: number \| 'auto';
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` worker threads process type)
- _elementStartDelay_: milliseconds to wait at charging station startup
- _elementsPerWorker_: number of charging stations per worker threads for the `workerSet` process type (`auto` means (number of stations) / (number of CPUs) if (number of stations) > (number of CPUs), otherwise 1)
- _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 |
+| worker | | {
"processType": "workerSet",
"startDelay": 500,
"elementStartDelay": 0,
"elementsPerWorker": 'auto',
"poolMinSize": 4,
"poolMaxSize": 16
} | {
processType: WorkerProcessType;
startDelay: number;
elementStartDelay: number;
elementsPerWorker: number \| 'auto';
poolMinSize: number;
poolMaxSize: number;
} | Worker configuration section:
- _processType_: worker threads process type (`workerSet`/`staticPool`/`dynamicPool`)
- _startDelay_: milliseconds to wait at worker threads startup (only for `workerSet` worker threads process type)
- _elementStartDelay_: milliseconds to wait at charging station startup
- _elementsPerWorker_: number of charging stations per worker threads for the `workerSet` process type (`auto` means (number of stations) / (number of CPUs) \* 1.5 if (number of stations) > (number of CPUs), otherwise 1)
- _poolMinSize_: worker threads pool minimum number of threads- _poolMaxSize_: worker threads pool maximum number of threads |
| uiServer | | {
"enabled": false,
"type": "ws",
"options": {
"host": "localhost",
"port": 8080
}
} | {
enabled: boolean;
type: ApplicationProtocol;
options: ServerOptions;
authentication: {
enabled: boolean;
type: AuthenticationType;
username: string;
password: string;
}
} | 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) |
@@ -392,7 +393,7 @@ make SUBMODULES_INIT=true
#### Smart Charging Profile
- :white_check_mark: ClearChargingProfile
-- :x: GetCompositeSchedule
+- :white_check_mark: GetCompositeSchedule
- :white_check_mark: SetChargingProfile
#### Remote Trigger Profile