Final Project files for mBed development.

Dependencies:   m3pi mbed

Files at this revision

API Documentation at this revision

Comitter:
lsaristo
Date:
Tue Nov 11 19:32:20 2014 +0000
Parent:
0:a0375ba4390e
Child:
2:c2764165a23d
Commit message:
Added super basic skeleton for project files

Changed in this revision

driver.c Show annotated file Show diff for this revision Revisions of this file
project.h Show annotated file Show diff for this revision Revisions of this file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/driver.c	Tue Nov 11 19:32:20 2014 +0000
@@ -0,0 +1,21 @@
+/**
+ * @file    driver.c
+ * @brief   Basic driver program for our robot's controller logic. 
+ *
+ * Maybe add lots of stuff here or maybe split it off into
+ * multiple subfiles?
+ *
+ * @author  John Wilkey
+ */
+ #include "project.h"
+ 
+ /**
+  * @brief Entry point. Main loop.
+  */
+ int main()
+ {
+       printf("This doesn't do anything yet...\n");
+       return 0;
+ }
+ 
+ 
\ No newline at end of file
--- /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