Diff: main.h

Revision:

8:12d780f7443e

Child:

9:3a0433c391cb

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/main.h	Thu Nov 13 07:12:31 2014 +0000
@@ -0,0 +1,71 @@
+/**
+ * @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>
+#include "mbed.h"
+#include "m3pi.h"
+#define TURN_SPEED 0.25
+#define DRIVE_SPEED 0.5
+#define ERR_SUCCESS 0
+#define ERR_FAILURE 1
+
+
+/**
+ * @brief Driver forward.
+ *
+ * @param[in]   amt     Amount to drive forward.
+ * @param[in]   spd     Drive speed.
+ * @return              Success or failure. 
+ */
+int forward(float amt, float spd);
+
+/**
+ * @brief Drive backward.
+ *
+ * @param[in]   amt     Amount to drive backward.
+ * @param[in]   spd     Drive speed.
+ * @return              Success or failure. 
+ */
+int backward(float amt, float spd);
+
+/**
+ * @brief Turn right.
+ *
+ * @param[in]   deg     Desired final turn angle from starting position.
+ * @param[in]   spd     Desired turning speed.
+ * @return              Success or failure. 
+ */
+int right(float deg);
+
+/**
+ * @brief Turn left.
+ *
+ * @param[in]   deg     Desired final turn angle from starting position.
+ * @param[in]   spd     Desired turning speed.
+ * @return              Success or failure. 
+ */
+int left (float deg);
+
+/**
+ * @brief Controller decision logic.
+ *
+ * Decide what to do next based on the status of the drawing so far.
+ *
+ */
+void next_action();
+
+/**
+ * @brief Print a formatted message to the LCD
+ */
+void pretty_print(char* msg);
+
+
+
+#endif