diff --git a/README.md b/README.md index 73c8e1d..fffa607 100644 --- a/README.md +++ b/README.md @@ -29,11 +29,42 @@ This project is a kobuki that drives around in dangerous areas and detects objec - Type `git clone https://gitlab.fdmci.hva.nl/technische-informatica-sm3/ti-projectten/rooziinuubii79.git 3. **Install the required packages** - - Open the terminal and navigate to the project - scr - Python - flask. - - Run the following command to install the required packages: - - `pip install -r requirements.txt` - - This will install all the python packages required to run the project. - - for C++, you will need to install the following packages: - - OpenCV - - mqtt-client -4. \ No newline at end of file + - Install the following packages on the server: "docker docker-buildx mosquitto nginx" + - Install the following packages on the Raspberry Pi: "g++ make cmake", https://github.com/eclipse-paho/paho.mqtt.c, https://github.com/eclipse-paho/paho.mqtt.cpp + + + +4. **Run the project** + + #### Server side + - Run the following commands in the terminal to start the website: + - `cd src/Python/flask` + - `sudo docker buildx build -t flaskapp:latest .` + - `sudo docker run --network="host" --restart=always flaskapp:latest` + - Run the following commands in the terminal to start the MQTT broker: + - `cd src/config/server/` + - `mosquitto -c mosquitto.conf` + - Run the following commands in the terminal to start the Nginx server: + - `cd src/config/server/` + - `cp nginx.conf /etc/nginx/nginx.conf` + - `cp nginx-sites.conf /etc/nginx/sites-enable/nginx-sites.conf` + + + #### Raspberry Pi side + - Run the following commands to build and start the driver: + - `cd src/C++/Driver` + - `cmake ..` + - `make` + - `./kobuki_driver` + - Run the following commands to autostart the driver on startup of the Raspberry Pi: + - `cd src/config/rpi/` + - `cp kobukiDriver.service /etc/systemd/system/kobukiDriver.service` + - `systemctl enable kobukiDriver.service` + - `systemctl start kobukiDriver.service` + +## Extra notes +Dont forget to change the IP address in the `src/C++/Driver/src/main.cpp` file to the IP address of the server. + + + +