kleiax/Bachelorarbeit-Rover
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Finish documention until someone change something

Browse Source
This commit is contained in:
kleiax
2022-02-15 20:12:50 +01:00
parent 3a2e51713b
commit c8e3344b27
50 changed files with 991 additions and 223 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/SpecialMenus/Akku/menuAkku.cpp
+1 -1
View File
@@ -1,7 +1,7 @@
/**
* @file menuAkku.cpp
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains a implementation of the class MenuAkku
* @version 0.1
* @date 2022-02-05
*
src/SpecialMenus/Akku/menuAkku.h
+31 -9
View File
@@ -1,7 +1,7 @@
/**
* @file menuAkku.h
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains a Menu class to show battery pack informations
* @version 0.1
* @date 2022-02-05
*
@@ -16,19 +16,41 @@
#include "menuControl.h"
/**
* @brief This class shows Akku informations
*
* Provide information for main battery pack and
* PS3-Controller battery pack
*
*/
class MenuAkku : public MenuControl {
public:
/**
* @brief Construct a new Menu Akku object
*
*/
MenuAkku();
void down(){}
void up(){}
void right();
void left();
void no();
void yes();
void down() override {}
void up() override {}
void right() override;
void left() override;
void no() override;
void yes() override;
void printMenu();
void update();
/**
* @brief Prints the Information to display and console
*
* The informations are only printed to the display if it
* set.
*/
void printMenu() override;
/**
* @brief Renew the informations and print them
*
*/
void update() override;
private:
const uint16_t delay = 5000;
src/SpecialMenus/GPS/menuGPS.cpp
+1 -1
View File
@@ -1,7 +1,7 @@
/**
* @file menuGPS.cpp
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains an implementation of the class MenuGPS
* @version 0.1
* @date 2022-01-29
*
src/SpecialMenus/GPS/menuGPS.h
+54 -10
View File
@@ -1,7 +1,7 @@
/**
* @file menuGPS.h
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains a class to print informations about the GPS object
* @version 0.1
* @date 2022-01-29
*
@@ -16,19 +16,63 @@
#include "menuControl.h"
/**
* @brief A class to print informations about the GPS object
*
*/
class MenuGPS : public MenuControl {
public:
/**
* @brief Construct a new Menu GPS object
*
* @param gps
*/
MenuGPS(TinyGPSPlus* gps);
void down();
void up();
void right();
void left();
void no();
void yes();
void printMenu();
void update();
/**
* @brief Next page
*/
void down() override;
/**
* @brief Previous page
*/
void up() override;
/**
* @brief Update information
*/
void right() override;
/**
* @brief Go to the parent menu
*/
void left() override;
/**
* @brief Go to the parent menu
*/
void no() override;
/**
* @brief Update information
*/
void yes() override;
/**
* @brief Prints the Information to display and console
*
* Prints the selected page.
* The informations are only printed to the display if it
* set.
*/
void printMenu() override;
/**
* @brief can be called to update shown data
*/
void update() override;
private:
const uint8_t countPages = 7;
@@ -41,4 +85,4 @@ class MenuGPS : public MenuControl {
uint32_t last_millis = 0;
};
#endif // MENU_GPS_H
#endif // MENU_GPS_H
src/SpecialMenus/PID/menuPidSettings.cpp
+2 -2
View File
@@ -1,7 +1,7 @@
/**
* @file pidSettings.cpp
* @file menuPidSettings.cpp
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains an implementation of the class MenuPidSettings
* @version 0.1
* @date 2022-01-19
*
src/SpecialMenus/PID/menuPidSettings.h
+50 -11
View File
@@ -1,7 +1,7 @@
/**
* @file pidSettings.h
* @file menuPidSettings.h
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains a class to tune the PID settings
* @version 0.1
* @date 2022-01-19
*
@@ -18,19 +18,58 @@
#define NUM_VAL 3
/**
* @brief A class to tune the PID settings
*
*/
class MenuPidSettings : public MenuControl {
public:
/**
* @brief Construct a new Menu Pid Settings object
*
* @param pid
*/
MenuPidSettings(PID* pid);
void down();
void up();
void right();
void left();
void no();
void yes();
/**
* @brief Decrement selected value
*/
void down() override;
void printMenu();
void update(){};
/**
* @brief Increment selected value
*/
void up() override;
/**
* @brief Select next value
*/
void right() override;
/**
* @brief Select previous value
*/
void left() override;
/**
* @brief Leave menu without saving
*/
void no() override;
/**
* @brief Leave menu with saving
*/
void yes() override;
/**
* @brief Prints the Information to display and console
*
* The informations are only printed to the display if it
* set.
*/
void printMenu() override;
void update() override {};
private:
PID* pid;
@@ -39,4 +78,4 @@ class MenuPidSettings : public MenuControl {
};
#endif // PID_SETTINGS_H
#endif // PID_SETTINGS_H
src/SpecialMenus/driveModi/Autopilot/menuAutopilot.cpp
+1 -1
View File
@@ -1,7 +1,7 @@
/**
* @file menuAutopilot.cpp
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains an implementation of the class MenuAutopilot
* @version 0.1
* @date 2022-02-03
*
src/SpecialMenus/driveModi/Autopilot/menuAutopilot.h
+24 -1
View File
@@ -1,7 +1,7 @@
/**
* @file menuAutopilot.h
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains a class to print informations about the Autopilot
* @version 0.1
* @date 2022-02-03
*
@@ -14,10 +14,33 @@
#include "SpecialMenus/driveModi/menuDriveMode.h"
/**
* @brief A class to print informations about the Autopilot
*
*/
class MenuAutopilot : public MenuDriveMode {
public:
/**
* @brief Construct a new Menu Autopilot object
*
* @param driveManager for MenuDriveMode
*/
MenuAutopilot(DriveManager* driveManager) : MenuDriveMode(driveManager) {}
/**
* @brief Prints the Information to display and console
*
* The informations are only printed to the display if it
* set.
*
* Changes the DriveModi to Autopilot if it is the first time called
* and save the Autopilot object.
*/
void printMenu();
/**
* @brief can be called to update shown data
*/
void update();
private:
src/SpecialMenus/driveModi/CaptureRoute/menuCaptureRoute.cpp
+1 -1
View File
@@ -1,7 +1,7 @@
/**
* @file menuCaptureRoute.cpp
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains an implementation of the class MenuCaptureRoute
* @version 0.1
* @date 2022-01-31
*
src/SpecialMenus/driveModi/CaptureRoute/menuCaptureRoute.h
+25 -2
View File
@@ -1,7 +1,7 @@
/**
* @file menuCaptureRoute.h
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains a class to print informations about CaptureRoute
* @version 0.1
* @date 2022-01-31
*
@@ -13,10 +13,33 @@
#include "SpecialMenus/driveModi/menuDriveMode.h"
/**
* @brief A class to print informations about the Autopilot
*
*/
class MenuCaptureRoute : public MenuDriveMode {
public:
/**
* @brief Construct a new Menu Capture Route object
*
* @param driveManager
*/
MenuCaptureRoute(DriveManager* driveManager) : MenuDriveMode(driveManager) {}
/**
* @brief Prints the Information to display and console
*
* The informations are only printed to the display if it
* set.
*
* Changes the DriveModi to CaptureRoute if it is the first time called
* and save the CaptureRoute object.
*/
void printMenu();
/**
* @brief can be called to update shown data
*/
void update();
private:
@@ -26,4 +49,4 @@ class MenuCaptureRoute : public MenuDriveMode {
RouteInfo routeInfo;
};
#endif // MENU_MANUAL_DRIVE_H
#endif // MENU_MANUAL_DRIVE_H
src/SpecialMenus/driveModi/ManualDrive/menuManualDrive.cpp
+1 -1
View File
@@ -1,7 +1,7 @@
/**
* @file menuManualDrive.cpp
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains an implementation of the class MenuManualDrive
* @version 0.1
* @date 2022-01-20
*
src/SpecialMenus/driveModi/ManualDrive/menuManualDrive.h
+20 -2
View File
@@ -1,7 +1,7 @@
/**
* @file menuManualDrive.h
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains a class to print information about the class ManualControl
* @version 0.1
* @date 2022-01-20
*
@@ -14,10 +14,28 @@
#include "SpecialMenus/driveModi/menuDriveMode.h"
/**
* @brief A class to print informations about the class ManualControl
*
*/
class MenuManualControl : public MenuDriveMode {
public:
/**
* @brief Construct a new Menu Manual Control object
*
* @param driveManager
*/
MenuManualControl(DriveManager* driveManager) : MenuDriveMode(driveManager) {}
/**
* @brief Prints the Information to display and console
*
* The informations are only printed to the display if it
* set.
*
* Changes the DriveModi to Autopilot if it is the first time called.
*/
void printMenu();
};
#endif // MENU_MANUAL_DRIVE_H
#endif // MENU_MANUAL_DRIVE_H
src/SpecialMenus/driveModi/menuDriveMode.cpp
+2 -2
View File
@@ -1,7 +1,7 @@
/**
* @file menuDriveMode.cpp
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains an implementation of the class MenuDriveMode
* @version 0.1
* @date 2022-01-31
*
@@ -24,4 +24,4 @@ void MenuDriveMode::left() {
void MenuDriveMode::no() {
this->left();
}
}
src/SpecialMenus/driveModi/menuDriveMode.h
+21 -8
View File
@@ -1,7 +1,7 @@
/**
* @file menuDriveMode.h
* @author Alexander Klein (alex@kleiax.de)
* @brief
* @brief Contains a base class for Menus about DriveModi
* @version 0.1
* @date 2022-01-31
*
@@ -14,18 +14,31 @@
#include "menuControl.h"
#include "driveModi/driveManager.h"
/**
* @brief A base class for Menus about DriveModi
*
*/
class MenuDriveMode : public MenuControl {
public:
/**
* @brief Construct a new Menu Drive Mode object
*
* @param driveManager
*/
MenuDriveMode(DriveManager* driveManager);
void down(){}
void up(){}
void right(){}
void left();
void no();
void yes(){}
void down() override {}
void up() override {}
void right() override {}
void left() override;
void no() override;
void yes() override {}
virtual void printMenu() = 0;
/**
* @brief can be called to update shown data
*/
void update(){}
protected:
@@ -33,4 +46,4 @@ class MenuDriveMode : public MenuControl {
bool firstPrint = true;
};
#endif // MENU_DRIVE_MODI_H
#endif // MENU_DRIVE_MODI_H