From 0e05dcdb64a0d0b0f1ef35fff643b5b1dc49ac33 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Heredero?= Date: Sat, 17 Jun 2023 15:38:30 +0200 Subject: [PATCH] update README.md --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3c5c9a0..33f6575 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,25 @@ regulation just for keep the grid alive during the time of the simulation. We st simulation send a score. This score is how many production we have made with the factory during the simulation. So the goal is to maximize this score. We didn't have time to make a better regulation. +### Full description +You can find the Javadoc of this project in the folder ``javadoc`` at the root of the project. + ## How to use To use this project you can just download the last release and run the JAR file with some arguments. -The arguments are: +The command to run the JAR file is: +``java -jar MinecraftController.jar [-erasedb]`` +Where the arguments are: +``db_url``: The complete URL of the InfluxDB server, including the protocol (http or https)... +Example: https://influx.sdi.hevs.ch +``db_org``: The name of the Influx DB to use. For this project, this name is the name of the group you've been +affected to. (SInXX) +``db_bucket``: The user's name to use to access the DB. It's also your group's name. (SInXX) +``db_token``: The Token to use to access the DB. +``modbus_host``: The IP address of the Minecraft ModbusTCP server (default value: localhost) +``modbus_port``: The port number of the Minecraft ModbusTCP server (default value: 1502) +``-erasedb``: Optional parameter! If set, the application will erase the previous data in InfluxDB... +Example: +``java -jar MinecraftController.jar https://influx.sdi.hevs.ch SIn15 SIn15 evP...nj-Q== localhost 1502 -erasedb`` + + +