From de57b0d7ce5cd7300210badb07034588948cf062 Mon Sep 17 00:00:00 2001
From: Jessica Dreyer <jessica.dreyer@stud.hs-bochum.de>
Date: Tue, 27 Jun 2023 10:43:33 +0000
Subject: [PATCH] Changed README
---
README.md | 42 +++++++++++++++++++++---------------------
1 file changed, 21 insertions(+), 21 deletions(-)
diff --git a/README.md b/README.md
index f5a00cc..35f635f 100644
--- a/README.md
+++ b/README.md
@@ -8,44 +8,44 @@ Jessica Dreyer, Sebastian Böttger
## Getting started
The main branch contains the following files:
-> localization.py: localization algorithm
-> driving.py: detection of section type, calculation of odometry, calculation driven distance in section
-> grafic.py: graphical output
-> race_management.py: main program
-> Lokalisierung_LEGO (folder), main.py: programming of the robot LEGO EV3
+* localization.py: localization algorithm
+* driving.py: detection of section type, calculation of odometry, calculation driven distance in section
+* grafic.py: graphical output
+* race_management.py: main program
+* Lokalisierung_LEGO (folder), main.py: programming of the robot LEGO EV3
## Name
localization of a vehicle on a race track
## Description
The following adjustments might be necessary, before the algorithm is executable:
- > change ip-address in main.py
- > entering the route in localization.py (get_set_of_section_*())
+* change ip-address in main.py
+* entering the route in localization.py (get_set_of_section_*())
Important notes regarding the robot:
- The sensors / motors are connected to the following ports of the robot:
- > Motor: OUTPUT A & OUTPUT B
- > ColorSensor: INPUT 4
- > GyroSensor: INPUT 1
+* The sensors / motors are connected to the following ports of the robot:
+ * Motor: OUTPUT A & OUTPUT B
+ * ColorSensor: INPUT 4
+ * GyroSensor: INPUT 1
- The following measured values are stored and must be adjusted if necessary (in main.py):
- > wheel circumference (radumfang)
- > wheel spacing (d)
+* The following measured values are stored and must be adjusted if necessary (in main.py):
+ * wheel circumference (radumfang)
+ * wheel spacing (d)
-Notes on constant values (in race_management.py):
- > CHAR_RECIVING: number of chars in one UDP-message
+* Notes on constant values (in race_management.py):
+ * CHAR_RECIVING: number of chars in one UDP-message
This value should only be changed if the sent string changes.
- > THRESHOLD_LEFT, THRESHOLD_RIGHT: value to detect a left or right turn
+ * THRESHOLD_LEFT, THRESHOLD_RIGHT: value to detect a left or right turn
This value can be changed to possibly improve the algorithm.
- > BLOCK_SIZE_DA: number of iterations to analyse the section type
+ * BLOCK_SIZE_DA: number of iterations to analyse the section type
This value can be changed to possibly improve the algorithm.
- > S = 0: value for a straight part of the track
- > R = 1: value for a right turn
- > L = 2: value for a left turn
+ * S = 0: value for a straight part of the track
+ * R = 1: value for a right turn
+ * L = 2: value for a left turn
This values should not be changed in order to maintain the algorithm.
## Authors and acknowledgment
--
GitLab