Finish documention until someone change something
This commit is contained in:
@@ -1,7 +1,7 @@
|
||||
/**
|
||||
* @file moveControl.h
|
||||
* @author Alexander Klein (alex@kleiax.de)
|
||||
* @brief Contrains the MoveControl class
|
||||
* @brief Contains the MoveControl class
|
||||
* @version 0.1
|
||||
* @date 2021-12-14
|
||||
*
|
||||
@@ -32,7 +32,7 @@ enum DrivingStatus {stop,
|
||||
/**
|
||||
* @brief This class manages the motors and the encoders
|
||||
*
|
||||
* The controler uses two PIDs to control the motors. The PIDs
|
||||
* The class uses two PIDs to control the motors. The PIDs
|
||||
* use the Speedometer class to get the current speed and the
|
||||
* given target speed to calculate a new duty cycle for the motors.
|
||||
*
|
||||
@@ -42,7 +42,7 @@ class MoveControl {
|
||||
/**
|
||||
* @brief Construct a new Move Control object
|
||||
*
|
||||
* Initalize the motors, encoders and PIDs with given
|
||||
* Initialize the motors, encoders and PIDs with given
|
||||
* values in moveControlConfig.h
|
||||
*/
|
||||
MoveControl();
|
||||
@@ -66,14 +66,14 @@ class MoveControl {
|
||||
void loop();
|
||||
|
||||
/**
|
||||
* @brief Noramly called repeatedly by loop() to calcluate new values.
|
||||
* @brief Normally called repeatedly by loop() to calculate new values.
|
||||
*/
|
||||
void runMoveControl();
|
||||
|
||||
/**
|
||||
* @brief Set the DrivingStatus
|
||||
*
|
||||
* @see DrDrivingStatus
|
||||
* @see DrivingStatus
|
||||
* @param status
|
||||
*/
|
||||
void setDrivingStatus(DrivingStatus status);
|
||||
@@ -99,8 +99,6 @@ class MoveControl {
|
||||
/**
|
||||
* @brief Set the pid tunings
|
||||
*
|
||||
* TODO: check if the function is working or indicates seg fault
|
||||
*
|
||||
* @param side 0 -> left, 1 -> right
|
||||
* @param p
|
||||
* @param i
|
||||
@@ -119,7 +117,7 @@ class MoveControl {
|
||||
/**
|
||||
* @brief Set the min delay between each loop
|
||||
*
|
||||
* @param delay time in Milliseconds
|
||||
* @param delay_ time in Milliseconds
|
||||
*/
|
||||
void setDelay(uint8_t delay_) { delay = delay_; }
|
||||
|
||||
|
||||
Reference in New Issue
Block a user