Jasper Gerth / controlandadjust

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   buttoncontrol includeair includeair Oudverslag

Diff: controlandadjust.h

Revision:
4:e732794d8e7f
Parent:
3:8e6dacabe898
Child:
5:5794dbc42c3d
--- a/controlandadjust.h	Tue Oct 06 13:21:20 2015 +0000
+++ b/controlandadjust.h	Tue Oct 06 13:47:30 2015 +0000
@@ -1,3 +1,13 @@
+/**
+ * @author Jasper Gerth
+ *
+ * 
+ * @section DESCRIPTION
+ *
+ * This library contains a P-, PI-, and a PID-controller.
+ * The controller takes controller consta  
+ */
+
 #ifndef MBED_CONTROLANDADJUST_H
 #define MBED_CONTROLANDADJUST_H
 /**
@@ -37,9 +47,16 @@
  */
 class controlandadjust
 {
+    
 public:
-///Instantiate the controller
+
+    /**
+     * Constructor.
+     *
+     *Constructs a controller
+     */
     controlandadjust(void);
+    
     /** P controller
     * @param error1 : float Error from motor 1
     * @param error2 : float Error from motor 2
@@ -87,8 +104,11 @@
     float motor2pwm();
 
 private:
+    /**
+     *Checks the signal and updates the PWM and direction for motor 1 and 2
+     */
     void verwerksignaal(float , float );
 
 };
 
-#endif
\ No newline at end of file
+#endif /* CONTROLANDADJUST_H */
\ No newline at end of file