Diff: project.h

Revision:

1:7e0243c27ecb

Child:

2:c2764165a23d

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/project.h	Tue Nov 11 19:32:20 2014 +0000
@@ -0,0 +1,57 @@
+/**
+ * @file    project.h
+ * @brief   Main header file for includes and whatnot 
+ *          for the other project files.
+ * @author  John Wilkey
+ */
+ 
+#ifndef _PROJECT_H
+#define _PROJECT_H
+
+#include <stdio.h>
+
+/**
+ * @brief Driver forward.
+ *
+ * @param[in]   amt     Amount to drive forward.
+ * @param[in]   spd     Drive speed.
+ * @return              Distance driven.
+ */
+float foward(float amt, float spd);
+
+/**
+ * @brief Drive backward.
+ *
+ * @param[in]   amt     Amount to drive backward.
+ * @param[in]   spd     Drive speed.
+ * @return              Distance driven.
+ */
+float backward(float amt);
+
+/**
+ * @brief Turn right.
+ *
+ * @param[in]   deg     Desired final turn angle from starting position.
+ * @param[in]   spd     Desired turning speed.
+ * @return              0 if successful, or an error condition.
+ */
+int right(float deg);
+
+/**
+ * @brief Turn left.
+ *
+ * @param[in]   deg     Desired final turn angle from starting position.
+ * @param[in]   spd     Desired turning speed.
+ * @return              0 if successful, or an error condition.
+ */
+int left (float def);
+
+/**
+ * #brief Controller decision logic.
+ *
+ * Decide what to do next based on the status of the drawing so far.
+ *
+ */
+ void next_action();
+
+#endif
\ No newline at end of file