diff --git a/README.md b/README.md index 840075b4b2c6f4cc4325cee6173305555adbd67c..de733baf027116fa5679089a7e786e680a9e027d 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,14 @@ This project deals with the localization of a vehicle on a race track. This is a student project from Bochum University of Applied Sciences. -The main approach of localization is based on locating the vehicle based on the current and already travelled section types. -A section type can be a right turn, a left turn and straight. +The main approach of the localization is to locate the vehicle based on the current and previously driven section types. +A section type can be a right turn, a left turn or a straight section. ## Robot -The used Robot is the LEGO EV3 Brick as a line follower to test the algorithm. +To test the algorithm, the robot LEGO EV3 Brick is used. It follows the trace with the help of a line tracker. -The robot use MicroPython. -How to install MicroPython and set up your Visual Studio Code to connect your pc to the robot is documented in this file: +The robot uses MicroPython. +A guide on how to install MicroPython, how to set up Visual Studio Code and how to connect the robot can be found at the following link: https://assets.education.lego.com/v3/assets/blt293eea581807678a/bltb470b9ea6e38f8d4/5f8802fc4376310c19e33714/getting-started-with-micropython-v2_enus.pdf?locale=de-de Important notes regarding the robot: @@ -37,14 +37,15 @@ Important notes regarding the robot: * socket * datetime -### Preparations before run -Clone this git. Connect the EV3 robot to the same network as your executing device. +### Preparations before running +* Clone this git. +* Connect the EV3 robot to the same network as your executing device. The following adjustments might be necessary, before the algorithm is executable: * change ip-address in Lokalisierung_LEGO/main.py to the ip-address of the executing device * insert the sections of the race track in localization.py (get_set_of_section_*()) * structure of a section: [name, section_type, previous_sections_type] -* if the track plotter is used, insert also a set of track parts in the file grafic (get_set_of_trackparts_*()). +* if the track plotter is used, insert a set of track parts in the file grafic (get_set_of_trackparts_*()). * structure of a section: [URL, name, start position(x,y), start orientation] * Images of the race tracks are not included in this git. If interested, please contact the authors. @@ -65,13 +66,14 @@ Notes on constant values (in race_management.py): ### Run 1. Connect the robot via Visual Studio Code. 2. Start the python file race_management.py - * Now some windows should pop up. - * You can't move this windows until the UDP-connection with the robot is connected. - * __When you want to stop the script you have to restart the python kernel.__ -3. Start the main.py file on the robot. - * To do this, select the file in the Lego-EV window in the lower left corner of Visual Studio Code. Then right click and click on "Run" -4. Now the robot should drive and send data to the pc which print the current detected section on the console and plot stuff. -5. To stop the robot/program press the left upper button on the robot, or close the dashboard window. + * Some pop-up windows will appear. + * The windows can't be moved until the UDP-connection is established. + **When you want to stop the script you have to restart the python kernel.** +3. Start the main.py file on the robot: + * Select the file in the Lego-EV window in Visual Studio Code (lower left corner). + * Start the file by right-clicking. +4. The robot drives and sends data to the executing device, which prints the current detected section to the console and plots further data. +5. To stop the robot / program press the left upper button on the robot or close the dashboard window. ## Description The main branch contains the following files: @@ -93,4 +95,4 @@ This project is licensed under the MIT License - see the LICENSE file for detail ## Project status Project closed. -Cordial invitation to further develop this project. \ No newline at end of file +Please don't hesitate to develop this project further. \ No newline at end of file