Added description to Fuzzy Controller and Console

alexeysp11 · Sep 9, 2020 · cc54103 · cc54103
1 parent 5fd1f1b
commit cc54103
Show file tree

Hide file tree

Showing 3 changed files with 112 additions and 0 deletions.
diff --git a/console/README.md b/console/README.md
@@ -1 +1,68 @@
 # console 
+## How this module works
+```
+Welcome to SDC console!
+>> sdc
+SDC CONSOLE APP
+
+SDC stands for Self-Driving Cars.
+So this app allows you to simulate some modules of SDC within a console.
+
+All modules can be called by:
+    sdc module --mode
+
+All information modules can be called by:
+    sdc -commands
+    sdc -help
+
+Main modules:
+    imu             | Inertial Measurement Unit (GPS, gyro, accelerometer)
+    gps             | GPS
+    gyro            | Gyroscope
+    accel           | Accelerometer
+    lidar           | Lidar
+    fuzzy           | Fuzzy Controller
+    nn              | Neural Network
+    test            | Unit-tests for each module
+    exit            | Exit
+```
+```
+>> sdc -commands
+Main modules:
+    imu             | Inertial Measurement Unit (GPS, gyro, accelerometer)
+    gps             | GPS
+    gyro            | Gyroscope
+    accel           | Accelerometer
+    lidar           | Lidar
+    fuzzy           | Fuzzy Controller
+    nn              | Neural Network
+    test            | Unit-tests for each module
+    exit            | Exit
+```
+```
+>> sdc -help
+SDC CONSOLE APP
+
+SDC stands for Self-Driving Cars.
+So this app allows you to simulate some modules of SDC within a console.
+
+All modules can be called by:
+    sdc module --mode
+
+All information modules can be called by:
+    sdc -commands
+    sdc -help
+```
+```
+>> sdc gps
+sdc gps:
+    --p             | GPS (position)
+    --v             | GPS (velocity)
+    --a             | GPS (acceleration)
+```
+```
+>> sdc gyro
+sdc gyro:
+    --const         | Gyroscope (constant angle)
+    --nu            | Gyroscope (non-uniform rotation)
+```
diff --git a/fuzzy_controller/README.md b/fuzzy_controller/README.md
@@ -1,3 +1,48 @@
 # fuzzy_controller
 The **Fuzzy Controller** module is used for counting speed of a car according to the *distance* between it and *next* and *previous* points on the map.    
 In this program we need to pass a value of distance to the input of the **fuzzy controller** and get a value of speed as an output. 
+## How this module works
+```
+Welcome to SDC console!
+>> sdc
+SDC CONSOLE APP
+
+SDC stands for Self-Driving Cars.
+So this app allows you to simulate some modules of SDC within a console.
+
+All modules can be called by:
+    sdc module --mode
+
+All information modules can be called by:
+    sdc -commands
+    sdc -help
+
+Main modules:
+    imu             | Inertial Measurement Unit (GPS, gyro, accelerometer)
+    gps             | GPS
+    gyro            | Gyroscope
+    accel           | Accelerometer
+    lidar           | Lidar
+    fuzzy           | Fuzzy Controller
+    nn              | Neural Network
+    test            | Unit-tests for each module
+    exit            | Exit
+```
+```
+>> sdc fuzzy
+Select one of these options:
+            1) Enter distance and get speed once,
+            2) Describe relationship between distance and speed in the graph.
+
+Please, enter 1 or 2: 1
+Distance (m): 14
+Speed = 30.0 km/h
+```
+```
+>> sdc fuzzy
+Select one of these options:
+            1) Enter distance and get speed once,
+            2) Describe relationship between distance and speed in the graph.
+
+Please, enter 1 or 2: 2
+```
diff --git a/fuzzy_controller/img/fuzzy_distance_speed.png b/fuzzy_controller/img/fuzzy_distance_speed.png